SHAPER  9.12.0
ModuleBase_OperationDescription Class Reference

Public Member Functions

 ModuleBase_OperationDescription (const QString &theId="")
 Constructor. More...
 
virtual ~ModuleBase_OperationDescription ()
 Destructor. More...
 
const QString & operationId () const
 Unique name of the operation. More...
 
const QString & description () const
 Returns a short description of operation (will be inserted in title of property panel) More...
 
void setDescription (const QString &theDescription)
 Sets a short description of operation (will be inserted in title of property panel) More...
 
const QString & xmlRepresentation () const
 Returns XML representation of the operation's widget. More...
 
void setXmlRepresentation (const QString &theXMLRepresentation)
 Sets XML representation of the operation's widget. More...
 
bool hasXmlRepresentation () const
 Returns true if there are no model widgets. More...
 

Detailed Description

Description of operation from XML

Constructor & Destructor Documentation

◆ ModuleBase_OperationDescription()

ModuleBase_OperationDescription::ModuleBase_OperationDescription ( const QString &  theId = "")

Constructor.

Parameters
theId- the operation identifier

◆ ~ModuleBase_OperationDescription()

ModuleBase_OperationDescription::~ModuleBase_OperationDescription ( )
virtual

Destructor.

Member Function Documentation

◆ operationId()

const QString & ModuleBase_OperationDescription::operationId ( ) const

Unique name of the operation.

Returns
string name of the operation.

◆ description()

const QString & ModuleBase_OperationDescription::description ( ) const

Returns a short description of operation (will be inserted in title of property panel)

◆ setDescription()

void ModuleBase_OperationDescription::setDescription ( const QString &  theDescription)

Sets a short description of operation (will be inserted in title of property panel)

◆ xmlRepresentation()

const QString & ModuleBase_OperationDescription::xmlRepresentation ( ) const

Returns XML representation of the operation's widget.

Returns
XML QString

◆ setXmlRepresentation()

void ModuleBase_OperationDescription::setXmlRepresentation ( const QString &  theXMLRepresentation)

Sets XML representation of the operation's widget.

Parameters
theXMLRepresentation- XML QString

◆ hasXmlRepresentation()

bool ModuleBase_OperationDescription::hasXmlRepresentation ( ) const

Returns true if there are no model widgets.

Returns
the boolean value

myWidgets.empty() ||