NDEVR
API Documentation
BasicObjectDialogSetupCallback

A convenience class for DesignObjectDialogSetupCallback that allows for a single function to setup a DesignObjectDialog. More...

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

Public Member Functions

 BasicObjectDialogSetupCallback (const std::function< void(DesignObjectDialog *, const DynamicPointer< QTDesignObject > &)> &callback)
 Constructs a callback that applies to all object types.
 BasicObjectDialogSetupCallback (const StringView &type, const std::function< void(DesignObjectDialog *, const DynamicPointer< QTDesignObject > &)> &callback)
 Constructs a callback for a specific object type name.
virtual UUID id () const override
 Returns the unique identifier for this callback.
virtual void setupDialog (const StringView &type_name, DesignObjectDialog *dialog, const DynamicPointer< QTDesignObject > &object) override
 Configures the dialog using the stored callback function.

Detailed Description

A convenience class for DesignObjectDialogSetupCallback that allows for a single function to setup a DesignObjectDialog.


Definition at line 75 of file DesignObjectDialog.h.

Constructor & Destructor Documentation

◆ BasicObjectDialogSetupCallback() [1/2]

BasicObjectDialogSetupCallback::BasicObjectDialogSetupCallback ( const StringView & type,
const std::function< void(DesignObjectDialog *, const DynamicPointer< QTDesignObject > &)> & callback )

Constructs a callback for a specific object type name.

Parameters
[in]typeThe type name to filter by.
[in]callbackThe function to invoke when setting up the dialog.

◆ BasicObjectDialogSetupCallback() [2/2]

BasicObjectDialogSetupCallback::BasicObjectDialogSetupCallback ( const std::function< void(DesignObjectDialog *, const DynamicPointer< QTDesignObject > &)> & callback)

Constructs a callback that applies to all object types.

Parameters
[in]callbackThe function to invoke when setting up the dialog.

Member Function Documentation

◆ id()

virtual UUID BasicObjectDialogSetupCallback::id ( ) const
inlineoverridevirtual

Returns the unique identifier for this callback.

Returns
The UUID of this callback.

Implements DesignObjectDialogSetupCallback.

Definition at line 100 of file DesignObjectDialog.h.

◆ setupDialog()

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

Configures the dialog using the stored callback function.

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

Implements DesignObjectDialogSetupCallback.


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