OpenTwin 0.1
OpenTwin
 
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
ot::ModalCommandBase Class Referenceabstract

#include "ModalCommandBase.h"

Inheritance diagram for ot::ModalCommandBase:
ModalCommandHealing

Public Member Functions

 ModalCommandBase (ot::ApplicationBase *app, const std::string &actionMnuID, const std::string &actionBtnID)
 
virtual ~ModalCommandBase ()
 
virtual bool executeAction (const std::string &action, rapidjson::Document &doc)=0
 
virtual void modelSelectionChanged (std::list< UID > &selectedEntityID)=0
 

Protected Member Functions

virtual std::string initializeAndCreateUI (const LockTypeFlags &modelRead, const LockTypeFlags &modelWrite)=0
 
void setupUI (void)
 
void addMenuPage (const std::string &menu)
 
void addMenuGroup (const std::string &menu, const std::string &group)
 
void addMenuSubgroup (const std::string &menu, const std::string &group, const std::string &subgroup)
 
void addMenuAction (const std::string &menu, const std::string &group, const std::string &buttonName, const std::string &text, const LockTypeFlags &flags, const std::string &iconName, const std::string &iconFolder=std::string("Default"))
 
void addMenuAction (const std::string &menu, const std::string &group, const std::string &subgroup, const std::string &buttonName, const std::string &text, const LockTypeFlags &flags, const std::string &iconName, const std::string &iconFolder=std::string("Default"))
 
void addMenuCheckBox (const std::string &menu, const std::string &group, const std::string &subgroup, const std::string &boxName, const std::string &boxText, bool checked, const LockTypeFlags &flags)
 
void addMenuLineEdit (const std::string &menu, const std::string &group, const std::string &subgroup, const std::string &editName, const std::string &editText, const std::string &editLabel, const LockTypeFlags &flags)
 
void setMenuCheckBox (const std::string &menu, const std::string &group, const std::string &subgroup, const std::string &boxName, bool checked)
 
void setMenuLineEdit (const std::string &menu, const std::string &group, const std::string &subgroup, const std::string &editName, const std::string &editText, bool error)
 

Protected Attributes

ot::ApplicationBase * application
 

Constructor & Destructor Documentation

◆ ModalCommandBase()

ot::ModalCommandBase::ModalCommandBase ( ot::ApplicationBase * app,
const std::string & actionMnuID,
const std::string & actionBtnID )

◆ ~ModalCommandBase()

ot::ModalCommandBase::~ModalCommandBase ( )
virtual

Member Function Documentation

◆ addMenuAction() [1/2]

void ot::ModalCommandBase::addMenuAction ( const std::string & menu,
const std::string & group,
const std::string & buttonName,
const std::string & text,
const LockTypeFlags & flags,
const std::string & iconName,
const std::string & iconFolder = std::string("Default") )
protected

◆ addMenuAction() [2/2]

void ot::ModalCommandBase::addMenuAction ( const std::string & menu,
const std::string & group,
const std::string & subgroup,
const std::string & buttonName,
const std::string & text,
const LockTypeFlags & flags,
const std::string & iconName,
const std::string & iconFolder = std::string("Default") )
protected

◆ addMenuCheckBox()

void ot::ModalCommandBase::addMenuCheckBox ( const std::string & menu,
const std::string & group,
const std::string & subgroup,
const std::string & boxName,
const std::string & boxText,
bool checked,
const LockTypeFlags & flags )
protected

◆ addMenuGroup()

void ot::ModalCommandBase::addMenuGroup ( const std::string & menu,
const std::string & group )
protected

◆ addMenuLineEdit()

void ot::ModalCommandBase::addMenuLineEdit ( const std::string & menu,
const std::string & group,
const std::string & subgroup,
const std::string & editName,
const std::string & editText,
const std::string & editLabel,
const LockTypeFlags & flags )
protected

◆ addMenuPage()

void ot::ModalCommandBase::addMenuPage ( const std::string & menu)
protected

◆ addMenuSubgroup()

void ot::ModalCommandBase::addMenuSubgroup ( const std::string & menu,
const std::string & group,
const std::string & subgroup )
protected

◆ executeAction()

virtual bool ot::ModalCommandBase::executeAction ( const std::string & action,
rapidjson::Document & doc )
pure virtual

Implemented in ModalCommandHealing.

◆ initializeAndCreateUI()

virtual std::string ot::ModalCommandBase::initializeAndCreateUI ( const LockTypeFlags & modelRead,
const LockTypeFlags & modelWrite )
protectedpure virtual

Implemented in ModalCommandHealing.

◆ modelSelectionChanged()

virtual void ot::ModalCommandBase::modelSelectionChanged ( std::list< UID > & selectedEntityID)
pure virtual

Implemented in ModalCommandHealing.

◆ setMenuCheckBox()

void ot::ModalCommandBase::setMenuCheckBox ( const std::string & menu,
const std::string & group,
const std::string & subgroup,
const std::string & boxName,
bool checked )
protected

◆ setMenuLineEdit()

void ot::ModalCommandBase::setMenuLineEdit ( const std::string & menu,
const std::string & group,
const std::string & subgroup,
const std::string & editName,
const std::string & editText,
bool error )
protected

◆ setupUI()

void ot::ModalCommandBase::setupUI ( void )
protected

Member Data Documentation

◆ application

ot::ApplicationBase* ot::ModalCommandBase::application
protected
The documentation for this class was generated from the following files: