diff options
Diffstat (limited to 'doc/src/qml')
30 files changed, 457 insertions, 457 deletions
diff --git a/doc/src/qml/basictypes.qdoc b/doc/src/qml/basictypes.qdoc index 5b207cfa72..c9998fe6e2 100644 --- a/doc/src/qml/basictypes.qdoc +++ b/doc/src/qml/basictypes.qdoc @@ -88,7 +88,7 @@ Item { width: 100.45; height: 150.82 } \endqml - \bold{Note:} In QML all reals are stored in double precision, \l + \b{Note:} In QML all reals are stored in double precision, \l {http://en.wikipedia.org/wiki/IEEE_754} {IEEE floating point} format. @@ -331,12 +331,12 @@ A font type has the properties of a QFont. The properties are: \list - \o \c string font.family - \o \c bool font.bold - \o \c bool font.italic - \o \c bool font.underline - \o \c real font.pointSize - \o \c int font.pixelSize + \li \c string font.family + \li \c bool font.bold + \li \c bool font.italic + \li \c bool font.underline + \li \c real font.pointSize + \li \c int font.pixelSize \endlist Example: @@ -357,9 +357,9 @@ are: \list - \o \c slot action.trigger - invoke the action - \o \c bool action.enabled - true if the action is enabled - \o \c string action.text - the text associated with the action + \li \c slot action.trigger - invoke the action + \li \c bool action.enabled - true if the action is enabled + \li \c string action.text - the text associated with the action \endlist Actions are used like this: @@ -458,7 +458,7 @@ \endqml It is important to note that changes in regular properties of JavaScript - objects assigned to a var property will \bold{not} trigger updates of bindings + objects assigned to a var property will \b{not} trigger updates of bindings that access them. The example below will display "The car has 4 wheels" as the change to the wheels property will not cause the reevaluation of the binding assigned to the "text" property: @@ -537,8 +537,8 @@ Finally, the \c variant type can also hold: \list - \o An array of \l {QML Basic Types}{basic type} values - \o A map of key-value pairs with \l {QML Basic Types}{basic-type} values + \li An array of \l {QML Basic Types}{basic type} values + \li A map of key-value pairs with \l {QML Basic Types}{basic-type} values \endlist For example, below is an \c items array and an \c attributes map. Their @@ -562,12 +562,12 @@ \endqml While this is a convenient way to store array and map-type values, you - must be aware that the \c items and \c attributes properties above are \i not + must be aware that the \c items and \c attributes properties above are \e not QML objects (and certainly not JavaScript object either) and the key-value - pairs in \c attributes are \i not QML properties. Rather, the \c items + pairs in \c attributes are \e not QML properties. Rather, the \c items property holds an array of values, and \c attributes holds a set of key-value pairs. Since they are stored as a set of values, instead of as an object, - their contents \i cannot be modified individually: + their contents \e cannot be modified individually: \qml Item { @@ -593,7 +593,7 @@ One way to "update" the contents of an array or map is to copy the property to a JavaScript object, modify the copy as desired, and then reassign the property to the updated copy. Note, however, that this is not efficient. - In the example below, which reassigns the \c attributes property, the \i entire + In the example below, which reassigns the \c attributes property, the \e entire set of key-value pairs must be serialized and deserialized every time it is copied between a JavaScript object and a QML property: @@ -616,7 +616,7 @@ within a JavaScript file. JavaScript programmers should also note that when a JavaScript object is - copied to an array or map property, the \i contents of the object (that is, + copied to an array or map property, the \e contents of the object (that is, its key-value properties) are copied, rather than the object itself. The property does not hold a reference to the original JavaScript object, and extra data such as the object's JavaScript prototype chain is also lost in diff --git a/doc/src/qml/c++models.qdoc b/doc/src/qml/c++models.qdoc index 943c79c184..e2f2f32b5c 100644 --- a/doc/src/qml/c++models.qdoc +++ b/doc/src/qml/c++models.qdoc @@ -41,7 +41,7 @@ models. \section1 QStringList-based Model A model may be a simple \l QStringList, which provides the contents of the list - via the \i modelData role. + via the \e modelData role. Here is a ListView with a delegate that references its model item's value using the \c modelData role: @@ -55,7 +55,7 @@ models. The complete example is available in Qt's \l {declarative/modelviews/stringlistmodel}{examples/declarative/modelviews/stringlistmodel} directory. - \bold{Note:} There is no way for the view to know that the contents of a QStringList + \b{Note:} There is no way for the view to know that the contents of a QStringList have changed. If the QStringList changes, it will be necessary to reset the model by calling QQmlContext::setContextProperty() again. @@ -107,18 +107,18 @@ models. \table \header - \o Qt Role - \o QML Role Name + \li Qt Role + \li QML Role Name \row - \o Qt::DisplayRole - \o display + \li Qt::DisplayRole + \li display \row - \o Qt::DecorationRole - \o decoration + \li Qt::DecorationRole + \li decoration \endtable Here is an application with a QAbstractListModel subclass named \c AnimalModel - that has \i type and \i size roles. It calls QAbstractItemModel::setRoleNames() to set the + that has \e type and \e size roles. It calls QAbstractItemModel::setRoleNames() to set the role names for accessing the properties via QML: \snippet examples/declarative/modelviews/abstractitemmodel/model.h 0 @@ -132,7 +132,7 @@ models. \snippet examples/declarative/modelviews/abstractitemmodel/main.cpp 0 \dots - This model is displayed by a ListView delegate that accesses the \i type and \i size + This model is displayed by a ListView delegate that accesses the \e type and \e size roles: \snippet examples/declarative/modelviews/abstractitemmodel/view.qml 0 @@ -152,10 +152,10 @@ models. with models of type QAbstractItemModel: \list - \o \i hasModelChildren role property to determine whether a node has child nodes. - \o \l VisualDataModel::rootIndex allows the root node to be specified - \o \l VisualDataModel::modelIndex() returns a QModelIndex which can be assigned to VisualDataModel::rootIndex - \o \l VisualDataModel::parentModelIndex() returns a QModelIndex which can be assigned to VisualDataModel::rootIndex + \li \e hasModelChildren role property to determine whether a node has child nodes. + \li \l VisualDataModel::rootIndex allows the root node to be specified + \li \l VisualDataModel::modelIndex() returns a QModelIndex which can be assigned to VisualDataModel::rootIndex + \li \l VisualDataModel::parentModelIndex() returns a QModelIndex which can be assigned to VisualDataModel::rootIndex \endlist \section1 Exposing C++ Data Models to QML @@ -169,7 +169,7 @@ created directly as elements within QML: \table \row -\o +\li \code class MyModelPlugin : public QQmlExtensionPlugin { @@ -184,7 +184,7 @@ public: Q_EXPORT_PLUGIN2(mymodelplugin, MyModelPlugin); \endcode -\o +\li \qml MyModel { id: myModel diff --git a/doc/src/qml/codingconventions.qdoc b/doc/src/qml/codingconventions.qdoc index 9e1ce34c2c..92d8ee112a 100644 --- a/doc/src/qml/codingconventions.qdoc +++ b/doc/src/qml/codingconventions.qdoc @@ -37,20 +37,20 @@ This document contains the QML coding conventions that we follow in our document Through our documentation and examples, QML objects are always structured in the following order: \list -\o id -\o property declarations -\o signal declarations -\o JavaScript functions -\o object properties -\o child objects -\o states -\o transitions +\li id +\li property declarations +\li signal declarations +\li JavaScript functions +\li object properties +\li child objects +\li states +\li transitions \endlist For better readability, we separate these different parts with an empty line. -For example, a hypothetical \i photo QML object would look like this: +For example, a hypothetical \e photo QML object would look like this: \snippet doc/src/snippets/qml/codingconventions/photo.qml 0 @@ -58,7 +58,7 @@ For example, a hypothetical \i photo QML object would look like this: \section1 Grouped Properties If using multiple properties from a group of properties, -we use the \i {group notation} rather than the \i {dot notation} to improve readability. +we use the \e {group notation} rather than the \e {dot notation} to improve readability. For example, this: @@ -74,7 +74,7 @@ can be written like this: QML and JavaScript do not enforce private properties like C++. There is a need to hide these private properties, for example, when the properties are part of the implementation. As a convention, private properties begin with two -\i underscore characters. For example, \c __area, is a property that is +\e underscore characters. For example, \c __area, is a property that is accessible but is not meant for public use. Note that QML and JavaScript will grant the user access to these properties. diff --git a/doc/src/qml/dynamicobjects.qdoc b/doc/src/qml/dynamicobjects.qdoc index c50f9dd337..2886d5b28a 100644 --- a/doc/src/qml/dynamicobjects.qdoc +++ b/doc/src/qml/dynamicobjects.qdoc @@ -68,10 +68,10 @@ a \l Component object from this URL. Once you have a \l Component, you can call its \l {Component::createObject()}{createObject()} method to create an instance of the component. This function can take one or two arguments: \list -\o The first is the parent for the new item. Since graphical items will not appear on the scene without a parent, it is +\li The first is the parent for the new item. Since graphical items will not appear on the scene without a parent, it is recommended that you set the parent this way. However, if you wish to set the parent later you can safely pass \c null to this function. -\o The second is optional and is a map of property-value items that define initial any property values for the item. +\li The second is optional and is a map of property-value items that define initial any property values for the item. Property values specified by this argument are applied to the object before its creation is finalized, avoiding binding errors that may occur if particular properties must be initialized to enable other property bindings. when certain properties have been bound to before they have been set by the code. Additionally, there are small @@ -144,11 +144,11 @@ the bindings in the dynamic item will no longer work. The actual creation context depends on how an item is created: \list -\o If \l {QML:Qt::createComponent()}{Qt.createComponent()} is used, the creation context +\li If \l {QML:Qt::createComponent()}{Qt.createComponent()} is used, the creation context is the QQmlContext in which this method is called -\o If \l{QML:Qt::createQmlObject()}{Qt.createQmlObject()} +\li If \l{QML:Qt::createQmlObject()}{Qt.createQmlObject()} if called, the creation context is the context of the parent item passed to this method -\o If a \c {Component{}} item is defined and \l {Component::createObject()}{createObject()} +\li If a \c {Component{}} item is defined and \l {Component::createObject()}{createObject()} is called on that item, the creation context is the context in which the \c Component is defined \endlist @@ -177,12 +177,12 @@ component. Each instance runs a NumberAnimation, and when the animation has fini \table \row -\o \c application.qml -\o \c SelfDestroyingRect.qml +\li \c application.qml +\li \c SelfDestroyingRect.qml \row -\o \snippet doc/src/snippets/qml/dynamicObjects-destroy.qml 0 -\o \snippet doc/src/snippets/qml/SelfDestroyingRect.qml 0 +\li \snippet doc/src/snippets/qml/dynamicObjects-destroy.qml 0 +\li \snippet doc/src/snippets/qml/SelfDestroyingRect.qml 0 \endtable diff --git a/doc/src/qml/extending-tutorial.qdoc b/doc/src/qml/extending-tutorial.qdoc index b995c32cca..a17cd24cac 100644 --- a/doc/src/qml/extending-tutorial.qdoc +++ b/doc/src/qml/extending-tutorial.qdoc @@ -44,13 +44,13 @@ examples/declarative/tutorials/extending directory. Tutorial chapters: \list 1 -\o \l{declarative/tutorials/extending/chapter1-basics}{Creating a New Type} -\o \l{declarative/tutorials/extending/chapter2-methods}{Connecting to C++ Methods and Signals} -\o \l{declarative/tutorials/extending/chapter3-bindings}{Property Binding} -\o \l{declarative/tutorials/extending/chapter4-customPropertyTypes}{Using Custom Property Types} -\o \l{declarative/tutorials/extending/chapter5-listproperties}{Using List Property Types} -\o \l{declarative/tutorials/extending/chapter6-plugins}{Writing an Extension Plugin} -\o \l{qml-extending-tutorial7.html}{In Summary} +\li \l{declarative/tutorials/extending/chapter1-basics}{Creating a New Type} +\li \l{declarative/tutorials/extending/chapter2-methods}{Connecting to C++ Methods and Signals} +\li \l{declarative/tutorials/extending/chapter3-bindings}{Property Binding} +\li \l{declarative/tutorials/extending/chapter4-customPropertyTypes}{Using Custom Property Types} +\li \l{declarative/tutorials/extending/chapter5-listproperties}{Using List Property Types} +\li \l{declarative/tutorials/extending/chapter6-plugins}{Writing an Extension Plugin} +\li \l{qml-extending-tutorial7.html}{In Summary} \endlist */ @@ -92,8 +92,8 @@ properties. Since QML makes extensive use of Qt's \l{Meta-Object System}{meta ob this new class must: \list -\o Inherit from QObject -\o Declare its properties using the Q_PROPERTY macro +\li Inherit from QObject +\li Declare its properties using the Q_PROPERTY macro \endlist Here is our \c PieChart class, defined in \c piechart.h: @@ -290,11 +290,11 @@ We can also use various other property types. QML has built-in support for the t listed in the \l{QML Basic Types} documentation, which includes the following: \list -\o bool, unsigned int, int, float, double, qreal -\o QString, QUrl, QColor -\o QDate, QTime, QDateTime -\o QPoint, QPointF, QSize, QSizeF, QRect, QRectF -\o QVariant +\li bool, unsigned int, int, float, double, qreal +\li QString, QUrl, QColor +\li QDate, QTime, QDateTime +\li QPoint, QPointF, QSize, QSizeF, QRect, QRectF +\li QVariant \endlist If we want to create a property whose type is not supported by QML by default, @@ -409,9 +409,9 @@ loading our own C++ application. To create a plugin library, we need: \list -\o A plugin class that registers our QML types -\o A project file that describes the plugin -\o A \l{Writing a qmldir file}{qmldir} file that tells the QML engine to load the plugin +\li A plugin class that registers our QML types +\li A project file that describes the plugin +\li A \l{Writing a qmldir file}{qmldir} file that tells the QML engine to load the plugin \endlist First, we create a plugin class named \c ChartsPlugin. It subclasses QQmlExtensionPlugin @@ -460,12 +460,12 @@ be used by \c app.qml without import statements. In this tutorial, we've shown the basic steps for creating a QML extension: \list -\o Define new QML types by subclassing QObject and registering them with qmlRegisterType() -\o Add callable methods using Q_INVOKABLE or Qt slots, and connect to Qt signals with an \c onSignal syntax -\o Add property bindings by defining \l{Qt's Property System}{NOTIFY} signals -\o Define custom property types if the built-in types are not sufficient -\o Define list property types using QQmlListProperty -\o Create a plugin library by defining a Qt plugin and writing a \c qmldir file +\li Define new QML types by subclassing QObject and registering them with qmlRegisterType() +\li Add callable methods using Q_INVOKABLE or Qt slots, and connect to Qt signals with an \c onSignal syntax +\li Add property bindings by defining \l{Qt's Property System}{NOTIFY} signals +\li Define custom property types if the built-in types are not sufficient +\li Define list property types using QQmlListProperty +\li Create a plugin library by defining a Qt plugin and writing a \c qmldir file \endlist diff --git a/doc/src/qml/integrating.qdoc b/doc/src/qml/integrating.qdoc index 2a88246006..83dcaeae74 100644 --- a/doc/src/qml/integrating.qdoc +++ b/doc/src/qml/integrating.qdoc @@ -90,9 +90,9 @@ The following QGraphicsView options are recommended for optimal performance of QML UIs: \list -\o QGraphicsView::setOptimizationFlags(QGraphicsView::DontSavePainterState) -\o QGraphicsView::setViewportUpdateMode(QGraphicsView::BoundingRectViewportUpdate) -\o QGraphicsScene::setItemIndexMethod(QGraphicsScene::NoIndex) +\li QGraphicsView::setOptimizationFlags(QGraphicsView::DontSavePainterState) +\li QGraphicsView::setViewportUpdateMode(QGraphicsView::BoundingRectViewportUpdate) +\li QGraphicsScene::setItemIndexMethod(QGraphicsScene::NoIndex) \endlist \section2 Loading QGraphicsWidget Objects in QML diff --git a/doc/src/qml/javascriptblocks.qdoc b/doc/src/qml/javascriptblocks.qdoc index 5a30324d1a..a898f20049 100644 --- a/doc/src/qml/javascriptblocks.qdoc +++ b/doc/src/qml/javascriptblocks.qdoc @@ -200,8 +200,8 @@ in \c script.js: \table \row -\o \snippet doc/src/snippets/qml/integrating-javascript/connectjs.qml 0 -\o \snippet doc/src/snippets/qml/integrating-javascript/script.js 0 +\li \snippet doc/src/snippets/qml/integrating-javascript/connectjs.qml 0 +\li \snippet doc/src/snippets/qml/integrating-javascript/script.js 0 \endtable The \c jsFunction() will now be called whenever MouseArea's \c clicked signal is emitted. @@ -243,10 +243,10 @@ which in turn can call \c factorial() in \c factorial.js, as it has included \table \row -\o {1,2} \snippet doc/src/snippets/qml/integrating-javascript/includejs/app.qml 0 -\o \snippet doc/src/snippets/qml/integrating-javascript/includejs/script.js 0 +\li {1,2} \snippet doc/src/snippets/qml/integrating-javascript/includejs/app.qml 0 +\li \snippet doc/src/snippets/qml/integrating-javascript/includejs/script.js 0 \row -\o \snippet doc/src/snippets/qml/integrating-javascript/includejs/factorial.js 0 +\li \snippet doc/src/snippets/qml/integrating-javascript/includejs/factorial.js 0 \endtable Notice that calling \l {QML:Qt::include()}{Qt.include()} imports all functions from @@ -280,9 +280,9 @@ via a module API; see qmlRegisterModuleApi() for more information. Due to the ability of a JavaScript file to import another script or QML module in this fashion in QtQuick 2.0, some extra semantics are defined: \list -\o a script with imports will not inherit imports from the QML file which imported it (so accessing Component.error will fail, for example) -\o a script without imports will inherit imports from the QML file which imported it (so accessing Component.error will succeed, for example) -\o a shared script (i.e., defined as .pragma library) does not inherit imports from any QML file even if it imports no other scripts +\li a script with imports will not inherit imports from the QML file which imported it (so accessing Component.error will fail, for example) +\li a script without imports will inherit imports from the QML file which imported it (so accessing Component.error will succeed, for example) +\li a shared script (i.e., defined as .pragma library) does not inherit imports from any QML file even if it imports no other scripts \endlist The first semantic is conceptually correct, given that a particular script @@ -339,12 +339,12 @@ parameters. It is occasionally necessary to run some imperative code at application (or component instance) startup. While it is tempting to just include the startup -script as \i {global code} in an external script file, this can have severe limitations +script as \e {global code} in an external script file, this can have severe limitations as the QML environment may not have been fully established. For example, some objects might not have been created or some \l {Property Binding}s may not have been run. \l {QML JavaScript Restrictions} covers the exact limitations of global script code. -The QML \l Component element provides an \i attached \c onCompleted property that +The QML \l Component element provides an \e attached \c onCompleted property that can be used to trigger the execution of script code at startup after the QML environment has been completely established. For example: @@ -380,7 +380,7 @@ See \l {qml-javascript-assignment}{Property Assignment versus Property Binding} QML executes standard JavaScript code, with the following restrictions: \list -\o JavaScript code cannot modify the global object. +\li JavaScript code cannot modify the global object. In QML, the global object is constant - existing properties cannot be modified or deleted, and no new properties may be created. @@ -413,7 +413,7 @@ Any attempt to modify the global object - either implicitly or explicitly - will cause an exception. If uncaught, this will result in an warning being printed, that includes the file and line number of the offending code. -\o Global code is run in a reduced scope +\li Global code is run in a reduced scope During startup, if a QML file includes an external JavaScript file with "global" code, it is executed in a scope that contains only the external file itself and @@ -438,7 +438,7 @@ This restriction exists as the QML environment is not yet fully established. To run code after the environment setup has completed, refer to \l {Running JavaScript at Startup}. -\o The value of \c this is currently undefined in QML in the majority of contexts +\li The value of \c this is currently undefined in QML in the majority of contexts The \c this keyword is supported when binding properties from JavaScript. In all other situations, the value of @@ -475,9 +475,9 @@ property may hold a "scarce resource" (image or pixmap). There are several important semantics of scarce resources which should be noted: \list -\o By default, a scarce resource is automatically released by the declarative engine as soon as evaluation of the expression in which the scarce resource is allocated is complete if there are no other references to the resource -\o A client may explicitly preserve a scarce resource, which will ensure that the resource will not be released until all references to the resource are released and the JavaScript engine runs its garbage collector -\o A client may explicitly destroy a scarce resource, which will immediately release the resource +\li By default, a scarce resource is automatically released by the declarative engine as soon as evaluation of the expression in which the scarce resource is allocated is complete if there are no other references to the resource +\li A client may explicitly preserve a scarce resource, which will ensure that the resource will not be released until all references to the resource are released and the JavaScript engine runs its garbage collector +\li A client may explicitly destroy a scarce resource, which will immediately release the resource \endlist In most cases, allowing the engine to automatically release the resource is diff --git a/doc/src/qml/modules.qdoc b/doc/src/qml/modules.qdoc index 27f8ae8fb1..c346f731b1 100644 --- a/doc/src/qml/modules.qdoc +++ b/doc/src/qml/modules.qdoc @@ -43,10 +43,10 @@ explicitly using the \c import statement to import them as modules. For example, an \c import statement is required to use: \list -\o A component defined in another QML file that is not in the same directory -\o A component defined in a QML file located on a remote server -\o A \l{QQmlExtensionPlugin}{QML extension plugin} library (unless the plugin is installed in the same directory) -\o A JavaScript file (note this must be imported using \l {#namespaces}{named imports}) +\li A component defined in another QML file that is not in the same directory +\li A component defined in a QML file located on a remote server +\li A \l{QQmlExtensionPlugin}{QML extension plugin} library (unless the plugin is installed in the same directory) +\li A JavaScript file (note this must be imported using \l {#namespaces}{named imports}) \endlist An \c import statement includes the module name, and possibly a version number. @@ -58,7 +58,7 @@ This imports version 1.0 of the "QtQuick" module into the global namespace. (The library itself must be imported to use any of the \l {QML Elements}, as they are not included in the global namespace by default.) -The \c Qt module is an \i installed module; it is found in the +The \c Qt module is an \e installed module; it is found in the \l{#import-path}{import path}. There are two types of QML modules: located modules (defined by a URL) and installed modules (defined by a URI). @@ -77,11 +77,11 @@ directory using a relative or absolute path, like this: \table \row -\o Directory structure -\o Contents of application.qml +\li Directory structure +\li Contents of application.qml \row -\o +\li \code MyQMLProject |- MyComponents @@ -92,7 +92,7 @@ MyQMLProject |- application.qml \endcode -\o +\li \qml import "../MyComponents" @@ -182,9 +182,9 @@ locations to be searched by the QML engine for a matching module. By default, th contains: \list -\o The directory of the current file -\o The location specified by QLibraryInfo::ImportsPath -\o Paths specified by the \c QML_IMPORT_PATH environment variable +\li The directory of the current file +\li The location specified by QLibraryInfo::ImportsPath +\li Paths specified by the \c QML_IMPORT_PATH environment variable \endlist Additional import paths can be added through QQmlEngine::addImportPath() or the @@ -269,7 +269,7 @@ a module that is imported as a network resource. By default, when a module is imported, its contents are imported into the global namespace. You may choose to import the module into another namespace, either to allow identically-named types to be referenced, or purely for readability. -To import a module into a specific namespace, use the \i as keyword: +To import a module into a specific namespace, use the \e as keyword: \snippet doc/src/snippets/qml/imports/named-imports.qml imports @@ -347,9 +347,9 @@ plugin <Name> [<Path>] typeinfo <File> \endcode -\bold {# <Comment>} lines are used for comments. They are ignored by the QML engine. +\b {# <Comment>} lines are used for comments. They are ignored by the QML engine. -\bold {<TypeName> [<InitialVersion>] <File>} lines are used to add QML files as types. +\b {<TypeName> [<InitialVersion>] <File>} lines are used to add QML files as types. <TypeName> is the type being made available, the optional <InitialVersion> is a version number, and <File> is the (relative) file name of the QML file defining the type. @@ -357,11 +357,11 @@ Installed files do not need to import the module of which they are a part, as th to the other QML files in the module as relative (local) files, but if the module is imported from a remote location, those files must nevertheless be listed in the \c qmldir file. Types which you do not wish to export to users of your module -may be marked with the \c internal keyword: \bold {internal <TypeName> <File>}. +may be marked with the \c internal keyword: \b {internal <TypeName> <File>}. The same type can be provided by different files in different versions, in which case later versions (e.g. 1.2) must precede earlier versions (e.g. 1.0), -since the \i first name-version match is used and a request for a version of a type +since the \e first name-version match is used and a request for a version of a type can be fulfilled by one defined in an earlier version of the module. If a user attempts to import a version earlier than the earliest provided or later than the latest provided, the import produces a runtime error, but if the user imports a version within the range of versions provided, @@ -372,16 +372,16 @@ If multiple are provided, only the first in the search path will be used (regard are provided by directories later in the search path). The versioning system ensures that a given QML file will work regardless of the version -of installed software, since a versioned import \i only imports types for that version, +of installed software, since a versioned import \e only imports types for that version, leaving other identifiers available, even if the actual installed version might otherwise provide those identifiers. -\bold {<Namespace> <InitialVersion> <File>} lines are used to import javascript files +\b {<Namespace> <InitialVersion> <File>} lines are used to import javascript files into a Namespace exported by the module. The contents of the script file are made available inside the namespace <Namespace>, which has the version number <InitialVersion>. -\bold {plugin <Name> [<Path>]} lines are used to add \l{QQmlExtensionPlugin}{QML C++ plugins} to the module. <Name> is the name of the library. It is usually not the same as the file name +\b{plugin <Name> [<Path>]} lines are used to add \l{QQmlExtensionPlugin}{QML C++ plugins} to the module. <Name> is the name of the library. It is usually not the same as the file name of the plugin binary, which is platform dependent; e.g. the library \c MyAppTypes would produce \c libMyAppTypes.so on Linux and \c MyAppTypes.dll on Windows. @@ -390,7 +390,7 @@ plugin file, or a relative path from the directory containing the \c qmldir file containing the plugin file. By default the engine searches for the plugin library in the directory that contains the \c qmldir file. The plugin search path can be queried with QQmlEngine::pluginPathList() and modified using QQmlEngine::addPluginPath(). When running the \l {QML Viewer}, use the \c -P option to add paths to the plugin search path. -\bold {typeinfo <File>} lines add \l{Writing a qmltypes file}{type description files} to +\b {typeinfo <File>} lines add \l{Writing a qmltypes file}{type description files} to the module that can be read by QML tools such as Qt Creator to get information about the types defined by the module's plugins. <File> is the (relative) file name of a .qmltypes file. @@ -434,9 +434,9 @@ to \c /tmp/imports/My/Module/qmldir to register it. While the qmldump tool covers most cases, it does not work if: \list -\o The plugin uses a \l{QQmlCustomParser}. The component that uses +\li The plugin uses a \l{QQmlCustomParser}. The component that uses the custom parser will not get its members documented. -\o The plugin can not be loaded. In particular if you cross-compiled +\li The plugin can not be loaded. In particular if you cross-compiled the plugin for a different architecture, qmldump will not be able to load it. \endlist diff --git a/doc/src/qml/network.qdoc b/doc/src/qml/network.qdoc index 71f42a4bfe..049bdddf5a 100644 --- a/doc/src/qml/network.qdoc +++ b/doc/src/qml/network.qdoc @@ -41,7 +41,7 @@ Image { } \endqml -Since a \i relative URL is the same +Since a \e relative URL is the same as a relative file, development of QML on regular file systems remains simple: \qml @@ -53,8 +53,8 @@ Image { Network transparency is supported throughout QML, for example: \list -\o Fonts - the \c source property of FontLoader is a URL -\o WebViews - the \c url property of WebView (obviously!) +\li Fonts - the \c source property of FontLoader is a URL +\li WebViews - the \c url property of WebView (obviously!) \endlist Even QML types themselves can be on the network - if the \l {QML Viewer} is used to load @@ -148,10 +148,10 @@ The \c import statement is only network transparent if it has an "as" clause. More specifically: \list -\o \c{import "dir"} only works on local file systems -\o \c{import libraryUri} only works on local file systems -\o \c{import "dir" as D} works network transparently -\o \c{import libraryUrl as U} works network transparently +\li \c{import "dir"} only works on local file systems +\li \c{import libraryUri} only works on local file systems +\li \c{import "dir" as D} works network transparently +\li \c{import libraryUrl as U} works network transparently \endlist \section1 XMLHttpRequest @@ -164,8 +164,8 @@ data from over a network. The XMLHttpRequest API implements the same \l {http://www.w3.org/TR/XMLHttpRequest/}{W3C standard} as many popular web browsers with following exceptions: \list -\i QML's XMLHttpRequest does not enforce the same origin policy. -\i QML's XMLHttpRequest does not support \i synchronous requests. +\li QML's XMLHttpRequest does not enforce the same origin policy. +\li QML's XMLHttpRequest does not support \e synchronous requests. \endlist Additionally, the \c responseXML XML DOM tree currently supported by QML is a reduced subset @@ -174,58 +174,58 @@ browser. The following objects and properties are supported by the QML implemen \table \header -\o \bold {Node} -\o \bold {Document} -\o \bold {Element} -\o \bold {Attr} -\o \bold {CharacterData} -\o \bold {Text} +\li \b {Node} +\li \b {Document} +\li \b {Element} +\li \b {Attr} +\li \b {CharacterData} +\li \b {Text} \row -\o +\li \list -\o nodeName -\o nodeValue -\o nodeType -\o parentNode -\o childNodes -\o firstChild -\o lastChild -\o previousSibling -\o nextSibling -\o attributes +\li nodeName +\li nodeValue +\li nodeType +\li parentNode +\li childNodes +\li firstChild +\li lastChild +\li previousSibling +\li nextSibling +\li attributes \endlist -\o +\li \list -\o xmlVersion -\o xmlEncoding -\o xmlStandalone -\o documentElement +\li xmlVersion +\li xmlEncoding +\li xmlStandalone +\li documentElement \endlist -\o +\li \list -\o tagName +\li tagName \endlist -\o +\li \list -\o name -\o value -\o ownerElement +\li name +\li value +\li ownerElement \endlist -\o +\li \list -\o data -\o length +\li data +\li length \endlist -\o +\li \list -\o isElementContentWhitespace -\o wholeText +\li isElementContentWhitespace +\li wholeText \endlist \endtable diff --git a/doc/src/qml/performance.qdoc b/doc/src/qml/performance.qdoc index 1d6b041803..c5db0e0b2d 100644 --- a/doc/src/qml/performance.qdoc +++ b/doc/src/qml/performance.qdoc @@ -443,8 +443,8 @@ with much worse performance. As such, always try to ensure you meet the followi criteria: \list -\o Avoid using eval() if at all possible -\o Do not delete properties of objects +\li Avoid using eval() if at all possible +\li Do not delete properties of objects \endlist \section1 Common Interface Elements @@ -545,10 +545,10 @@ QML. While the optimal implementation of any such model will depend heavily on use-case it must fulfil, some general guidelines are as follows: \list -\o Be as asynchronous as possible -\o Do all processing in a (low priority) worker thread -\o Batch up backend operations so that (potentially slow) I/O and IPC is minimised -\o Use a sliding slice window to cache results, whose parameters are determined with the help of profiling +\li Be as asynchronous as possible +\li Do all processing in a (low priority) worker thread +\li Batch up backend operations so that (potentially slow) I/O and IPC is minimised +\li Use a sliding slice window to cache results, whose parameters are determined with the help of profiling \endlist It is important to note that using a low-priority worker thread is recommended to @@ -592,15 +592,15 @@ needed (see the upcoming section on lazy initialisation). The following list is a good summary of things to keep in mind when designing a delegate: \list -\o The fewer elements that are in a delegate, the faster they can be created, and thus +\li The fewer elements that are in a delegate, the faster they can be created, and thus the faster the view can be scrolled. -\o Keep the number of bindings in a delegate to a minimum; in particular, use anchors +\li Keep the number of bindings in a delegate to a minimum; in particular, use anchors rather than bindings for relative positioning within a delegate. -\o Set a cacheBuffer to allow asynchronous creation of delegates outside the visible area. +\li Set a cacheBuffer to allow asynchronous creation of delegates outside the visible area. Be mindful that this creates additional delegates and therefore the size of the cacheBuffer must be balanced against additional memory usage. -\o Avoid using ShaderEffect elements within delegates. -\o Never enable clipping on a delegate. +\li Avoid using ShaderEffect elements within delegates. +\li Never enable clipping on a delegate. \endlist \section1 Visual Effects @@ -669,10 +669,10 @@ it is necessary. This may be achieved by using either \l Loader or creating com The Loader is an element which allows dynamic loading and unloading of components. \list -\o Using the "active" property of a Loader, initialisation can be delayed until required. -\o Using the overloaded version of the "setSource()" function, initial property values can +\li Using the "active" property of a Loader, initialisation can be delayed until required. +\li Using the overloaded version of the "setSource()" function, initial property values can be supplied. -\o Setting the Loader \l {Loader::asynchronous}{asynchronous} property to true may also +\li Setting the Loader \l {Loader::asynchronous}{asynchronous} property to true may also improve fluidity while a component is instantiated. \endlist diff --git a/doc/src/qml/propertybinding.qdoc b/doc/src/qml/propertybinding.qdoc index ce5ad0be4a..6922f54003 100644 --- a/doc/src/qml/propertybinding.qdoc +++ b/doc/src/qml/propertybinding.qdoc @@ -33,7 +33,7 @@ \section1 Properties -QML components have \i properties that can be read and modified by other objects. +QML components have \e properties that can be read and modified by other objects. In QML, properties serve many purposes but their main function is to hold to values. Values may be a \l{QML Basic Types}{basic type}, or other QML elements. @@ -156,7 +156,7 @@ JavaScript code. \section1 Types of Properties -Properties may bind to different types, but they are are \i type-safe. That is, +Properties may bind to different types, but they are are \e type-safe. That is, properties only allow you to assign a value that matches the property type. For example, if a property is a real, and if you try to assign a string to it you will get an error. @@ -200,21 +200,21 @@ For more information about the \c children property, please read the \keyword attached-properties \section2 Attached Properties -Certain objects provide additional properties by \i attaching properties to other -objects. For example, the \l Keys element have properties that can \i attach to other QML +Certain objects provide additional properties by \e attaching properties to other +objects. For example, the \l Keys element have properties that can \e attach to other QML objects to provide keyboard handling. \snippet doc/src/snippets/qml/properties.qml list attached property The element \l ListView provides the delegate, \c listdelegate, the property \c isCurrentItem as an attached property. The \c ListView.isCurrentItem -\i{attached property} provides highlight information to the delegate. +\e{attached property} provides highlight information to the delegate. Effectively, the \l ListView element attaches the \c ListView.isCurrentItem property to each delegate it creates. \keyword attached-signalhandlers \section2 Attached Signal Handlers -\i {Attached signal handlers} are similar +\e {Attached signal handlers} are similar to \l{Attached Properties}{attached properties} in that they attach to objects to provide additional functionality to objects. Two prominent elements, \l Component and \l Keys element provide @@ -247,8 +247,8 @@ for more details about list properties and their available operations. \keyword qml-grouped-properties \section2 Grouped Properties -In some cases properties form a logical group and use either the \i dot notation -or \i group notation. +In some cases properties form a logical group and use either the \e dot notation +or \e group notation. Grouped properties may be written both ways: \snippet doc/src/snippets/qml/properties.qml grouped properties @@ -259,8 +259,8 @@ In the element documentation grouped properties are shown using the dot notation Unlike a property definition, which allocates a new, unique storage space for the property, a property alias connects the newly declared property, called the -\i{aliasing property} as a direct reference to an existing property, the -\i{aliased property}. Read or write operations on the aliasing property results +\e{aliasing property} as a direct reference to an existing property, the +\e{aliased property}. Read or write operations on the aliasing property results in a read or write operations on the aliased property, respectively. A property alias declaration is similar to an ordinary property definition: @@ -322,8 +322,8 @@ aliases to reassign children to the \l ListView, creating a tab effect. \section2 Default Properties When imported, QML components will bind declared children to their designated -\i{default properties}. The optional \c default attribute specifies a property -as the \i {default property}. For example, the State element's default property +\e{default properties}. The optional \c default attribute specifies a property +as the \e {default property}. For example, the State element's default property is its \l{State::changes}{changes} property. \l PropertyChanges elements may simply be placed as the \c{State}'s children and they will be bound to the \c changes property. diff --git a/doc/src/qml/qmlcomponents.qdoc b/doc/src/qml/qmlcomponents.qdoc index 21b94f2ae3..6d116df979 100644 --- a/doc/src/qml/qmlcomponents.qdoc +++ b/doc/src/qml/qmlcomponents.qdoc @@ -33,10 +33,10 @@ \title QML Components \brief creating and instantiating components -A \i component is an instantiable QML definition, typically contained in a \c -.qml file. For instance, a Button \i component may be defined in \c Button.qml +A \e component is an instantiable QML definition, typically contained in a \c +.qml file. For instance, a Button \e component may be defined in \c Button.qml file. The \l{The QML Engine}{QML engine} may instantiate this Button -component to create Button \i objects. Alternatively, a component may be defined +component to create Button \e objects. Alternatively, a component may be defined inside a \l Component element. Moreover, the Button definition may also contain other components. A Button @@ -67,12 +67,12 @@ component. Components may incorporate any \l{Qt Quick}{QML feature} such as: \list -\o \l{Property Binding in QML}{Properties} - for binding to data and functions -\o \l{JavaScript Expressions in QML}{JavaScript functions} - for performing routines and logic -\o \l{QML Signal and Handler Event System}{Signals and handlers} - t notify other +\li \l{Property Binding in QML}{Properties} - for binding to data and functions +\li \l{JavaScript Expressions in QML}{JavaScript functions} - for performing routines and logic +\li \l{QML Signal and Handler Event System}{Signals and handlers} - t notify other objects about events -\o \l{QML States}{States} and \l{QML Animation and Transitions}{Transitions} -\o many others +\li \l{QML States}{States} and \l{QML Animation and Transitions}{Transitions} +\li many others \endlist For information about these features, visit the respective overviews or the main Qt Quick \l{Qt Quick}{reference} page. @@ -129,7 +129,7 @@ signal handler executes when the component finishes destruction. \keyword qml-top-level \section1 Top-Level Component -Choosing the \i{top-level} or the \i{root} object of components is an important +Choosing the \e{top-level} or the \e{root} object of components is an important design aspect because the top-level object dictates which properties are accessible outside the component. Some elements are not visual elements and will not have visual properties exposed outside the component. Likewise, some diff --git a/doc/src/qml/qmldate.qdoc b/doc/src/qml/qmldate.qdoc index 7ac200db46..696d97ba1d 100644 --- a/doc/src/qml/qmldate.qdoc +++ b/doc/src/qml/qmldate.qdoc @@ -36,9 +36,9 @@ Functions that accept a locale format may be either an enumeration value: \table - \row \i Locale.LongFormat \i The long version of the string; for example, returning "January" as a month name. - \row \i Locale.ShortFormat \i The short version of the string; for example, returning "Jan" as a month name. - \row \i Locale.NarrowFormat \i A special version for use when space is limited; + \row \li Locale.LongFormat \li The long version of the string; for example, returning "January" as a month name. + \row \li Locale.ShortFormat \li The short version of the string; for example, returning "Jan" as a month name. + \row \li Locale.NarrowFormat \li A special version for use when space is limited; for example, returning "J" as a month name. Note that the narrow format might contain the same text for different months and days or it can even be an empty string if the locale doesn't support narrow names, so you should avoid using it for date formatting. @@ -47,21 +47,21 @@ or a string specifying the format These expressions may be used for format dates: \table - \header \i Expression \i Output - \row \i d \i the day as number without a leading zero (1 to 31) - \row \i dd \i the day as number with a leading zero (01 to 31) - \row \i ddd - \i the abbreviated localized day name (e.g. 'Mon' to 'Sun'). - \row \i dddd - \i the long localized day name (e.g. 'Monday' to 'Sunday'). - \row \i M \i the month as number without a leading zero (1 to 12) - \row \i MM \i the month as number with a leading zero (01 to 12) - \row \i MMM - \i the abbreviated localized month name (e.g. 'Jan' to 'Dec'). - \row \i MMMM - \i the long localized month name (e.g. 'January' to 'December'). - \row \i yy \i the year as two digit number (00 to 99) - \row \i yyyy \i the year as four digit number. If the year is negative, + \header \li Expression \li Output + \row \li d \li the day as number without a leading zero (1 to 31) + \row \li dd \li the day as number with a leading zero (01 to 31) + \row \li ddd + \li the abbreviated localized day name (e.g. 'Mon' to 'Sun'). + \row \li dddd + \li the long localized day name (e.g. 'Monday' to 'Sunday'). + \row \li M \li the month as number without a leading zero (1 to 12) + \row \li MM \li the month as number with a leading zero (01 to 12) + \row \li MMM + \li the abbreviated localized month name (e.g. 'Jan' to 'Dec'). + \row \li MMMM + \li the long localized month name (e.g. 'January' to 'December'). + \row \li yy \li the year as two digit number (00 to 99) + \row \li yyyy \li the year as four digit number. If the year is negative, a minus sign is prepended in addition. \endtable @@ -74,35 +74,35 @@ 1969): \table - \header \o Format \o Result - \row \o dd.MM.yyyy \o 20.07.1969 - \row \o ddd MMMM d yy \o Sun July 20 69 - \row \o 'The day is' dddd \o The day is Sunday + \header \li Format \li Result + \row \li dd.MM.yyyy \li 20.07.1969 + \row \li ddd MMMM d yy \li Sun July 20 69 + \row \li 'The day is' dddd \li The day is Sunday \endtable These expressions may be used for formatting time: \table - \header \i Expression \i Output - \row \i h - \i the hour without a leading zero (0 to 23 or 1 to 12 if AM/PM display) - \row \i hh - \i the hour with a leading zero (00 to 23 or 01 to 12 if AM/PM display) - \row \i H - \i the hour without a leading zero (0 to 23, even with AM/PM display) - \row \i HH - \i the hour with a leading zero (00 to 23, even with AM/PM display) - \row \i m \i the minute without a leading zero (0 to 59) - \row \i mm \i the minute with a leading zero (00 to 59) - \row \i s \i the second without a leading zero (0 to 59) - \row \i ss \i the second with a leading zero (00 to 59) - \row \i z \i the milliseconds without leading zeroes (0 to 999) - \row \i zzz \i the milliseconds with leading zeroes (000 to 999) - \row \i AP or A - \i use AM/PM display. \e AP will be replaced by either "AM" or "PM". - \row \i ap or a - \i use am/pm display. \e ap will be replaced by either "am" or "pm". - \row \i t \i the timezone (for example "CEST") + \header \li Expression \li Output + \row \li h + \li the hour without a leading zero (0 to 23 or 1 to 12 if AM/PM display) + \row \li hh + \li the hour with a leading zero (00 to 23 or 01 to 12 if AM/PM display) + \row \li H + \li the hour without a leading zero (0 to 23, even with AM/PM display) + \row \li HH + \li the hour with a leading zero (00 to 23, even with AM/PM display) + \row \li m \li the minute without a leading zero (0 to 59) + \row \li mm \li the minute with a leading zero (00 to 59) + \row \li s \li the second without a leading zero (0 to 59) + \row \li ss \li the second with a leading zero (00 to 59) + \row \li z \li the milliseconds without leading zeroes (0 to 999) + \row \li zzz \li the milliseconds with leading zeroes (000 to 999) + \row \li AP or A + \li use AM/PM display. \e AP will be replaced by either "AM" or "PM". + \row \li ap or a + \li use am/pm display. \e ap will be replaced by either "am" or "pm". + \row \li t \li the timezone (for example "CEST") \endtable All other input characters will be ignored. Any sequence of characters that @@ -113,10 +113,10 @@ Example format strings (assuming that the QTime is 14:13:09.042) \table - \header \i Format \i Result - \row \i hh:mm:ss.zzz \i 14:13:09.042 - \row \i h:m:s ap \i 2:13:9 pm - \row \i H:m:s a \i 14:13:9 pm + \header \li Format \li Result + \row \li hh:mm:ss.zzz \li 14:13:09.042 + \row \li h:m:s ap \li 2:13:9 pm + \row \li H:m:s a \li 14:13:9 pm \endtable If the date is invalid, an empty string will be returned. diff --git a/doc/src/qml/qmldocument.qdoc b/doc/src/qml/qmldocument.qdoc index 426f135a45..30845999b4 100644 --- a/doc/src/qml/qmldocument.qdoc +++ b/doc/src/qml/qmldocument.qdoc @@ -43,16 +43,16 @@ QML documents are always encoded in UTF-8 format. A QML document always begins with one or more import statements. To prevent elements introduced in later versions from affecting existing QML programs, the element types available within a document are controlled by the imported QML \l {Modules} with -a corresponding \i version. +a corresponding \e version. -QML does \i not have a preprocessor that modifies the document prior to +QML does \e not have a preprocessor that modifies the document prior to presentation to the \l{The QML Engine}{QML engine}, unlike C or C++. The \c import statements do not copy and prepend the code in the document, but instead instruct the QML engine on how to resolve type references found in the document. Any type reference present in a QML document - such as \c Rectangle and \c ListView - including those made within an \l {Inline JavaScript}{JavaScript block} or \l {Property Binding in QML}{property -bindings}, are \i resolved based exclusively on the import statements. At least +bindings}, are \e resolved based exclusively on the import statements. At least one \c import statement must be present such as \c{import QtQuick 2.0}. Each \c id value in a QML document must be unique within that document. They do @@ -65,7 +65,7 @@ A QML document defines a single, top-level \l {QML Components}{QML component}. A QML component is a template that is interpreted by the QML engine to create an object with some predefined behaviour. As it is a template, a single QML component can be "run" multiple times to produce several objects, each of -which are said to be \i instances of the component. +which are said to be \e instances of the component. Once created, instances are not dependent on the component that created them, so they can operate on independent data. Here is an example of a simple "Button" @@ -75,12 +75,12 @@ text property: \table \row -\o Button.qml -\o application.qml +\li Button.qml +\li application.qml \row -\o \snippet doc/src/snippets/qml/qml-documents/qmldocuments.qml document -\o +\li \snippet doc/src/snippets/qml/qml-documents/qmldocuments.qml document +\li \qml import QtQuick 2.0 @@ -99,7 +99,7 @@ Column { \endtable Any snippet of QML code can become a component, just by placing it in the file -"<Name>.qml" where <Name> is the component name, and begins with an \bold +"<Name>.qml" where <Name> is the component name, and begins with an \b uppercase letter. Note that the case of all characters in the <Name> are significant on some filesystems, notably UNIX filesystems. It is recommended that the case of the filename matches the case of the component name in QML @@ -113,7 +113,7 @@ load them in other components. \section1 Inline Components In addition to the top-level component that all QML documents define, and any -reusable components placed in separate files, documents may also include \i +reusable components placed in separate files, documents may also include \e inline components. Inline components are declared using the \l Component element, as can be seen in the first example above. Inline components share all the characteristics of regular top-level components and use the same \c import @@ -137,9 +137,9 @@ These final two examples perform identically to the original document. \table \row -\o +\li \snippet doc/src/snippets/qml/qml-documents/inline-component.qml document -\o +\li \snippet doc/src/snippets/qml/qml-documents/inline-text-component.qml document \endtable diff --git a/doc/src/qml/qmlengine.qdoc b/doc/src/qml/qmlengine.qdoc index 0865755c7b..b0754fe3ab 100644 --- a/doc/src/qml/qmlengine.qdoc +++ b/doc/src/qml/qmlengine.qdoc @@ -44,10 +44,10 @@ specified in QML files, plugins, or applications. that provide the essential capabilities for doing this. These are: \list - \o QQmlEngine: A QML engine provides the environment for executing QML code. Every + \li QQmlEngine: A QML engine provides the environment for executing QML code. Every application requires at least one engine instance. - \o QQmlComponent: A component encapsulates QML information. - \o QQmlContext: A context allows an application to expose data to + \li QQmlComponent: A component encapsulates QML information. + \li QQmlContext: A context allows an application to expose data to the QML components created by an engine. \endlist @@ -55,9 +55,9 @@ specified in QML files, plugins, or applications. context, component encapsulation, and visual items. \list - \o QQuickItem - \o QQuickPaintedItem - \o QQuickView + \li QQuickItem + \li QQuickPaintedItem + \li QQuickView \endlist \section2 Declarative Engine @@ -110,11 +110,11 @@ specified in QML files, plugins, or applications. \table \row - \o + \li \snippet doc/src/snippets/qml/qtbinding/loading/main.cpp QQmlComponent-a \dots 0 \snippet doc/src/snippets/qml/qtbinding/loading/main.cpp QQmlComponent-b - \o + \li \snippet doc/src/snippets/qml/qtbinding/loading/main.cpp QQuickView \endtable @@ -195,11 +195,11 @@ specified in QML files, plugins, or applications. \table \row - \o + \li \snippet doc/src/snippets/qml/qtbinding/context-advanced/applicationdata.h 0 \codeline \snippet doc/src/snippets/qml/qtbinding/context-advanced/main.cpp 0 - \o + \li \snippet doc/src/snippets/qml/qtbinding/context-advanced/MyItem.qml 0 \endtable @@ -246,8 +246,8 @@ specified in QML files, plugins, or applications. \table \row - \o \snippet doc/src/snippets/qml/qtbinding/functions-qml/MyItem.qml 0 - \o \snippet doc/src/snippets/qml/qtbinding/functions-qml/main.cpp 0 + \li \snippet doc/src/snippets/qml/qtbinding/functions-qml/MyItem.qml 0 + \li \snippet doc/src/snippets/qml/qtbinding/functions-qml/main.cpp 0 \endtable Notice the Q_RETURN_ARG() and Q_ARG() arguments for @@ -261,9 +261,9 @@ specified in QML files, plugins, or applications. \table \row - \o + \li \snippet doc/src/snippets/qml/qtbinding/functions-cpp/MyItem.qml 0 - \o + \li \snippet doc/src/snippets/qml/qtbinding/functions-cpp/myclass.h 0 \codeline \snippet doc/src/snippets/qml/qtbinding/functions-cpp/main.cpp 0 @@ -288,9 +288,9 @@ specified in QML files, plugins, or applications. \table \row - \o + \li \snippet doc/src/snippets/qml/qtbinding/signals-qml/MyItem.qml 0 - \o + \li \snippet doc/src/snippets/qml/qtbinding/signals-qml/myclass.h 0 \codeline \snippet doc/src/snippets/qml/qtbinding/signals-qml/main.cpp 0 @@ -306,13 +306,13 @@ specified in QML files, plugins, or applications. \table \row - \o + \li \snippet doc/src/snippets/qml/qtbinding/signals-cpp/imageviewer.h start \dots 4 \snippet doc/src/snippets/qml/qtbinding/signals-cpp/imageviewer.h end - \o + \li \snippet doc/src/snippets/qml/qtbinding/signals-cpp/standalone.qml 0 \endtable @@ -331,8 +331,8 @@ specified in QML files, plugins, or applications. \table \row - \o \snippet doc/src/snippets/qml/qtbinding/signals-cpp/main.cpp connections - \o \snippet doc/src/snippets/qml/qtbinding/signals-cpp/MyItem.qml 0 + \li \snippet doc/src/snippets/qml/qtbinding/signals-cpp/main.cpp connections + \li \snippet doc/src/snippets/qml/qtbinding/signals-cpp/MyItem.qml 0 \endtable C++ signals can use enum values as parameters provided that the enum is @@ -381,8 +381,8 @@ specified in QML files, plugins, or applications. \table \row - \o \snippet doc/src/snippets/qml/qtbinding/properties-cpp/applicationdata.h 0 - \o \snippet doc/src/snippets/qml/qtbinding/properties-cpp/MyItem.qml 0 + \li \snippet doc/src/snippets/qml/qtbinding/properties-cpp/applicationdata.h 0 + \li \snippet doc/src/snippets/qml/qtbinding/properties-cpp/MyItem.qml 0 \endtable Notice the \c backgroundColorChanged signal is declared as the NOTIFY signal @@ -438,14 +438,14 @@ specified in QML files, plugins, or applications. return pointers to invalid objects. QML makes the following guarentees: \list - \o An object assigned to a QObject (or QObject-derived) pointer property + \li An object assigned to a QObject (or QObject-derived) pointer property will be valid at the time of assignment. Following assignment, it is the responsibility of the class to subsequently guard this pointer, either through a class specific method or the generic QPointer class. - \o An object assigned to a QVariant will be valid at the time of assignment. + \li An object assigned to a QVariant will be valid at the time of assignment. When assigning an object to a QVariant property, QML will always use a QMetaType::QObjectStar typed QVariant. It is the responsibility of the class @@ -453,7 +453,7 @@ specified in QML files, plugins, or applications. properties is to check the type of the QVariant when it is set and if the type is not handled by your class, reset it to an invalid variant. - \o An object assigned to a QObject (or QObject-derived) list property will + \li An object assigned to a QObject (or QObject-derived) list property will be valid at the time of assignment. Following assignment, it is the responsibility of the class to subsequently diff --git a/doc/src/qml/qmlevents.qdoc b/doc/src/qml/qmlevents.qdoc index 1f2e7a9908..2567dddb2a 100644 --- a/doc/src/qml/qmlevents.qdoc +++ b/doc/src/qml/qmlevents.qdoc @@ -38,8 +38,8 @@ The button may change colors to indicate its state or perform some logic. As well, application needs to know whether the user is clicking the button. The application may need to relay this clicking event to other applications. -QML has a signal and handler mechanism, where the \i signal is the event -and the component responds to the event through the \i handler. The signal +QML has a signal and handler mechanism, where the \e signal is the event +and the component responds to the event through the \e handler. The signal is emitted and the handler is invoked. Placing logic such as scripts or other operations in the handler allows the component to respond to the event. @@ -66,7 +66,7 @@ If the signal has no parameters, the "\c{()}" brackets are optional. If parameters are used, the parameter types must be declared, as for the \c string and \c variant arguments of the \c perform signal. -Adding a signal to an item automatically adds a \i{signal handler} as well. The +Adding a signal to an item automatically adds a \e{signal handler} as well. The signal hander is named \c on<SignalName>, with the first letter of the signal in uppercase. The previous signals have the following signal handlers: \snippet doc/src/snippets/qml/events.qml signal handler declaration diff --git a/doc/src/qml/qmli18n.qdoc b/doc/src/qml/qmli18n.qdoc index 4e546c7ed4..d15beafb38 100644 --- a/doc/src/qml/qmli18n.qdoc +++ b/doc/src/qml/qmli18n.qdoc @@ -47,8 +47,8 @@ QScriptEngine::installTranslatorFunctions(). QML relies on the core internationalization capabilities provided by Qt. These capabilities are described more fully in: \list -\o \l {Internationalization with Qt} -\o \l {Qt Linguist Manual} +\li \l {Internationalization with Qt} +\li \l {Qt Linguist Manual} \endlist You can test a translation with the \l {QML Viewer} using the -translation option. diff --git a/doc/src/qml/qmlintro.qdoc b/doc/src/qml/qmlintro.qdoc index 3290a27bc3..390af69c69 100644 --- a/doc/src/qml/qmlintro.qdoc +++ b/doc/src/qml/qmlintro.qdoc @@ -129,13 +129,13 @@ additional elements are defined inside the light blue rectangle. \e components, often interchangeably. \list -\o When we talk about an \e element, we usually mean the syntactic structure, +\li When we talk about an \e element, we usually mean the syntactic structure, including the name, the opening and closing braces, and its contents. -\o An \e item is an element that has a visual appearance. All items are +\li An \e item is an element that has a visual appearance. All items are elements that inherit \l Item either directly or indirectly. For example, a \l Rectangle is an item, but a \l State is an element because it does not have an intrinsic appearance. -\o A \e component is an element that is defined to be reused. In many cases, +\li A \e component is an element that is defined to be reused. In many cases, components are often items, too. \endlist @@ -333,8 +333,8 @@ the case. Commenting in QML is similar to JavaScript. \list -\o Single line comments start with // and finish at the end of the line. -\o Multi-line comments start with /* and finish with *\/ +\li Single line comments start with // and finish at the end of the line. +\li Multi-line comments start with /* and finish with *\/ \endlist Comments are ignored by the QML engine. They are useful for explaining what @@ -379,15 +379,15 @@ referred to in the JavaScript code, as below: When a property changes value, it can send a signal to notify others of this change. -To receive these signals, simply create a \i{signal handler} named with an +To receive these signals, simply create a \e{signal handler} named with an \e on<Property>Changed syntax. For example, the \l TextInput element has a \l{TextInput::}{text} property. When this property changes, the \c textChanged signal is emitted. We can monitor this property for changes with the \c onTextChanged handler. \table -\header \o Property \o Signal \o Signal Handler -\row \o \l{TextInput::}{text} \o \c textChanged \o \c onTextChanged +\header \li Property \li Signal \li Signal Handler +\row \li \l{TextInput::}{text} \li \c textChanged \li \c onTextChanged \endtable The following code shows this in practice: @@ -720,10 +720,10 @@ of their own; they simply arrange their child items in the space allocated to them. Any background color, if desired, must be added to a parent Rectangle. \list -\o \l{#Row}{Row} arranges its children in a row. -\o \l{#Column}{Column} arranges its children in a column. -\o \l{#Grid}{Grid} arranges its children in a grid. -\o \l{#Flow}{Flow} arranges its children like words on a page. +\li \l{#Row}{Row} arranges its children in a row. +\li \l{#Column}{Column} arranges its children in a column. +\li \l{#Grid}{Grid} arranges its children in a grid. +\li \l{#Flow}{Flow} arranges its children like words on a page. \endlist Each of these items provides many of the same properties as the others, diff --git a/doc/src/qml/qmlnumber.qdoc b/doc/src/qml/qmlnumber.qdoc index 099a619c0e..47dc0338c0 100644 --- a/doc/src/qml/qmlnumber.qdoc +++ b/doc/src/qml/qmlnumber.qdoc @@ -44,11 +44,11 @@ Valid formats are: \list - \o 'f' Decimal floating point, e.g. 248.65 - \o 'e' Scientific notation using e character, e.g. 2.4865e+2 - \o 'E' Scientific notation using E character, e.g. 2.4865E+2 - \o 'g' Use the shorter of e or f - \o 'G' Use the shorter of E or f + \li 'f' Decimal floating point, e.g. 248.65 + \li 'e' Scientific notation using e character, e.g. 2.4865e+2 + \li 'E' Scientific notation using E character, e.g. 2.4865E+2 + \li 'g' Use the shorter of e or f + \li 'G' Use the shorter of E or f \endlist If precision is not specified, the precision will be 2. diff --git a/doc/src/qml/qmlplugins.qdoc b/doc/src/qml/qmlplugins.qdoc index e41bba2906..b81c4c5ae1 100644 --- a/doc/src/qml/qmlplugins.qdoc +++ b/doc/src/qml/qmlplugins.qdoc @@ -43,13 +43,13 @@ To write a QML extension plugin: \list 1 - \o Subclass QQmlExtensionPlugin - \o Implement QQmlExtensionPlugin's + \li Subclass QQmlExtensionPlugin + \li Implement QQmlExtensionPlugin's \l{QQmlExtensionPlugin::}{registerTypes()} method - \o Register types with qmlRegisterType() - \o Export the class using the Q_EXPORT_PLUGIN2() macro - \o Write a project file for the plugin - \o Create a \l{Writing a qmldir file}{qmldir file} to describe the plugin + \li Register types with qmlRegisterType() + \li Export the class using the Q_EXPORT_PLUGIN2() macro + \li Write a project file for the plugin + \li Create a \l{Writing a qmldir file}{qmldir file} to describe the plugin \endlist QML extension plugins are for either application-specific or library-like @@ -122,11 +122,11 @@ \section1 Reference \list - \o \l {Tutorial: Writing QML extensions with C++} - contains a chapter + \li \l {Tutorial: Writing QML extensions with C++} - contains a chapter on creating QML plugins. - \o \l{Creating QML Types} - information about registering C++ types into + \li \l{Creating QML Types} - information about registering C++ types into the runtime. - \o \l{How to Create Qt Plugins} - information about Qt plugins + \li \l{How to Create Qt Plugins} - information about Qt plugins \endlist diff --git a/doc/src/qml/qmlruntime.qdoc b/doc/src/qml/qmlruntime.qdoc index a803fabd7a..e5472aed99 100644 --- a/doc/src/qml/qmlruntime.qdoc +++ b/doc/src/qml/qmlruntime.qdoc @@ -50,8 +50,8 @@ the application. This is done by writing a Qt C++ application that loads the QQmlEngine by either: \list -\o Loading the QML file through a QQuickView instance, or -\o Creating a QQmlEngine instance and loading QML files with QQmlComponent +\li Loading the QML file through a QQuickView instance, or +\li Creating a QQmlEngine instance and loading QML files with QQmlComponent \endlist diff --git a/doc/src/qml/qmlsyntax.qdoc b/doc/src/qml/qmlsyntax.qdoc index 1cd6ad7f46..6dfebb5174 100644 --- a/doc/src/qml/qmlsyntax.qdoc +++ b/doc/src/qml/qmlsyntax.qdoc @@ -103,7 +103,7 @@ Rotation { \endcode These expressions can include references to other objects and properties, in which case -a \i binding is established: when the value of the expression changes, the property the +a \e binding is established: when the value of the expression changes, the property the expression has been assigned to is automatically updated to that value. \code @@ -122,15 +122,15 @@ Item { In the example above, the \c text2 object will display the same text as \c text1. If \c text1 is changed, \c text2 is automatically changed to the same value. -Note that to refer to other objects, we use their \i id values. (See below for more -information on the \i id property.) +Note that to refer to other objects, we use their \e id values. (See below for more +information on the \e id property.) \section1 QML Comments Commenting in QML is similar to JavaScript. \list -\o Single line comments start with // and finish at the end of the line. -\o Multiline comments start with /* and finish with *\/ +\li Single line comments start with // and finish at the end of the line. +\li Multiline comments start with /* and finish with *\/ \endlist \snippet doc/src/snippets/qml/comments.qml 0 diff --git a/doc/src/qml/qmltypes.qdoc b/doc/src/qml/qmltypes.qdoc index 9555e54f7e..ae4ad47c3d 100644 --- a/doc/src/qml/qmltypes.qdoc +++ b/doc/src/qml/qmltypes.qdoc @@ -70,14 +70,14 @@ int qmlRegisterType(const char *uri, int versionMajor, int versionMinor, const c Alternatively, these functions provide a way for other types of C++ types to be visible in the QML context. \list - \o \l qmlRegisterUncreatableType() is suited for attached + \li \l qmlRegisterUncreatableType() is suited for attached properties and enum types. - \o \l qmlRegisterTypeNotAvailable() is for + \li \l qmlRegisterTypeNotAvailable() is for reserving a namespace and suited for generating useful errors. - \o \l qmlRegisterInterface() - for registering base or abstract classes for + \li \l qmlRegisterInterface() - for registering base or abstract classes for \l{qml-c++-coercion}{coercion and inheritance}. This is useful for general Qt objects or \l{Qt Objects and Interfaces}{pointers} to objects. - \o \l qmlRegisterExtendedType() - for \l{qml-c++-extension}{extended types} + \li \l qmlRegisterExtendedType() - for \l{qml-c++-extension}{extended types} \endlist \section2 Qt Objects and Interfaces @@ -119,7 +119,7 @@ int qmlRegisterType(const char *uri, int versionMajor, int versionMinor, const c \l{The Property System}{Property System} and in effect, QML \l{Property Binding in QML}{property bindings} also use Qt properties. - Essentially, a Qt C++ property has a \i write function, \i read function, + Essentially, a Qt C++ property has a \e write function, \e read function, and has a signal function. QML properties are inheritely public, both readable and writable, albeit type-safe. QML properties may also have signals which are emitted when the property value or binding changes. @@ -154,7 +154,7 @@ Q_PROPERTY(int size READ size WRITE setSize NOTIFY shoeChanged) QML}{JavaScript expressions} can perform clean-up operations or call other functions. - \bold{Note:} The QML signal handler will always be named + \b{Note:} The QML signal handler will always be named on<Property-name>Changed, regardless of the name used for the NOTIFY signal in C++. We recommend using <property-name>Changed() for the NOTIFY signal in C++. @@ -224,9 +224,9 @@ Q_PROPERTY(int size READ size CONSTANT) \section2 Attached Properties Attached properties annotate or add properties to another type or component. - For example, the \l Keys \i{attaching type} contains \i{attached properties} + For example, the \l Keys \e{attaching type} contains \e{attached properties} that other elements may use to respond to key input. Conceptually, attached - properties are a \i type exporting a set of additional properties that can + properties are a \e type exporting a set of additional properties that can be set on any other object instance. The attaching type is a QObject derived type. The properties on the @@ -344,7 +344,7 @@ Q_PROPERTY(int size READ size CONSTANT) \snippet examples/declarative/cppextensions/referenceexamples/properties/example.qml 0 - The \c guests property is a \i{list property} of \c Person objects. A list + The \c guests property is a \e{list property} of \c Person objects. A list of \c Person objects are bound to the \c BirthdayParty's \c host property, and assigns three \c Person objects to the guests property. @@ -370,11 +370,11 @@ Q_PROPERTY(int size READ size CONSTANT) Array types. In particular, QML currently supports: \list - \o \c {QList<int>} - \o \c {QList<qreal>} - \o \c {QList<bool>} - \o \c {QList<QString>} and \c{QStringList} - \o \c {QList<QUrl>} + \li \c {QList<int>} + \li \c {QList<qreal>} + \li \c {QList<bool>} + \li \c {QList<QString>} and \c{QStringList} + \li \c {QList<QUrl>} \endlist These sequence types are implemented directly in terms of the underlying C++ @@ -398,7 +398,7 @@ Q_PROPERTY(int size READ size CONSTANT) instance of any other sequence type will be passed between QML and C++ as an opaque QVariantList. - \bold {Important Note:} There are some minor differences between the + \b {Important Note:} There are some minor differences between the semantics of such sequence Array types and default JavaScript Array types which result from the use of a C++ storage type in the implementation. In particular, deleting an element from an Array will result in a @@ -412,11 +412,11 @@ Q_PROPERTY(int size READ size CONSTANT) The default-constructed values for each sequence type are as follows: \table - \row \o QList<int> \o integer value 0 - \row \o QList<qreal> \o real value 0.0 - \row \o QList<bool> \o boolean value \c {false} - \row \o QList<QString> and QStringList \o empty QString - \row \o QList<QUrl> \o empty QUrl + \row \li QList<int> \li integer value 0 + \row \li QList<qreal> \li real value 0.0 + \row \li QList<bool> \li boolean value \c {false} + \row \li QList<QString> and QStringList \li empty QString + \row \li QList<QUrl> \li empty QUrl \endtable If you wish to remove elements from a sequence rather than simply replace @@ -454,7 +454,7 @@ Q_PROPERTY(int size READ size CONSTANT) scenario. Consider a custom type, \c TestElement, that has two properties, \c a and - \c b. Property \c a does \i not have a NOTIFY signal, and property \c b does + \c b. Property \c a does \e not have a NOTIFY signal, and property \c b does have a NOTIFY signal. \code @@ -490,7 +490,7 @@ Q_PROPERTY(int size READ size CONSTANT) A \l{signals and slots}{signal} in Qt C++ is readily available as a \l{QML Signal and Handler Event System}{QML signal}. A signal will have - a corresponding signal \i{handler}, created automatically. The handler + a corresponding signal \e{handler}, created automatically. The handler name will have \c on prepended at the beginning of the name. The first character of the signal is uppercased for the signal handler. The signal parameter is also availabe to the QML signal. @@ -513,9 +513,9 @@ Q_PROPERTY(int size READ size CONSTANT) \l {Connections} element. Additionally, if a property is added to a C++ class, all QML elements - based on that C++ class will have a \i{value-changed} signal handler + based on that C++ class will have a \e{value-changed} signal handler for that property. The name of the signal handler is - \i{on<Property-name>Changed}, with the first letter of the property + \e{on<Property-name>Changed}, with the first letter of the property name being upper case. The \l {Extending QML - Signal Support Example}{Signal Support Example} @@ -699,10 +699,10 @@ Q_PROPERTY(int size READ size CONSTANT) other concerns, extension objects allow limited extension possibilities without direct modifications. - \i{Extension objects} add additional properties to an existing type. + \e{Extension objects} add additional properties to an existing type. Extension objects can only add properties, not signals or methods. An extended type definition allows the programmer to supply an additional type, - known as the \i{extension type}, when registering the class. The + known as the \e{extension type}, when registering the class. The properties are transparently merged with the original target class when used from within QML. diff --git a/doc/src/qml/qmlviewer.qdoc b/doc/src/qml/qmlviewer.qdoc index 9006a053fc..04c6b42966 100644 --- a/doc/src/qml/qmlviewer.qdoc +++ b/doc/src/qml/qmlviewer.qdoc @@ -38,7 +38,7 @@ runtime to load QML documents and also includes additional features useful for the development of QML-based applications. The QML Viewer is a tool for testing and developing QML applications. It is -\i not intended for use in a production environment and should not be used for the +\e not intended for use in a production environment and should not be used for the deployment of QML applications. In those cases, the QML runtime should be invoked from a Qt application instead; see \l {Qt Declarative UI Runtime} for more information. @@ -172,9 +172,9 @@ information about the application's runtime environment through the following pr \table \row -\o \c runtime.isActiveWindow +\li \c runtime.isActiveWindow -\o This property indicates whether the QML Viewer window is the current active +\li This property indicates whether the QML Viewer window is the current active window on the system. It is useful for "pausing" an application, particularly animations, when the QML Viewer loses focus or moves to the background. @@ -193,22 +193,22 @@ Rectangle { } \endqml -\bold{Note:} Since Qt Quick 1.1 this information is accessible outside of the QML Viewer, +\b{Note:} Since Qt Quick 1.1 this information is accessible outside of the QML Viewer, through the \c active property of the \l {QML:Qt::application}{Qt.application} object. \row -\o \c runtime.orientation +\li \c runtime.orientation -\o This property indicates the current orientation of the QML Viewer. +\li This property indicates the current orientation of the QML Viewer. This indicates the orientation currently selected in the QML Viewer's -\i {Settings -> Properties} menu. The \c orientation value can be one of the following: +\e {Settings -> Properties} menu. The \c orientation value can be one of the following: \list -\o \c Orientation.Portrait -\o \c Orientation.Landscape -\o \c Orientation.PortraitInverted (Portrait orientation, upside-down) -\o \c Orientation.LandscapeInverted (Landscape orientation, upside-down) +\li \c Orientation.Portrait +\li \c Orientation.Landscape +\li \c Orientation.PortraitInverted (Portrait orientation, upside-down) +\li \c Orientation.LandscapeInverted (Landscape orientation, upside-down) \endlist When the viewer's orientation changes, the appearance of the loaded QML document diff --git a/doc/src/qml/qtbinding.qdoc b/doc/src/qml/qtbinding.qdoc index 7410836e9c..b480d1292f 100644 --- a/doc/src/qml/qtbinding.qdoc +++ b/doc/src/qml/qtbinding.qdoc @@ -40,11 +40,11 @@ reusable QML components for distribution. You may want to mix QML and C++ for a number of reasons. For example: \list -\o To use functionality defined in a C++ source (for example, when using a C++ Qt-based data model, or +\li To use functionality defined in a C++ source (for example, when using a C++ Qt-based data model, or calling functions in a third-party C++ library) -\o To access functionality in the Qt Declarative module (for example, to dynamically generate +\li To access functionality in the Qt Declarative module (for example, to dynamically generate images using QQmlImageProvider) -\o To write your own QML elements (whether for your applications, or for distribution to others) +\li To write your own QML elements (whether for your applications, or for distribution to others) \endlist To use the Qt Declarative module, you must include and link to the module appropriately, as shown on @@ -59,10 +59,10 @@ embedding QML into C++ applications. There are several core classes in the Qt De that provide the essential capabilities for doing this. These are: \list -\o QQmlEngine: A QML engine provides the environment for executing QML code. Every +\li QQmlEngine: A QML engine provides the environment for executing QML code. Every application requires at least one engine instance. -\o QQmlComponent: A component encapsulates a \l{QML Documents}{QML document}. -\o QQmlContext: A context allows an application to expose data to the QML components +\li QQmlComponent: A component encapsulates a \l{QML Documents}{QML document}. +\li QQmlContext: A context allows an application to expose data to the QML components created by an engine. \endlist @@ -95,10 +95,10 @@ UI code}.) There are a number of ways to extend your QML application through C++. For example, you could: \list -\o Load a QML component and manipulate it (or its children) from C++ -\o Embed a C++ object and its properties directly into a QML component (for example, to make a +\li Load a QML component and manipulate it (or its children) from C++ +\li Embed a C++ object and its properties directly into a QML component (for example, to make a particular C++ object callable from QML, or to replace a dummy list model with a real data set) -\o Define new QML elements (through QObject-based C++ classes) and create them directly from your +\li Define new QML elements (through QObject-based C++ classes) and create them directly from your QML code \endlist @@ -125,11 +125,11 @@ component, which is accessible via QQuickView::rootObject(): \table \row -\o +\li \snippet doc/src/snippets/qml/qtbinding/loading/main.cpp QQmlComponent-a \dots 0 \snippet doc/src/snippets/qml/qtbinding/loading/main.cpp QQmlComponent-b -\o +\li \snippet doc/src/snippets/qml/qtbinding/loading/main.cpp QQuickView \endtable @@ -201,11 +201,11 @@ invokes a method on the object instance: \table \row -\o +\li \snippet doc/src/snippets/qml/qtbinding/context-advanced/applicationdata.h 0 \codeline \snippet doc/src/snippets/qml/qtbinding/context-advanced/main.cpp 0 -\o +\li \snippet doc/src/snippets/qml/qtbinding/context-advanced/MyItem.qml 0 \endtable @@ -286,8 +286,8 @@ QMetaObject::invokeMethod(). Here is a C++ application that uses this to call a \table \row -\o \snippet doc/src/snippets/qml/qtbinding/functions-qml/MyItem.qml 0 -\o \snippet doc/src/snippets/qml/qtbinding/functions-qml/main.cpp 0 +\li \snippet doc/src/snippets/qml/qtbinding/functions-qml/MyItem.qml 0 +\li \snippet doc/src/snippets/qml/qtbinding/functions-qml/main.cpp 0 \endtable Notice the Q_RETURN_ARG() and Q_ARG() arguments for QMetaObject::invokeMethod() must be specified as @@ -299,9 +299,9 @@ methods on the \c myObject object, which has been set using QQmlContext::setCont \table \row -\o +\li \snippet doc/src/snippets/qml/qtbinding/functions-cpp/MyItem.qml 0 -\o +\li \snippet doc/src/snippets/qml/qtbinding/functions-cpp/myclass.h 0 \codeline \snippet doc/src/snippets/qml/qtbinding/functions-cpp/main.cpp 0 @@ -324,9 +324,9 @@ is emitted: \table \row -\o +\li \snippet doc/src/snippets/qml/qtbinding/signals-qml/MyItem.qml 0 -\o +\li \snippet doc/src/snippets/qml/qtbinding/signals-qml/myclass.h 0 \codeline \snippet doc/src/snippets/qml/qtbinding/signals-qml/main.cpp 0 @@ -340,13 +340,13 @@ C++ object are connected to through \c onImagedChanged and \c onLoadingError sig \table \row -\o +\li \snippet doc/src/snippets/qml/qtbinding/signals-cpp/imageviewer.h start \dots 4 \snippet doc/src/snippets/qml/qtbinding/signals-cpp/imageviewer.h end -\o +\li \snippet doc/src/snippets/qml/qtbinding/signals-cpp/standalone.qml 0 \endtable @@ -362,8 +362,8 @@ instead to create the signal handler: \table \row -\o \snippet doc/src/snippets/qml/qtbinding/signals-cpp/main.cpp connections -\o \snippet doc/src/snippets/qml/qtbinding/signals-cpp/MyItem.qml 0 +\li \snippet doc/src/snippets/qml/qtbinding/signals-cpp/main.cpp connections +\li \snippet doc/src/snippets/qml/qtbinding/signals-cpp/MyItem.qml 0 \endtable C++ signals can use enum values as parameters provided that the enum is declared in the @@ -410,8 +410,8 @@ property. This property can be written to and read from QML: \table \row -\o \snippet doc/src/snippets/qml/qtbinding/properties-cpp/applicationdata.h 0 -\o \snippet doc/src/snippets/qml/qtbinding/properties-cpp/MyItem.qml 0 +\li \snippet doc/src/snippets/qml/qtbinding/properties-cpp/applicationdata.h 0 +\li \snippet doc/src/snippets/qml/qtbinding/properties-cpp/MyItem.qml 0 \endtable Notice the \c backgroundColorChanged signal is declared as the NOTIFY signal for the @@ -432,20 +432,20 @@ functions - must be of a type that is recognizable by QML. By default, QML recognizes the following data types: \list -\o bool -\o unsigned int, int -\o float, double, qreal -\o QString -\o QUrl -\o QColor -\o QDate, QTime, QDateTime -\o QPoint, QPointF -\o QSize, QSizeF -\o QRect, QRectF -\o QVariant -\o QVariantList, QVariantMap -\o QObject* -\o Enumerations declared with Q_ENUMS() +\li bool +\li unsigned int, int +\li float, double, qreal +\li QString +\li QUrl +\li QColor +\li QDate, QTime, QDateTime +\li QPoint, QPointF +\li QSize, QSizeF +\li QRect, QRectF +\li QVariant +\li QVariantList, QVariantMap +\li QObject* +\li Enumerations declared with Q_ENUMS() \endlist To allow a custom C++ type to be created or used in QML, the C++ class must be registered as a QML @@ -464,12 +464,12 @@ converted to JavaScript array and object values, repectively: \table \header -\o Type -\o String format -\o Example +\li Type +\li String format +\li Example \row -\o \snippet doc/src/snippets/qml/qtbinding/variantlistmap/MyItem.qml 0 -\o \snippet doc/src/snippets/qml/qtbinding/variantlistmap/main.cpp 0 +\li \snippet doc/src/snippets/qml/qtbinding/variantlistmap/MyItem.qml 0 +\li \snippet doc/src/snippets/qml/qtbinding/variantlistmap/main.cpp 0 \endtable This produces output like: @@ -535,45 +535,45 @@ pass simple values from QML to C++. \table \header -\o Type -\o String format -\o Example +\li Type +\li String format +\li Example \row -\o QColor -\o Color name, "#RRGGBB", "#RRGGBBAA" -\o "red", "#ff0000", "#ff000000" +\li QColor +\li Color name, "#RRGGBB", "#RRGGBBAA" +\li "red", "#ff0000", "#ff000000" \row -\o QDate -\o "YYYY-MM-DD" -\o "2010-05-31" +\li QDate +\li "YYYY-MM-DD" +\li "2010-05-31" \row -\o QPoint -\o "x,y" -\o "10,20" +\li QPoint +\li "x,y" +\li "10,20" \row -\o QRect -\o "x,y,WidthxHeight" -\o "50,50,100x100" +\li QRect +\li "x,y,WidthxHeight" +\li "50,50,100x100" \row -\o QSize -\o "WidthxHeight" -\o "100x200" +\li QSize +\li "WidthxHeight" +\li "100x200" \row -\o QTime -\o "hh:mm:ss" -\o "14:22:55" +\li QTime +\li "hh:mm:ss" +\li "14:22:55" \row -\o QUrl -\o URL string -\o "http://www.example.com" +\li QUrl +\li URL string +\li "http://www.example.com" \row -\o QVector3D -\o "x,y,z" -\o "0,1,0" +\li QVector3D +\li "x,y,z" +\li "0,1,0" \row -\o Enumeration value -\o Enum value name -\o "AlignRight" +\li Enumeration value +\li Enum value name +\li "AlignRight" \endtable (More details on these string formats and types can be found in the @@ -615,16 +615,16 @@ in order to update the resources in the package. To use the resource system in a mixed QML/C++ application: \list -\o Create a \c .qrc \l {The Qt Resource System}{resource collection file} that lists resource +\li Create a \c .qrc \l {The Qt Resource System}{resource collection file} that lists resource files in XML format -\o From C++, load the main QML file as a resource using the \c :/ prefix or as a URL with the +\li From C++, load the main QML file as a resource using the \c :/ prefix or as a URL with the \c qrc scheme \endlist Once this is done, all files specified by relative paths in QML will be loaded from the resource system instead. Use of the resource system is completely transparent to the QML layer; this means all QML code should refer to resource files using relative -paths and should \i not use the \c qrc scheme. This scheme should only be used from +paths and should \e not use the \c qrc scheme. This scheme should only be used from C++ code for referring to resource files. Here is a application packaged using the \l {The Qt Resource System}{Qt resource system}. diff --git a/doc/src/qml/qtdeclarative.qdoc b/doc/src/qml/qtdeclarative.qdoc index 9d14f7fc57..20d1c40d66 100644 --- a/doc/src/qml/qtdeclarative.qdoc +++ b/doc/src/qml/qtdeclarative.qdoc @@ -95,7 +95,7 @@ int qmlRegisterType(const char *uri, int versionMajor, int versionMinor, const char *qmlName); \endcode - The former is the standard form which registers the type \i T as a new type. + The former is the standard form which registers the type \e T as a new type. The latter allows a particular revision of a class to be registered in a specified version (see \l {QML Type Versioning}). @@ -245,7 +245,7 @@ may be registered into any given namespace (combination of \a uri, \a versionMajor and \a versionMinor). This function should be used to register a module API provider function which returns a QJSValue as a module API. - \bold{NOTE:} QJSValue module API properties will \bold{not} trigger binding re-evaluation if changed. + \b{NOTE:} QJSValue module API properties will \b{not} trigger binding re-evaluation if changed. Usage: \code diff --git a/doc/src/qml/qtjavascript.qdoc b/doc/src/qml/qtjavascript.qdoc index 394435f77b..0775730dd3 100644 --- a/doc/src/qml/qtjavascript.qdoc +++ b/doc/src/qml/qtjavascript.qdoc @@ -64,7 +64,7 @@ Custom properties can be made available to scripts by registering them with the script engine. This is most easily done by setting - properties of the script engine's \i{Global Object}: + properties of the script engine's \e{Global Object}: \snippet doc/src/snippets/qtjavascript/registeringvalues/main.cpp 0 diff --git a/doc/src/qml/qtprogrammers.qdoc b/doc/src/qml/qtprogrammers.qdoc index 9338a2c29f..fd47d9bf58 100644 --- a/doc/src/qml/qtprogrammers.qdoc +++ b/doc/src/qml/qtprogrammers.qdoc @@ -31,7 +31,7 @@ \title QML for Qt Programmers \brief learning QML for programmers with Qt knowledge -While QML does not require Qt knowledge to use, if you \i are already familiar with Qt, +While QML does not require Qt knowledge to use, if you \e are already familiar with Qt, much of your knowledge is directly relevant to learning and using QML. Of course, an application with a user interface defined in QML also uses Qt for all the non-UI logic. @@ -41,14 +41,14 @@ logic. QML provides direct access to the following concepts from Qt: \list - \o QAction - the \l {QML Basic Types}{action} type - \o QObject signals and slots - available as functions to call in JavaScript - \o QObject properties - available as variables in JavaScript - \o QWidget - QQuickView is a QML-displaying widget - \o Qt models - used directly in data binding (QAbstractItemModel) + \li QAction - the \l {QML Basic Types}{action} type + \li QObject signals and slots - available as functions to call in JavaScript + \li QObject properties - available as variables in JavaScript + \li QWidget - QQuickView is a QML-displaying widget + \li Qt models - used directly in data binding (QAbstractItemModel) \endlist -Qt knowledge is \i required for \l{Extending QML with C++}, +Qt knowledge is \e required for \l{Extending QML with C++}, and also for \l{Integrating QML Code with existing Qt UI code}. \section1 QML Items Compared with Widgets @@ -60,10 +60,10 @@ look and feel of view delegates, QML Items can be used for this as well. There are three structurally different types of widget: \list - \o Simple widgets that are not used as parents (QLabel, QCheckBox, QToolButton, etc.) - \o Parent widgets that are normally used as parents to other widgets (QGroupBox, + \li Simple widgets that are not used as parents (QLabel, QCheckBox, QToolButton, etc.) + \li Parent widgets that are normally used as parents to other widgets (QGroupBox, QStackedWidget, QTabWidget, etc.) - \o Compound widgets that are internally composed of child widgets (QComboBox, + \li Compound widgets that are internally composed of child widgets (QComboBox, QSpinBox, QFileDialog, QTabWidget, etc.) \endlist @@ -128,9 +128,9 @@ requirement that they be wholly contained ("clipped") to the parent (although th This difference has rather far-reaching consequences, for example: \list -\o A shadow or highlight around a widget could be a child of that widget. -\o Particle effects can flow outside the object where they originate. -\o Transitioning animations can "hide" items by visibly moving them beyond +\li A shadow or highlight around a widget could be a child of that widget. +\li Particle effects can flow outside the object where they originate. +\li Transitioning animations can "hide" items by visibly moving them beyond the screen bounds. \endlist diff --git a/doc/src/qml/scope.qdoc b/doc/src/qml/scope.qdoc index 649653f9e3..15cebc735d 100644 --- a/doc/src/qml/scope.qdoc +++ b/doc/src/qml/scope.qdoc @@ -128,7 +128,7 @@ require the use of the JavaScript \c this property. Care must be used when accessing \l {Attached Properties} from bindings due to their interaction with the scope object. Conceptually attached properties -exist on \i all objects, even if they only have an effect on a subset of those. +exist on \e all objects, even if they only have an effect on a subset of those. Consequently unqualified attached property reads will always resolve to an attached property on the scope object, which is not always what the programmer intended. diff --git a/doc/src/qml/security.qdoc b/doc/src/qml/security.qdoc index 262e560d33..190d6930c5 100644 --- a/doc/src/qml/security.qdoc +++ b/doc/src/qml/security.qdoc @@ -61,21 +61,21 @@ perform appropriate checks on untrusted data it loads. A non-exhaustive list of the ways you could shoot yourself in the foot is: \list - \i Using \c import to import QML or JavaScript you do not control. BAD - \i Using \l Loader to import QML you do not control. BAD - \i Using \l{XMLHttpRequest}{XMLHttpRequest} to load data you do not control and executing it. BAD + \li Using \c import to import QML or JavaScript you do not control. BAD + \li Using \l Loader to import QML you do not control. BAD + \li Using \l{XMLHttpRequest}{XMLHttpRequest} to load data you do not control and executing it. BAD \endlist However, the above does not mean that you have no use for the network transparency of QML. -There are many good and useful things you \i can do: +There are many good and useful things you \e can do: \list - \i Create \l Image elements with source URLs of any online images. GOOD - \i Use XmlListModel to present online content. GOOD - \i Use \l{XMLHttpRequest}{XMLHttpRequest} to interact with online services. GOOD + \li Create \l Image elements with source URLs of any online images. GOOD + \li Use XmlListModel to present online content. GOOD + \li Use \l{XMLHttpRequest}{XMLHttpRequest} to interact with online services. GOOD \endlist -The only reason this page is necessary at all is that JavaScript, when run in a \i{web browser}, +The only reason this page is necessary at all is that JavaScript, when run in a \e{web browser}, has quite many restrictions. With QML, you should neither rely on similar restrictions, nor worry about working around them. */ |