SHAPER  9.12.0
Config_AttributeMessage Class Reference

Class to pass an attribute's (widget's) entry info extracted from xml file. More...

Inheritance diagram for Config_AttributeMessage:
Inheritance graph

Public Member Functions

CONFIG_EXPORT Config_AttributeMessage (const Events_ID theId, const void *theParent=0)
 Constructor. More...
 
virtual CONFIG_EXPORT ~Config_AttributeMessage ()
 Destructor. More...
 
CONFIG_EXPORT const std::string & attributeId () const
 Returns attribute's unique id. More...
 
CONFIG_EXPORT const std::string & featureId () const
 Returns attribute's feature's unique id. More...
 
CONFIG_EXPORT bool isObligatory () const
 Returns true if attribute is obligatory: Required to be set by user, else it's feature is invalid. More...
 
CONFIG_EXPORT bool isConcealment () const
 Returns true if attribute should conceal input features. More...
 
CONFIG_EXPORT bool isMainArgument () const
 Returns true if attribute is a main argument of the feature. More...
 
CONFIG_EXPORT bool isGeometricalSelection () const
 Returns true if attribute selects geometry instead of shape;. More...
 
CONFIG_EXPORT const std::list< std::pair< std::string, std::string > > & getCases () const
 Returns container of ids of pair of a case and switches. More...
 
CONFIG_EXPORT void setCases (const std::list< std::pair< std::string, std::string > > &theCases)
 Sets ids of pair of a case and switches. More...
 
CONFIG_EXPORT void setAttributeId (const std::string &theId)
 Set attribute's unique id. More...
 
CONFIG_EXPORT void setFeatureId (const std::string &id)
 Set attribute's feature's unique id. More...
 
CONFIG_EXPORT void setConcealment (bool isConcealment)
 Set attribute's concealment state. More...
 
CONFIG_EXPORT void setObligatory (bool isObligatory)
 Set attribute's obligatory state. More...
 
CONFIG_EXPORT void setMainArgument (bool isMainArg)
 Set a state that the attribute is a main argument of the feature. More...
 
CONFIG_EXPORT void setGeometricalSelection (bool isGeometricalSelection)
 Set attribute's geometrical selection state. More...
 
const Events_IDeventID () 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 * MODEL_EVENT ()
 Same event as Config_FeatureMessage::MODEL_EVENT() More...
 

Detailed Description

Class to pass an attribute's (widget's) entry info extracted from xml file.

<widget id="tool_object" concealment="true" obligatory="0"/>

Constructor & Destructor Documentation

◆ Config_AttributeMessage()

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

Constructor.

◆ ~Config_AttributeMessage()

Config_AttributeMessage::~Config_AttributeMessage ( )
virtual

Destructor.

Member Function Documentation

◆ MODEL_EVENT()

static const char* Config_AttributeMessage::MODEL_EVENT ( )
inlinestatic

◆ attributeId()

const std::string & Config_AttributeMessage::attributeId ( ) const

Returns attribute's unique id.

◆ featureId()

const std::string & Config_AttributeMessage::featureId ( ) const

Returns attribute's feature's unique id.

◆ isObligatory()

bool Config_AttributeMessage::isObligatory ( ) const

Returns true if attribute is obligatory: Required to be set by user, else it's feature is invalid.

◆ isConcealment()

bool Config_AttributeMessage::isConcealment ( ) const

Returns true if attribute should conceal input features.

◆ isMainArgument()

bool Config_AttributeMessage::isMainArgument ( ) const

Returns true if attribute is a main argument of the feature.

◆ isGeometricalSelection()

bool Config_AttributeMessage::isGeometricalSelection ( ) const

Returns true if attribute selects geometry instead of shape;.

◆ getCases()

const std::list< std::pair< std::string, std::string > > & Config_AttributeMessage::getCases ( ) const

Returns container of ids of pair of a case and switches.

◆ setCases()

void Config_AttributeMessage::setCases ( const std::list< std::pair< std::string, std::string > > &  theCases)

Sets ids of pair of a case and switches.

◆ setAttributeId()

void Config_AttributeMessage::setAttributeId ( const std::string &  theId)

Set attribute's unique id.

◆ setFeatureId()

void Config_AttributeMessage::setFeatureId ( const std::string &  id)

Set attribute's feature's unique id.

◆ setConcealment()

void Config_AttributeMessage::setConcealment ( bool  isConcealment)

Set attribute's concealment state.

◆ setObligatory()

void Config_AttributeMessage::setObligatory ( bool  isObligatory)

Set attribute's obligatory state.

◆ setMainArgument()

void Config_AttributeMessage::setMainArgument ( bool  isMainArg)

Set a state that the attribute is a main argument of the feature.

◆ setGeometricalSelection()

void Config_AttributeMessage::setGeometricalSelection ( bool  isGeometricalSelection)

Set attribute's geometrical selection state.

◆ 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.