Search Toolkit Book for CProjectViewTypeDescriptor

CProjectViewTypeDescriptor - holds description of a project view type. More...

#include <gui/core/project_view_factory.hpp>

Inheritance diagram for CProjectViewTypeDescriptor:

Collaboration diagram for CProjectViewTypeDescriptor:

Public Member Functions
	CProjectViewTypeDescriptor (const string &label, const string &icon_alias, const string &hint, const string &description, const string &help_id, const string &category, bool singleton, const string &primary_type, EPVObjectsAccepted multi_accepted, bool prefetch_needed=true)

const string	GetPrimaryInputType () const

EPVObjectsAccepted	GetObjectsAccepted () const

bool	IsPrefetchNeeded () const

Public Member Functions inherited from CViewTypeDescriptor
	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 string &	GetLabel () const

virtual const string &	GetIconAlias () const

virtual const string &	GetHint () const

virtual const string &	GetDescription () const

virtual const string &	GetHelpId () const

virtual const string &	GetLogEvent () const

Public Member Functions inherited from IUIObject
virtual	~IUIObject ()

Protected Attributes
string	m_PrimaryType

EPVObjectsAccepted	m_MultiAccepted

bool	mf_PrefetchNeeded

Protected Attributes inherited from CViewTypeDescriptor
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

Additional Inherited Members
Public Types inherited from CViewTypeDescriptor
enum	EAcceptionType { eNone , eSingle , eMultiple }

Detailed Description

CProjectViewTypeDescriptor - holds description of a project view type.

Definition at line 57 of file project_view_factory.hpp.

Constructor & Destructor Documentation

◆ CProjectViewTypeDescriptor()

CProjectViewTypeDescriptor::CProjectViewTypeDescriptor	(	const string &	label,
		const string &	icon_alias,
		const string &	hint,
		const string &	description,
		const string &	help_id,
		const string &	category,
		bool	singleton,
		const string &	primary_type,
		EPVObjectsAccepted	multi_accepted,
		bool	prefetch_needed = `true`
	)