NDEVR
API Documentation
DesignObjectEditor

A basic Editor that shows generic information, such as name and description. More...

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

Public Member Functions

 DesignObjectEditor (const DynamicPointer< QTDesignObject > &object, QWidget *parent=nullptr)
 Constructs a DesignObjectEditor for the given design object.
virtual Buffer< QWidget * > printableWidgets () override
 Returns the list of widgets that can be printed.
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 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.

Protected Member Functions

void descriptionChanged ()
 Slot called when the description text is modified.
void IconChanged ()
 Slot called when the icon selection changes.
void onDesignObjectUpdate ()
 Slot called when the underlying design object is updated externally.
virtual void revert ()
 Reverts any pending changes back to the stored design object state.
void searchTermsChanged ()
 Slot called when the search terms field is modified.
void updateSoftware ()
 Slot called to update the software version information.
virtual void updateValues () override
 Updates the displayed values from the underlying design object.
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

bool m_updating = false
 Whether the editor is currently refreshing its displayed values.
Ui::ModelEditorUI * ui
 The generated UI form for this editor.
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

A basic Editor that shows generic information, such as name and description.


If Library services are enabled allows for adding and removing from the library.

Definition at line 45 of file DesignObjectEditor.h.

Constructor & Destructor Documentation

◆ DesignObjectEditor()

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

Constructs a DesignObjectEditor for the given design object.

Parameters
[in]objectThe design object to edit.
[in]parentThe parent widget.

References DesignObjectEditor().

Referenced by DesignObjectEditor().

Member Function Documentation

◆ printableWidgets()

virtual Buffer< QWidget * > DesignObjectEditor::printableWidgets ( )
inlineoverridevirtual

Returns the list of widgets that can be printed.

This editor has none.

Returns
An empty buffer of widget pointers.

Reimplemented from Editor.

Definition at line 60 of file DesignObjectEditor.h.


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