Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
|
The QDesignerFormWindowManagerInterface class allows you to manipulate the collection of form windows in \QD, and control \QD's form editing actions. More...
#include <abstractformwindowmanager.h>
Public Types | |
enum | Action { DeleteAction = 103 , SelectAllAction , LowerAction = 200 , RaiseAction , UndoAction = 300 , RedoAction , HorizontalLayoutAction = 400 , VerticalLayoutAction , SplitHorizontalAction , SplitVerticalAction , GridLayoutAction , FormLayoutAction , BreakLayoutAction , AdjustSizeAction , SimplifyLayoutAction , DefaultPreviewAction = 500 , FormWindowSettingsDialogAction = 600 } |
Specifies an action of \QD. More... | |
enum | ActionGroup { StyledPreviewActionGroup = 100 } |
Specifies an action group of \QD. More... | |
Public Slots | |
virtual void | addFormWindow (QDesignerFormWindowInterface *formWindow)=0 |
Adds the given formWindow to the collection of windows that \QD's form window manager maintains. | |
virtual void | removeFormWindow (QDesignerFormWindowInterface *formWindow)=0 |
Removes the given formWindow from the collection of windows that \QD's form window manager maintains. | |
virtual void | setActiveFormWindow (QDesignerFormWindowInterface *formWindow)=0 |
Sets the given formWindow to be the currently active form window in \QD's workspace. | |
virtual void | showPreview ()=0 |
Show a preview of the current form using the default parameters. | |
virtual void | closeAllPreviews ()=0 |
Close all currently open previews. | |
virtual void | showPluginDialog ()=0 |
Opens a dialog showing the plugins loaded by \QD's and its plugin load failures. | |
Public Slots inherited from QObject | |
void | deleteLater () |
\threadsafe | |
Signals | |
void | formWindowAdded (QDesignerFormWindowInterface *formWindow) |
This signal is emitted when a new form window is added to the collection of windows that \QD's form window manager maintains. | |
void | formWindowRemoved (QDesignerFormWindowInterface *formWindow) |
This signal is emitted when a form window is removed from the collection of windows that \QD's form window manager maintains. | |
void | activeFormWindowChanged (QDesignerFormWindowInterface *formWindow) |
This signal is emitted when the contents of the currently active form window in \QD's workspace changed. | |
void | formWindowSettingsChanged (QDesignerFormWindowInterface *fw) |
This signal is emitted when the settings of the form window change. | |
Signals inherited from QObject | |
void | destroyed (QObject *=nullptr) |
This signal is emitted immediately before the object obj is destroyed, after any instances of QPointer have been notified, and cannot be blocked. | |
void | objectNameChanged (const QString &objectName, QPrivateSignal) |
This signal is emitted after the object's name has been changed. | |
Public Member Functions | |
QDesignerFormWindowManagerInterface (QObject *parent=nullptr) | |
Constructs an interface with the given parent for the form window manager. | |
virtual | ~QDesignerFormWindowManagerInterface () |
Destroys the interface for the form window manager. | |
virtual QAction * | action (Action action) const =0 |
Returns the action specified by the enumeration value action. | |
virtual QActionGroup * | actionGroup (ActionGroup actionGroup) const =0 |
Returns the action group specified by the enumeration value actionGroup. | |
QAction * | actionDelete () const |
Allows you to intervene and control \QD's "cut" action. | |
QAction * | actionSelectAll () const |
Allows you to intervene and control \QD's "select all" action. | |
QAction * | actionLower () const |
Allows you to intervene and control the action of lowering a form window in \QD's workspace. | |
QAction * | actionRaise () const |
Allows you to intervene and control the action of raising of a form window in \QD's workspace. | |
QAction * | actionUndo () const |
Allows you to intervene and control \QD's "undo" action. | |
QAction * | actionRedo () const |
Allows you to intervene and control \QD's "redo" action. | |
QAction * | actionHorizontalLayout () const |
Allows you to intervene and control a request for horizontal layout for a form window in \QD's workspace. | |
QAction * | actionVerticalLayout () const |
Allows you to intervene and control a request for vertical layout for a form window in \QD's workspace. | |
QAction * | actionSplitHorizontal () const |
Allows you to intervene and control \QD's "split horizontal" action. | |
QAction * | actionSplitVertical () const |
Allows you to intervene and control \QD's "split vertical" action. | |
QAction * | actionGridLayout () const |
Allows you to intervene and control a request for grid layout for a form window in \QD's workspace. | |
QAction * | actionFormLayout () const |
Allows you to intervene and control \QD's "form layout" action. | |
QAction * | actionBreakLayout () const |
Allows you to intervene and control \QD's "break layout" action. | |
QAction * | actionAdjustSize () const |
Allows you to intervene and control \QD's "adjust size" action. | |
QAction * | actionSimplifyLayout () const |
Allows you to intervene and control \QD's "simplify layout" action. | |
virtual QDesignerFormWindowInterface * | activeFormWindow () const =0 |
Returns the currently active form window in \QD's workspace. | |
virtual int | formWindowCount () const =0 |
Returns the number of form windows maintained by \QD's form window manager. | |
virtual QDesignerFormWindowInterface * | formWindow (int index) const =0 |
Returns the form window at the given index. | |
virtual QDesignerFormWindowInterface * | createFormWindow (QWidget *parentWidget=nullptr, Qt::WindowFlags flags=Qt::WindowFlags())=0 |
Creates a form window with the given parent and the given window flags. | |
virtual QDesignerFormEditorInterface * | core () const =0 |
Returns a pointer to \QD's current QDesignerFormEditorInterface object. | |
virtual void | dragItems (const QList< QDesignerDnDItemInterface * > &item_list)=0 |
virtual QPixmap | createPreviewPixmap () const =0 |
Creates a pixmap representing the preview of the currently active form. | |
Public Member Functions inherited from QObject | |
Q_INVOKABLE | QObject (QObject *parent=nullptr) |
Constructs an object with parent object parent. | |
virtual | ~QObject () |
Destroys the object, deleting all its child objects. | |
virtual bool | event (QEvent *event) |
This virtual function receives events to an object and should return true if the event e was recognized and processed. | |
virtual bool | eventFilter (QObject *watched, QEvent *event) |
Filters events if this object has been installed as an event filter for the watched object. | |
QString | objectName () const |
Q_WEAK_OVERLOAD void | setObjectName (const QString &name) |
Sets the object's name to name. | |
void | setObjectName (QAnyStringView name) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
QBindable< QString > | bindableObjectName () |
bool | isWidgetType () const |
Returns true if the object is a widget; otherwise returns false . | |
bool | isWindowType () const |
Returns true if the object is a window; otherwise returns false . | |
bool | isQuickItemType () const |
Returns true if the object is a QQuickItem; otherwise returns false . | |
bool | signalsBlocked () const noexcept |
Returns true if signals are blocked; otherwise returns false . | |
bool | blockSignals (bool b) noexcept |
If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it). | |
QThread * | thread () const |
Returns the thread in which the object lives. | |
bool | moveToThread (QThread *thread QT6_DECL_NEW_OVERLOAD_TAIL) |
Changes the thread affinity for this object and its children and returns true on success. | |
int | startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer) |
This is an overloaded function that will start a timer of type timerType and a timeout of interval milliseconds. | |
int | startTimer (std::chrono::nanoseconds time, Qt::TimerType timerType=Qt::CoarseTimer) |
void | killTimer (int id) |
Kills the timer with timer identifier, id. | |
void | killTimer (Qt::TimerId id) |
template<typename T > | |
T | findChild (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const |
Returns the child of this object that can be cast into type T and that is called name, or \nullptr if there is no such object. | |
template<typename T > | |
QList< T > | findChildren (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const |
Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects. | |
template<typename T > | |
T | findChild (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
template<typename T > | |
QList< T > | findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
const QObjectList & | children () const |
Returns a list of child objects. | |
void | setParent (QObject *parent) |
Makes the object a child of parent. | |
void | installEventFilter (QObject *filterObj) |
Installs an event filter filterObj on this object. | |
void | removeEventFilter (QObject *obj) |
Removes an event filter object obj from this object. | |
QMetaObject::Connection | connect (const QObject *sender, const char *signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const |
bool | disconnect (const char *signal=nullptr, const QObject *receiver=nullptr, const char *member=nullptr) const |
bool | disconnect (const QObject *receiver, const char *member=nullptr) const |
void | dumpObjectTree () const |
Dumps a tree of children to the debug output. | |
void | dumpObjectInfo () const |
Dumps information about signal connections, etc. | |
bool | setProperty (const char *name, const QVariant &value) |
Sets the value of the object's name property to value. | |
bool | setProperty (const char *name, QVariant &&value) |
QVariant | property (const char *name) const |
Returns the value of the object's name property. | |
QList< QByteArray > | dynamicPropertyNames () const |
QBindingStorage * | bindingStorage () |
const QBindingStorage * | bindingStorage () const |
QObject * | parent () const |
Returns a pointer to the parent object. | |
bool | inherits (const char *classname) const |
Returns true if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns false . | |
Additional Inherited Members | |
Static Public Member Functions inherited from QObject | |
static QMetaObject::Connection | connect (const QObject *sender, const char *signal, const QObject *receiver, const char *member, Qt::ConnectionType=Qt::AutoConnection) |
\threadsafe | |
static QMetaObject::Connection | connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection) |
template<typename Func1 , typename Func2 > | |
static QMetaObject::Connection | connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const typename QtPrivate::ContextTypeForFunctor< Func2 >::ContextType *context, Func2 &&slot, Qt::ConnectionType type=Qt::AutoConnection) |
template<typename Func1 , typename Func2 > | |
static QMetaObject::Connection | connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 &&slot) |
static bool | disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *member) |
\threadsafe | |
static bool | disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &member) |
static bool | disconnect (const QMetaObject::Connection &) |
Disconnect a connection. | |
template<typename Func1 , typename Func2 > | |
static bool | disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object *receiver, Func2 slot) |
template<typename Func1 > | |
static bool | disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const QObject *receiver, void **zero) |
Protected Member Functions inherited from QObject | |
QObject * | sender () const |
Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns \nullptr. | |
int | senderSignalIndex () const |
int | receivers (const char *signal) const |
Returns the number of receivers connected to the signal. | |
bool | isSignalConnected (const QMetaMethod &signal) const |
virtual void | timerEvent (QTimerEvent *event) |
This event handler can be reimplemented in a subclass to receive timer events for the object. | |
virtual void | childEvent (QChildEvent *event) |
This event handler can be reimplemented in a subclass to receive child events. | |
virtual void | customEvent (QEvent *event) |
This event handler can be reimplemented in a subclass to receive custom events. | |
virtual void | connectNotify (const QMetaMethod &signal) |
virtual void | disconnectNotify (const QMetaMethod &signal) |
QObject (QObjectPrivate &dd, QObject *parent=nullptr) | |
Protected Attributes inherited from QObject | |
QScopedPointer< QObjectData > | d_ptr |
Properties inherited from QObject | |
QString | objectName |
the name of this object | |
Related Symbols inherited from QObject | |
template< class T > T | qobject_cast (const QObject *object) |
Returns the given object cast to type T if the object is of type T (or of a subclass); otherwise returns \nullptr. | |
template< typename T > T | qFindChildqFindChildren (const QObject *obj, const QString &name)() |
template< typename T > QList< T > | qFindChildrenqFindChildren (const QObject *obj, const QString &name)() |
QObjectList | |
\macro Q_CLASSINFO(Name, Value) | |
The QDesignerFormWindowManagerInterface class allows you to manipulate the collection of form windows in \QD, and control \QD's form editing actions.
\inmodule QtDesigner
QDesignerFormWindowManagerInterface is not intended to be instantiated directly. \QD uses the form window manager to control the various form windows in its workspace. You can retrieve an interface to \QD's form window manager using the QDesignerFormEditorInterface::formWindowManager() function. For example:
When implementing a custom widget plugin, a pointer to \QD'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 \QD.
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 \QD's workspace.
In addition, QDesignerFormWindowManagerInterface contains a collection of functions that enables you to intervene and control \QD'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.
Definition at line 23 of file abstractformwindowmanager.h.
Specifies an action of \QD.
Definition at line 30 of file abstractformwindowmanager.h.
Specifies an action group of \QD.
Enumerator | |
---|---|
StyledPreviewActionGroup |
Definition at line 62 of file abstractformwindowmanager.h.
|
explicit |
Constructs an interface with the given parent for the form window manager.
Definition at line 106 of file abstractformwindowmanager.cpp.
|
virtualdefault |
Destroys the interface for the form window manager.
Returns the action specified by the enumeration value action.
Obsoletes the action accessors of Qt 4.X.
Implemented in qdesigner_internal::FormWindowManager.
QAction * QDesignerFormWindowManagerInterface::actionAdjustSize | ( | ) | const |
QAction * QDesignerFormWindowManagerInterface::actionBreakLayout | ( | ) | const |
QAction * QDesignerFormWindowManagerInterface::actionDelete | ( | ) | const |
Allows you to intervene and control \QD's "cut" action.
The function returns the original action.
Use action() instead.
Allows you to intervene and control \QD's "copy" action. The function returns the original action.
Use action() instead.
Allows you to intervene and control \QD's "paste" action. The function returns the original action.
Use action() instead.
Allows you to intervene and control \QD's "delete" action. The function returns the original action.
Use action() instead.
The function returns the original action.
Use action() instead.
Allows you to intervene and control \QD's "copy" action. The function returns the original action.
Use action() instead.
Allows you to intervene and control \QD's "paste" action. The function returns the original action.
Use action() instead.
Allows you to intervene and control \QD's "delete" action. The function returns the original action.
Use action() instead.
Definition at line 173 of file abstractformwindowmanager.cpp.
QAction * QDesignerFormWindowManagerInterface::actionFormLayout | ( | ) | const |
Allows you to intervene and control \QD's "form layout" action.
The function returns the original action.
Use action() instead.
The function returns the original action.
Use action() instead.
Definition at line 307 of file abstractformwindowmanager.cpp.
QAction * QDesignerFormWindowManagerInterface::actionGridLayout | ( | ) | const |
Allows you to intervene and control a request for grid layout for a form window in \QD's workspace.
The function returns the original action.
Use action() instead.
The function returns the original action.
Use action() instead.
Definition at line 291 of file abstractformwindowmanager.cpp.
|
pure virtual |
Returns the action group specified by the enumeration value actionGroup.
Implemented in qdesigner_internal::FormWindowManager.
QAction * QDesignerFormWindowManagerInterface::actionHorizontalLayout | ( | ) | const |
Allows you to intervene and control a request for horizontal layout for a form window in \QD's workspace.
The function returns the original action.
Use action() instead.
The function returns the original action.
Use action() instead.
Definition at line 233 of file abstractformwindowmanager.cpp.
QAction * QDesignerFormWindowManagerInterface::actionLower | ( | ) | const |
Allows you to intervene and control the action of lowering a form window in \QD's workspace.
The function returns the original action.
Use action() instead.
The function returns the original action.
Use action() instead.
Definition at line 203 of file abstractformwindowmanager.cpp.
QAction * QDesignerFormWindowManagerInterface::actionRaise | ( | ) | const |
Allows you to intervene and control the action of raising of a form window in \QD's workspace.
The function returns the original action.
Use action() instead.
The function returns the original action.
Use action() instead.
Definition at line 218 of file abstractformwindowmanager.cpp.
QAction * QDesignerFormWindowManagerInterface::actionRedo | ( | ) | const |
QAction * QDesignerFormWindowManagerInterface::actionSelectAll | ( | ) | const |
QAction * QDesignerFormWindowManagerInterface::actionSimplifyLayout | ( | ) | const |
Allows you to intervene and control \QD's "simplify layout" action.
The function returns the original action.
Use action() instead.
The function returns the original action.
Use action() instead.
Definition at line 351 of file abstractformwindowmanager.cpp.
QAction * QDesignerFormWindowManagerInterface::actionSplitHorizontal | ( | ) | const |
QAction * QDesignerFormWindowManagerInterface::actionSplitVertical | ( | ) | const |
QAction * QDesignerFormWindowManagerInterface::actionUndo | ( | ) | const |
QAction * QDesignerFormWindowManagerInterface::actionVerticalLayout | ( | ) | const |
Allows you to intervene and control a request for vertical layout for a form window in \QD's workspace.
The function returns the original action.
Use action() instead.
The function returns the original action.
Use action() instead.
Definition at line 248 of file abstractformwindowmanager.cpp.
|
pure virtual |
Returns the currently active form window in \QD's workspace.
Implemented in qdesigner_internal::FormWindowManager.
|
signal |
This signal is emitted when the contents of the currently active form window in \QD's workspace changed.
A pointer to the currently active formWindow is passed as an argument.
|
pure virtualslot |
Adds the given formWindow to the collection of windows that \QD's form window manager maintains.
|
pure virtualslot |
|
pure virtual |
Returns a pointer to \QD's current QDesignerFormEditorInterface object.
Implemented in qdesigner_internal::FormWindowManager.
|
pure virtual |
Creates a form window with the given parent and the given window flags.
Implemented in qdesigner_internal::FormWindowManager.
|
pure virtual |
Creates a pixmap representing the preview of the currently active form.
Implemented in qdesigner_internal::FormWindowManager.
|
pure virtual |
Implemented in qdesigner_internal::FormWindowManager.
|
pure virtual |
Returns the form window at the given index.
Implemented in qdesigner_internal::FormWindowManager.
|
signal |
This signal is emitted when a new form window is added to the collection of windows that \QD's form window manager maintains.
A pointer to the new formWindow is passed as an argument.
|
pure virtual |
Returns the number of form windows maintained by \QD's form window manager.
Implemented in qdesigner_internal::FormWindowManager.
|
signal |
This signal is emitted when a form window is removed from the collection of windows that \QD's form window manager maintains.
A pointer to the removed formWindow is passed as an argument.
|
signal |
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.
|
pure virtualslot |
Removes the given formWindow from the collection of windows that \QD's form window manager maintains.
|
pure virtualslot |
Sets the given formWindow to be the currently active form window in \QD's workspace.
|
pure virtualslot |
Opens a dialog showing the plugins loaded by \QD's and its plugin load failures.
Implemented in qdesigner_internal::QDesignerFormWindowManager.
|
pure virtualslot |
Show a preview of the current form using the default parameters.