NDEVR
API Documentation
TransitIncidentVehicleEditor

Editor widget for viewing and modifying a transit incident vehicle's details. More...

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

Public Member Functions

 TransitIncidentVehicleEditor (const DynamicPointer< QTDesignObject > &object, QWidget *parent=nullptr)
 Constructs a TransitIncidentVehicleEditor.
virtual bool fullscreenTouch () const override
 Returns whether this editor should be shown fullscreen on touch devices.
void showDescription (bool show_description)
 Shows or hides the description field in the editor.
void showDrivers (bool show_description)
 Shows or hides the driver sub-editor.
virtual void updateValues () override
 Refreshes the UI fields from the underlying model data.
TransitIncidentVehicle vehicle () const
 Returns the TransitIncidentVehicle being edited.
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.

Static Public Member Functions

static void Register ()
 Registers this editor type with the editor factory.

Protected Member Functions

void descriptionChangedSlot ()
 Slot invoked when the description field value changes.
void setupMetadataWidget (DesignObjectStringWidget *widget, const StringView &metadata)
 Binds a DesignObjectStringWidget to the specified metadata key.
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

TransitIncidentPersonEditorm_driver_editor
 Editor for the vehicle driver.
TransitIncidentPersonEditorm_owner_editer
 Editor for the vehicle owner.
TransitIncidentPersonTablem_passenger_table
 Table of passengers in the vehicle.
Ui::TransitIncidentVehicleEditorUI * ui
 The auto-generated UI form.
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 viewing and modifying a transit incident vehicle's details.

Definition at line 15 of file TransitIncidentVehicleEditor.h.

Constructor & Destructor Documentation

◆ TransitIncidentVehicleEditor()

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

Constructs a TransitIncidentVehicleEditor.

Parameters
[in]objectThe design object representing the vehicle.
[in]parentThe parent widget.

Member Function Documentation

◆ fullscreenTouch()

virtual bool TransitIncidentVehicleEditor::fullscreenTouch ( ) const
inlineoverridevirtual

Returns whether this editor should be shown fullscreen on touch devices.

Returns
True.

Definition at line 38 of file TransitIncidentVehicleEditor.h.

◆ setupMetadataWidget()

void TransitIncidentVehicleEditor::setupMetadataWidget ( DesignObjectStringWidget * widget,
const StringView & metadata )
protected

Binds a DesignObjectStringWidget to the specified metadata key.

Parameters
[in]widgetThe string widget to configure.
[in]metadataThe metadata key to bind.

◆ showDescription()

void TransitIncidentVehicleEditor::showDescription ( bool show_description)

Shows or hides the description field in the editor.

Parameters
[in]show_descriptionWhether to show the description field.

◆ showDrivers()

void TransitIncidentVehicleEditor::showDrivers ( bool show_description)

Shows or hides the driver sub-editor.

Parameters
[in]show_descriptionWhether to show the driver section.

◆ vehicle()

TransitIncidentVehicle TransitIncidentVehicleEditor::vehicle ( ) const

Returns the TransitIncidentVehicle being edited.

Returns
The vehicle model.

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