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
Signals | Public Member Functions | Protected Member Functions | Friends | List of all members
QtAbstractPropertyManager Class Referenceabstract

The QtAbstractPropertyManager provides an interface for property managers. More...

#include <qtpropertybrowser_p.h>

+ Inheritance diagram for QtAbstractPropertyManager:
+ Collaboration diagram for QtAbstractPropertyManager:

Signals

void propertyInserted (QtProperty *property, QtProperty *parent, QtProperty *after)
 This signal is emitted when a new subproperty is inserted into an existing property, passing pointers to the newProperty, parentProperty and precedingProperty as parameters.
 
void propertyChanged (QtProperty *property)
 This signal is emitted whenever a property's data changes, passing a pointer to the property as parameter.
 
void propertyRemoved (QtProperty *property, QtProperty *parent)
 This signal is emitted when a subproperty is removed, passing pointers to the removed property and the parent property as parameters.
 
void propertyDestroyed (QtProperty *property)
 This signal is emitted when the specified property is about to be destroyed.
 
- 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

 QtAbstractPropertyManager (QObject *parent=0)
 Creates an abstract property manager with the given parent.
 
 ~QtAbstractPropertyManager ()
 Destroys the manager.
 
QSet< QtProperty * > properties () const
 Returns the set of properties created by this manager.
 
void clear () const
 Destroys all the properties that this manager has created.
 
QtProperty * addProperty (const QString &name=QString())
 Creates a property with the given name which then is owned by this manager.
 
- 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.
 

Protected Member Functions

virtual bool hasValue (const QtProperty *property) const
 Returns whether the given property has a value.
 
virtual QIcon valueIcon (const QtProperty *property) const
 Returns an icon representing the current state of the given property.
 
virtual QString valueText (const QtProperty *property) const
 Returns a string representing the current state of the given property.
 
virtual void initializeProperty (QtProperty *property)=0
 This function is called whenever a new valid property pointer has been created, passing the pointer as parameter.
 
virtual void uninitializeProperty (QtProperty *property)
 This function is called just before the specified property is destroyed.
 
virtual QtProperty * createProperty ()
 Creates a property.
 
- 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)
 

Friends

class QtProperty
 

Additional Inherited Members

- Public Slots inherited from QObject
void deleteLater ()
 \threadsafe
 
- 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 Attributes inherited from QObject
QScopedPointer< QObjectData > d_ptr
 
- Properties inherited from QObject
QString objectName
 the name of this object
 
- Related Symbols inherited from QObject
 Returns the given object cast to type T if the object is of type T (or of a subclass); otherwise returns \nullptr.
 
 
 
 \macro Q_CLASSINFO(Name, Value)
 

Detailed Description

The QtAbstractPropertyManager provides an interface for property managers.

\inmodule QtDesigner

Since
4.4

A manager can create and manage properties of a given type, and is used in conjunction with the QtAbstractPropertyBrowser class.

When using a property browser widget, the properties are created and managed by implementations of the QtAbstractPropertyManager class. To ensure that the properties' values will be displayed using suitable editing widgets, the managers are associated with objects of QtAbstractEditorFactory subclasses. The property browser will use these associations to determine which factories it should use to create the preferred editing widgets.

The QtAbstractPropertyManager class provides common functionality like creating a property using the addProperty() function, and retrieving the properties created by the manager using the properties() function. The class also provides signals that are emitted when the manager's properties change: propertyInserted(), propertyRemoved(), propertyChanged() and propertyDestroyed().

QtAbstractPropertyManager subclasses are supposed to provide their own type specific API. Note that several ready-made implementations are available:

\list

See also
QtAbstractEditorFactoryBase, QtAbstractPropertyBrowser, QtProperty

Definition at line 70 of file qtpropertybrowser_p.h.

Constructor & Destructor Documentation

◆ QtAbstractPropertyManager()

QtAbstractPropertyManager::QtAbstractPropertyManager ( QObject * parent = 0)
explicit

Creates an abstract property manager with the given parent.

Definition at line 633 of file qtpropertybrowser.cpp.

◆ ~QtAbstractPropertyManager()

QtAbstractPropertyManager::~QtAbstractPropertyManager ( )

Destroys the manager.

All properties created by the manager are destroyed.

Definition at line 644 of file qtpropertybrowser.cpp.

References clear().

+ Here is the call graph for this function:

Member Function Documentation

◆ addProperty()

QtProperty * QtAbstractPropertyManager::addProperty ( const QString & name = QString())

Creates a property with the given name which then is owned by this manager.

Internally, this function calls the createProperty() and initializeProperty() functions.

See also
initializeProperty(), properties()

Definition at line 721 of file qtpropertybrowser.cpp.

References createProperty(), and initializeProperty().

+ Here is the call graph for this function:

◆ clear()

void QtAbstractPropertyManager::clear ( ) const

Destroys all the properties that this manager has created.

See also
propertyDestroyed(), uninitializeProperty()

Definition at line 654 of file qtpropertybrowser.cpp.

Referenced by ~QtAbstractPropertyManager(), QtBoolPropertyManager::~QtBoolPropertyManager(), QtCharPropertyManager::~QtCharPropertyManager(), QtColorPropertyManager::~QtColorPropertyManager(), QtCursorPropertyManager::~QtCursorPropertyManager(), QtDatePropertyManager::~QtDatePropertyManager(), QtDateTimePropertyManager::~QtDateTimePropertyManager(), QtDoublePropertyManager::~QtDoublePropertyManager(), QtEnumPropertyManager::~QtEnumPropertyManager(), QtFlagPropertyManager::~QtFlagPropertyManager(), QtFontPropertyManager::~QtFontPropertyManager(), QtIntPropertyManager::~QtIntPropertyManager(), QtKeySequencePropertyManager::~QtKeySequencePropertyManager(), QtLocalePropertyManager::~QtLocalePropertyManager(), QtPointFPropertyManager::~QtPointFPropertyManager(), QtPointPropertyManager::~QtPointPropertyManager(), QtRectFPropertyManager::~QtRectFPropertyManager(), QtRectPropertyManager::~QtRectPropertyManager(), QtSizeFPropertyManager::~QtSizeFPropertyManager(), QtSizePolicyPropertyManager::~QtSizePolicyPropertyManager(), QtSizePropertyManager::~QtSizePropertyManager(), QtStringPropertyManager::~QtStringPropertyManager(), QtTimePropertyManager::~QtTimePropertyManager(), and QtVariantPropertyManager::~QtVariantPropertyManager().

+ Here is the caller graph for this function:

◆ createProperty()

QtProperty * QtAbstractPropertyManager::createProperty ( )
protectedvirtual

Creates a property.

The base implementation produce QtProperty instances; Reimplement this function to make this manager produce objects of a QtProperty subclass.

See also
addProperty(), initializeProperty()

Reimplemented in QtVariantPropertyManager.

Definition at line 741 of file qtpropertybrowser.cpp.

References QtProperty::QtProperty().

Referenced by addProperty().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ hasValue()

bool QtAbstractPropertyManager::hasValue ( const QtProperty * property) const
protectedvirtual

Returns whether the given property has a value.

The default implementation of this function returns true.

See also
QtProperty::hasValue()

Reimplemented in QtGroupPropertyManager, and QtVariantPropertyManager.

Definition at line 677 of file qtpropertybrowser.cpp.

◆ initializeProperty()

virtual void QtAbstractPropertyManager::initializeProperty ( QtProperty * property)
protectedpure virtual

This function is called whenever a new valid property pointer has been created, passing the pointer as parameter.

The purpose is to let the manager know that the property has been created so that it can provide additional attributes for the new property, e.g. QtIntPropertyManager adds \l {QtIntPropertyManager::value()}{value}, \l {QtIntPropertyManager::minimum()}{minimum} and \l {QtIntPropertyManager::maximum()}{maximum} attributes. Since each manager subclass adds type specific attributes, this function is pure virtual and must be reimplemented when deriving from the QtAbstractPropertyManager class.

See also
addProperty(), createProperty()

Implemented in qdesigner_internal::DesignerPropertyManager, QtBoolPropertyManager, QtCharPropertyManager, QtColorPropertyManager, QtCursorPropertyManager, QtDatePropertyManager, QtDateTimePropertyManager, QtDoublePropertyManager, QtEnumPropertyManager, QtFlagPropertyManager, QtFontPropertyManager, QtGroupPropertyManager, QtIntPropertyManager, QtKeySequencePropertyManager, QtLocalePropertyManager, QtPointFPropertyManager, QtPointPropertyManager, QtRectFPropertyManager, QtRectPropertyManager, QtSizeFPropertyManager, QtSizePolicyPropertyManager, QtSizePropertyManager, QtStringPropertyManager, QtTimePropertyManager, and QtVariantPropertyManager.

Referenced by addProperty().

+ Here is the caller graph for this function:

◆ properties()

QSet< QtProperty * > QtAbstractPropertyManager::properties ( ) const

Returns the set of properties created by this manager.

See also
addProperty()

Definition at line 665 of file qtpropertybrowser.cpp.

◆ propertyChanged

void QtAbstractPropertyManager::propertyChanged ( QtProperty * property)
signal

This signal is emitted whenever a property's data changes, passing a pointer to the property as parameter.

Note that signal is only emitted for properties that are created by this manager.

See also
QtAbstractPropertyBrowser::itemChanged()

◆ propertyDestroyed

void QtAbstractPropertyManager::propertyDestroyed ( QtProperty * property)
signal

This signal is emitted when the specified property is about to be destroyed.

Note that signal is only emitted for properties that are created by this manager.

See also
clear(), uninitializeProperty()

◆ propertyInserted

void QtAbstractPropertyManager::propertyInserted ( QtProperty * newProperty,
QtProperty * parentProperty,
QtProperty * precedingProperty )
signal

This signal is emitted when a new subproperty is inserted into an existing property, passing pointers to the newProperty, parentProperty and precedingProperty as parameters.

If precedingProperty is 0, the newProperty was inserted at the beginning of the parentProperty's subproperties list.

Note that signal is emitted only if the parentProperty is created by this manager.

See also
QtAbstractPropertyBrowser::itemInserted()

◆ propertyRemoved

void QtAbstractPropertyManager::propertyRemoved ( QtProperty * property,
QtProperty * parent )
signal

This signal is emitted when a subproperty is removed, passing pointers to the removed property and the parent property as parameters.

Note that signal is emitted only when the parent property is created by this manager.

See also
QtAbstractPropertyBrowser::itemRemoved()

Referenced by QtVariantPropertyManager::QtVariantPropertyManager().

+ Here is the caller graph for this function:

◆ uninitializeProperty()

void QtAbstractPropertyManager::uninitializeProperty ( QtProperty * property)
protectedvirtual

This function is called just before the specified property is destroyed.

The purpose is to let the property manager know that the property is being destroyed so that it can remove the property's additional attributes.

See also
clear(), propertyDestroyed()

Reimplemented in qdesigner_internal::DesignerPropertyManager, QtBoolPropertyManager, QtCharPropertyManager, QtColorPropertyManager, QtCursorPropertyManager, QtDatePropertyManager, QtDateTimePropertyManager, QtDoublePropertyManager, QtEnumPropertyManager, QtFlagPropertyManager, QtFontPropertyManager, QtGroupPropertyManager, QtIntPropertyManager, QtKeySequencePropertyManager, QtLocalePropertyManager, QtPointFPropertyManager, QtPointPropertyManager, QtRectFPropertyManager, QtRectPropertyManager, QtSizeFPropertyManager, QtSizePolicyPropertyManager, QtSizePropertyManager, QtStringPropertyManager, QtTimePropertyManager, and QtVariantPropertyManager.

Definition at line 774 of file qtpropertybrowser.cpp.

◆ valueIcon()

QIcon QtAbstractPropertyManager::valueIcon ( const QtProperty * property) const
protectedvirtual

Returns an icon representing the current state of the given property.

The default implementation of this function returns an invalid icon.

See also
QtProperty::valueIcon()

Reimplemented in qdesigner_internal::DesignerPropertyManager, QtBoolPropertyManager, QtColorPropertyManager, QtCursorPropertyManager, QtEnumPropertyManager, QtFontPropertyManager, and QtVariantPropertyManager.

Definition at line 692 of file qtpropertybrowser.cpp.

◆ valueText()

QString QtAbstractPropertyManager::valueText ( const QtProperty * property) const
protectedvirtual

Returns a string representing the current state of the given property.

The default implementation of this function returns an empty string.

See also
QtProperty::valueText()

Reimplemented in qdesigner_internal::DesignerPropertyManager, QtBoolPropertyManager, QtCharPropertyManager, QtColorPropertyManager, QtCursorPropertyManager, QtDatePropertyManager, QtDateTimePropertyManager, QtDoublePropertyManager, QtEnumPropertyManager, QtFlagPropertyManager, QtFontPropertyManager, QtIntPropertyManager, QtKeySequencePropertyManager, QtLocalePropertyManager, QtPointFPropertyManager, QtPointPropertyManager, QtRectFPropertyManager, QtRectPropertyManager, QtSizeFPropertyManager, QtSizePolicyPropertyManager, QtSizePropertyManager, QtStringPropertyManager, QtTimePropertyManager, and QtVariantPropertyManager.

Definition at line 707 of file qtpropertybrowser.cpp.

Friends And Related Symbol Documentation

◆ QtProperty

friend class QtProperty
friend

Definition at line 95 of file qtpropertybrowser_p.h.

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