hdicoreThirdPartyPlugin.h

Go to the documentation of this file.

#ifndef __HDI_CORE_3RD_PARTY_PLUGIN__
#define __HDI_CORE_3RD_PARTY_PLUGIN__

#include "hdicoreTypes.h"

namespace hdi
{
    namespace plugin
    {
        class ThirdPartyPlugin;
    }

    namespace core
    {
        class ThirdPartyPlugin
        {
            public:
                enum Options
                {
                    NoOptions                           = 0,
                    AutoSelectsResultsOption            = 1 << 0,
                    RetainsPartialPathSelectionOption   = 1 << 1
                };

                ThirdPartyPlugin();
            
                ThirdPartyPlugin(const ThirdPartyPlugin& p_);

                virtual ~ThirdPartyPlugin();
            
                virtual ThirdPartyPlugin& operator=(const ThirdPartyPlugin& rhs_);
                
                virtual bool operator==(const ThirdPartyPlugin& rhs_) const;
                
                virtual bool operator!=(const ThirdPartyPlugin& rhs_) const;
            
                virtual SPPluginRef spPluginRef() const;

                virtual bool isEmpty() const;

                virtual std::string filePath() const;

                virtual std::string fileName() const;

                virtual std::string name() const;

                virtual Options options() const;

                virtual bool started() const;

                virtual bool broken() const;
                
                virtual bool prepMessageData(SPMessageData& message__) const;
                
                virtual SPErr message(
                    const std::string& caller_,
                    const std::string& selector_,
                    SPMessageData* const message_,
                    SPErr& result__
                ) const;
                
                virtual bool cleanMessageData(SPMessageData& message__) const;


            private:
                friend plugin::ThirdPartyPlugin* __accessImpl(const ThirdPartyPlugin&);
                friend ThirdPartyPlugin __accessCtor(plugin::ThirdPartyPlugin*&);
                
                void* __data;

                ThirdPartyPlugin(plugin::ThirdPartyPlugin*&);
                
                void* __impl() const;
        };
        
        typedef std::auto_ptr<ThirdPartyPlugin> ThirdPartyPluginAP;
        
        extern plugin::ThirdPartyPlugin* __accessImpl(const ThirdPartyPlugin&);
        extern ThirdPartyPlugin __accessCtor(plugin::ThirdPartyPlugin*&);
    }
}

hdi::core::ThirdPartyPlugin::Options operator|(
    const hdi::core::ThirdPartyPlugin::Options lhs_,
    const hdi::core::ThirdPartyPlugin::Options rhs_
);

hdi::core::ThirdPartyPlugin::Options& operator|=(
    hdi::core::ThirdPartyPlugin::Options& lhs__,
    const hdi::core::ThirdPartyPlugin::Options rhs_
);

#endif
// __HDI_CORE_3RD_PARTY_PLUGIN__