SHAPER  9.12.0
XGUI_ActiveControlSelector Class Referenceabstract

Interface to have an active control and process selection by the control. More...

Inheritance diagram for XGUI_ActiveControlSelector:
Inheritance graph

Signals

void activated ()
 control is activated More...
 
void deactivated ()
 control is deactivated More...
 

Public Member Functions

 XGUI_ActiveControlSelector ()
 Constructor. More...
 
virtual ~XGUI_ActiveControlSelector ()
 Destructor. More...
 
virtual QString getType ()=0
 Returns name of the selector. More...
 
virtual void reset ()
 Clear need to be activated widget if it exists. More...
 
void setEnable (const bool &theEnabled)
 Sets enable/disable state of the selector. More...
 
bool isEnabled () const
 Returns whether the selector is enabled or not. More...
 
virtual void setActive (const bool &isActive)=0
 Sets control active. More...
 
virtual bool needToBeActivated () const
 Returns whether the selector should be activated as soon as possible (by deactivatate other) More...
 
virtual void processSelection ()=0
 Processes current selection of workshop. Reaction to selection change in workshop. More...
 

Protected Attributes

bool myIsEnabled
 enable state of the selector More...
 

Detailed Description

Interface to have an active control and process selection by the control.

Activation of control may set selection modes and selection filters of the control.

Constructor & Destructor Documentation

◆ XGUI_ActiveControlSelector()

XGUI_ActiveControlSelector::XGUI_ActiveControlSelector ( )
inline

Constructor.

Parameters
theWorkshopthe current workshop instance

◆ ~XGUI_ActiveControlSelector()

virtual XGUI_ActiveControlSelector::~XGUI_ActiveControlSelector ( )
inlinevirtual

Destructor.

Member Function Documentation

◆ getType()

virtual QString XGUI_ActiveControlSelector::getType ( )
pure virtual

Returns name of the selector.

Implemented in XGUI_PropertyPanelSelector, and XGUI_FacesPanelSelector.

◆ reset()

virtual void XGUI_ActiveControlSelector::reset ( )
inlinevirtual

Clear need to be activated widget if it exists.

Reimplemented in XGUI_PropertyPanelSelector, and XGUI_FacesPanelSelector.

◆ setEnable()

void XGUI_ActiveControlSelector::setEnable ( const bool &  theEnabled)
inline

Sets enable/disable state of the selector.

If disable, it will not react to selection

Parameters
theEnabledif true, selector is enabled

◆ isEnabled()

bool XGUI_ActiveControlSelector::isEnabled ( ) const
inline

Returns whether the selector is enabled or not.

Returns
boolean result

◆ setActive()

virtual void XGUI_ActiveControlSelector::setActive ( const bool &  isActive)
pure virtual

Sets control active.

It should activates/deactivates selection and selection filters.

Parameters
isActiveif true, the control becomes active

Implemented in XGUI_PropertyPanelSelector, and XGUI_FacesPanelSelector.

◆ needToBeActivated()

virtual bool XGUI_ActiveControlSelector::needToBeActivated ( ) const
inlinevirtual

Returns whether the selector should be activated as soon as possible (by deactivatate other)

Returns
boolean result

Reimplemented in XGUI_PropertyPanelSelector.

◆ processSelection()

virtual void XGUI_ActiveControlSelector::processSelection ( )
pure virtual

Processes current selection of workshop. Reaction to selection change in workshop.

Implemented in XGUI_PropertyPanelSelector, and XGUI_FacesPanelSelector.

◆ activated

void XGUI_ActiveControlSelector::activated ( )
signal

control is activated

◆ deactivated

void XGUI_ActiveControlSelector::deactivated ( )
signal

control is deactivated

Field Documentation

◆ myIsEnabled

bool XGUI_ActiveControlSelector::myIsEnabled
protected

enable state of the selector