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
Signals | Public Member Functions | Properties | List of all members
QQmlXmlListModelRole Class Reference

#include <qqmlxmllistmodel_p.h>

+ Inheritance diagram for QQmlXmlListModelRole:
+ Collaboration diagram for QQmlXmlListModelRole:

Signals

void nameChanged ()
 
void elementNameChanged ()
 
void attributeNameChanged ()
 
- 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

 QQmlXmlListModelRole ()=default
 
 ~QQmlXmlListModelRole ()=default
 
QString name () const
 \qmlmodule QtQml.XmlListModel \title Qt XmlListModel QML Types \keyword Qt XmlListModel QML Types
 
void setName (const QString &name)
 
QString elementName () const
 
void setElementName (const QString &name)
 
QString attributeName () const
 \qmlproperty string QtQml.XmlListModel::XmlListModelRole::attributeName
 
void setAttributeName (const QString &attributeName)
 
bool isValid () 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< 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.
 

Properties

QString name
 
QString elementName
 
QString attributeName
 
- 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
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)
 
- Protected Attributes inherited from QObject
QScopedPointer< QObjectData > d_ptr
 
- 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

Definition at line 61 of file qqmlxmllistmodel_p.h.

Constructor & Destructor Documentation

◆ QQmlXmlListModelRole()

QQmlXmlListModelRole::QQmlXmlListModelRole ( )
default

◆ ~QQmlXmlListModelRole()

QQmlXmlListModelRole::~QQmlXmlListModelRole ( )
default

Member Function Documentation

◆ attributeName()

QString QQmlXmlListModelRole::attributeName ( ) const

\qmlproperty string QtQml.XmlListModel::XmlListModelRole::attributeName

The attribute of the XML element that will be used to read the data. The XML element is specified by \l elementName property.

basic-example

empty-elementName-example

If you do not need to parse any attributes for the specified XML element, simply leave this property blank.

See also
elementName

Definition at line 234 of file qqmlxmllistmodel.cpp.

◆ attributeNameChanged

void QQmlXmlListModelRole::attributeNameChanged ( )
signal

Referenced by setAttributeName().

+ Here is the caller graph for this function:

◆ elementName()

QString QQmlXmlListModelRole::elementName ( ) const 
\qmlproperty string QtQml.XmlListModel::XmlListModelRole::elementName

The name of the XML element, or a path to the XML element, that will be
used to read the data. The element must actually contain text.

Optionally the \l attributeName property can be specified to extract
the data.

! [basic-example] For example, the following model has a role named "title", which reads the data from the XML element { <title>}. It also has another role named "timestamp", which uses the same XML element { <title>}, but reads its "created" attribute to extract the actual value.

\qml XmlListModel { id: xmlModel source: "file.xml" query: "/documents/document" XmlListModelRole { name: "title"; elementName: "title" } XmlListModelRole { name: "timestamp" elementName: "title" attributeName: "created" } }

ListView { anchors.fill: parent model: xmlModel delegate: Text { text: title + " created on " + timestamp } } \endqml ! [basic-example]

! [empty-elementName-example] When the \l attributeName is specified, the \l elementName can be left empty. In this case the attribute of the top level XML element of the query will be read.

For example, if you have the following xml document:

<documents>
<document title="Title1"/>
<document title="Title2"/>
</documents>
title
QString title
[35]
Definition src_corelib_kernel_qobject.cpp:314

To extract the document titles you need the following model:

\qml XmlListModel { id: xmlModel source: "file.xml" query: "/documents/document" XmlListModelRole { name: "title" elementName: "" attributeName: "title" } } \endqml ! [empty-elementName-example] 

The elementName property can actually contain a path to the nested xml
element. All the elements in the path must be joined with the \c {'/'}
character.

For example, if you have the following xml document:
\code
<documents>
    <document>
        <title>Title1</title>
        <info>
            <num_pages>10</num_pages>
        </info>
    </document>
    <document>
        <title>Title2</title>
        <info>
            <num_pages>20</num_pages>
        </info>
    </document>
</documents>
\endcode

You can extract the number of pages with the following role:

\qml
XmlListModel {
    id: xmlModel
    source: "file.xml"
    query: "/documents/document"

... XmlListModelRole { name: "pages" elementName: "info/num_pages" } } \endqml

Note
The path to the element must not start or end with {'/'}.
See also
attributeName

Definition at line 195 of file qqmlxmllistmodel.cpp.

◆ elementNameChanged

void QQmlXmlListModelRole::elementNameChanged ( )
signal

Referenced by setElementName().

+ Here is the caller graph for this function:

◆ isValid()

bool QQmlXmlListModelRole::isValid ( ) const

Definition at line 247 of file qqmlxmllistmodel.cpp.

References QString::isEmpty().

+ Here is the call graph for this function:

◆ name()

QT_BEGIN_NAMESPACE QString QQmlXmlListModelRole::name ( ) const

\qmlmodule QtQml.XmlListModel \title Qt XmlListModel QML Types \keyword Qt XmlListModel QML Types

Provides QML types for creating models from XML data

This QML module contains types for creating models from XML data.

To use the types in this module, import the module with the following line:

\qml import QtQml.XmlListModel \endqml

\qmltype XmlListModelRole \inqmlmodule QtQml.XmlListModel

For specifying a role to an \l XmlListModel.

See also
{All QML Types}{Qt Qml}

\qmlproperty string QtQml.XmlListModel::XmlListModelRole::name

The name for the role. This name is used to access the model data for this role.

For example, the following model has a role named "title", which can be accessed from the view's delegate:

\qml XmlListModel { id: xmlModel source: "file.xml" query: "/documents/document" XmlListModelRole { name: "title"; elementName: "title" } } \endqml

\qml ListView { model: xmlModel delegate: Text { text: title } } \endqml

Definition at line 75 of file qqmlxmllistmodel.cpp.

◆ nameChanged

void QQmlXmlListModelRole::nameChanged ( )
signal

Referenced by setName().

+ Here is the caller graph for this function:

◆ setAttributeName()

void QQmlXmlListModelRole::setAttributeName ( const QString & attributeName)

Definition at line 239 of file qqmlxmllistmodel.cpp.

References attributeName, attributeNameChanged(), and Q_EMIT.

+ Here is the call graph for this function:

◆ setElementName()

void QQmlXmlListModelRole::setElementName ( const QString & name)

Definition at line 200 of file qqmlxmllistmodel.cpp.

References elementNameChanged(), name, Q_EMIT, qmlWarning(), QStringLiteral, and tr.

+ Here is the call graph for this function:

◆ setName()

void QQmlXmlListModelRole::setName ( const QString & name)

Definition at line 80 of file qqmlxmllistmodel.cpp.

References name, nameChanged(), and Q_EMIT.

+ Here is the call graph for this function:

Property Documentation

◆ attributeName

QString QQmlXmlListModelRole::attributeName
readwrite

Definition at line 66 of file qqmlxmllistmodel_p.h.

Referenced by setAttributeName().

◆ elementName

QString QQmlXmlListModelRole::elementName
readwrite

Definition at line 65 of file qqmlxmllistmodel_p.h.

◆ name

QString QQmlXmlListModelRole::name
readwrite

Definition at line 64 of file qqmlxmllistmodel_p.h.

Referenced by QQmlXmlListModel::appendRole(), setElementName(), and setName().

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