NCBI C++ ToolKit
Public Types | Public Member Functions | Protected Attributes | List of all members
CViewTypeDescriptor Class Reference

Search Toolkit Book for CViewTypeDescriptor

CViewTypeDescriptor - holds description of a view type. More...

#include <gui/framework/view.hpp>

+ Inheritance diagram for CViewTypeDescriptor:
+ Collaboration diagram for CViewTypeDescriptor:

Public Types

enum  EAcceptionType { eNone , eSingle , eMultiple }
 

Public Member Functions

 CViewTypeDescriptor (const string &label, const string &icon_alias, const string &hint, const string &description, const string &help_id, const string &category, bool singleton)
 CViewTypeDescriptor. More...
 
virtual ~CViewTypeDescriptor ()
 
virtual string GetCategory () const
 get view category (used for view grouping in UI) More...
 
virtual bool IsSingleton () const
 true if only one instance of this type can be created More...
 
virtual void SetCategory (const string &category)
 
virtual void SetSingleton (bool singleton)
 
- Public Member Functions inherited from CUIObject
 CUIObject (const string &label, const string &icon_alias, const string &hint=kEmptyStr, const string &description=kEmptyStr, const string &help_id=kEmptyStr, const string &log_event=kEmptyStr)
 CUIObject. More...
 
 CUIObject (const CUIObject &obj)
 
virtual ~CUIObject ()
 
virtual void Init (const string &label, const string &icon_alias, const string &hint=kEmptyStr, const string &description=kEmptyStr, const string &help_id=kEmptyStr, const string &log_event=kEmptyStr)
 
virtual void SetLabel (const string &label)
 
virtual void SetIconAlias (const string &alias)
 
virtual void SetHint (const string &hint)
 
virtual void SetDescription (const string &descr)
 
virtual void SetHelpId (const string &help_id)
 
virtual void SetLogEvent (const string &log_event)
 
virtual const stringGetLabel () const
 
virtual const stringGetIconAlias () const
 
virtual const stringGetHint () const
 
virtual const stringGetDescription () const
 
virtual const stringGetHelpId () const
 
virtual const stringGetLogEvent () const
 
- Public Member Functions inherited from IUIObject
virtual ~IUIObject ()
 

Protected Attributes

string m_Category
 
bool m_Singleton
 
- Protected Attributes inherited from CUIObject
string m_Label
 
string m_IconAlias
 
string m_Hint
 
string m_Description
 
string m_HelpId
 
string m_LogEvent
 

Detailed Description

CViewTypeDescriptor - holds description of a view type.

CViewTypeDescriptor is used for declaring view types and presenting the information about available types in the UI.

Definition at line 96 of file view.hpp.


The documentation for this class was generated from the following files:
Modified on Sun Jun 23 05:21:51 2024 by modify_doxy.py rev. 669887