SHAPER  9.12.0
ModuleBase_IWidgetCreator Class Reference

Interface to WidgetCreator which can create specific widgets by type. More...

Inheritance diagram for ModuleBase_IWidgetCreator:
Inheritance graph

Public Member Functions

 ModuleBase_IWidgetCreator ()
 Default constructor. More...
 
 ~ModuleBase_IWidgetCreator ()
 Virtual destructor. More...
 
virtual void panelTypes (std::set< std::string > &)
 Returns a container of possible page types, which this creator can process The default implementation is empty. More...
 
virtual void pageTypes (std::set< std::string > &theTypes)
 Returns a container of possible page types, which this creator can process The default implementation is empty. More...
 
virtual void widgetTypes (std::set< std::string > &theTypes)
 Returns a container of possible widget types, which this creator can process. More...
 
virtual QWidgetcreatePanelByType (const std::string &theType, QWidget *theParent, const FeaturePtr &theFeature, Config_WidgetAPI *theWidgetApi=0)
 Create panel control by its type. More...
 
virtual ModuleBase_PageBasecreatePageByType (const std::string &theType, QWidget *theParent, Config_WidgetAPI *theWidgetApi)
 Create page by its type The default implementation is empty. More...
 
virtual ModuleBase_ModelWidgetcreateWidgetByType (const std::string &theType, QWidget *theParent, Config_WidgetAPI *theWidgetApi, ModuleBase_IWorkshop *theWorkshop)
 Create widget by its type The default implementation is empty. More...
 

Detailed Description

Interface to WidgetCreator which can create specific widgets by type.

Constructor & Destructor Documentation

◆ ModuleBase_IWidgetCreator()

ModuleBase_IWidgetCreator::ModuleBase_IWidgetCreator ( )

Default constructor.

◆ ~ModuleBase_IWidgetCreator()

ModuleBase_IWidgetCreator::~ModuleBase_IWidgetCreator ( )

Virtual destructor.

Member Function Documentation

◆ panelTypes()

virtual void ModuleBase_IWidgetCreator::panelTypes ( std::set< std::string > &  )
inlinevirtual

Returns a container of possible page types, which this creator can process The default implementation is empty.

Parameters
theTypesa list of type names

Reimplemented in SamplePanelPlugin_WidgetCreator.

◆ pageTypes()

virtual void ModuleBase_IWidgetCreator::pageTypes ( std::set< std::string > &  theTypes)
inlinevirtual

Returns a container of possible page types, which this creator can process The default implementation is empty.

Parameters
theTypesa list of type names

◆ widgetTypes()

virtual void ModuleBase_IWidgetCreator::widgetTypes ( std::set< std::string > &  theTypes)
inlinevirtual

Returns a container of possible widget types, which this creator can process.

Parameters
theTypesa list of type names

Reimplemented in SamplePanelPlugin_ModelWidgetCreator, ParametersPlugin_WidgetCreator, and CollectionPlugin_WidgetCreator.

◆ createPanelByType()

QWidget * ModuleBase_IWidgetCreator::createPanelByType ( const std::string &  theType,
QWidget theParent,
const FeaturePtr &  theFeature,
Config_WidgetAPI theWidgetApi = 0 
)
virtual

Create panel control by its type.

The default implementation is empty

Parameters
theTypea panel type
theParenta parent widget
theFeaturea feature modified in the panel
theWidgetApia low-level API for reading xml definitions of widget
Returns
created widget or null

◆ createPageByType()

ModuleBase_PageBase * ModuleBase_IWidgetCreator::createPageByType ( const std::string &  theType,
QWidget theParent,
Config_WidgetAPI theWidgetApi 
)
virtual

Create page by its type The default implementation is empty.

Parameters
theTypea type
theParenta parent widget
theWidgetApia low-level API for reading xml definitions of widgets

◆ createWidgetByType()

ModuleBase_ModelWidget * ModuleBase_IWidgetCreator::createWidgetByType ( const std::string &  theType,
QWidget theParent,
Config_WidgetAPI theWidgetApi,
ModuleBase_IWorkshop theWorkshop 
)
virtual

Create widget by its type The default implementation is empty.

Parameters
theTypea type
theParenta parent widget
theWidgetApia low-level API for reading xml definitions of widgets
theWorkshopa workshop class instance

Reimplemented in ParametersPlugin_WidgetCreator, SamplePanelPlugin_ModelWidgetCreator, and CollectionPlugin_WidgetCreator.