A base class for displaying options for editing a single DesignObject, typically a Model. More...

Inheritance diagram for Editor:

Collaboration diagram for Editor:

Public Member Functions
	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 InterfaceOrientationController *	orientationController () 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.
virtual void	updateValues ()=0
	Updates the displayed values to reflect the current state of the target object.

Protected Member Functions
void	onDesignObjectDeletedSlot ()
	Slot called when the target design object is deleted.
void	onDesignObjectUpdateSlot ()
	Slot called when the target design object is updated.

Protected Attributes
DynamicPointer< QTDesignObject >	m_design_object
	The design object being edited.
bool	m_is_read_only = false
	Whether the editor is in read-only mode.
InterfaceOrientationController *	m_orientation_controller
	The orientation controller for this editor.

Detailed Description

A base class for displaying options for editing a single DesignObject, typically a Model.

Definition at line 57 of file Editor.h.

Constructor & Destructor Documentation

◆ Editor() [1/2]

Editor::Editor ( QWidget * parent = nullptr )

Constructs an Editor with no design object target.

Parameters

[in] parent The parent widget.

Referenced by DesignObjectDialog::addEditor(), and DesignObjectDialog::hasEditor().

◆ Editor() [2/2]

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

Constructs an Editor targeting the given design object.

Parameters

[in]	object	The design object to edit.
[in]	parent	The parent widget.

Member Function Documentation

◆ bottomOptions()

virtual Buffer< QWidget * > Editor::bottomOptions ( )

inlinevirtual

Returns widgets to be placed at the bottom of the editor layout.

Returns: A buffer of bottom option widgets.

Reimplemented in DesignObjectDialog.

Definition at line 105 of file Editor.h.

◆ customDialogIcon()

virtual StringView Editor::customDialogIcon ( ) const

inlinevirtual

Returns a custom icon name for the editor dialog, or an empty string if none.

Returns: The custom dialog icon name.

Reimplemented in DesignObjectDialog.

Definition at line 85 of file Editor.h.

◆ customDialogTitle()

virtual TranslatedString Editor::customDialogTitle ( ) const

inlinevirtual

Returns a custom title for the editor dialog, or an empty string if none.

Returns: The custom dialog title.

Reimplemented in DesignObjectDialog.

Definition at line 80 of file Editor.h.

◆ disableExport()

virtual bool Editor::disableExport ( ) const

inlinevirtual

Returns whether exporting should be disabled for this editor.

Returns: True if export is disabled.

Reimplemented in VLCVideoModelViewer.

Definition at line 167 of file Editor.h.

◆ getModel()

Model Editor::getModel ( ) const

Returns the target design object as a Model.

Returns: The Model being edited.

◆ getObject()

DesignObject Editor::getObject ( ) const

Returns the target design object.

Returns: The DesignObject being edited.

◆ isBusy()

virtual bool Editor::isBusy ( ) const

inlinevirtual

Returns whether the editor is currently busy performing an operation.

Returns: True if the editor is busy.

Definition at line 162 of file Editor.h.

◆ isHorizontal()

virtual bool Editor::isHorizontal ( ) const

virtual

Returns whether the editor layout is horizontal.

Returns: True if the layout is horizontal.

◆ orientationController()

virtual InterfaceOrientationController * Editor::orientationController ( ) const

virtual

Returns the orientation controller associated with this editor.

Returns: A pointer to the InterfaceOrientationController, or nullptr.

◆ printableWidgetOptions()

virtual Buffer< QWidget * > Editor::printableWidgetOptions ( )

inlinevirtual

Returns option widgets to configure printing for this editor.

Returns: A buffer of print option widgets.

Reimplemented in DesignObjectDialog, and PolylineSliceEditor.

Definition at line 100 of file Editor.h.

◆ printableWidgets()

virtual Buffer< QWidget * > Editor::printableWidgets ( )

inlinevirtual

Returns the widgets that can be printed from this editor.

Returns: A buffer of printable widgets.

Reimplemented in BlastReportEditor, CustomerInfoSheet, CustomerJobInfoSheet, DesignObjectDialog, DesignObjectEditor, and PolylineSliceEditor.

Definition at line 95 of file Editor.h.

◆ requestScrollEnabled()

virtual void Editor::requestScrollEnabled ( bool enabled )

virtual

Requests enabling or disabling scrolling within the editor.

Parameters

[in] enabled True to enable scrolling.

Reimplemented in SolidMaterialEditor.

◆ setHorizontal()

virtual void Editor::setHorizontal ( bool horizontal )

virtual

Sets whether the editor layout is horizontal.

Parameters

[in] horizontal True for horizontal layout, false for vertical.

Reimplemented in CameraEditor, DesignObjectDialog, ModelMaterialsDialog, SolidMaterialEditor, and StationEditor.

◆ setReadOnly()

virtual void Editor::setReadOnly ( bool read_only )

virtual

Sets whether the editor is in read-only mode.

Parameters

[in] read_only True to make the editor read-only.

Reimplemented in DesignObjectDialog.

◆ setTarget()

virtual void Editor::setTarget ( const DynamicPointer< QTDesignObject > & object )

virtual

Sets the design object target for this editor.

Parameters

[in] object The design object to edit.

Reimplemented in BuildActionItemsWidget, BuildActionWidget, DesignObjectDialog, and StationEditor.

◆ setup()

virtual void Editor::setup	(	DesignObjectDialog *	,
		const ShowPropertiesSettings &	)

inlinevirtual

Sets up the editor with a parent dialog and property display settings.

Parameters

[in]	dialog	The parent DesignObjectDialog.
[in]	settings	The property display settings.

Definition at line 157 of file Editor.h.

◆ showMode()

virtual EditorShowMode Editor::showMode ( ) const

virtual

Returns the preferred display mode for this editor.

Returns: The EditorShowMode.

Reimplemented in DesignObjectDialog, ImageModelDialog, LayerEditor, LineworkMaterialEditor, OrientationOperationsWidget, PaperEditor, PolylineSliceEditor, ProjectEditor, SolidMaterialEditor, StationEditor, and VLCVideoModelViewer.

◆ target()

const DynamicPointer< QTDesignObject > & Editor::target ( ) const

inline

Returns the current design object target.

Returns: A const reference to the target design object pointer.

Definition at line 151 of file Editor.h.

References m_design_object.

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

NDEVR/Headers/Editor.h

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Editor() [1/2]

◆ Editor() [2/2]

Member Function Documentation

◆ bottomOptions()

◆ customDialogIcon()

◆ customDialogTitle()

◆ disableExport()

◆ getModel()

◆ getObject()

◆ isBusy()

◆ isHorizontal()

◆ orientationController()

◆ printableWidgetOptions()

◆ printableWidgets()

◆ requestScrollEnabled()

◆ setHorizontal()

◆ setReadOnly()

◆ setTarget()

◆ setup()

◆ showMode()

◆ target()