NDEVR
API Documentation
ImageModelDialog

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

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

Public Member Functions

 ImageModelDialog (const DynamicPointer< QTDesignObject > &project, QWidget *parent=nullptr)
 Constructs an ImageModelDialog for the given project.
void insertModel (Model &model, bool resize)
 Inserts a model into the dialog for editing.
void setIsReport (bool is_report)
 Sets whether this dialog is being used in a report context.
EditorShowMode showMode () const override
 Returns the display mode for this editor.
QSize sizeHint () const override
 Returns the recommended size for this dialog.
virtual void updateValues () override
 Refreshes the dialog UI to reflect the current state of the underlying design object.
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 Attributes

QCustomTextEditm_description_edit = nullptr
 Text edit for the image description.
QTImageEditorm_image_editor = nullptr
 The image editor widget for modifying images.
ImageViewm_image_view = nullptr
 The widget displaying the image preview.
QBoxLayout * m_main_layout = nullptr
 The main layout for arranging child widgets.
QCustomComboBoxm_placement_pattern = nullptr
 Combo box for selecting the image placement pattern.
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.

Additional Inherited Members

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.

Detailed Description

A popup Editor dialog for showing options or information related to ImageModel model objects.


Definition at line 13 of file ImageModelDialog.h.

Constructor & Destructor Documentation

◆ ImageModelDialog()

ImageModelDialog::ImageModelDialog ( const DynamicPointer< QTDesignObject > & project,
QWidget * parent = nullptr )

Constructs an ImageModelDialog for the given project.

Parameters
[in]projectThe design object representing the project or image model to edit.
[in]parentThe parent widget, or nullptr if no parent.

References ImageModelDialog(), and project().

Referenced by ImageModelDialog().

Member Function Documentation

◆ insertModel()

void ImageModelDialog::insertModel ( Model & model,
bool resize )

Inserts a model into the dialog for editing.

Parameters
[in]modelThe model to insert.
[in]resizeWhether to resize the dialog to accommodate the model.

◆ setIsReport()

void ImageModelDialog::setIsReport ( bool is_report)

Sets whether this dialog is being used in a report context.

Parameters
[in]is_reportWhether the dialog should render in report mode.

◆ showMode()

EditorShowMode ImageModelDialog::showMode ( ) const
overridevirtual

Returns the display mode for this editor.

Returns
The EditorShowMode indicating how the editor should be presented.

Reimplemented from Editor.

◆ sizeHint()

QSize ImageModelDialog::sizeHint ( ) const
override

Returns the recommended size for this dialog.

Returns
The preferred QSize for the dialog.

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