Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
|
The QDesignerFormEditorInterface class allows you to access Qt Widgets Designer's various components. More...
#include <abstractformeditor.h>
Public Member Functions | |
QDesignerFormEditorInterface (QObject *parent=nullptr) | |
Constructs a QDesignerFormEditorInterface object with the given parent. | |
virtual | ~QDesignerFormEditorInterface () |
Destroys the QDesignerFormEditorInterface object. | |
QExtensionManager * | extensionManager () const |
Returns an interface to \QD's extension manager. | |
QWidget * | topLevel () const |
Returns \QD's top-level widget. | |
QDesignerWidgetBoxInterface * | widgetBox () const |
Returns an interface to \QD's widget box. | |
QDesignerPropertyEditorInterface * | propertyEditor () const |
Returns an interface to \QD's property editor. | |
QDesignerObjectInspectorInterface * | objectInspector () const |
Returns an interface to \QD's object inspector. | |
QDesignerFormWindowManagerInterface * | formWindowManager () const |
Returns an interface to \QD's form window manager. | |
QDesignerWidgetDataBaseInterface * | widgetDataBase () const |
QDesignerMetaDataBaseInterface * | metaDataBase () const |
QDesignerPromotionInterface * | promotion () const |
QDesignerWidgetFactoryInterface * | widgetFactory () const |
QDesignerActionEditorInterface * | actionEditor () const |
Returns an interface to \QD's action editor. | |
QDesignerIntegrationInterface * | integration () const |
QDesignerPluginManager * | pluginManager () const |
QDesignerIntrospectionInterface * | introspection () const |
QDesignerDialogGuiInterface * | dialogGui () const |
QDesignerSettingsInterface * | settingsManager () const |
QString | resourceLocation () const |
QtResourceModel * | resourceModel () const |
QtGradientManager * | gradientManager () const |
QList< QDesignerOptionsPageInterface * > | optionsPages () const |
void | setTopLevel (QWidget *topLevel) |
void | setWidgetBox (QDesignerWidgetBoxInterface *widgetBox) |
Sets \QD's widget box to be the specified widgetBox. | |
void | setPropertyEditor (QDesignerPropertyEditorInterface *propertyEditor) |
Sets \QD's property editor to be the specified propertyEditor. | |
void | setObjectInspector (QDesignerObjectInspectorInterface *objectInspector) |
Sets \QD's object inspector to be the specified objectInspector. | |
void | setPluginManager (QDesignerPluginManager *pluginManager) |
void | setActionEditor (QDesignerActionEditorInterface *actionEditor) |
Sets \QD's action editor to be the specified actionEditor. | |
void | setIntegration (QDesignerIntegrationInterface *integration) |
void | setIntrospection (QDesignerIntrospectionInterface *introspection) |
void | setDialogGui (QDesignerDialogGuiInterface *dialogGui) |
void | setSettingsManager (QDesignerSettingsInterface *settingsManager) |
void | setResourceModel (QtResourceModel *model) |
void | setGradientManager (QtGradientManager *manager) |
void | setOptionsPages (const QList< QDesignerOptionsPageInterface * > &optionsPages) |
QObjectList | pluginInstances () const |
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 . | |
Static Public Member Functions | |
static QIcon | createIcon (const QString &name) |
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 | |
void | setFormManager (QDesignerFormWindowManagerInterface *formWindowManager) |
void | setMetaDataBase (QDesignerMetaDataBaseInterface *metaDataBase) |
void | setWidgetDataBase (QDesignerWidgetDataBaseInterface *widgetDataBase) |
void | setPromotion (QDesignerPromotionInterface *promotion) |
void | setWidgetFactory (QDesignerWidgetFactoryInterface *widgetFactory) |
void | setExtensionManager (QExtensionManager *extensionManager) |
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) | |
Additional Inherited Members | |
Public Slots inherited from QObject | |
void | deleteLater () |
\threadsafe | |
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. | |
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 QDesignerFormEditorInterface class allows you to access Qt Widgets Designer's various components.
\inmodule QtDesigner
\QD's current QDesignerFormEditorInterface object holds information about all \QD's components: The action editor, the object inspector, the property editor, the widget box, and the extension and form window managers. QDesignerFormEditorInterface contains a collection of functions that provides interfaces to all these components. They are typically used to query (and manipulate) the respective component. For example:
QDesignerFormEditorInterface is not intended to be instantiated directly. A pointer to \QD's current QDesignerFormEditorInterface object (formEditor
in the example above) is provided by the QDesignerCustomWidgetInterface::initialize() function's parameter. When implementing a custom widget plugin, you must subclass the QDesignerCustomWidgetInterface to expose your plugin to \QD.
QDesignerFormEditorInterface also provides functions that can set the action editor, property editor, object inspector and widget box. These are only useful if you want to provide your own custom components.
If designer is embedded in another program, one could to provide its own settings manager. The manager is used by the components of \QD to store/retrieve persistent configuration settings. The default manager uses QSettings as the backend.
Finally, QDesignerFormEditorInterface provides the topLevel() function that returns \QD's top-level widget.
Definition at line 39 of file abstractformeditor.h.
Constructs a QDesignerFormEditorInterface object with the given parent.
Definition at line 139 of file abstractformeditor.cpp.
|
virtualdefault |
Destroys the QDesignerFormEditorInterface object.
QDesignerActionEditorInterface * QDesignerFormEditorInterface::actionEditor | ( | ) | const |
Returns an interface to \QD's action editor.
Definition at line 196 of file abstractformeditor.cpp.
QDesignerDialogGuiInterface * QDesignerFormEditorInterface::dialogGui | ( | ) | const |
Returns the dialog GUI used by the form editor.
Definition at line 528 of file abstractformeditor.cpp.
QExtensionManager * QDesignerFormEditorInterface::extensionManager | ( | ) | const |
Returns an interface to \QD's extension manager.
Definition at line 246 of file abstractformeditor.cpp.
QDesignerFormWindowManagerInterface * QDesignerFormEditorInterface::formWindowManager | ( | ) | const |
Returns an interface to \QD's form window manager.
Definition at line 230 of file abstractformeditor.cpp.
QtGradientManager * QDesignerFormEditorInterface::gradientManager | ( | ) | const |
Definition at line 442 of file abstractformeditor.cpp.
QDesignerIntegrationInterface * QDesignerFormEditorInterface::integration | ( | ) | const |
Returns an interface to the integration.
Definition at line 361 of file abstractformeditor.cpp.
QDesignerIntrospectionInterface * QDesignerFormEditorInterface::introspection | ( | ) | const |
Definition at line 491 of file abstractformeditor.cpp.
QDesignerMetaDataBaseInterface * QDesignerFormEditorInterface::metaDataBase | ( | ) | const |
Returns an interface to the meta database used by the form editor.
Definition at line 264 of file abstractformeditor.cpp.
QDesignerObjectInspectorInterface * QDesignerFormEditorInterface::objectInspector | ( | ) | const |
Returns an interface to \QD's object inspector.
Definition at line 340 of file abstractformeditor.cpp.
QList< QDesignerOptionsPageInterface * > QDesignerFormEditorInterface::optionsPages | ( | ) | const |
Definition at line 379 of file abstractformeditor.cpp.
QObjectList QDesignerFormEditorInterface::pluginInstances | ( | ) | const |
Returns the plugin instances of QDesignerPluginManager.
Definition at line 553 of file abstractformeditor.cpp.
QDesignerPluginManager * QDesignerFormEditorInterface::pluginManager | ( | ) | const |
Returns the plugin manager used by the form editor.
Definition at line 400 of file abstractformeditor.cpp.
QDesignerPromotionInterface * QDesignerFormEditorInterface::promotion | ( | ) | const |
Returns an interface to the designer promotion handler.
Definition at line 301 of file abstractformeditor.cpp.
QDesignerPropertyEditorInterface * QDesignerFormEditorInterface::propertyEditor | ( | ) | const |
Returns an interface to \QD's property editor.
Definition at line 176 of file abstractformeditor.cpp.
QString QDesignerFormEditorInterface::resourceLocation | ( | ) | const |
Returns the path to the resources used by the form editor.
Definition at line 513 of file abstractformeditor.cpp.
QtResourceModel * QDesignerFormEditorInterface::resourceModel | ( | ) | const |
Definition at line 421 of file abstractformeditor.cpp.
void QDesignerFormEditorInterface::setActionEditor | ( | QDesignerActionEditorInterface * | actionEditor | ) |
Sets \QD's action editor to be the specified actionEditor.
Definition at line 206 of file abstractformeditor.cpp.
void QDesignerFormEditorInterface::setDialogGui | ( | QDesignerDialogGuiInterface * | dialogGui | ) |
Sets the dialog GUI used by the form editor to the specified dialogGui.
Definition at line 539 of file abstractformeditor.cpp.
|
protected |
Definition at line 254 of file abstractformeditor.cpp.
|
protected |
Definition at line 238 of file abstractformeditor.cpp.
void QDesignerFormEditorInterface::setGradientManager | ( | QtGradientManager * | gradientManager | ) |
Sets the gradient manager used by the style sheet editor to the specified gradientManager.
Definition at line 453 of file abstractformeditor.cpp.
void QDesignerFormEditorInterface::setIntegration | ( | QDesignerIntegrationInterface * | integration | ) |
Definition at line 369 of file abstractformeditor.cpp.
void QDesignerFormEditorInterface::setIntrospection | ( | QDesignerIntrospectionInterface * | introspection | ) |
Sets the introspection used by the form editor to the specified introspection.
Definition at line 502 of file abstractformeditor.cpp.
|
protected |
Definition at line 272 of file abstractformeditor.cpp.
void QDesignerFormEditorInterface::setObjectInspector | ( | QDesignerObjectInspectorInterface * | objectInspector | ) |
Sets \QD's object inspector to be the specified objectInspector.
Definition at line 351 of file abstractformeditor.cpp.
void QDesignerFormEditorInterface::setOptionsPages | ( | const QList< QDesignerOptionsPageInterface * > & | optionsPages | ) |
Definition at line 389 of file abstractformeditor.cpp.
void QDesignerFormEditorInterface::setPluginManager | ( | QDesignerPluginManager * | pluginManager | ) |
Sets the plugin manager used by the form editor to the specified pluginManager.
Definition at line 411 of file abstractformeditor.cpp.
|
protected |
Sets the designer promotion handler.
Definition at line 312 of file abstractformeditor.cpp.
void QDesignerFormEditorInterface::setPropertyEditor | ( | QDesignerPropertyEditorInterface * | propertyEditor | ) |
Sets \QD's property editor to be the specified propertyEditor.
Definition at line 186 of file abstractformeditor.cpp.
void QDesignerFormEditorInterface::setResourceModel | ( | QtResourceModel * | resourceModel | ) |
Sets the resource model used by the form editor to the specified resourceModel.
Definition at line 432 of file abstractformeditor.cpp.
void QDesignerFormEditorInterface::setSettingsManager | ( | QDesignerSettingsInterface * | settingsManager | ) |
Definition at line 473 of file abstractformeditor.cpp.
QDesignerSettingsInterface * QDesignerFormEditorInterface::settingsManager | ( | ) | const |
Definition at line 463 of file abstractformeditor.cpp.
Definition at line 222 of file abstractformeditor.cpp.
void QDesignerFormEditorInterface::setWidgetBox | ( | QDesignerWidgetBoxInterface * | widgetBox | ) |
Sets \QD's widget box to be the specified widgetBox.
Definition at line 166 of file abstractformeditor.cpp.
|
protected |
Definition at line 290 of file abstractformeditor.cpp.
|
protected |
Definition at line 332 of file abstractformeditor.cpp.
QWidget * QDesignerFormEditorInterface::topLevel | ( | ) | const |
Returns \QD's top-level widget.
Definition at line 214 of file abstractformeditor.cpp.
QDesignerWidgetBoxInterface * QDesignerFormEditorInterface::widgetBox | ( | ) | const |
Returns an interface to \QD's widget box.
Definition at line 156 of file abstractformeditor.cpp.
QDesignerWidgetDataBaseInterface * QDesignerFormEditorInterface::widgetDataBase | ( | ) | const |
Returns an interface to the widget database used by the form editor.
Definition at line 282 of file abstractformeditor.cpp.
QDesignerWidgetFactoryInterface * QDesignerFormEditorInterface::widgetFactory | ( | ) | const |
Returns an interface to the widget factory used by the form editor to create widgets for the form.
Definition at line 324 of file abstractformeditor.cpp.