41 #ifndef GUI_OBJECTS_PLUGININFO_BASE_HPP
42 #define GUI_OBJECTS_PLUGININFO_BASE_HPP
56 #ifndef BEGIN_objects_SCOPE
57 # define BEGIN_objects_SCOPE BEGIN_SCOPE(objects)
58 # define END_objects_SCOPE END_SCOPE(objects)
99 eAffinity_foreground = 0,
100 eAffinity_background = 1,
101 eAffinity_background_restartable = 2
137 e_applicable_user_types
152 bool IsSetVer_major(
void)
const;
159 bool CanGetVer_major(
void)
const;
162 void ResetVer_major(
void);
190 bool IsSetVer_minor(
void)
const;
197 bool CanGetVer_minor(
void)
const;
200 void ResetVer_minor(
void);
228 bool IsSetVer_revision(
void)
const;
235 bool CanGetVer_revision(
void)
const;
238 void ResetVer_revision(
void);
266 bool IsSetVer_build_date(
void)
const;
273 bool CanGetVer_build_date(
void)
const;
276 void ResetVer_build_date(
void);
306 bool IsSetClass_name(
void)
const;
313 bool CanGetClass_name(
void)
const;
316 void ResetClass_name(
void);
346 bool IsSetMenu_item(
void)
const;
353 bool CanGetMenu_item(
void)
const;
356 void ResetMenu_item(
void);
386 bool IsSetTooltip(
void)
const;
393 bool CanGetTooltip(
void)
const;
396 void ResetTooltip(
void);
402 const TTooltip& GetTooltip(
void)
const;
426 bool IsSetHelp_file(
void)
const;
433 bool CanGetHelp_file(
void)
const;
436 void ResetHelp_file(
void);
466 bool IsSetAutorun(
void)
const;
473 bool CanGetAutorun(
void)
const;
476 void ResetAutorun(
void);
479 void SetDefaultAutorun(
void);
506 bool IsSetAffinity(
void)
const;
513 bool CanGetAffinity(
void)
const;
516 void ResetAffinity(
void);
519 void SetDefaultAffinity(
void);
548 bool IsSetCommand(
void)
const;
555 bool CanGetCommand(
void)
const;
558 void ResetCommand(
void);
564 const TCommand& GetCommand(
void)
const;
588 bool IsSetIcon_info(
void)
const;
595 bool CanGetIcon_info(
void)
const;
598 void ResetIcon_info(
void);
627 bool IsSetApplicable_user_types(
void)
const;
634 bool CanGetApplicable_user_types(
void)
const;
637 void ResetApplicable_user_types(
void);
652 virtual void Reset(
void);
Base class for all serializable objects.
static char UnassignedByte(void)
void ThrowUnassigned(TMemberIndex index) const
#define ENUM_METHOD_NAME(EnumName)
static string UnassignedString(void)
uint32_t Uint4
4-byte (32-bit) unsigned integer
#define END_NCBI_SCOPE
End previously defined NCBI scope.
#define BEGIN_NCBI_SCOPE
Define ncbi namespace.
#define NCBI_GUIOBJECTS_EXPORT
THelp_file & SetHelp_file(void)
Assign a value to Help_file data member.
void SetDefaultAffinity(void)
Assign default value to Affinity data member.
CRef< TIcon_info > m_Icon_info
TApplicable_user_types & SetApplicable_user_types(void)
Assign a value to Applicable_user_types data member.
bool IsSetVer_major(void) const
major version number Check if a value has been assigned to Ver_major data member.
void ResetVer_major(void)
Reset Ver_major data member.
bool IsSetVer_minor(void) const
minor version number Check if a value has been assigned to Ver_minor data member.
const TClass_name & GetClass_name(void) const
Get the Class_name member data.
TVer_revision GetVer_revision(void) const
Get the Ver_revision member data.
bool CanGetVer_build_date(void) const
Check if it is safe to call GetVer_build_date method.
bool CanGetTooltip(void) const
Check if it is safe to call GetTooltip method.
const TIcon_info & GetIcon_info(void) const
Get the Icon_info member data.
bool IsSetVer_revision(void) const
plugin-specific revision number Check if a value has been assigned to Ver_revision data member.
bool IsSetTooltip(void) const
text for mouse-overs and status bars Check if a value has been assigned to Tooltip data member.
DECLARE_INTERNAL_TYPE_INFO()
TVer_minor GetVer_minor(void) const
Get the Ver_minor member data.
TMenu_item & SetMenu_item(void)
Assign a value to Menu_item data member.
bool CanGetAffinity(void) const
Check if it is safe to call GetAffinity method.
TVer_revision & SetVer_revision(void)
Assign a value to Ver_revision data member.
void ResetVer_minor(void)
Reset Ver_minor data member.
bool CanGetApplicable_user_types(void) const
Check if it is safe to call GetApplicable_user_types method.
void SetDefaultAutorun(void)
Assign default value to Autorun data member.
void ResetAutorun(void)
Reset Autorun data member.
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...
bool IsSetAffinity(void) const
Check if a value has been assigned to Affinity data member.
TAutorun GetAutorun(void) const
Get the Autorun member data.
CPluginInfo_Base(const CPluginInfo_Base &)
EAffinity
if 'foreground-only' is true, then this plugin will run entirely in the foreground (main) thread.
bool CanGetVer_revision(void) const
Check if it is safe to call GetVer_revision method.
void ResetCommand(void)
Reset Command data member.
bool CanGetIcon_info(void) const
Check if it is safe to call GetIcon_info method.
const TVer_build_date & GetVer_build_date(void) const
Get the Ver_build_date member data.
const TMenu_item & GetMenu_item(void) const
Get the Menu_item member data.
bool IsSetCommand(void) const
the command and requirements for this plugin Check if a value has been assigned to Command data membe...
TVer_major GetVer_major(void) const
Get the Ver_major member data.
bool IsSetIcon_info(void) const
optional information about an icon suitable for this plugin this is managed as a named resource,...
list< CRef< CPluginUserType > > TApplicable_user_types
CPluginIconInfo TIcon_info
bool IsSetClass_name(void) const
text tag uniquely identifying this plugin Check if a value has been assigned to Class_name data membe...
TClass_name & SetClass_name(void)
Assign a value to Class_name data member.
TCommand & SetCommand(void)
Assign a value to Command data member.
bool CanGetClass_name(void) const
Check if it is safe to call GetClass_name method.
bool IsSetVer_build_date(void) const
date of build Check if a value has been assigned to Ver_build_date data member.
Tparent::CMemberIndex< E_memberIndex, 14 > TmemberIndex
const TApplicable_user_types & GetApplicable_user_types(void) const
Get the Applicable_user_types member data.
bool CanGetVer_major(void) const
Check if it is safe to call GetVer_major method.
TTooltip & SetTooltip(void)
Assign a value to Tooltip data member.
bool CanGetHelp_file(void) const
Check if it is safe to call GetHelp_file method.
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.
TAutorun & SetAutorun(void)
Assign a value to Autorun data member.
CPluginInfo_Base & operator=(const CPluginInfo_Base &)
void ResetAffinity(void)
Reset Affinity data member.
TVer_minor & SetVer_minor(void)
Assign a value to Ver_minor data member.
const TCommand & GetCommand(void) const
Get the Command member data.
const TTooltip & GetTooltip(void) const
Get the Tooltip member data.
CRef< TCommand > m_Command
const THelp_file & GetHelp_file(void) const
Get the Help_file member data.
list< CRef< CPluginUserType > > m_Applicable_user_types
bool CanGetMenu_item(void) const
Check if it is safe to call GetMenu_item method.
bool CanGetCommand(void) const
Check if it is safe to call GetCommand method.
bool IsSetHelp_file(void) const
location of the help file associated with this plugin Check if a value has been assigned to Help_file...
TAffinity GetAffinity(void) const
Get the Affinity member data.
bool IsSetAutorun(void) const
if 'autorun' is true, we launch this plugin command at application startup Check if a value has been ...
void ResetVer_revision(void)
Reset Ver_revision data member.
bool CanGetAutorun(void) const
Check if it is safe to call GetAutorun method.
TAffinity & SetAffinity(void)
Assign a value to Affinity data member.
bool CanGetVer_minor(void) const
Check if it is safe to call GetVer_minor method.
TVer_major & SetVer_major(void)
Assign a value to Ver_major data member.
TVer_build_date & SetVer_build_date(void)
Assign a value to Ver_build_date data member.
Defines to provide correct exporting from DLLs in Windows.
const GenericPointer< typename T::ValueType > T2 value