NDEVR
API Documentation
LineworkMaterialEditor

A popup Editor dialog for showing options or information related to Materials used with outlines or linework such as pixel thickness. More...

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

Public Member Functions

 LineworkMaterialEditor (const DynamicPointer< QTDesignObject > &object, QWidget *parent=Q_NULLPTR)
 Constructs a LineworkMaterialEditor for the given material design object.
Material material ()
 Returns the Material object currently being edited.
virtual EditorShowMode showMode () const override
 Returns the display mode for this editor.
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.
const DynamicPointer< QTDesignObject > & target () const
 Returns the current design object target.

Protected Member Functions

virtual void updateValues () override
 Refreshes the editor UI to reflect the current material state.
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
 Guard flag to prevent recursive UI updates.
Ui::LineworkMaterialEditorUI * ui
 The auto-generated UI form for the 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 popup Editor dialog for showing options or information related to Materials used with outlines or linework such as pixel thickness.


Definition at line 46 of file LineworkMaterialEditor.h.

Constructor & Destructor Documentation

◆ LineworkMaterialEditor()

LineworkMaterialEditor::LineworkMaterialEditor ( const DynamicPointer< QTDesignObject > & object,
QWidget * parent = Q_NULLPTR )

Constructs a LineworkMaterialEditor for the given material design object.

Parameters
[in]objectThe material design object to edit.
[in]parentThe parent widget, or nullptr if no parent.

References LineworkMaterialEditor().

Referenced by LineworkMaterialEditor().

Member Function Documentation

◆ material()

Material LineworkMaterialEditor::material ( )

Returns the Material object currently being edited.

Returns
The current Material.

◆ showMode()

virtual EditorShowMode LineworkMaterialEditor::showMode ( ) const
overridevirtual

Returns the display mode for this editor.

Returns
The EditorShowMode indicating how the editor should be presented.

Reimplemented from Editor.


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