NDEVR
API Documentation

A popup Editor dialog for showing options or information related to StationModel objects. More...

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

Public Member Functions

 StationEditor (const DynamicPointer< QTDesignObject > &station, QWidget *parent=nullptr)
 Constructs a StationEditor targeting a specific station.
 StationEditor (QWidget *parent=nullptr)
 Constructs a StationEditor with no initial target.
void addStationToolWidget (QWidget *widget)
 Adds a custom tool widget to the station editor tab area.
Vertex< 3, fltp08currentLocation () const
 Returns the current 3D location of the station.
bool isInRelativeMode () const
 Checks whether the editor is currently in relative positioning mode.
bool isPrismStation () const
 Checks whether this station is a prism station type.
void setHorizontal (bool horizontal) override
 Sets the layout orientation of the editor.
void setPrismOffsetSlot ()
 Slot invoked to apply the prism offset from the UI.
void setRelativeLocationFromUISlot ()
 Slot invoked to set the relative location based on the current UI values.
virtual void setTarget (const DynamicPointer< QTDesignObject > &object) override
 Sets the target design object for this editor.
void setupForNewTarget ()
 Configures the editor UI for a newly assigned target.
void showEditingControls (bool show)
 Shows or hides the editing controls in the editor.
EditorShowMode showMode () const override
 Returns the preferred show mode for this editor.
bool supportsRelative () const
 Checks whether this station supports relative positioning.
void updateFromReferenceCombo ()
 Slot invoked when the reference combo selection changes.
void updatePositionFromDialogSlot ()
 Slot invoked to update the station position from the dialog fields.
void updateRelativePositionFromDialog ()
 Slot invoked to update the relative position from the dialog fields.
void updateValues () override
 Refreshes the displayed values from the current target.
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 setReadOnly (bool read_only)
 Sets whether the editor is in read-only mode.
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

void clearReferenceInformation ()
 Clears any displayed reference information in the editor.
void init ()
 Initializes the editor UI and connects signals.
void setPositionFromDialog ()
 Applies the absolute position from the dialog fields to the target station.
void setupRelativePosition ()
 Configures the relative position UI elements based on the current target.
void updateComputedPosition ()
 Recomputes and displays the computed absolute position from relative data.
void updateRelativePosition ()
 Refreshes the displayed relative position values.
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

QCustomTabWidgetm_tool_tab_widget
 Tab widget containing station tool pages.
Buffer< QWidget * > m_tool_widgets
 Custom tool widgets added to the tab area.
Ui::StationEditorUI * ui
 The auto-generated UI form for the station 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 StationModel objects.


Definition at line 46 of file StationEditor.h.

Constructor & Destructor Documentation

◆ StationEditor() [1/2]

StationEditor::StationEditor ( QWidget * parent = nullptr)

Constructs a StationEditor with no initial target.

Parameters
[in]parentThe parent widget.

Referenced by StationEditor().

◆ StationEditor() [2/2]

StationEditor::StationEditor ( const DynamicPointer< QTDesignObject > & station,
QWidget * parent = nullptr )

Constructs a StationEditor targeting a specific station.

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

References StationEditor().

Member Function Documentation

◆ addStationToolWidget()

void StationEditor::addStationToolWidget ( QWidget * widget)

Adds a custom tool widget to the station editor tab area.

Parameters
[in]widgetThe widget to add.

◆ currentLocation()

Vertex< 3, fltp08 > StationEditor::currentLocation ( ) const

Returns the current 3D location of the station.

Returns
The station position as a 3D vertex.

◆ isInRelativeMode()

bool StationEditor::isInRelativeMode ( ) const

Checks whether the editor is currently in relative positioning mode.

Returns
True if in relative mode.

◆ isPrismStation()

bool StationEditor::isPrismStation ( ) const

Checks whether this station is a prism station type.

Returns
True if the station uses a prism.

◆ setHorizontal()

void StationEditor::setHorizontal ( bool horizontal)
overridevirtual

Sets the layout orientation of the editor.

Parameters
[in]horizontalWhether to use horizontal layout.

Reimplemented from Editor.

◆ setTarget()

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

Sets the target design object for this editor.

Parameters
[in]objectThe design object to target.

Reimplemented from Editor.

◆ showEditingControls()

void StationEditor::showEditingControls ( bool show)

Shows or hides the editing controls in the editor.

Parameters
[in]showWhether to show the editing controls.

◆ showMode()

EditorShowMode StationEditor::showMode ( ) const
overridevirtual

Returns the preferred show mode for this editor.

Returns
The EditorShowMode describing how this editor should be displayed.

Reimplemented from Editor.

◆ supportsRelative()

bool StationEditor::supportsRelative ( ) const

Checks whether this station supports relative positioning.

Returns
True if relative mode is supported.

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