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
QWinRegistryKey Class Reference

#include <qwinregistry_p.h>

Inheritance diagram for QWinRegistryKey:
Collaboration diagram for QWinRegistryKey:

Signals

void valueChanged ()
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

 QWinRegistryKey (QObject *parent=nullptr)
 QWinRegistryKey (HKEY parentHandle, const wchar_t *subKey, REGSAM permissions=KEY_READ, REGSAM access=0, QObject *parent=nullptr)
 QWinRegistryKey (HKEY parentHandle, const QString &subKey, REGSAM permissions=KEY_READ, REGSAM access=0, QObject *parent=nullptr)
 ~QWinRegistryKey ()
 QWinRegistryKey (QWinRegistryKey &&other) noexcept
void swap (QWinRegistryKey &other) noexcept
bool isValid () const
HKEY handle () const
 operator HKEY () const
void close ()
QString name () const
QVariant value (const wchar_t *subKey) const
QVariant value (const QString &subKey) const
template<typename T>
std::optional< T > value (const wchar_t *subKey) const
template<typename T>
std::optional< T > value (const QString &subKey) const
QString stringValue (const wchar_t *subKey) const
QString stringValue (const QString &subKey) 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< 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 isQmlObjectType () const
 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).
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.

Protected Member Functions

void connectNotify (const QMetaMethod &signal) override
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 disconnectNotify (const QMetaMethod &signal)
 QObject (QObjectPrivate &dd, QObject *parent=nullptr)

Friends

Q_CORE_EXPORT QDebug operator<< (QDebug dbg, const QWinRegistryKey &key)

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< QObjectDatad_ptr
Properties inherited from QObject
QString objectName
 the name of this object

Detailed Description

Definition at line 28 of file qwinregistry_p.h.

Constructor & Destructor Documentation

◆ QWinRegistryKey() [1/4]

QWinRegistryKey::QWinRegistryKey ( QObject * parent = nullptr)

Definition at line 31 of file qwinregistry.cpp.

◆ QWinRegistryKey() [2/4]

QWinRegistryKey::QWinRegistryKey ( HKEY parentHandle,
const wchar_t * subKey,
REGSAM permissions = KEY_READ,
REGSAM access = 0,
QObject * parent = nullptr )
explicit

Definition at line 38 of file qwinregistry.cpp.

◆ QWinRegistryKey() [3/4]

QWinRegistryKey::QWinRegistryKey ( HKEY parentHandle,
const QString & subKey,
REGSAM permissions = KEY_READ,
REGSAM access = 0,
QObject * parent = nullptr )
explicit

Definition at line 49 of file qwinregistry.cpp.

◆ ~QWinRegistryKey()

QWinRegistryKey::~QWinRegistryKey ( )

Definition at line 55 of file qwinregistry.cpp.

◆ QWinRegistryKey() [4/4]

QWinRegistryKey::QWinRegistryKey ( QWinRegistryKey && other)
inlinenoexcept

Definition at line 43 of file qwinregistry_p.h.

Member Function Documentation

◆ close()

void QWinRegistryKey::close ( )

Definition at line 60 of file qwinregistry.cpp.

◆ connectNotify()

void QWinRegistryKey::connectNotify ( const QMetaMethod & signal)
overrideprotectedvirtual
Since
5.0

This virtual function is called when something has been connected to signal in this object.

If you want to compare signal with a specific signal, you can use QMetaMethod::fromSignal() as follows:

// signal is valueChanged
}
Warning
This function violates the object-oriented principle of modularity. However, it might be useful when you need to perform an expensive operation only if something is connected to a signal.
This function is called from the thread which performs the connection, which may be a different thread from the thread in which this object lives. This function may also be called with a QObject internal mutex locked. It is therefore not allowed to re-enter any QObject functions, including isSignalConnected(), from your reimplementation. If you lock a mutex in your reimplementation, make sure that you don't call QObject functions with that mutex held in other places or it will result in a deadlock.
See also
connect(), disconnectNotify()

Reimplemented from QObject.

Definition at line 201 of file qwinregistry.cpp.

◆ handle()

HKEY QWinRegistryKey::handle ( ) const
inlinenodiscard

Definition at line 53 of file qwinregistry_p.h.

◆ isValid()

bool QWinRegistryKey::isValid ( ) const
inlinenodiscard

Definition at line 51 of file qwinregistry_p.h.

◆ name()

QString QWinRegistryKey::name ( ) const

Definition at line 68 of file qwinregistry.cpp.

◆ operator HKEY()

QWinRegistryKey::operator HKEY ( ) const
inline

Definition at line 55 of file qwinregistry_p.h.

◆ stringValue() [1/2]

QString QWinRegistryKey::stringValue ( const QString & subKey) const

Definition at line 196 of file qwinregistry.cpp.

◆ stringValue() [2/2]

QString QWinRegistryKey::stringValue ( const wchar_t * subKey) const

Definition at line 191 of file qwinregistry.cpp.

◆ swap()

void QWinRegistryKey::swap ( QWinRegistryKey & other)
inlinenoexcept

Definition at line 46 of file qwinregistry_p.h.

◆ value() [1/4]

QVariant QWinRegistryKey::value ( const QString & subKey) const
nodiscard

Definition at line 182 of file qwinregistry.cpp.

◆ value() [2/4]

template<typename T>
std::optional< T > QWinRegistryKey::value ( const QString & subKey) const
inlinenodiscard

Definition at line 71 of file qwinregistry_p.h.

◆ value() [3/4]

QVariant QWinRegistryKey::value ( const wchar_t * subKey) const
nodiscard

Definition at line 101 of file qwinregistry.cpp.

◆ value() [4/4]

template<typename T>
std::optional< T > QWinRegistryKey::value ( const wchar_t * subKey) const
inlinenodiscard

Definition at line 65 of file qwinregistry_p.h.

◆ valueChanged

void QWinRegistryKey::valueChanged ( )
signal

◆ operator<<

Q_CORE_EXPORT QDebug operator<< ( QDebug dbg,
const QWinRegistryKey & key )
friend

Definition at line 241 of file qwinregistry.cpp.


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