Search Toolkit Book for CPluginInfo
#include <gui/objects/PluginInfo.hpp>
Inheritance diagram for CPluginInfo:
Collaboration diagram for CPluginInfo:
Public Member Functions | |
| CPluginInfo (void) | |
| ~CPluginInfo (void) | |
| void | SetInfo (int major, int minor, int rev, const string &build_date, const string &class_name, const string &menu_item, const string &tooltip, const string &help_file) |
| void | SetInfo (int major, int minor, int rev, const string &build_date, const string &class_name, const string &menu_item, const string &tooltip, const string &help_file, const string &icon_alias, const string &icon_local_path) |
| CPluginCommand & | SetAlgoCommand (CPluginCommand::TCommand cmd) |
| CPluginCommand & | SetViewCommand (CPluginCommand::TCommand cmd) |
| CPluginCommand & | SetDataCommand (CPluginCommand::TCommand cmd) |
| void | AddApplicableUserType (const string &type, const string &subtype=kEmptyStr) |
| Public Member Functions inherited from CPluginInfo_Base | |
| CPluginInfo_Base (void) | |
| virtual | ~CPluginInfo_Base (void) |
| DECLARE_INTERNAL_TYPE_INFO () | |
| bool | IsSetVer_major (void) const |
| major version number Check if a value has been assigned to Ver_major data member. More... | |
| bool | CanGetVer_major (void) const |
| Check if it is safe to call GetVer_major method. More... | |
| void | ResetVer_major (void) |
| Reset Ver_major data member. More... | |
| TVer_major | GetVer_major (void) const |
| Get the Ver_major member data. More... | |
| void | SetVer_major (TVer_major value) |
| Assign a value to Ver_major data member. More... | |
| TVer_major & | SetVer_major (void) |
| Assign a value to Ver_major data member. More... | |
| bool | IsSetVer_minor (void) const |
| minor version number Check if a value has been assigned to Ver_minor data member. More... | |
| bool | CanGetVer_minor (void) const |
| Check if it is safe to call GetVer_minor method. More... | |
| void | ResetVer_minor (void) |
| Reset Ver_minor data member. More... | |
| TVer_minor | GetVer_minor (void) const |
| Get the Ver_minor member data. More... | |
| void | SetVer_minor (TVer_minor value) |
| Assign a value to Ver_minor data member. More... | |
| TVer_minor & | SetVer_minor (void) |
| Assign a value to Ver_minor data member. More... | |
| bool | IsSetVer_revision (void) const |
| plugin-specific revision number Check if a value has been assigned to Ver_revision data member. More... | |
| bool | CanGetVer_revision (void) const |
| Check if it is safe to call GetVer_revision method. More... | |
| void | ResetVer_revision (void) |
| Reset Ver_revision data member. More... | |
| TVer_revision | GetVer_revision (void) const |
| Get the Ver_revision member data. More... | |
| void | SetVer_revision (TVer_revision value) |
| Assign a value to Ver_revision data member. More... | |
| TVer_revision & | SetVer_revision (void) |
| Assign a value to Ver_revision data member. More... | |
| bool | IsSetVer_build_date (void) const |
| date of build Check if a value has been assigned to Ver_build_date data member. More... | |
| bool | CanGetVer_build_date (void) const |
| Check if it is safe to call GetVer_build_date method. More... | |
| void | ResetVer_build_date (void) |
| Reset Ver_build_date data member. More... | |
| const TVer_build_date & | GetVer_build_date (void) const |
| Get the Ver_build_date member data. More... | |
| void | SetVer_build_date (const TVer_build_date &value) |
| Assign a value to Ver_build_date data member. More... | |
| void | SetVer_build_date (TVer_build_date &&value) |
| TVer_build_date & | SetVer_build_date (void) |
| Assign a value to Ver_build_date data member. More... | |
| bool | IsSetClass_name (void) const |
| text tag uniquely identifying this plugin Check if a value has been assigned to Class_name data member. More... | |
| bool | CanGetClass_name (void) const |
| Check if it is safe to call GetClass_name method. More... | |
| void | ResetClass_name (void) |
| Reset Class_name data member. More... | |
| const TClass_name & | GetClass_name (void) const |
| Get the Class_name member data. More... | |
| void | SetClass_name (const TClass_name &value) |
| Assign a value to Class_name data member. More... | |
| void | SetClass_name (TClass_name &&value) |
| TClass_name & | SetClass_name (void) |
| Assign a value to Class_name data member. More... | |
| bool | IsSetMenu_item (void) const |
| menu item that will be shown in a GUI Check if a value has been assigned to Menu_item data member. More... | |
| bool | CanGetMenu_item (void) const |
| Check if it is safe to call GetMenu_item method. More... | |
| void | ResetMenu_item (void) |
| Reset Menu_item data member. More... | |
| const TMenu_item & | GetMenu_item (void) const |
| Get the Menu_item member data. More... | |
| void | SetMenu_item (const TMenu_item &value) |
| Assign a value to Menu_item data member. More... | |
| void | SetMenu_item (TMenu_item &&value) |
| TMenu_item & | SetMenu_item (void) |
| Assign a value to Menu_item data member. More... | |
| bool | IsSetTooltip (void) const |
| text for mouse-overs and status bars Check if a value has been assigned to Tooltip data member. More... | |
| bool | CanGetTooltip (void) const |
| Check if it is safe to call GetTooltip method. More... | |
| void | ResetTooltip (void) |
| Reset Tooltip data member. More... | |
| const TTooltip & | GetTooltip (void) const |
| Get the Tooltip member data. More... | |
| void | SetTooltip (const TTooltip &value) |
| Assign a value to Tooltip data member. More... | |
| void | SetTooltip (TTooltip &&value) |
| TTooltip & | SetTooltip (void) |
| Assign a value to Tooltip data member. More... | |
| bool | IsSetHelp_file (void) const |
| location of the help file associated with this plugin Check if a value has been assigned to Help_file data member. More... | |
| bool | CanGetHelp_file (void) const |
| Check if it is safe to call GetHelp_file method. More... | |
| void | ResetHelp_file (void) |
| Reset Help_file data member. More... | |
| const THelp_file & | GetHelp_file (void) const |
| Get the Help_file member data. More... | |
| void | SetHelp_file (const THelp_file &value) |
| Assign a value to Help_file data member. More... | |
| void | SetHelp_file (THelp_file &&value) |
| THelp_file & | SetHelp_file (void) |
| Assign a value to Help_file data member. More... | |
| bool | IsSetAutorun (void) const |
| if 'autorun' is true, we launch this plugin command at application startup Check if a value has been assigned to Autorun data member. More... | |
| bool | CanGetAutorun (void) const |
| Check if it is safe to call GetAutorun method. More... | |
| void | ResetAutorun (void) |
| Reset Autorun data member. More... | |
| void | SetDefaultAutorun (void) |
| Assign default value to Autorun data member. More... | |
| TAutorun | GetAutorun (void) const |
| Get the Autorun member data. More... | |
| void | SetAutorun (TAutorun value) |
| Assign a value to Autorun data member. More... | |
| TAutorun & | SetAutorun (void) |
| Assign a value to Autorun data member. More... | |
| bool | IsSetAffinity (void) const |
| Check if a value has been assigned to Affinity data member. More... | |
| bool | CanGetAffinity (void) const |
| Check if it is safe to call GetAffinity method. More... | |
| void | ResetAffinity (void) |
| Reset Affinity data member. More... | |
| void | SetDefaultAffinity (void) |
| Assign default value to Affinity data member. More... | |
| TAffinity | GetAffinity (void) const |
| Get the Affinity member data. More... | |
| void | SetAffinity (TAffinity value) |
| Assign a value to Affinity data member. More... | |
| TAffinity & | SetAffinity (void) |
| Assign a value to Affinity data member. More... | |
| bool | IsSetCommand (void) const |
| the command and requirements for this plugin Check if a value has been assigned to Command data member. More... | |
| bool | CanGetCommand (void) const |
| Check if it is safe to call GetCommand method. More... | |
| void | ResetCommand (void) |
| Reset Command data member. More... | |
| const TCommand & | GetCommand (void) const |
| Get the Command member data. More... | |
| void | SetCommand (TCommand &value) |
| Assign a value to Command data member. More... | |
| TCommand & | SetCommand (void) |
| Assign a value to Command data member. More... | |
| bool | IsSetIcon_info (void) const |
| optional information about an icon suitable for this plugin this is managed as a named resource, with separate registration of the resource binding the name to an image Check if a value has been assigned to Icon_info data member. More... | |
| bool | CanGetIcon_info (void) const |
| Check if it is safe to call GetIcon_info method. More... | |
| void | ResetIcon_info (void) |
| Reset Icon_info data member. More... | |
| const TIcon_info & | GetIcon_info (void) const |
| Get the Icon_info member data. More... | |
| void | SetIcon_info (TIcon_info &value) |
| Assign a value to Icon_info data member. More... | |
| TIcon_info & | SetIcon_info (void) |
| Assign a value to Icon_info data member. More... | |
| bool | IsSetApplicable_user_types (void) const |
| here is the set of user types to which this plugin subscribes any object of these types will work for this plugin Check if a value has been assigned to Applicable_user_types data member. More... | |
| bool | CanGetApplicable_user_types (void) const |
| Check if it is safe to call GetApplicable_user_types method. More... | |
| void | ResetApplicable_user_types (void) |
| Reset Applicable_user_types data member. More... | |
| const TApplicable_user_types & | GetApplicable_user_types (void) const |
| Get the Applicable_user_types member data. More... | |
| TApplicable_user_types & | SetApplicable_user_types (void) |
| Assign a value to Applicable_user_types data member. More... | |
| virtual void | Reset (void) |
| Reset the whole object. More... | |
| Public Member Functions inherited from CSerialObject | |
| CSerialObject (void) | |
| virtual | ~CSerialObject (void) |
| virtual const CTypeInfo * | GetThisTypeInfo (void) const =0 |
| virtual void | Assign (const CSerialObject &source, ESerialRecursionMode how=eRecursive) |
| Set object to copy of another one. More... | |
| virtual bool | Equals (const CSerialObject &object, ESerialRecursionMode how=eRecursive) const |
| Check if both objects contain the same values. More... | |
| virtual void | DebugDump (CDebugDumpContext ddc, unsigned int depth) const |
| Define method for dumping debug information. More... | |
| void | ThrowUnassigned (TMemberIndex index) const |
| void | ThrowUnassigned (TMemberIndex index, const char *file_name, int file_line) const |
| bool | HasNamespaceName (void) const |
| Check if object data type has namespace name. More... | |
| const string & | GetNamespaceName (void) const |
| Get namespace name. More... | |
| bool | HasNamespacePrefix (void) const |
| Check if data type has namespace prefix. More... | |
| const string & | GetNamespacePrefix (void) const |
| Get namespace prefix. More... | |
| Public Member Functions inherited from CObject | |
| CObject (void) | |
| Constructor. More... | |
| CObject (const CObject &src) | |
| Copy constructor. More... | |
| virtual | ~CObject (void) |
| Destructor. More... | |
| CObject & | operator= (const CObject &src) THROWS_NONE |
| Assignment operator. More... | |
| bool | CanBeDeleted (void) const THROWS_NONE |
| Check if object can be deleted. More... | |
| bool | IsAllocatedInPool (void) const THROWS_NONE |
| Check if object is allocated in memory pool (not system heap) More... | |
| bool | Referenced (void) const THROWS_NONE |
| Check if object is referenced. More... | |
| bool | ReferencedOnlyOnce (void) const THROWS_NONE |
| Check if object is referenced only once. More... | |
| void | AddReference (void) const |
| Add reference to object. More... | |
| void | RemoveReference (void) const |
| Remove reference to object. More... | |
| void | ReleaseReference (void) const |
| Remove reference without deleting object. More... | |
| virtual void | DoNotDeleteThisObject (void) |
| Mark this object as not allocated in heap – do not delete this object. More... | |
| virtual void | DoDeleteThisObject (void) |
| Mark this object as allocated in heap – object can be deleted. More... | |
| void * | operator new (size_t size) |
| Define new operator for memory allocation. More... | |
| void * | operator new[] (size_t size) |
| Define new[] operator for 'array' memory allocation. More... | |
| void | operator delete (void *ptr) |
| Define delete operator for memory deallocation. More... | |
| void | operator delete[] (void *ptr) |
| Define delete[] operator for memory deallocation. More... | |
| void * | operator new (size_t size, void *place) |
| Define new operator. More... | |
| void | operator delete (void *ptr, void *place) |
| Define delete operator. More... | |
| void * | operator new (size_t size, CObjectMemoryPool *place) |
| Define new operator using memory pool. More... | |
| void | operator delete (void *ptr, CObjectMemoryPool *place) |
| Define delete operator. More... | |
| Public Member Functions inherited from CDebugDumpable | |
| CDebugDumpable (void) | |
| virtual | ~CDebugDumpable (void) |
| void | DebugDumpText (ostream &out, const string &bundle, unsigned int depth) const |
| void | DebugDumpFormat (CDebugDumpFormatter &ddf, const string &bundle, unsigned int depth) const |
| void | DumpToConsole (void) const |
Private Types | |
| typedef CPluginInfo_Base | Tparent |
Private Member Functions | |
| CPluginInfo (const CPluginInfo &value) | |
| CPluginInfo & | operator= (const CPluginInfo &value) |
Additional Inherited Members | |
| Public Types inherited from CPluginInfo_Base | |
| enum | EAffinity { eAffinity_foreground = 0 , eAffinity_background = 1 , eAffinity_background_restartable = 2 } |
| if 'foreground-only' is true, then this plugin will run entirely in the foreground (main) thread. More... | |
| enum class | E_memberIndex { e__allMandatory = 0 , e_ver_major , e_ver_minor , e_ver_revision , e_ver_build_date , e_class_name , e_menu_item , e_tooltip , e_help_file , e_autorun , e_affinity , e_command , e_icon_info , e_applicable_user_types } |
| typedef int | TVer_major |
| typedef int | TVer_minor |
| typedef int | TVer_revision |
| typedef string | TVer_build_date |
| typedef string | TClass_name |
| typedef string | TMenu_item |
| typedef string | TTooltip |
| typedef string | THelp_file |
| typedef bool | TAutorun |
| typedef EAffinity | TAffinity |
| typedef CPluginCommand | TCommand |
| typedef CPluginIconInfo | TIcon_info |
| typedef list< CRef< CPluginUserType > > | TApplicable_user_types |
| typedef Tparent::CMemberIndex< E_memberIndex, 14 > | TmemberIndex |
| Public Types inherited from CObject | |
| enum | EAllocFillMode { eAllocFillNone = 1 , eAllocFillZero , eAllocFillPattern } |
| Control filling of newly allocated memory. More... | |
| typedef CObjectCounterLocker | TLockerType |
| Default locker type for CRef. More... | |
| typedef atomic< Uint8 > | TCounter |
| Counter type is CAtomiCounter. More... | |
| typedef Uint8 | TCount |
| Alias for value type of counter. More... | |
| Static Public Member Functions inherited from CPluginInfo_Base | |
| static const NCBI_NS_NCBI::CEnumeratedTypeValues *ENUM_METHOD_NAME() | EAffinity (void) |
| Access to EAffinity's attributes (values, names) as defined in spec. More... | |
| Static Public Member Functions inherited from CSerialObject | |
| static void | SetVerifyDataThread (ESerialVerifyData verify) |
| static void | SetVerifyDataGlobal (ESerialVerifyData verify) |
| static string | UnassignedString (void) |
| static CStringUTF8 | UnassignedStringUTF8 (void) |
| static char | UnassignedByte (void) |
| Static Public Member Functions inherited from CObject | |
| static NCBI_XNCBI_EXPORT void | ThrowNullPointerException (void) |
| Define method to throw null pointer exception. More... | |
| static NCBI_XNCBI_EXPORT void | ThrowNullPointerException (const type_info &type) |
| static EAllocFillMode | GetAllocFillMode (void) |
| static void | SetAllocFillMode (EAllocFillMode mode) |
| static void | SetAllocFillMode (const string &value) |
| Set mode from configuration parameter value. More... | |
| Static Public Member Functions inherited from CDebugDumpable | |
| static void | EnableDebugDump (bool on) |
| Static Public Attributes inherited from CSerialObject | |
| static const char * | ms_UnassignedStr = "<*unassigned*>" |
| static const char | ms_UnassignedByte = char(0xcd) |
| Static Public Attributes inherited from CObject | |
| static const TCount | eCounterBitsCanBeDeleted = 1 << 0 |
| Define possible object states. More... | |
| static const TCount | eCounterBitsInPlainHeap = 1 << 1 |
| Heap signature was found. More... | |
| static const TCount | eCounterBitsPlaceMask |
| Mask for 'in heap' state flags. More... | |
| static const int | eCounterStep = 1 << 2 |
| Skip over the "in heap" bits. More... | |
| static const TCount | eCounterValid = TCount(1) << (sizeof(TCount) * 8 - 2) |
| Minimal value for valid objects (reference counter is zero) Must be a single bit value. More... | |
| static const TCount | eCounterStateMask |
| Valid object, and object in heap. More... | |
| Protected Member Functions inherited from CObject | |
| virtual void | DeleteThis (void) |
| Virtual method "deleting" this object. More... | |
Detailed Description
Definition at line 52 of file PluginInfo.hpp.
Member Typedef Documentation
◆ Tparent
|
private |
Definition at line 54 of file PluginInfo.hpp.
Constructor & Destructor Documentation
◆ CPluginInfo() [1/2]
|
inline |
Definition at line 97 of file PluginInfo.hpp.
◆ ~CPluginInfo()
| CPluginInfo::~CPluginInfo | ( | void | ) |
Definition at line 52 of file PluginInfo.cpp.
◆ CPluginInfo() [2/2]
|
private |
Member Function Documentation
◆ AddApplicableUserType()
Definition at line 131 of file PluginInfo.cpp.
References CPluginInfo_Base::SetApplicable_user_types().
◆ operator=()
|
private |
◆ SetAlgoCommand()
| CPluginCommand & CPluginInfo::SetAlgoCommand | ( | CPluginCommand::TCommand | cmd | ) |
Definition at line 103 of file PluginInfo.cpp.
References algo, cmd, and CPluginInfo_Base::SetCommand().
◆ SetDataCommand()
| CPluginCommand & CPluginInfo::SetDataCommand | ( | CPluginCommand::TCommand | cmd | ) |
Definition at line 123 of file PluginInfo.cpp.
References cmd, data, and CPluginInfo_Base::SetCommand().
◆ SetInfo() [1/2]
| void CPluginInfo::SetInfo | ( | int | major, |
| int | minor, | ||
| int | rev, | ||
| const string & | build_date, | ||
| const string & | class_name, | ||
| const string & | menu_item, | ||
| const string & | tooltip, | ||
| const string & | help_file | ||
| ) |
Definition at line 58 of file PluginInfo.cpp.
References CPluginInfo_Base::SetClass_name(), CPluginInfo_Base::SetHelp_file(), CPluginInfo_Base::SetMenu_item(), CPluginInfo_Base::SetTooltip(), CPluginInfo_Base::SetVer_build_date(), CPluginInfo_Base::SetVer_major(), CPluginInfo_Base::SetVer_minor(), and CPluginInfo_Base::SetVer_revision().
Referenced by SetInfo().
◆ SetInfo() [2/2]
| void CPluginInfo::SetInfo | ( | int | major, |
| int | minor, | ||
| int | rev, | ||
| const string & | build_date, | ||
| const string & | class_name, | ||
| const string & | menu_item, | ||
| const string & | tooltip, | ||
| const string & | help_file, | ||
| const string & | icon_alias, | ||
| const string & | icon_local_path | ||
| ) |
Definition at line 87 of file PluginInfo.cpp.
References CPluginIconInfo_Base::SetAlias(), CPluginInfo_Base::SetIcon_info(), SetInfo(), and CPluginIconInfo_Base::SetPath().
◆ SetViewCommand()
| CPluginCommand & CPluginInfo::SetViewCommand | ( | CPluginCommand::TCommand | cmd | ) |
Definition at line 111 of file PluginInfo.cpp.
References cmd, CPluginInfo_Base::eAffinity_foreground, CPluginInfo_Base::SetAffinity(), CPluginCommand_Base::SetCommand(), and CPluginInfo_Base::SetCommand().
The documentation for this class was generated from the following files:
- include/gui/objects/PluginInfo.hpp
- src/gui/objects/PluginInfo.cpp
