Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
|
The QtStringPropertyManager provides and manages QString properties. More...
#include <qtpropertymanager_p.h>
Public Slots | |
void | setValue (QtProperty *property, const QString &val) |
Sets the value of the given property to value. | |
void | setRegExp (QtProperty *property, const QRegularExpression ®Exp) |
Sets the regular expression of the given property to regExp. | |
Public Slots inherited from QObject | |
void | deleteLater () |
\threadsafe | |
Signals | |
void | valueChanged (QtProperty *property, const QString &val) |
This signal is emitted whenever a property created by this manager changes its value, passing a pointer to the property and the new value as parameters. | |
void | regExpChanged (QtProperty *property, const QRegularExpression ®Exp) |
This signal is emitted whenever a property created by this manager changes its currenlty set regular expression, passing a pointer to the property and the new regExp as parameters. | |
Signals inherited from QtAbstractPropertyManager | |
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 | |
QtStringPropertyManager (QObject *parent=0) | |
Creates a manager with the given parent. | |
~QtStringPropertyManager () | |
Destroys this manager, and all the properties it has created. | |
QString | value (const QtProperty *property) const |
Returns the given property's value. | |
QRegularExpression | regExp (const QtProperty *property) const |
Returns the given property's currently set regular expression. | |
Public Member Functions inherited from QtAbstractPropertyManager | |
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 | |
QString | valueText (const QtProperty *property) const override |
\reimp | |
void | initializeProperty (QtProperty *property) override |
\reimp | |
void | uninitializeProperty (QtProperty *property) override |
\reimp | |
Protected Member Functions inherited from QtAbstractPropertyManager | |
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 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) | |
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 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 QtStringPropertyManager provides and manages QString properties.
\inmodule QtDesigner
A string property's value can be retrieved using the value() function, and set using the setValue() slot.
The current value can be checked against a regular expression. To set the regular expression use the setRegExp() slot, use the regExp() function to retrieve the currently set expression.
In addition, QtStringPropertyManager provides the valueChanged() signal which is emitted whenever a property created by this manager changes, and the regExpChanged() signal which is emitted whenever such a property changes its currently set regular expression.
Definition at line 141 of file qtpropertymanager_p.h.
QtStringPropertyManager::QtStringPropertyManager | ( | QObject * | parent = 0 | ) |
Creates a manager with the given parent.
Definition at line 1230 of file qtpropertymanager.cpp.
QtStringPropertyManager::~QtStringPropertyManager | ( | ) |
Destroys this manager, and all the properties it has created.
Definition at line 1239 of file qtpropertymanager.cpp.
References QtAbstractPropertyManager::clear().
|
overrideprotectedvirtual |
QRegularExpression QtStringPropertyManager::regExp | ( | const QtProperty * | property | ) | const |
Returns the given property's currently set regular expression.
If the given property is not managed by this manager, this function returns an empty expression.
Definition at line 1265 of file qtpropertymanager.cpp.
|
signal |
This signal is emitted whenever a property created by this manager changes its currenlty set regular expression, passing a pointer to the property and the new regExp as parameters.
Referenced by QtVariantPropertyManager::QtVariantPropertyManager(), QtLineEditFactory::connectPropertyManager(), and QtLineEditFactory::disconnectPropertyManager().
|
slot |
Sets the regular expression of the given property to regExp.
Definition at line 1320 of file qtpropertymanager.cpp.
|
slot |
Sets the value of the given property to value.
If the specified value doesn't match the given property's regular expression, this function does nothing.
Definition at line 1291 of file qtpropertymanager.cpp.
|
overrideprotectedvirtual |
\reimp
Reimplemented from QtAbstractPropertyManager.
Definition at line 1349 of file qtpropertymanager.cpp.
QString QtStringPropertyManager::value | ( | const QtProperty * | property | ) | const |
Returns the given property's value.
If the given property is not managed by this manager, this function returns an empty string.
Definition at line 1252 of file qtpropertymanager.cpp.
|
signal |
This signal is emitted whenever a property created by this manager changes its value, passing a pointer to the property and the new value as parameters.
|
overrideprotectedvirtual |
\reimp
Reimplemented from QtAbstractPropertyManager.
Definition at line 1273 of file qtpropertymanager.cpp.