SHAPER  9.12.0
ModelAPI_ObjectRenamedMessage Class Reference

Message that the object is renamed. More...

Inheritance diagram for ModelAPI_ObjectRenamedMessage:
Inheritance graph

Public Member Functions

MODELAPI_EXPORT ModelAPI_ObjectRenamedMessage (const Events_ID theID, const void *theSender=0)
 Creates an empty message. More...
 
virtual MODELAPI_EXPORT ~ModelAPI_ObjectRenamedMessage ()
 The virtual destructor. More...
 
MODELAPI_EXPORT ObjectPtr object () const
 Returns an object. More...
 
MODELAPI_EXPORT void setObject (ObjectPtr theObject)
 Sets an object. More...
 
MODELAPI_EXPORT std::wstring oldName () const
 Returns an old name. More...
 
MODELAPI_EXPORT void setOldName (const std::wstring &theOldName)
 Sets an old name. More...
 
MODELAPI_EXPORT std::wstring newName () const
 Returns a new name. More...
 
MODELAPI_EXPORT void setNewName (const std::wstring &theNewName)
 Sets a new name. 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 MODELAPI_EXPORT Events_IDeventId ()
 Static. Returns EventID of the message. More...
 
static MODELAPI_EXPORT void send (ObjectPtr theObject, const std::wstring &theOldName, const std::wstring &theNewName, const void *theSender)
 Useful method that creates and sends the AttributeEvalMessage event. More...
 

Detailed Description

Message that the object is renamed.

Constructor & Destructor Documentation

◆ ModelAPI_ObjectRenamedMessage()

ModelAPI_ObjectRenamedMessage::ModelAPI_ObjectRenamedMessage ( const Events_ID  theID,
const void *  theSender = 0 
)

Creates an empty message.

◆ ~ModelAPI_ObjectRenamedMessage()

ModelAPI_ObjectRenamedMessage::~ModelAPI_ObjectRenamedMessage ( )
virtual

The virtual destructor.

Member Function Documentation

◆ eventId()

static MODELAPI_EXPORT Events_ID& ModelAPI_ObjectRenamedMessage::eventId ( )
inlinestatic

Static. Returns EventID of the message.

◆ send()

void ModelAPI_ObjectRenamedMessage::send ( ObjectPtr  theObject,
const std::wstring &  theOldName,
const std::wstring &  theNewName,
const void *  theSender 
)
static

Useful method that creates and sends the AttributeEvalMessage event.

◆ object()

ObjectPtr ModelAPI_ObjectRenamedMessage::object ( ) const

Returns an object.

◆ setObject()

void ModelAPI_ObjectRenamedMessage::setObject ( ObjectPtr  theObject)

Sets an object.

◆ oldName()

std::wstring ModelAPI_ObjectRenamedMessage::oldName ( ) const

Returns an old name.

◆ setOldName()

void ModelAPI_ObjectRenamedMessage::setOldName ( const std::wstring &  theOldName)

Sets an old name.

◆ newName()

std::wstring ModelAPI_ObjectRenamedMessage::newName ( ) const

Returns a new name.

◆ setNewName()

void ModelAPI_ObjectRenamedMessage::setNewName ( const std::wstring &  theNewName)

Sets a new name.

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