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
qqmlcomponent.h
Go to the documentation of this file.
1
// Copyright (C) 2016 The Qt Company Ltd.
2
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
3
4
#ifndef QQMLCOMPONENT_H
5
#define QQMLCOMPONENT_H
6
7
#include <QtCore/qvariant.h>
8
#include <QtCore/qmap.h>
9
10
#include <QtQml/qqml.h>
11
#include <QtQml/qqmlerror.h>
12
13
#include <QtCore/qobject.h>
14
#include <QtCore/qstring.h>
15
#include <QtQml/qjsvalue.h>
16
17
QT_BEGIN_NAMESPACE
18
19
20
class
QByteArray
;
21
class
QQmlEngine
;
22
class
QQmlComponent
;
23
class
QQmlIncubator
;
24
class
QQmlComponentPrivate
;
25
class
QQmlComponentAttached
;
26
27
namespace
QV4
{
28
class
ExecutableCompilationUnit;
29
}
30
31
class
Q_QML_EXPORT
QQmlComponent
:
public
QObject
32
{
33
Q_OBJECT
34
Q_DECLARE_PRIVATE(
QQmlComponent
)
35
36
Q_PROPERTY
(
qreal
progress READ progress NOTIFY progressChanged)
37
Q_PROPERTY
(
Status
status READ status NOTIFY
statusChanged
)
38
Q_PROPERTY
(
QUrl
url
READ
url
CONSTANT)
39
40
public:
41
enum
CompilationMode
{ PreferSynchronous, Asynchronous };
42
Q_ENUM
(CompilationMode)
43
44
QQmlComponent
(
QObject
*parent =
nullptr
);
45
QQmlComponent
(
QQmlEngine
*,
QObject
*parent =
nullptr
);
46
QQmlComponent
(
QQmlEngine
*,
const
QString
&
fileName
,
QObject
*parent =
nullptr
);
47
QQmlComponent
(
QQmlEngine
*,
const
QString
&
fileName
, CompilationMode
mode
,
QObject
*parent =
nullptr
);
48
QQmlComponent
(
QQmlEngine
*,
const
QUrl
&
url
,
QObject
*parent =
nullptr
);
49
QQmlComponent
(
QQmlEngine
*,
const
QUrl
&
url
, CompilationMode
mode
,
QObject
*parent =
nullptr
);
50
51
explicit
QQmlComponent
(
QQmlEngine
*
engine
,
QAnyStringView
uri,
QAnyStringView
typeName
,
QObject
*parent =
nullptr
);
52
explicit
QQmlComponent
(
QQmlEngine
*
engine
,
QAnyStringView
uri,
QAnyStringView
typeName
, CompilationMode
mode
,
QObject
*parent =
nullptr
);
53
54
~QQmlComponent
()
override
;
55
56
enum
Status
{
Null
, Ready, Loading,
Error
};
57
Q_ENUM
(Status)
58
Status status()
const
;
59
60
bool
isNull()
const
;
61
bool
isReady()
const
;
62
bool
isError()
const
;
63
bool
isLoading()
const
;
64
65
bool
isBound()
const
;
66
67
QList<QQmlError> errors()
const
;
68
Q_INVOKABLE
QString
errorString()
const
;
69
70
qreal
progress()
const
;
71
72
QUrl
url
()
const
;
73
74
virtual
QObject
*
create
(
QQmlContext
*
context
=
nullptr
);
75
QObject
*createWithInitialProperties(
const
QVariantMap
& initialProperties,
QQmlContext
*
context
=
nullptr
);
76
void
setInitialProperties(
QObject
*
component
,
const
QVariantMap
&
properties
);
77
virtual
QObject
*beginCreate(
QQmlContext
*);
78
virtual
void
completeCreate();
79
80
void
create
(
QQmlIncubator
&,
QQmlContext
*
context
=
nullptr
,
81
QQmlContext
*forContext =
nullptr
);
82
83
QQmlContext
*creationContext()
const
;
84
QQmlEngine
*
engine
()
const
;
85
86
static
QQmlComponentAttached
*qmlAttachedProperties(
QObject
*);
87
88
public
Q_SLOTS
:
89
void
loadUrl(
const
QUrl
&
url
);
90
void
loadUrl(
const
QUrl
&
url
, CompilationMode
mode
);
91
void
loadFromModule(
QAnyStringView
uri,
QAnyStringView
typeName
,
92
QQmlComponent::CompilationMode
mode
= PreferSynchronous);
93
void
setData
(
const
QByteArray
&,
const
QUrl
&
baseUrl
);
94
95
Q_SIGNALS
:
96
void
statusChanged
(
QQmlComponent::Status
);
97
void
progressChanged
(
qreal
);
98
99
protected
:
100
QQmlComponent
(
QQmlComponentPrivate
&dd,
QObject
* parent);
101
102
#if QT_DEPRECATED_SINCE(6, 3)
103
QT_DEPRECATED_X
(
"Use the overload with proper arguments"
)
104
Q_INVOKABLE
void
createObject(
QQmlV4FunctionPtr
);
105
#endif
106
107
Q_INVOKABLE
QObject
*createObject(
108
QObject
*parent =
nullptr
,
const
QVariantMap
&
properties
= {});
109
Q_INVOKABLE
void
incubateObject(
QQmlV4FunctionPtr
);
110
111
private
:
112
QQmlComponent
(
QQmlEngine
*,
QV4::ExecutableCompilationUnit
*compilationUnit,
int
,
113
QObject
*parent);
114
115
Q_DISABLE_COPY(
QQmlComponent
)
116
friend class
QQmlTypeData
;
117
friend class
QQmlObjectCreator
;
118
};
119
120
121
// Don't do this at home.
122
namespace
QQmlPrivate
{
123
124
// Generally you cannot use QQmlComponentAttached as attached properties object in derived classes.
125
// It is private.
126
template
<
class
T>
127
struct
OverridableAttachedType
<T,
QQmlComponentAttached
>
128
{
129
using
Type
=
void
;
130
};
131
132
// QQmlComponent itself is allowed to use QQmlComponentAttached, though.
133
template
<>
134
struct
OverridableAttachedType
<
QQmlComponent
,
QQmlComponentAttached
>
135
{
136
using
Type
=
QQmlComponentAttached
;
137
};
138
139
}
// namespace QQmlPrivate
140
141
QT_END_NAMESPACE
142
143
#endif
// QQMLCOMPONENT_H
QAnyStringView
\inmodule QtCore
Definition
qanystringview.h:33
QByteArray
\inmodule QtCore
Definition
qbytearray.h:57
QMap< QString, QVariant >
QObject
\inmodule QtCore
Definition
qobject.h:103
QQmlComponentAttached
Definition
qqmlcomponentattached_p.h:28
QQmlComponentPrivate
Definition
qqmlcomponent_p.h:40
QQmlComponent
The QQmlComponent class encapsulates a QML component definition.
Definition
qqmlcomponent.h:32
QQmlComponent::Status
Status
\qmltype Component \instantiates QQmlComponent\inqmlmodule QtQml
Definition
qqmlcomponent.h:56
QQmlComponent::CompilationMode
CompilationMode
Specifies whether the QQmlComponent should load the component immediately, or asynchonously.
Definition
qqmlcomponent.h:41
QQmlComponent::progressChanged
void progressChanged(qreal)
Emitted whenever the component's loading progress changes.
QQmlComponent::statusChanged
void statusChanged(QQmlComponent::Status)
Emitted whenever the component's status changes.
QQmlContext
The QQmlContext class defines a context within a QML engine.
Definition
qqmlcontext.h:25
QQmlEngine
The QQmlEngine class provides an environment for instantiating QML components.
Definition
qqmlengine.h:57
QQmlIncubator
The QQmlIncubator class allows QML objects to be created asynchronously.
Definition
qqmlincubator.h:20
QQmlObjectCreator
Definition
qqmlobjectcreator_p.h:119
QQmlTypeData
Definition
qqmltypedata_p.h:24
QQmlV4Function
Definition
qv4engine_p.h:85
QString
\macro QT_RESTRICTED_CAST_FROM_ASCII
Definition
qstring.h:129
QUrl
\inmodule QtCore
Definition
qurl.h:94
QV4::ExecutableCompilationUnit
Definition
qv4executablecompilationunit_p.h:67
statusChanged
void statusChanged(QQmlComponent::Status status)
[1]
Definition
qlogging.cpp:11
QQmlPrivate
Definition
qv4compileddata_p.h:63
QT_BEGIN_NAMESPACE
Combined button and popup list for selecting options.
Definition
qstandardpaths_haiku.cpp:21
QT_END_NAMESPACE
Definition
qsharedpointer.cpp:1590
QV4
Definition
qv4debugservice.h:28
context
static void * context
Definition
qandroidaudiosource.cpp:42
QCborSimpleType::Null
@ Null
properties
static const QCssKnownValue properties[NumProperties - 1]
Definition
qcssparser.cpp:40
void
DBusConnection const char DBusError DBusBusType DBusError return DBusConnection DBusHandleMessageFunction void DBusFreeFunction return DBusConnection return DBusConnection return const char DBusError return DBusConnection DBusMessage dbus_uint32_t return DBusConnection dbus_bool_t DBusConnection DBusAddWatchFunction DBusRemoveWatchFunction DBusWatchToggledFunction void DBusFreeFunction return DBusConnection DBusDispatchStatusFunction void DBusFreeFunction DBusTimeout return DBusTimeout return DBusWatch return DBusWatch unsigned int return DBusError const DBusError return const DBusMessage return DBusMessage return DBusMessage return DBusMessage return DBusMessage return DBusMessage return DBusMessageIter int const void return DBusMessageIter DBusMessageIter return DBusMessageIter void DBusMessageIter void int return DBusMessage DBusMessageIter return DBusMessageIter return DBusMessageIter DBusMessageIter const char const char const char const char return DBusMessage return DBusMessage const char return DBusMessage dbus_bool_t return DBusMessage dbus_uint32_t return DBusMessage void
Definition
qdbus_symbols_p.h:409
typeName
const char * typeName
Definition
qmetatype.cpp:959
mode
GLenum mode
Definition
qopengles2ext.h:333
component
static qreal component(const QPointF &point, unsigned int i)
Definition
qpathclipper.cpp:626
Error
@ Error
Definition
qqmlbuiltinfunctions.cpp:1761
QT_DEPRECATED_X
#define QT_DEPRECATED_X(text)
Definition
qtdeprecationmarkers.h:27
Q_ENUM
#define Q_ENUM(x)
Definition
qtmetamacros.h:68
Q_PROPERTY
#define Q_PROPERTY(...)
Definition
qtmetamacros.h:56
Q_OBJECT
#define Q_OBJECT
Definition
qtmetamacros.h:119
Q_INVOKABLE
#define Q_INVOKABLE
Definition
qtmetamacros.h:76
Q_SLOTS
#define Q_SLOTS
Definition
qtmetamacros.h:44
Q_SIGNALS
#define Q_SIGNALS
Definition
qtmetamacros.h:45
qreal
double qreal
Definition
qtypes.h:187
url
QUrl url("example.com")
[constructor-url-reference]
Definition
src_corelib_io_qurl.cpp:19
baseUrl
QUrl baseUrl
Definition
src_corelib_io_qurl.cpp:128
setData
mimeData setData("text/csv", csvData)
fileName
fileName
[0]
Definition
src_gui_dialogs_qfiledialog.cpp:5
create
view create()
engine
QJSEngine engine
[0]
Definition
src_script_qjsvalue.cpp:14
QQmlPrivate::OverridableAttachedType
Definition
qqmlprivate.h:342
Type
Definition
moc.h:23
qtdeclarative
src
qml
qml
qqmlcomponent.h
Generated by
1.10.0