The QDesignerIntegration class is \QD's implementation of QDesignerIntegrationInterface. More...

#include <abstractintegration.h>

Inheritance diagram for QDesignerIntegration:

Collaboration diagram for QDesignerIntegration:

Public Member Functions
	QDesignerIntegration (QDesignerFormEditorInterface core, QObject parent=nullptr)

virtual	~QDesignerIntegration ()

QString	headerSuffix () const override

void	setHeaderSuffix (const QString &headerSuffix) override

bool	isHeaderLowercase () const override

void	setHeaderLowercase (bool headerLowerCase) override

Feature	features () const override

virtual void	setFeatures (Feature f) override

ResourceFileWatcherBehaviour	resourceFileWatcherBehaviour () const override

void	setResourceFileWatcherBehaviour (ResourceFileWatcherBehaviour behaviour) override

virtual QWidget *	containerWindow (QWidget *widget) const override
	Returns the outer window containing a form for applying main container geometries.

QDesignerResourceBrowserInterface *	createResourceBrowser (QWidget *parent=nullptr) override
	Creates a resource browser depending on IDE integration.

QString	contextHelpId () const override

void	updateProperty (const QString &name, const QVariant &value, bool enableSubPropertyHandling) override
	Triggered by the property editor to update a property value.

void	updateProperty (const QString &name, const QVariant &value) override
	Triggered by the property editor to update a property value without subproperty handling.

void	resetProperty (const QString &name) override
	Triggered by the property editor to reset a property value.

void	addDynamicProperty (const QString &name, const QVariant &value) override
	Triggered by the property editor to add a dynamic property value.

void	removeDynamicProperty (const QString &name) override
	Triggered by the property editor to remove a dynamic property.

void	updateActiveFormWindow (QDesignerFormWindowInterface *formWindow) override
	Sets up the active form window.

void	setupFormWindow (QDesignerFormWindowInterface *formWindow) override
	Sets up the new form window.

void	updateSelection () override
	Sets the selected widget of the form window in various components.

void	updateCustomWidgetPlugins () override
	Triggers a reload of the custom widget plugins.

Public Member Functions inherited from QDesignerIntegrationInterface
	QDesignerIntegrationInterface (QDesignerFormEditorInterface core, QObject parent=nullptr)

virtual	~QDesignerIntegrationInterface ()

QDesignerFormEditorInterface *	core () const

QVersionNumber	qtVersion () const

void	setQtVersion (const QVersionNumber &qtVersion)

bool	hasFeature (Feature f) const

void	emitObjectNameChanged (QDesignerFormWindowInterface formWindow, QObject object, const QString &newName, const QString &oldName)

void	emitNavigateToSlot (const QString &objectName, const QString &signalSignature, const QStringList &parameterNames)

void	emitNavigateToSlot (const QString &slotSignature)

void	emitHelpRequested (const QString &manual, const QString &document)

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 void	initializePlugins (QDesignerFormEditorInterface *formEditor)

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)

Additional Inherited Members
Public Types inherited from QDesignerIntegrationInterface
enum	ResourceFileWatcherBehaviour { NoResourceFileWatcher , ReloadResourceFileSilently , PromptToReloadResourceFile }

enum	FeatureFlag { ResourceEditorFeature = 0x1 , SlotNavigationFeature = 0x2 , DefaultWidgetActionFeature = 0x4 , DefaultFeature = ResourceEditorFeature \| DefaultWidgetActionFeature }

Public Slots inherited from QDesignerIntegrationInterface
Public Slots inherited from QObject
void	deleteLater ()
	\threadsafe

Signals inherited from QDesignerIntegrationInterface
void	propertyChanged (QDesignerFormWindowInterface *formWindow, const QString &name, const QVariant &value)

void	objectNameChanged (QDesignerFormWindowInterface formWindow, QObject object, const QString &newName, const QString &oldName)

void	helpRequested (const QString &manual, const QString &document)

void	navigateToSlot (const QString &objectName, const QString &signalSignature, const QStringList &parameterNames)

void	navigateToSlot (const QString &slotSignature)

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 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 QDesignerIntegrationInterface
QString	headerSuffix
	Returns the suffix of the header of promoted widgets.

bool	headerLowercase
	Returns whether headers of promoted widgets should be lower-cased (as the user types the class name).

QVersionNumber	qtVersion
	Determines the Qt version used when writing out forms.

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 QDesignerIntegration class is \QD's implementation of QDesignerIntegrationInterface.

\inmodule QtDesigner

IDE integrations should register classes derived from QDesignerIntegration with QDesignerFormEditorInterface.

Definition at line 111 of file abstractintegration.h.

Constructor & Destructor Documentation

◆ QDesignerIntegration()

QDesignerIntegration::QDesignerIntegration	(	QDesignerFormEditorInterface *	core,
		QObject *	parent = nullptr )

explicit

Definition at line 638 of file abstractintegration.cpp.

◆ ~QDesignerIntegration()

QDesignerIntegration::~QDesignerIntegration ( )

virtual

Definition at line 645 of file abstractintegration.cpp.

Member Function Documentation

◆ addDynamicProperty()

void QDesignerIntegration::addDynamicProperty	(	const QString &	name,
		const QVariant &	value )

overridevirtual

Triggered by the property editor to add a dynamic property value.

If a different property editor is used, it should invoke this function.

Implements QDesignerIntegrationInterface.

Definition at line 713 of file abstractintegration.cpp.

◆ containerWindow()

QWidget * QDesignerIntegration::containerWindow ( QWidget * widget ) const

overridevirtual

Returns the outer window containing a form for applying main container geometries.

Should be implemented by IDE integrations.

Implements QDesignerIntegrationInterface.

Definition at line 740 of file abstractintegration.cpp.

◆ contextHelpId()

QString QDesignerIntegration::contextHelpId ( ) const

overridevirtual

Implements QDesignerIntegrationInterface.

Definition at line 761 of file abstractintegration.cpp.

◆ createResourceBrowser()

QDesignerResourceBrowserInterface * QDesignerIntegration::createResourceBrowser ( QWidget * parent = nullptr )

overridevirtual

Creates a resource browser depending on IDE integration.

Note: Language integration takes precedence.

Implements QDesignerIntegrationInterface.

Definition at line 756 of file abstractintegration.cpp.

◆ features()

QDesignerIntegrationInterface::Feature QDesignerIntegration::features ( ) const

overridevirtual

Implements QDesignerIntegrationInterface.

Definition at line 674 of file abstractintegration.cpp.

Referenced by testing.tools.test_runner._PerProcessConfig::InitializeFeatures().

Here is the caller graph for this function:

◆ headerSuffix()

QString QDesignerIntegration::headerSuffix ( ) const

overridevirtual

Implements QDesignerIntegrationInterface.

Definition at line 654 of file abstractintegration.cpp.

◆ initializePlugins()

void QDesignerIntegration::initializePlugins ( QDesignerFormEditorInterface * formEditor )

static

Definition at line 746 of file abstractintegration.cpp.

◆ isHeaderLowercase()

bool QDesignerIntegration::isHeaderLowercase ( ) const

overridevirtual

Implements QDesignerIntegrationInterface.

Definition at line 664 of file abstractintegration.cpp.

◆ removeDynamicProperty()

void QDesignerIntegration::removeDynamicProperty ( const QString & name )

overridevirtual

Triggered by the property editor to remove a dynamic property.

If a different property editor is used, it should invoke this function.

Implements QDesignerIntegrationInterface.

Definition at line 718 of file abstractintegration.cpp.

◆ resetProperty()

void QDesignerIntegration::resetProperty ( const QString & name )

overridevirtual

Triggered by the property editor to reset a property value.

If a different property editor is used, it should invoke this function.

Implements QDesignerIntegrationInterface.

Definition at line 708 of file abstractintegration.cpp.

◆ resourceFileWatcherBehaviour()

QDesignerIntegrationInterface::ResourceFileWatcherBehaviour QDesignerIntegration::resourceFileWatcherBehaviour ( ) const

overridevirtual

Implements QDesignerIntegrationInterface.

Definition at line 684 of file abstractintegration.cpp.

◆ setFeatures()

void QDesignerIntegration::setFeatures ( Feature f )

overridevirtual

Implements QDesignerIntegrationInterface.

Definition at line 679 of file abstractintegration.cpp.

◆ setHeaderLowercase()

void QDesignerIntegration::setHeaderLowercase ( bool headerLowerCase )

overridevirtual

Implements QDesignerIntegrationInterface.

Definition at line 669 of file abstractintegration.cpp.

◆ setHeaderSuffix()

void QDesignerIntegration::setHeaderSuffix ( const QString & headerSuffix )

overridevirtual

Implements QDesignerIntegrationInterface.

Definition at line 659 of file abstractintegration.cpp.

◆ setResourceFileWatcherBehaviour()

void QDesignerIntegration::setResourceFileWatcherBehaviour ( ResourceFileWatcherBehaviour behaviour )

overridevirtual

Implements QDesignerIntegrationInterface.

Definition at line 689 of file abstractintegration.cpp.

◆ setupFormWindow()

void QDesignerIntegration::setupFormWindow ( QDesignerFormWindowInterface * formWindow )

overridevirtual

Sets up the new form window.

Implements QDesignerIntegrationInterface.

Definition at line 728 of file abstractintegration.cpp.

◆ updateActiveFormWindow()

void QDesignerIntegration::updateActiveFormWindow ( QDesignerFormWindowInterface * formWindow )

overridevirtual

Sets up the active form window.

Implements QDesignerIntegrationInterface.

Definition at line 723 of file abstractintegration.cpp.

◆ updateCustomWidgetPlugins()

void QDesignerIntegration::updateCustomWidgetPlugins ( )

overridevirtual

Triggers a reload of the custom widget plugins.

Implements QDesignerIntegrationInterface.

Definition at line 751 of file abstractintegration.cpp.

◆ updateProperty() [1/2]

void QDesignerIntegration::updateProperty	(	const QString &	name,
		const QVariant &	value )

overridevirtual

Triggered by the property editor to update a property value without subproperty handling.

If a different property editor is used, it should invoke this function.

Implements QDesignerIntegrationInterface.

Definition at line 703 of file abstractintegration.cpp.

◆ updateProperty() [2/2]

void QDesignerIntegration::updateProperty	(	const QString &	name,
		const QVariant &	value,
		bool	enableSubPropertyHandling )

overridevirtual

Triggered by the property editor to update a property value.

If a different property editor is used, it should invoke this function.

Implements QDesignerIntegrationInterface.

Definition at line 697 of file abstractintegration.cpp.

◆ updateSelection()

void QDesignerIntegration::updateSelection ( )

overridevirtual

Sets the selected widget of the form window in various components.

In IDE integrations, the method can be overwritten to move the selection handles of the form's main window, should it be selected.

Implements QDesignerIntegrationInterface.

Definition at line 735 of file abstractintegration.cpp.

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

qttools/src/designer/src/lib/sdk/abstractintegration.h (435029af318aa40b272e78461bffc5c992041753)
qttools/src/designer/src/lib/sdk/abstractintegration.cpp (435029af318aa40b272e78461bffc5c992041753)

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QDesignerIntegration()

◆ ~QDesignerIntegration()

Member Function Documentation

◆ addDynamicProperty()

◆ containerWindow()

◆ contextHelpId()

◆ createResourceBrowser()

◆ features()

◆ headerSuffix()

◆ initializePlugins()

◆ isHeaderLowercase()

◆ removeDynamicProperty()

◆ resetProperty()

◆ resourceFileWatcherBehaviour()

◆ setFeatures()

◆ setHeaderLowercase()

◆ setHeaderSuffix()

◆ setResourceFileWatcherBehaviour()

◆ setupFormWindow()

◆ updateActiveFormWindow()

◆ updateCustomWidgetPlugins()

◆ updateProperty() [1/2]

◆ updateProperty() [2/2]

◆ updateSelection()