Config_FeatureMessage Class Reference

Class to pass a feature entry extracted from xml file. More...

Inheritance diagram for Config_FeatureMessage:

Public Member Functions
CONFIG_EXPORT	Config_FeatureMessage (const Events_ID theId, const void *theParent=0)
	Constructs Config_FeatureMessage. More...
virtual CONFIG_EXPORT	~Config_FeatureMessage ()
	Deletes Config_FeatureMessage. More...
CONFIG_EXPORT const std::string &	id () const
	Feature's Id. More...
CONFIG_EXPORT const std::string &	icon () const
	Feature's Icon. More...
CONFIG_EXPORT const std::string &	keysequence () const
	Feature's shortcut. More...
CONFIG_EXPORT const std::string &	text () const
	Feature's text. More...
CONFIG_EXPORT const std::string &	tooltip () const
	Feature's tooltip. More...
CONFIG_EXPORT const std::string &	groupId () const
	Id of Feature's Group. More...
CONFIG_EXPORT const std::string &	toolBarId () const
	Id of Feature's Toolbar. More...
CONFIG_EXPORT const std::string &	helpFileName () const
	Returns help file name for the feature. More...
CONFIG_EXPORT const std::string &	workbenchId () const
	Id of Feature's Workbench. More...
CONFIG_EXPORT const std::string &	documentKind () const
	Kind of a document which contains the feature. More...
CONFIG_EXPORT const std::string &	pluginLibrary () const
	Name of a library which contains the feature. More...
CONFIG_EXPORT const std::string &	nestedFeatures () const
	Space separated list of nested features. More...
CONFIG_EXPORT const std::string &	actionsWhenNested () const
	Space separated list of actions. More...
CONFIG_EXPORT bool	isUseInput () const
	If false - feature has no Property panel representation. More...
CONFIG_EXPORT bool	isInternal () const
	If true - feature will not be added into the workbench. More...
CONFIG_EXPORT bool	isModal () const
	If true - the feature will be represented by modal dialog box GUI. More...
CONFIG_EXPORT bool	isApplyContinue () const
	If true - the feature can have Apply/Continue button in its property panel. More...
CONFIG_EXPORT bool	isAutoPreview () const
	If true - preview of the feature is done by any modification of the feature attributes. More...
CONFIG_EXPORT bool	isTitleInToolbar () const
	If true - title should normally be displayed in the toolbar. More...
CONFIG_EXPORT bool	isHideFacesPanel () const
	If true - then HideFaces panel has to be shown. More...
CONFIG_EXPORT bool	isAbortConfirmation () const
CONFIG_EXPORT void	setId (const std::string &id)
	Set feature's Id. More...
CONFIG_EXPORT void	setIcon (const std::string &icon)
	Set feature's Icon. More...
CONFIG_EXPORT void	setKeysequence (const std::string &keysequence)
	Set feature's shortcut. More...
CONFIG_EXPORT void	setText (const std::string &text)
	Set feature's text. More...
CONFIG_EXPORT void	setTooltip (const std::string &tooltip)
	Set feature's tooltip. More...
CONFIG_EXPORT void	setGroupId (const std::string &groupId)
	Set id of Feature's Group. More...
CONFIG_EXPORT void	setToolBarId (const std::string &aId)
	Set id of Feature's Group. More...
CONFIG_EXPORT void	setHelpFileName (const std::string &aName)
	Set help file name. More...
CONFIG_EXPORT void	setWorkbenchId (const std::string &workbenchId)
	Set id of Feature's Workbench. More...
CONFIG_EXPORT void	setDocumentKind (const std::string &documentKind)
	Set kind of a document which contains the feature. More...
CONFIG_EXPORT void	setPluginLibrary (const std::string &thePluginLibrary)
	Set name of a library which contains the feature. More...
CONFIG_EXPORT void	setNestedFeatures (const std::string &theNestedFeatures)
	Set space separated list of nested features. More...
CONFIG_EXPORT void	setActionsWhenNested (const std::string &theActions)
	Set space separated list of nested features. More...
CONFIG_EXPORT void	setUseInput (bool isUseInput)
	Set use input state; If false - feature has no Property panel representation. More...
CONFIG_EXPORT void	setInternal (bool isInternal)
	Set internal state; If true - feature will not be added into the workbench. More...
CONFIG_EXPORT void	setAutoPreview (bool isAutoPreview)
	Set auto preview state; If true - preview of the feature is computed automatically. More...
CONFIG_EXPORT void	setModal (bool isModal)
	Set modality state; If true - the feature will be represented by modal dialog box GUI. More...
CONFIG_EXPORT void	setTitleInToolbar (bool theValue)
	Set flag to display title in toolbar. More...
CONFIG_EXPORT void	setHideFacesPanel (bool theValue)
	Set flag to display title in toolbar. More...
CONFIG_EXPORT void	setAbortConfirmation (bool theValue)
	Set flag to display title in toolbar. More...
CONFIG_EXPORT void	setApplyContinue (bool isModal)
	Set Apply/Continue state; If true - the feature can have Apply/Continue button in its property panel. More...
const Events_ID &	eventID () const
	Returns identifier of the message. More...
void *	sender () const
	Returns sender of the message or NULL if it is anonymous message. More...

Static Public Member Functions
static const char *	GUI_EVENT ()
	Event ID that feature is loaded in workbench (GUI) More...
static const char *	MODEL_EVENT ()
	Event ID that feature is loaded in workbench (Model) More...

Detailed Description

Class to pass a feature entry extracted from xml file.

Example of the feature entry:

<feature id="Part" text="New part" tooltip="Creates a new part" icon=":pictures/part_ico.png"/>

Constructor & Destructor Documentation

Config_FeatureMessage()

Config_FeatureMessage::Config_FeatureMessage	(	const Events_ID	theId,
		const void *	theParent = 0
	)

Constructs Config_FeatureMessage.

~Config_FeatureMessage()

Config_FeatureMessage::~Config_FeatureMessage ( )

virtual

Deletes Config_FeatureMessage.

Member Function Documentation

GUI_EVENT()

static const char* Config_FeatureMessage::GUI_EVENT ( )

inlinestatic

Event ID that feature is loaded in workbench (GUI)

MODEL_EVENT()

static const char* Config_FeatureMessage::MODEL_EVENT ( )

inlinestatic

Event ID that feature is loaded in workbench (Model)

id()

const std::string & Config_FeatureMessage::id

(

)

const

Feature's Id.

icon()

const std::string & Config_FeatureMessage::icon

(

)

const

Feature's Icon.

keysequence()

const std::string & Config_FeatureMessage::keysequence

(

)

const

Feature's shortcut.

text()

const std::string & Config_FeatureMessage::text

(

)

const

Feature's text.

tooltip()

const std::string & Config_FeatureMessage::tooltip

(

)

const

Feature's tooltip.

groupId()

const std::string & Config_FeatureMessage::groupId

(

)

const

Id of Feature's Group.

toolBarId()

const std::string & Config_FeatureMessage::toolBarId

(

)

const

Id of Feature's Toolbar.

helpFileName()

const std::string & Config_FeatureMessage::helpFileName

(

)

const

Returns help file name for the feature.

workbenchId()

const std::string & Config_FeatureMessage::workbenchId

(

)

const

Id of Feature's Workbench.

documentKind()

const std::string & Config_FeatureMessage::documentKind

(

)

const

Kind of a document which contains the feature.

pluginLibrary()

const std::string & Config_FeatureMessage::pluginLibrary

(

)

const

Name of a library which contains the feature.

nestedFeatures()

const std::string & Config_FeatureMessage::nestedFeatures

(

)

const

Space separated list of nested features.

actionsWhenNested()

const std::string & Config_FeatureMessage::actionsWhenNested

(

)

const

Space separated list of actions.

isUseInput()

bool Config_FeatureMessage::isUseInput

(

)

const

If false - feature has no Property panel representation.

isInternal()

bool Config_FeatureMessage::isInternal

(

)

const

If true - feature will not be added into the workbench.

isModal()

bool Config_FeatureMessage::isModal

(

)

const

If true - the feature will be represented by modal dialog box GUI.

isApplyContinue()

bool Config_FeatureMessage::isApplyContinue

(

)

const

If true - the feature can have Apply/Continue button in its property panel.

isAutoPreview()

bool Config_FeatureMessage::isAutoPreview

(

)

const

If true - preview of the feature is done by any modification of the feature attributes.

isTitleInToolbar()

bool Config_FeatureMessage::isTitleInToolbar

(

)

const

If true - title should normally be displayed in the toolbar.

isHideFacesPanel()

bool Config_FeatureMessage::isHideFacesPanel

(

)

const

If true - then HideFaces panel has to be shown.

setId()

void Config_FeatureMessage::setId

(

const std::string &

id

)

Set feature's Id.

setIcon()

void Config_FeatureMessage::setIcon

(

const std::string &

icon

)

Set feature's Icon.

setKeysequence()

void Config_FeatureMessage::setKeysequence

(

const std::string &

keysequence

)

Set feature's shortcut.

setText()

void Config_FeatureMessage::setText

(

const std::string &

text

)

Set feature's text.

setTooltip()

void Config_FeatureMessage::setTooltip

(

const std::string &

tooltip

)

Set feature's tooltip.

setGroupId()

void Config_FeatureMessage::setGroupId

(

const std::string &

groupId

)

Set id of Feature's Group.

setToolBarId()

void Config_FeatureMessage::setToolBarId

(

const std::string &

aId

)

Set id of Feature's Group.

setHelpFileName()

void Config_FeatureMessage::setHelpFileName

(

const std::string &

aName

)

Set help file name.

setWorkbenchId()

void Config_FeatureMessage::setWorkbenchId

(

const std::string &

workbenchId

)

Set id of Feature's Workbench.

setDocumentKind()

void Config_FeatureMessage::setDocumentKind

(

const std::string &

documentKind

)

Set kind of a document which contains the feature.

setPluginLibrary()

void Config_FeatureMessage::setPluginLibrary

(

const std::string &

thePluginLibrary

)

Set name of a library which contains the feature.

setNestedFeatures()

void Config_FeatureMessage::setNestedFeatures

(

const std::string &

theNestedFeatures

)

Set space separated list of nested features.

setActionsWhenNested()

void Config_FeatureMessage::setActionsWhenNested

(

const std::string &

theActions

)

Set space separated list of nested features.

setUseInput()

void Config_FeatureMessage::setUseInput

(

bool

isUseInput

)

Set use input state; If false - feature has no Property panel representation.

setInternal()

void Config_FeatureMessage::setInternal

(

bool

isInternal

)

Set internal state; If true - feature will not be added into the workbench.

setAutoPreview()

void Config_FeatureMessage::setAutoPreview

(

bool

isAutoPreview

)

Set auto preview state; If true - preview of the feature is computed automatically.

setModal()

void Config_FeatureMessage::setModal

(

bool

isModal

)

Set modality state; If true - the feature will be represented by modal dialog box GUI.

setTitleInToolbar()

void Config_FeatureMessage::setTitleInToolbar

(

bool

theValue

)

Set flag to display title in toolbar.

setHideFacesPanel()

void Config_FeatureMessage::setHideFacesPanel

(

bool

theValue

)

Set flag to display title in toolbar.

setAbortConfirmation()

void Config_FeatureMessage::setAbortConfirmation

(

bool

theValue

)

Set flag to display title in toolbar.

setApplyContinue()

void Config_FeatureMessage::setApplyContinue

(

bool

isModal

)

Set Apply/Continue state; If true - the feature can have Apply/Continue button in its property panel.

eventID()

const Events_ID& Events_Message::eventID ( ) const

inlineinherited

Returns identifier of the message.

sender()

void* Events_Message::sender ( ) const

inlineinherited

Returns sender of the message or NULL if it is anonymous message.