The QDesignerFormEditorInterface class allows you to access Qt Widgets Designer's various components. More...

#include <abstractformeditor.h>

Inheritance diagram for QDesignerFormEditorInterface:

Collaboration diagram for QDesignerFormEditorInterface:

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	isQmlExposed () const noexcept
	Returns whether the object has been created by the QML engine or ownership has been explicitly set via QJSEngine::setObjectOwnership().
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 &)
	Disconnects connection and resets it to \l{QMetaObject::Connection::operator bool()}{invalid}.
static bool	disconnect (QMetaObject::Connection &)
static bool	disconnect (QMetaObject::Connection &&conn)
	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)

Detailed Description

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.

See also: QDesignerCustomWidgetInterface

Definition at line 42 of file abstractformeditor.h.

Constructor & Destructor Documentation

◆ QDesignerFormEditorInterface()

QDesignerFormEditorInterface::QDesignerFormEditorInterface ( QObject * parent = nullptr )

explicit

Constructs a QDesignerFormEditorInterface object with the given parent.

Definition at line 140 of file abstractformeditor.cpp.

◆ ~QDesignerFormEditorInterface()

QDesignerFormEditorInterface::~QDesignerFormEditorInterface ( )

virtualdefault

Destroys the QDesignerFormEditorInterface object.

Member Function Documentation

◆ actionEditor()

QDesignerActionEditorInterface * QDesignerFormEditorInterface::actionEditor ( ) const

Returns an interface to \QD's action editor.

See also: setActionEditor()

Definition at line 197 of file abstractformeditor.cpp.

◆ createIcon()

QIcon QDesignerFormEditorInterface::createIcon ( const QString & name )

static

Since: 5.0

Return icons for actions of \QD.

Definition at line 567 of file abstractformeditor.cpp.

◆ dialogGui()

QDesignerDialogGuiInterface * QDesignerFormEditorInterface::dialogGui ( ) const

Returns the dialog GUI used by the form editor.

Definition at line 529 of file abstractformeditor.cpp.

◆ extensionManager()

QExtensionManager * QDesignerFormEditorInterface::extensionManager ( ) const

Returns an interface to \QD's extension manager.

Definition at line 247 of file abstractformeditor.cpp.

◆ formWindowManager()

QDesignerFormWindowManagerInterface * QDesignerFormEditorInterface::formWindowManager ( ) const

Returns an interface to \QD's form window manager.

Definition at line 231 of file abstractformeditor.cpp.

◆ gradientManager()

QtGradientManager * QDesignerFormEditorInterface::gradientManager ( ) const

Since: 4.4 Returns the gradient manager used by the style sheet editor.

Definition at line 443 of file abstractformeditor.cpp.

◆ integration()

QDesignerIntegrationInterface * QDesignerFormEditorInterface::integration ( ) const

Returns an interface to the integration.

Definition at line 362 of file abstractformeditor.cpp.

◆ introspection()

QDesignerIntrospectionInterface * QDesignerFormEditorInterface::introspection ( ) const

Since: 4.4 Returns the introspection used by the form editor.

Definition at line 492 of file abstractformeditor.cpp.

◆ metaDataBase()

QDesignerMetaDataBaseInterface * QDesignerFormEditorInterface::metaDataBase ( ) const

Returns an interface to the meta database used by the form editor.

Definition at line 265 of file abstractformeditor.cpp.

◆ objectInspector()

QDesignerObjectInspectorInterface * QDesignerFormEditorInterface::objectInspector ( ) const

Returns an interface to \QD's object inspector.

Definition at line 341 of file abstractformeditor.cpp.

◆ optionsPages()

QList< QDesignerOptionsPageInterface * > QDesignerFormEditorInterface::optionsPages ( ) const

Since: 4.5 Returns the list of options pages that allow the user to configure \QD components.

Definition at line 380 of file abstractformeditor.cpp.

◆ pluginInstances()

QObjectList QDesignerFormEditorInterface::pluginInstances ( ) const

Since: 5.0

Returns the plugin instances of QDesignerPluginManager.

Definition at line 554 of file abstractformeditor.cpp.

◆ pluginManager()

QDesignerPluginManager * QDesignerFormEditorInterface::pluginManager ( ) const

Returns the plugin manager used by the form editor.

Definition at line 401 of file abstractformeditor.cpp.

◆ promotion()

QDesignerPromotionInterface * QDesignerFormEditorInterface::promotion ( ) const

Returns an interface to the designer promotion handler.

Definition at line 302 of file abstractformeditor.cpp.

◆ propertyEditor()

QDesignerPropertyEditorInterface * QDesignerFormEditorInterface::propertyEditor ( ) const

Returns an interface to \QD's property editor.

See also: setPropertyEditor()

Definition at line 177 of file abstractformeditor.cpp.

◆ resourceLocation()

QString QDesignerFormEditorInterface::resourceLocation ( ) const

Returns the path to the resources used by the form editor.

Definition at line 514 of file abstractformeditor.cpp.

◆ resourceModel()

QtResourceModel * QDesignerFormEditorInterface::resourceModel ( ) const

Since: 4.4 Returns the resource model used by the form editor.

Definition at line 422 of file abstractformeditor.cpp.

◆ setActionEditor()

void QDesignerFormEditorInterface::setActionEditor ( QDesignerActionEditorInterface * actionEditor )

Sets \QD's action editor to be the specified actionEditor.

See also: actionEditor()

Definition at line 207 of file abstractformeditor.cpp.

◆ setDialogGui()

void QDesignerFormEditorInterface::setDialogGui ( QDesignerDialogGuiInterface * dialogGui )

Sets the dialog GUI used by the form editor to the specified dialogGui.

Definition at line 540 of file abstractformeditor.cpp.

◆ setExtensionManager()

void QDesignerFormEditorInterface::setExtensionManager ( QExtensionManager * extensionManager )

protected

Definition at line 255 of file abstractformeditor.cpp.

◆ setFormManager()

void QDesignerFormEditorInterface::setFormManager ( QDesignerFormWindowManagerInterface * formWindowManager )

protected

Definition at line 239 of file abstractformeditor.cpp.

◆ setGradientManager()

void QDesignerFormEditorInterface::setGradientManager ( QtGradientManager * gradientManager )

Sets the gradient manager used by the style sheet editor to the specified gradientManager.

Definition at line 454 of file abstractformeditor.cpp.

◆ setIntegration()

void QDesignerFormEditorInterface::setIntegration ( QDesignerIntegrationInterface * integration )

Definition at line 370 of file abstractformeditor.cpp.

◆ setIntrospection()

void QDesignerFormEditorInterface::setIntrospection ( QDesignerIntrospectionInterface * introspection )

Since: 4.4

Sets the introspection used by the form editor to the specified introspection.

Definition at line 503 of file abstractformeditor.cpp.

◆ setMetaDataBase()

void QDesignerFormEditorInterface::setMetaDataBase ( QDesignerMetaDataBaseInterface * metaDataBase )

protected

Definition at line 273 of file abstractformeditor.cpp.

◆ setObjectInspector()

void QDesignerFormEditorInterface::setObjectInspector ( QDesignerObjectInspectorInterface * objectInspector )

Sets \QD's object inspector to be the specified objectInspector.

See also: objectInspector()

Definition at line 352 of file abstractformeditor.cpp.

◆ setOptionsPages()

void QDesignerFormEditorInterface::setOptionsPages ( const QList< QDesignerOptionsPageInterface * > & optionsPages )

Since: 4.5 Sets the list of options pages that allow the user to configure \QD components.

Definition at line 390 of file abstractformeditor.cpp.

◆ setPluginManager()

void QDesignerFormEditorInterface::setPluginManager ( QDesignerPluginManager * pluginManager )

Sets the plugin manager used by the form editor to the specified pluginManager.

Definition at line 412 of file abstractformeditor.cpp.

◆ setPromotion()

void QDesignerFormEditorInterface::setPromotion ( QDesignerPromotionInterface * promotion )

protected

Sets the designer promotion handler.

Definition at line 313 of file abstractformeditor.cpp.

◆ setPropertyEditor()

void QDesignerFormEditorInterface::setPropertyEditor ( QDesignerPropertyEditorInterface * propertyEditor )

Sets \QD's property editor to be the specified propertyEditor.

See also: propertyEditor()

Definition at line 187 of file abstractformeditor.cpp.

◆ setResourceModel()

void QDesignerFormEditorInterface::setResourceModel ( QtResourceModel * resourceModel )

Sets the resource model used by the form editor to the specified resourceModel.

Definition at line 433 of file abstractformeditor.cpp.

◆ setSettingsManager()

void QDesignerFormEditorInterface::setSettingsManager ( QDesignerSettingsInterface * settingsManager )

Since: 4.5 Sets the settings manager used to store/retrieve the persistent settings of the components.

Definition at line 474 of file abstractformeditor.cpp.

◆ settingsManager()

QDesignerSettingsInterface * QDesignerFormEditorInterface::settingsManager ( ) const

Since: 4.5 Returns the settings manager used by the components to store persistent settings.

Definition at line 464 of file abstractformeditor.cpp.

◆ setTopLevel()

void QDesignerFormEditorInterface::setTopLevel ( QWidget * topLevel )

Definition at line 223 of file abstractformeditor.cpp.

◆ setWidgetBox()

void QDesignerFormEditorInterface::setWidgetBox ( QDesignerWidgetBoxInterface * widgetBox )

Sets \QD's widget box to be the specified widgetBox.

See also: widgetBox()

Definition at line 167 of file abstractformeditor.cpp.

◆ setWidgetDataBase()

void QDesignerFormEditorInterface::setWidgetDataBase ( QDesignerWidgetDataBaseInterface * widgetDataBase )

protected

Definition at line 291 of file abstractformeditor.cpp.

◆ setWidgetFactory()

void QDesignerFormEditorInterface::setWidgetFactory ( QDesignerWidgetFactoryInterface * widgetFactory )

protected

Definition at line 333 of file abstractformeditor.cpp.

◆ topLevel()

QWidget * QDesignerFormEditorInterface::topLevel ( ) const

Returns \QD's top-level widget.

Definition at line 215 of file abstractformeditor.cpp.

◆ widgetBox()

QDesignerWidgetBoxInterface * QDesignerFormEditorInterface::widgetBox ( ) const

Returns an interface to \QD's widget box.

See also: setWidgetBox()

Definition at line 157 of file abstractformeditor.cpp.

◆ widgetDataBase()

QDesignerWidgetDataBaseInterface * QDesignerFormEditorInterface::widgetDataBase ( ) const

Returns an interface to the widget database used by the form editor.

Definition at line 283 of file abstractformeditor.cpp.

◆ widgetFactory()

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 325 of file abstractformeditor.cpp.

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

qttools/src/designer/src/lib/sdk/abstractformeditor.h (50c3238aed664f75f332b50cfc1facd7ba403326)
qttools/src/designer/src/lib/sdk/abstractformeditor.cpp (50c3238aed664f75f332b50cfc1facd7ba403326)

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QDesignerFormEditorInterface()

◆ ~QDesignerFormEditorInterface()

Member Function Documentation

◆ actionEditor()

◆ createIcon()

◆ dialogGui()

◆ extensionManager()

◆ formWindowManager()

◆ gradientManager()

◆ integration()

◆ introspection()

◆ metaDataBase()

◆ objectInspector()

◆ optionsPages()

◆ pluginInstances()

◆ pluginManager()

◆ promotion()

◆ propertyEditor()

◆ resourceLocation()

◆ resourceModel()

◆ setActionEditor()

◆ setDialogGui()

◆ setExtensionManager()

◆ setFormManager()

◆ setGradientManager()

◆ setIntegration()

◆ setIntrospection()

◆ setMetaDataBase()

◆ setObjectInspector()

◆ setOptionsPages()

◆ setPluginManager()

◆ setPromotion()

◆ setPropertyEditor()

◆ setResourceModel()

◆ setSettingsManager()

◆ settingsManager()

◆ setTopLevel()

◆ setWidgetBox()

◆ setWidgetDataBase()

◆ setWidgetFactory()

◆ topLevel()

◆ widgetBox()

◆ widgetDataBase()

◆ widgetFactory()