QDesignerFormWindowManagerInterface Class
The QDesignerFormWindowManagerInterface class allows you to manipulate the collection of form windows in Qt Designer, and control Qt Designer's form editing actions. More...
| Header: | #include <QDesignerFormWindowManagerInterface> |
| CMake: | find_package(Qt6 REQUIRED COMPONENTS Designer) target_link_libraries(mytarget PRIVATE Qt6::Designer) |
| qmake: | QT += designer |
| Inherits: | QObject |
Public Types
| enum | Action { CutAction, CopyAction, PasteAction, DeleteAction, SelectAllAction, …, FormWindowSettingsDialogAction } |
| enum | ActionGroup { StyledPreviewActionGroup } |
Public Functions
| QDesignerFormWindowManagerInterface(QObject *parent = nullptr) | |
| virtual | ~QDesignerFormWindowManagerInterface() |
| virtual QAction * | action(QDesignerFormWindowManagerInterface::Action action) const = 0 |
| virtual QActionGroup * | actionGroup(QDesignerFormWindowManagerInterface::ActionGroup actionGroup) const = 0 |
| virtual QDesignerFormWindowInterface * | activeFormWindow() const = 0 |
| virtual QDesignerFormEditorInterface * | core() const = 0 |
| virtual QDesignerFormWindowInterface * | createFormWindow(QWidget *parent = nullptr, Qt::WindowFlags flags = Qt::WindowFlags()) = 0 |
| virtual QPixmap | createPreviewPixmap() const = 0 |
| virtual QDesignerFormWindowInterface * | formWindow(int index) const = 0 |
| virtual int | formWindowCount() const = 0 |
Public Slots
| virtual void | addFormWindow(QDesignerFormWindowInterface *formWindow) = 0 |
| virtual void | closeAllPreviews() = 0 |
| virtual void | removeFormWindow(QDesignerFormWindowInterface *formWindow) = 0 |
| virtual void | setActiveFormWindow(QDesignerFormWindowInterface *formWindow) = 0 |
| virtual void | showPluginDialog() = 0 |
| virtual void | showPreview() = 0 |
Signals
| void | activeFormWindowChanged(QDesignerFormWindowInterface *formWindow) |
| void | formWindowAdded(QDesignerFormWindowInterface *formWindow) |
| void | formWindowRemoved(QDesignerFormWindowInterface *formWindow) |
| void | formWindowSettingsChanged(QDesignerFormWindowInterface *formWindow) |
Detailed Description
QDesignerFormWindowManagerInterface is not intended to be instantiated directly. Qt Designer uses the form window manager to control the various form windows in its workspace. You can retrieve an interface to Qt Designer's form window manager using the QDesignerFormEditorInterface::formWindowManager() function. For example:
auto *manager = formEditor->formWindowManager();
auto *formWindow = manager->formWindow(0);
manager->setActiveFormWindow(formWindow);
When implementing a custom widget plugin, a pointer to Qt Designer's current QDesignerFormEditorInterface object (formEditor in the example above) is provided by the QDesignerCustomWidgetInterface::initialize() function's parameter. You must subclass the QDesignerCustomWidgetInterface to expose your plugin to Qt Designer.
The form window manager interface provides the createFormWindow() function that enables you to create a new form window which you can add to the collection of form windows that the manager maintains, using the addFormWindow() slot. It also provides the formWindowCount() function returning the number of form windows currently under the manager's control, the formWindow() function returning the form window associated with a given index, and the activeFormWindow() function returning the currently selected form window. The removeFormWindow() slot allows you to reduce the number of form windows the manager must maintain, and the setActiveFormWindow() slot allows you to change the form window focus in Qt Designer's workspace.
In addition, QDesignerFormWindowManagerInterface contains a collection of functions that enables you to intervene and control Qt Designer's form editing actions. All these functions return the original action, making it possible to propagate the function further after intervention.
Finally, the interface provides three signals which are emitted when a form window is added, when the currently selected form window changes, or when a form window is removed, respectively. All the signals carry the form window in question as their parameter.
See also QDesignerFormEditorInterface and QDesignerFormWindowInterface.
Member Type Documentation
enum QDesignerFormWindowManagerInterface::Action
Specifies an action of Qt Designer.
| Constant | Value | Description |
|---|---|---|
QDesignerFormWindowManagerInterface::CutAction | 100 | Clipboard Cut |
QDesignerFormWindowManagerInterface::CopyAction | 101 | Clipboard Copy |
QDesignerFormWindowManagerInterface::PasteAction | 102 | Clipboard Paste |
QDesignerFormWindowManagerInterface::DeleteAction | 103 | Clipboard Delete |
QDesignerFormWindowManagerInterface::SelectAllAction | 104 | Select All |
QDesignerFormWindowManagerInterface::LowerAction | 200 | Lower current widget |
QDesignerFormWindowManagerInterface::RaiseAction | 201 | Raise current widget |
QDesignerFormWindowManagerInterface::UndoAction | 300 | Undo |
QDesignerFormWindowManagerInterface::RedoAction | 301 | Redo |
QDesignerFormWindowManagerInterface::HorizontalLayoutAction | 400 | Lay out using QHBoxLayout |
QDesignerFormWindowManagerInterface::VerticalLayoutAction | 401 | Lay out using QVBoxLayout |
QDesignerFormWindowManagerInterface::SplitHorizontalAction | 402 | Lay out in horizontal QSplitter |
QDesignerFormWindowManagerInterface::SplitVerticalAction | 403 | Lay out in vertical QSplitter |
QDesignerFormWindowManagerInterface::GridLayoutAction | 404 | Lay out using QGridLayout |
QDesignerFormWindowManagerInterface::FormLayoutAction | 405 | Lay out using QFormLayout |
QDesignerFormWindowManagerInterface::BreakLayoutAction | 406 | Break existing layout |
QDesignerFormWindowManagerInterface::AdjustSizeAction | 407 | Adjust size |
QDesignerFormWindowManagerInterface::SimplifyLayoutAction | 408 | Simplify QGridLayout or QFormLayout |
QDesignerFormWindowManagerInterface::DefaultPreviewAction | 500 | Create a preview in default style |
QDesignerFormWindowManagerInterface::FormWindowSettingsDialogAction | 600 | Show dialog with form settings |
See also action().
enum QDesignerFormWindowManagerInterface::ActionGroup
Specifies an action group of Qt Designer.
| Constant | Value | Description |
|---|---|---|
QDesignerFormWindowManagerInterface::StyledPreviewActionGroup | 100 | Action group containing styled preview actions |
See also actionGroup().
Member Function Documentation
[explicit] QDesignerFormWindowManagerInterface::QDesignerFormWindowManagerInterface(QObject *parent = nullptr)
Constructs an interface with the given parent for the form window manager.
[virtual noexcept] QDesignerFormWindowManagerInterface::~QDesignerFormWindowManagerInterface()
Destroys the interface for the form window manager.
[pure virtual] QAction *QDesignerFormWindowManagerInterface::action(QDesignerFormWindowManagerInterface::Action action) const
Returns the action specified by the enumeration value action.
Obsoletes the action accessors of Qt 4.X.
[pure virtual] QActionGroup *QDesignerFormWindowManagerInterface::actionGroup(QDesignerFormWindowManagerInterface::ActionGroup actionGroup) const
Returns the action group specified by the enumeration value actionGroup.
[pure virtual] QDesignerFormWindowInterface *QDesignerFormWindowManagerInterface::activeFormWindow() const
Returns the currently active form window in Qt Designer's workspace.
See also setActiveFormWindow() and removeFormWindow().
[signal] void QDesignerFormWindowManagerInterface::activeFormWindowChanged(QDesignerFormWindowInterface *formWindow)
This signal is emitted when the contents of the currently active form window in Qt Designer's workspace changed. A pointer to the currently active formWindow is passed as an argument.
See also activeFormWindow().
[pure virtual slot] void QDesignerFormWindowManagerInterface::addFormWindow(QDesignerFormWindowInterface *formWindow)
Adds the given formWindow to the collection of windows that Qt Designer's form window manager maintains.
See also formWindowAdded().
[pure virtual slot] void QDesignerFormWindowManagerInterface::closeAllPreviews()
Close all currently open previews.
See also showPreview().
[pure virtual] QDesignerFormEditorInterface *QDesignerFormWindowManagerInterface::core() const
Returns a pointer to Qt Designer's current QDesignerFormEditorInterface object.
[pure virtual] QDesignerFormWindowInterface *QDesignerFormWindowManagerInterface::createFormWindow(QWidget *parent = nullptr, Qt::WindowFlags flags = Qt::WindowFlags())
Creates a form window with the given parent and the given window flags.
See also addFormWindow().
[pure virtual] QPixmap QDesignerFormWindowManagerInterface::createPreviewPixmap() const
Creates a pixmap representing the preview of the currently active form.
[pure virtual] QDesignerFormWindowInterface *QDesignerFormWindowManagerInterface::formWindow(int index) const
Returns the form window at the given index.
See also setActiveFormWindow() and removeFormWindow().
[signal] void QDesignerFormWindowManagerInterface::formWindowAdded(QDesignerFormWindowInterface *formWindow)
This signal is emitted when a new form window is added to the collection of windows that Qt Designer's form window manager maintains. A pointer to the new formWindow is passed as an argument.
See also addFormWindow() and setActiveFormWindow().
[pure virtual] int QDesignerFormWindowManagerInterface::formWindowCount() const
Returns the number of form windows maintained by Qt Designer's form window manager.
[signal] void QDesignerFormWindowManagerInterface::formWindowRemoved(QDesignerFormWindowInterface *formWindow)
This signal is emitted when a form window is removed from the collection of windows that Qt Designer's form window manager maintains. A pointer to the removed formWindow is passed as an argument.
See also removeFormWindow().
[signal] void QDesignerFormWindowManagerInterface::formWindowSettingsChanged(QDesignerFormWindowInterface *formWindow)
This signal is emitted when the settings of the form window change. It can be used to update window titles, etc. accordingly. A pointer to the formWindow is passed as an argument.
See also FormWindowSettingsDialogAction.
[pure virtual slot] void QDesignerFormWindowManagerInterface::removeFormWindow(QDesignerFormWindowInterface *formWindow)
Removes the given formWindow from the collection of windows that Qt Designer's form window manager maintains.
See also formWindow() and formWindowRemoved().
[pure virtual slot] void QDesignerFormWindowManagerInterface::setActiveFormWindow(QDesignerFormWindowInterface *formWindow)
Sets the given formWindow to be the currently active form window in Qt Designer's workspace.
See also activeFormWindow() and activeFormWindowChanged().
[pure virtual slot] void QDesignerFormWindowManagerInterface::showPluginDialog()
Opens a dialog showing the plugins loaded by Qt Designer's and its plugin load failures.
[pure virtual slot] void QDesignerFormWindowManagerInterface::showPreview()
Show a preview of the current form using the default parameters.
See also closeAllPreviews().