Qt
Internal/Contributor docs for the Qt SDK. <b>Note:</b> These are NOT official API docs; those are found <a href='https://doc.qt.io/'>here</a>.
Loading...
Searching...
No Matches
QDeclarativePluginParameter Class Reference

#include <qdeclarativepluginparameter_p.h>

+ Inheritance diagram for QDeclarativePluginParameter:
+ Collaboration diagram for QDeclarativePluginParameter:

Signals

void nameChanged (const QString &name)
 
void valueChanged (const QVariant &value)
 
void initialized ()
 
- 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

 QDeclarativePluginParameter (QObject *parent=0)
 \qmltype PluginParameter \inqmlmodule QtPositioning
 
 ~QDeclarativePluginParameter ()
 
void setName (const QString &name)
 
QString name () const
 
void setValue (const QVariant &value)
 
QVariant value () const
 
bool isInitialized () 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 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 name
 
QVariant value
 
- Properties inherited from QObject
QString objectName
 the name of this object
 

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 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

Definition at line 27 of file qdeclarativepluginparameter_p.h.

Constructor & Destructor Documentation

◆ QDeclarativePluginParameter()

QT_BEGIN_NAMESPACE QDeclarativePluginParameter::QDeclarativePluginParameter ( QObject * parent = 0)
explicit

\qmltype PluginParameter \inqmlmodule QtPositioning

Since
QtPositioning 5.14

The PluginParameter type describes a parameter for a \omit plugin, either geoservice \l Plugin, or \endomit position plugin.

The PluginParameter object is used to provide a parameter of some kind to a plugin. Typically, these parameters contain details like an application token for access to a service, or a proxy server to use for network access, or the serial port to which a serial GPS receiver is connected.

To set such a parameter, declare a PluginParameter inside an element that accepts plugin parameters as configuration objects, such as a \omit \l Plugin object, or a \endomit \l PositionSource object, and set values for its \l{name} and \l{value} properties. A list of valid parameter names for each plugin is available from the \omit \l {Qt Location::Plugin References and Parameters}{plugin reference pages} for geoservice plugins, and \endomit \l {Qt Positioning plugins::Default plugins}{default plugins page} for position plugins.

Definition at line 68 of file qdeclarativepluginparameter.cpp.

◆ ~QDeclarativePluginParameter()

QDeclarativePluginParameter::~QDeclarativePluginParameter ( )

Definition at line 71 of file qdeclarativepluginparameter.cpp.

Member Function Documentation

◆ initialized

void QDeclarativePluginParameter::initialized ( )
signal

Referenced by QDeclarativeGeoServiceProvider::componentComplete(), QDeclarativePositionSource::componentComplete(), QDeclarativeSatelliteSource::componentComplete(), setName(), and setValue().

+ Here is the caller graph for this function:

◆ isInitialized()

bool QDeclarativePluginParameter::isInitialized ( ) const

Definition at line 107 of file qdeclarativepluginparameter.cpp.

References QString::isEmpty(), and QVariant::isValid().

+ Here is the call graph for this function:

◆ name()

QString QDeclarativePluginParameter::name ( ) const

Definition at line 85 of file qdeclarativepluginparameter.cpp.

◆ nameChanged

void QDeclarativePluginParameter::nameChanged ( const QString & name)
signal

Referenced by setName().

+ Here is the caller graph for this function:

◆ setName()

void QDeclarativePluginParameter::setName ( const QString & name)

Definition at line 73 of file qdeclarativepluginparameter.cpp.

References emit, initialized(), QString::isEmpty(), QVariant::isValid(), name, and nameChanged().

+ Here is the call graph for this function:

◆ setValue()

void QDeclarativePluginParameter::setValue ( const QVariant & value)

Definition at line 90 of file qdeclarativepluginparameter.cpp.

References emit, initialized(), QString::isEmpty(), QVariant::isValid(), value, and valueChanged().

+ Here is the call graph for this function:

◆ value()

QVariant QDeclarativePluginParameter::value ( ) const

Definition at line 102 of file qdeclarativepluginparameter.cpp.

◆ valueChanged

void QDeclarativePluginParameter::valueChanged ( const QVariant & value)
signal

Referenced by setValue().

+ Here is the caller graph for this function:

Property Documentation

◆ name

QString QDeclarativePluginParameter::name
readwrite

◆ value

QVariant QDeclarativePluginParameter::value
readwrite

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