Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
QDesignerIntegrationInterface Class Referenceabstract

The QDesignerIntegrationInterface glues together parts of \QD and allows for overwriting functionality for IDE integration. More...

#include <abstractintegration.h>

+ Inheritance diagram for QDesignerIntegrationInterface:
+ Collaboration diagram for QDesignerIntegrationInterface:

Public Types

enum  ResourceFileWatcherBehaviour { NoResourceFileWatcher , ReloadResourceFileSilently , PromptToReloadResourceFile }
 
enum  FeatureFlag { ResourceEditorFeature = 0x1 , SlotNavigationFeature = 0x2 , DefaultWidgetActionFeature = 0x4 , DefaultFeature = ResourceEditorFeature | DefaultWidgetActionFeature }
 

Public Slots

virtual void setFeatures (Feature f)=0
 
virtual void updateProperty (const QString &name, const QVariant &value, bool enableSubPropertyHandling)=0
 Triggered by the property editor to update a property value.
 
virtual void updateProperty (const QString &name, const QVariant &value)=0
 Triggered by the property editor to update a property value without subproperty handling.
 
virtual void resetProperty (const QString &name)=0
 Triggered by the property editor to reset a property value.
 
virtual void addDynamicProperty (const QString &name, const QVariant &value)=0
 Triggered by the property editor to add a dynamic property value.
 
virtual void removeDynamicProperty (const QString &name)=0
 Triggered by the property editor to remove a dynamic property.
 
virtual void updateActiveFormWindow (QDesignerFormWindowInterface *formWindow)=0
 Sets up the active form window.
 
virtual void setupFormWindow (QDesignerFormWindowInterface *formWindow)=0
 Sets up the new form window.
 
virtual void updateSelection ()=0
 Sets the selected widget of the form window in various components.
 
virtual void updateCustomWidgetPlugins ()=0
 Triggers a reload of the custom widget plugins.
 
- Public Slots inherited from QObject
void deleteLater ()
 \threadsafe
 

Signals

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.
 

Public Member Functions

 QDesignerIntegrationInterface (QDesignerFormEditorInterface *core, QObject *parent=nullptr)
 
virtual ~QDesignerIntegrationInterface ()
 
QDesignerFormEditorInterfacecore () const
 
virtual QWidgetcontainerWindow (QWidget *widget) const =0
 Returns the outer window containing a form for applying main container geometries.
 
virtual QDesignerResourceBrowserInterfacecreateResourceBrowser (QWidget *parent=nullptr)=0
 Creates a resource browser depending on IDE integration.
 
virtual QString headerSuffix () const =0
 
virtual void setHeaderSuffix (const QString &headerSuffix)=0
 
virtual bool isHeaderLowercase () const =0
 
virtual void setHeaderLowercase (bool headerLowerCase)=0
 
QVersionNumber qtVersion () const
 
void setQtVersion (const QVersionNumber &qtVersion)
 
virtual Feature features () const =0
 
bool hasFeature (Feature f) const
 
virtual ResourceFileWatcherBehaviour resourceFileWatcherBehaviour () const =0
 
virtual void setResourceFileWatcherBehaviour (ResourceFileWatcherBehaviour behaviour)=0
 
virtual QString contextHelpId () const =0
 
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< QStringbindableObjectName ()
 
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).
 
QThreadthread () 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 >
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 >
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 QObjectListchildren () 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< QByteArraydynamicPropertyNames () const
 
QBindingStoragebindingStorage ()
 
const QBindingStoragebindingStorage () const
 
QObjectparent () 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.
 

Properties

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
 

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
QObjectsender () 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< QObjectDatad_ptr
 

Detailed Description

The QDesignerIntegrationInterface glues together parts of \QD and allows for overwriting functionality for IDE integration.

\inmodule QtDesigner

See also
QDesignerFormEditorInterface

Definition at line 28 of file abstractintegration.h.

Member Enumeration Documentation

◆ FeatureFlag

This enum describes the features that are available and can be controlled by the integration.

\value ResourceEditorFeature The resource editor is enabled. \value SlotNavigationFeature Provide context menu entry offering 'Go to slot'. \value DefaultWidgetActionFeature Trigger the preferred action of QDesignerTaskMenuExtension when widget is activated. \value DefaultFeature Default for \QD

See also
hasFeature(), features()
Enumerator
ResourceEditorFeature 
SlotNavigationFeature 
DefaultWidgetActionFeature 
DefaultFeature 

Definition at line 44 of file abstractintegration.h.

◆ ResourceFileWatcherBehaviour

This enum describes if and how resource files are watched.

\value NoResourceFileWatcher Do not watch for changes \value ReloadResourceFileSilently Reload files silently. \value PromptToReloadResourceFile Prompt the user to reload.

Enumerator
NoResourceFileWatcher 
ReloadResourceFileSilently 
PromptToReloadResourceFile 

Definition at line 36 of file abstractintegration.h.

Constructor & Destructor Documentation

◆ QDesignerIntegrationInterface()

QDesignerIntegrationInterface::QDesignerIntegrationInterface ( QDesignerFormEditorInterface * core,
QObject * parent = nullptr )
explicit

Definition at line 218 of file abstractintegration.cpp.

◆ ~QDesignerIntegrationInterface()

QDesignerIntegrationInterface::~QDesignerIntegrationInterface ( )
virtualdefault

Member Function Documentation

◆ addDynamicProperty

virtual void QDesignerIntegrationInterface::addDynamicProperty ( const QString & name,
const QVariant & value )
pure virtualslot

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

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

Implemented in QDesignerIntegration.

◆ containerWindow()

virtual QWidget * QDesignerIntegrationInterface::containerWindow ( QWidget * widget) const
pure virtual

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

Should be implemented by IDE integrations.

Implemented in QDesignerIntegration.

◆ contextHelpId()

virtual QString QDesignerIntegrationInterface::contextHelpId ( ) const
pure virtual

Implemented in QDesignerIntegration.

◆ core()

QDesignerFormEditorInterface * QDesignerIntegrationInterface::core ( ) const

Definition at line 226 of file abstractintegration.cpp.

◆ createResourceBrowser()

virtual QDesignerResourceBrowserInterface * QDesignerIntegrationInterface::createResourceBrowser ( QWidget * parent = nullptr)
pure virtual

Creates a resource browser depending on IDE integration.

Note
Language integration takes precedence.

Implemented in QDesignerIntegration.

◆ emitHelpRequested()

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

Definition at line 263 of file abstractintegration.cpp.

◆ emitNavigateToSlot() [1/2]

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

Definition at line 251 of file abstractintegration.cpp.

◆ emitNavigateToSlot() [2/2]

void QDesignerIntegrationInterface::emitNavigateToSlot ( const QString & slotSignature)

Definition at line 258 of file abstractintegration.cpp.

◆ emitObjectNameChanged()

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

Definition at line 246 of file abstractintegration.cpp.

◆ features()

virtual Feature QDesignerIntegrationInterface::features ( ) const
pure virtual

Implemented in QDesignerIntegration.

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

+ Here is the caller graph for this function:

◆ hasFeature()

bool QDesignerIntegrationInterface::hasFeature ( Feature f) const

Definition at line 231 of file abstractintegration.cpp.

◆ headerSuffix()

virtual QString QDesignerIntegrationInterface::headerSuffix ( ) const
pure virtual

Implemented in QDesignerIntegration.

◆ helpRequested

void QDesignerIntegrationInterface::helpRequested ( const QString & manual,
const QString & document )
signal

◆ isHeaderLowercase()

virtual bool QDesignerIntegrationInterface::isHeaderLowercase ( ) const
pure virtual

Implemented in QDesignerIntegration.

◆ navigateToSlot [1/2]

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

◆ navigateToSlot [2/2]

void QDesignerIntegrationInterface::navigateToSlot ( const QString & slotSignature)
signal

◆ objectNameChanged

void QDesignerIntegrationInterface::objectNameChanged ( QDesignerFormWindowInterface * formWindow,
QObject * object,
const QString & newName,
const QString & oldName )
signal

◆ propertyChanged

void QDesignerIntegrationInterface::propertyChanged ( QDesignerFormWindowInterface * formWindow,
const QString & name,
const QVariant & value )
signal

◆ qtVersion()

QVersionNumber QDesignerIntegrationInterface::qtVersion ( ) const

Definition at line 236 of file abstractintegration.cpp.

◆ removeDynamicProperty

virtual void QDesignerIntegrationInterface::removeDynamicProperty ( const QString & name)
pure virtualslot

Triggered by the property editor to remove a dynamic property.

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

Implemented in QDesignerIntegration.

◆ resetProperty

virtual void QDesignerIntegrationInterface::resetProperty ( const QString & name)
pure virtualslot

Triggered by the property editor to reset a property value.

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

Implemented in QDesignerIntegration.

◆ resourceFileWatcherBehaviour()

virtual ResourceFileWatcherBehaviour QDesignerIntegrationInterface::resourceFileWatcherBehaviour ( ) const
pure virtual

Implemented in QDesignerIntegration.

◆ setFeatures

virtual void QDesignerIntegrationInterface::setFeatures ( Feature f)
pure virtualslot

Implemented in QDesignerIntegration.

◆ setHeaderLowercase()

virtual void QDesignerIntegrationInterface::setHeaderLowercase ( bool headerLowerCase)
pure virtual

Implemented in QDesignerIntegration.

◆ setHeaderSuffix()

virtual void QDesignerIntegrationInterface::setHeaderSuffix ( const QString & headerSuffix)
pure virtual

Implemented in QDesignerIntegration.

◆ setQtVersion()

void QDesignerIntegrationInterface::setQtVersion ( const QVersionNumber & qtVersion)

Definition at line 241 of file abstractintegration.cpp.

◆ setResourceFileWatcherBehaviour()

virtual void QDesignerIntegrationInterface::setResourceFileWatcherBehaviour ( ResourceFileWatcherBehaviour behaviour)
pure virtual

Implemented in QDesignerIntegration.

◆ setupFormWindow

virtual void QDesignerIntegrationInterface::setupFormWindow ( QDesignerFormWindowInterface * formWindow)
pure virtualslot

Sets up the new form window.

Implemented in QDesignerIntegration.

◆ updateActiveFormWindow

virtual void QDesignerIntegrationInterface::updateActiveFormWindow ( QDesignerFormWindowInterface * formWindow)
pure virtualslot

Sets up the active form window.

Implemented in QDesignerIntegration.

◆ updateCustomWidgetPlugins

virtual void QDesignerIntegrationInterface::updateCustomWidgetPlugins ( )
pure virtualslot

Triggers a reload of the custom widget plugins.

Implemented in QDesignerIntegration.

◆ updateProperty [1/2]

virtual void QDesignerIntegrationInterface::updateProperty ( const QString & name,
const QVariant & value )
pure virtualslot

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.

Implemented in QDesignerIntegration.

◆ updateProperty [2/2]

virtual void QDesignerIntegrationInterface::updateProperty ( const QString & name,
const QVariant & value,
bool enableSubPropertyHandling )
pure virtualslot

Triggered by the property editor to update a property value.

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

Implemented in QDesignerIntegration.

◆ updateSelection

virtual void QDesignerIntegrationInterface::updateSelection ( )
pure virtualslot

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.

Implemented in QDesignerIntegration.

Property Documentation

◆ headerLowercase

bool QDesignerIntegrationInterface::headerLowercase
readwrite

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

Definition at line 32 of file abstractintegration.h.

◆ headerSuffix

QString QDesignerIntegrationInterface::headerSuffix
readwrite

Returns the suffix of the header of promoted widgets.

Definition at line 31 of file abstractintegration.h.

◆ qtVersion

QVersionNumber QDesignerIntegrationInterface::qtVersion
readwrite

Determines the Qt version used when writing out forms.

Since
6.9

Definition at line 33 of file abstractintegration.h.


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