NDEVR
API Documentation
DesignObjectDialogFactory

Allows extended functionality to DesignObjectDialogs by adding callbacks that can be used primarily to add tabs to the dialog. More...

Inheritance diagram for DesignObjectDialogFactory:
[legend]
Collaboration diagram for DesignObjectDialogFactory:
[legend]

Public Member Functions

void addSetupCallback (DesignObjectDialogSetupCallback *callback)
 Registers a setup callback with the factory.
void removeSetupCallback (const UUID &id)
 Removes a setup callback by its UUID.
void removeSetupCallback (DesignObjectDialogSetupCallback *callback)
 Removes a setup callback from the factory.
void setupDialog (const StringView &type_name, const DynamicPointer< QTDesignObject > &object, DesignObjectDialog *dialog)
 Invokes all registered callbacks to set up a dialog for the given object.

Static Public Member Functions

static DesignObjectDialogFactoryDefaultInstance ()
 Returns the singleton instance of the factory.

Protected Member Functions

 DesignObjectDialogFactory ()
 Protected default constructor.

Protected Attributes

Dictionary< UUID, DesignObjectDialogSetupCallback * > m_creation_callbacks
 Map of registered setup callbacks by UUID.

Detailed Description

Allows extended functionality to DesignObjectDialogs by adding callbacks that can be used primarily to add tabs to the dialog.


Definition at line 110 of file DesignObjectDialog.h.

Constructor & Destructor Documentation

◆ DesignObjectDialogFactory()

DesignObjectDialogFactory::DesignObjectDialogFactory ( )
inlineprotected

Protected default constructor.

Use DefaultInstance() to access.

Definition at line 116 of file DesignObjectDialog.h.

Referenced by DefaultInstance().

Member Function Documentation

◆ addSetupCallback()

void DesignObjectDialogFactory::addSetupCallback ( DesignObjectDialogSetupCallback * callback)

Registers a setup callback with the factory.

Parameters
[in]callbackThe callback to add.

◆ DefaultInstance()

DesignObjectDialogFactory & DesignObjectDialogFactory::DefaultInstance ( )
static

Returns the singleton instance of the factory.

Returns
Reference to the default DesignObjectDialogFactory.

References DesignObjectDialogFactory().

◆ removeSetupCallback() [1/2]

void DesignObjectDialogFactory::removeSetupCallback ( const UUID & id)

Removes a setup callback by its UUID.

Parameters
[in]idThe UUID of the callback to remove.

◆ removeSetupCallback() [2/2]

void DesignObjectDialogFactory::removeSetupCallback ( DesignObjectDialogSetupCallback * callback)

Removes a setup callback from the factory.

Parameters
[in]callbackThe callback to remove.

◆ setupDialog()

void DesignObjectDialogFactory::setupDialog ( const StringView & type_name,
const DynamicPointer< QTDesignObject > & object,
DesignObjectDialog * dialog )

Invokes all registered callbacks to set up a dialog for the given object.

Parameters
[in]type_nameThe type name of the design object.
[in]objectThe target design object.
[in]dialogThe dialog to configure.

The documentation for this class was generated from the following file: