NDEVR
API Documentation
BuildActionUISetupWidget

Editor widget for configuring how a build action is presented in the UI, such as ribbon placement and tree visibility. More...

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

Public Member Functions

 BuildActionUISetupWidget (const DynamicPointer< QTDesignObject > &object, BuildActionProgramLogic *logic, QWidget *parent=nullptr)
 Constructs the widget with a target design object and program logic reference.
 BuildActionUISetupWidget (QWidget *parent)
 Constructs the widget with no initial target.
BuildActionDefinition definition () const
 Returns the BuildActionDefinition derived from the current target.
virtual void updateValues ()
 Refreshes all UI fields from the current target data.
Public Member Functions inherited from Editor
 Editor (const DynamicPointer< QTDesignObject > &object, QWidget *parent=nullptr)
 Constructs an Editor targeting the given design object.
 Editor (QWidget *parent=nullptr)
 Constructs an Editor with no design object target.
virtual Buffer< QWidget * > bottomOptions ()
 Returns widgets to be placed at the bottom of the editor layout.
virtual StringView customDialogIcon () const
 Returns a custom icon name for the editor dialog, or an empty string if none.
virtual TranslatedString customDialogTitle () const
 Returns a custom title for the editor dialog, or an empty string if none.
virtual bool disableExport () const
 Returns whether exporting should be disabled for this editor.
Model getModel () const
 Returns the target design object as a Model.
DesignObject getObject () const
 Returns the target design object.
virtual bool isBusy () const
 Returns whether the editor is currently busy performing an operation.
void isBusyStatusChanged ()
 Emitted when the busy status of the editor changes.
virtual bool isHorizontal () const
 Returns whether the editor layout is horizontal.
virtual void moveTargetWithMouse ()
 Initiates interactive mouse-based movement of the target object in the viewport.
void objectUpdatedSignal ()
 Emitted when the target object has been updated.
virtual InterfaceOrientationControllerorientationController () const
 Returns the orientation controller associated with this editor.
virtual Buffer< QWidget * > printableWidgetOptions ()
 Returns option widgets to configure printing for this editor.
virtual Buffer< QWidget * > printableWidgets ()
 Returns the widgets that can be printed from this editor.
virtual void requestScrollEnabled (bool enabled)
 Requests enabling or disabling scrolling within the editor.
virtual void setHorizontal (bool horizontal)
 Sets whether the editor layout is horizontal.
virtual void setReadOnly (bool read_only)
 Sets whether the editor is in read-only mode.
virtual void setTarget (const DynamicPointer< QTDesignObject > &object)
 Sets the design object target for this editor.
virtual void setup (DesignObjectDialog *, const ShowPropertiesSettings &)
 Sets up the editor with a parent dialog and property display settings.
virtual EditorShowMode showMode () const
 Returns the preferred display mode for this editor.
const DynamicPointer< QTDesignObject > & target () const
 Returns the current design object target.

Additional Inherited Members

Protected Member Functions inherited from Editor
void onDesignObjectDeletedSlot ()
 Slot called when the target design object is deleted.
void onDesignObjectUpdateSlot ()
 Slot called when the target design object is updated.
Protected Attributes inherited from Editor
DynamicPointer< QTDesignObjectm_design_object
 The design object being edited.
bool m_is_read_only = false
 Whether the editor is in read-only mode.
InterfaceOrientationControllerm_orientation_controller
 The orientation controller for this editor.

Detailed Description

Editor widget for configuring how a build action is presented in the UI, such as ribbon placement and tree visibility.

Definition at line 15 of file BuildActionUISetupWidget.h.

Constructor & Destructor Documentation

◆ BuildActionUISetupWidget() [1/2]

BuildActionUISetupWidget::BuildActionUISetupWidget ( QWidget * parent)

Constructs the widget with no initial target.

Parameters
[in]parentThe parent widget.

◆ BuildActionUISetupWidget() [2/2]

BuildActionUISetupWidget::BuildActionUISetupWidget ( const DynamicPointer< QTDesignObject > & object,
BuildActionProgramLogic * logic,
QWidget * parent = nullptr )

Constructs the widget with a target design object and program logic reference.

Parameters
[in]objectThe design object to edit.
[in]logicThe build action program logic for UI setup.
[in]parentOptional parent widget.

Member Function Documentation

◆ definition()

BuildActionDefinition BuildActionUISetupWidget::definition ( ) const

Returns the BuildActionDefinition derived from the current target.

Returns
The build action definition.

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