 |
NDEVR
API Documentation
|
|
NDEVR
API Documentation
|
A popup Editor dialog for showing options or information related to paper/print layout settings. More...
Public Member Functions | |
| PaperEditor (const DynamicPointer< QTDesignObject > &object, QWidget *parent=nullptr) | |
| Constructs a paper editor for the given design object. | |
| PaperEditor (QWidget *parent=nullptr) | |
| Constructs a paper editor without a target object. | |
| virtual EditorShowMode | showMode () const |
| Returns the preferred display mode for this editor. | |
| virtual void | updateValues () |
| Updates the UI values from the current design object state. | |
| void | writeImage (std::function< void(const QImage &image)> callback) |
| Renders the paper layout to an image and passes it to the callback. | |
| void | writeImagePDF () |
| Exports the paper layout as a rasterized image embedded in a PDF file. | |
| void | writePDF () |
| Exports the paper layout as a vector PDF file. | |
| 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 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. | |
| const DynamicPointer< QTDesignObject > & | target () const |
| Returns the current design object target. | |
Protected Member Functions | |
| void | updateDPISlot () |
| Slot called when the DPI value is changed by the user. | |
| void | updateMarginSlot () |
| Slot called when the margin values are changed by the user. | |
| void | updateSizeSlot () |
| Slot called when the paper size is changed by the user. | |
| 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. | |
Additional Inherited Members | |
| Protected Attributes inherited from Editor | |
| 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. | |
A popup Editor dialog for showing options or information related to paper/print layout settings.
Allows the user to configure paper size, margins, DPI, and export to PDF or image.
Definition at line 46 of file PaperEditor.h.
| PaperEditor::PaperEditor | ( | QWidget * | parent = nullptr | ) |
Constructs a paper editor without a target object.
| [in] | parent | The parent widget. |
| PaperEditor::PaperEditor | ( | const DynamicPointer< QTDesignObject > & | object, |
| QWidget * | parent = nullptr ) |
Constructs a paper editor for the given design object.
| [in] | object | The design object representing the paper/page layout. |
| [in] | parent | The parent widget. |
|
virtual |
Returns the preferred display mode for this editor.
Reimplemented from Editor.
| void PaperEditor::writeImage | ( | std::function< void(const QImage &image)> | callback | ) |
Renders the paper layout to an image and passes it to the callback.
| [in] | callback | The function to call with the rendered image. |