diff options
author | David Boddie <david.boddie@nokia.com> | 2011-05-10 19:50:33 +0200 |
---|---|---|
committer | David Boddie <david.boddie@nokia.com> | 2011-05-11 17:36:22 +0200 |
commit | 520e8e3cfe19fb9a49b2cf80dd2376aa2b80f1e5 (patch) | |
tree | adefe2e3c1d4224de6a7a53c64bcfeeaa1fc99eb /doc | |
parent | a016b739224f8a322d46693af425ef10ee8ad018 (diff) | |
download | qt4-tools-520e8e3cfe19fb9a49b2cf80dd2376aa2b80f1e5.tar.gz |
Doc: Various fixes to documentation, some based on changes in master.
Diffstat (limited to 'doc')
-rw-r--r-- | doc/src/declarative/qtbinding.qdoc | 26 | ||||
-rw-r--r-- | doc/src/declarative/righttoleft.qdoc | 2 | ||||
-rw-r--r-- | doc/src/declarative/whatsnew.qdoc | 38 | ||||
-rw-r--r-- | doc/src/development/qmake-manual.qdoc | 4 | ||||
-rw-r--r-- | doc/src/examples/codeeditor.qdoc | 4 | ||||
-rw-r--r-- | doc/src/examples/syntaxhighlighter.qdoc | 10 | ||||
-rw-r--r-- | doc/src/getting-started/examples.qdoc | 7 |
7 files changed, 57 insertions, 34 deletions
diff --git a/doc/src/declarative/qtbinding.qdoc b/doc/src/declarative/qtbinding.qdoc index 02d88ae360..da87db23e1 100644 --- a/doc/src/declarative/qtbinding.qdoc +++ b/doc/src/declarative/qtbinding.qdoc @@ -108,7 +108,7 @@ These methods are shown below. Naturally these approaches are not exclusive; you these methods throughout your application as appropriate. -\section2 Loading QML components from C++ +\section2 Loading QML Components from C++ A QML document can be loaded with QDeclarativeComponent or QDeclarativeView. QDeclarativeComponent loads a QML component as a C++ object; QDeclarativeView also does this, @@ -180,7 +180,7 @@ required \c objectName. It is better for the C++ implementation to know as littl the QML user interface implementation and the composition of the QML object tree. -\section2 Embedding C++ objects into QML components +\section2 Embedding C++ Objects into QML Components When loading a QML scene into a C++ application, it can be useful to directly embed C++ data into the QML object. QDeclarativeContext enables this by exposing data to the context of a QML @@ -231,7 +231,7 @@ in QML views. Also see the QDeclarativeContext documentation for more information. -\section2 Defining new QML elements +\section2 Defining New QML Elements While new QML elements can be \l {Defining New Components}{defined in QML}, they can also be defined by C++ classes; in fact, many of the core \l {QML Elements} are implemented through @@ -270,7 +270,7 @@ For more information on defining new QML elements, see the \l {Tutorial: Writing -\section1 Exchanging data between QML and C++ +\section1 Exchanging Data between QML and C++ QML and C++ objects can communicate with one another through signals, slots and property modifications. For a C++ object, any data that is exposed to Qt's \l{The Meta-Object System}{Meta-Object System} @@ -279,7 +279,7 @@ the QML side, all QML object data is automatically made available to the meta-ob be accessed from C++. -\section2 Calling functions +\section2 Calling Functions QML functions can be called from C++ and vice-versa. @@ -314,7 +314,7 @@ same name but different arguments, the correct function will be called according the types of arguments that are provided. -\section2 Receiving signals +\section2 Receiving Signals All QML signals are automatically available to C++, and can be connected to using QObject::connect() like any ordinary Qt C++ signal. In return, any C++ signal can be received by a QML object using @@ -373,7 +373,7 @@ class that is emitting the signal, and that the enum is registered using Q_ENUMS See \l {Using enumerations of a custom type} below for details. -\section2 Modifying properties +\section2 Modifying Properties Any properties declared in a QML object are automatically accessible from C++. Given a QML item like this: @@ -454,7 +454,7 @@ To allow a custom C++ type to be created or used in QML, the C++ class must be r type using qmlRegisterType(), as shown in the \l {Defining new QML elements} section above. -\section2 JavaScript arrays and objects +\section2 JavaScript Arrays and Objects There is built-in support for automatic type conversion between QVariantList and JavaScript arrays, and QVariantMap and JavaScript objects. @@ -489,7 +489,7 @@ parameter, the value can be created as a JavaScript array or object in the QML side, and is automatically converted to a QVariantList or QVariantMap when it is passed to C++. -\section2 Using enumerations of a custom type +\section2 Using Enumerations of a Custom Type To use an enumeration from a custom C++ component, the enumeration must be declared with Q_ENUMS() to register it with Qt's meta object system. For example, the following C++ type has a \c Status enum: @@ -511,22 +511,22 @@ the \l {Extending QML Functionalities using C++} reference documentation for more information. -\section2 Using enumeration values as signal parameters +\section2 Using Enumeration Values as Signal Parameters C++ signals may pass enumeration values as signal parameters to QML, providing that the enumeration and the signal are declared within the same class, or that the enumeration value is one of those declared in the \l {Qt}{Qt Namespace}. Additionally, if a C++ signal with an enum parameter should be connectable to a QML function using the -\l {Connecting signals to methods and other signals}{connect()} function, the enum type must be -registered using qRegisterMetaType(). +\l{QML Signal and Handler Event System#Connecting Signals to Methods and Signals}{connect()} +function, the enum type must be registered using qRegisterMetaType(). For QML signals, enum values may be used as signal parameters using the \c int type: \snippet doc/src/snippets/declarative/qtbinding/enums/standalone.qml 1 -\section2 Automatic type conversion from strings +\section2 Automatic Type Conversion from Strings As a convenience, some basic types can be specified in QML using format strings to make it easier to pass simple values from QML to C++. diff --git a/doc/src/declarative/righttoleft.qdoc b/doc/src/declarative/righttoleft.qdoc index 7db61367b5..89e5147e5f 100644 --- a/doc/src/declarative/righttoleft.qdoc +++ b/doc/src/declarative/righttoleft.qdoc @@ -106,7 +106,7 @@ Applying mirroring in this manner does not change the actual value of the releva direction of positioners and model views that takes the mirroring into account. Similarly the \l Text, \l TextInput and \l TextEdit elements have gained the read-only property \c effectiveHorizontalAlignment for querying the effective visual alignment of text. For anchors, the read only -\l {Item::anchors}{anchors.mirrored} property reflects whether anchors have been mirrored. +\l {Item::anchors.top}{anchors.mirrored} property reflects whether anchors have been mirrored. Note that application layouts and animations that are defined using \l {Item::}{x} property values (as opposed to anchors or positioner elements) are not affected by the \l LayoutMirroring attached property. diff --git a/doc/src/declarative/whatsnew.qdoc b/doc/src/declarative/whatsnew.qdoc index 6eb1548ab2..69c88777ed 100644 --- a/doc/src/declarative/whatsnew.qdoc +++ b/doc/src/declarative/whatsnew.qdoc @@ -26,12 +26,13 @@ ****************************************************************************/ /*! -\title What's new in Qt Quick +\title What's New in Qt Quick \page qtquick-whatsnew.html \section1 Qt 4.7.4 includes QtQuick 1.1 -QtQuick 1.1 is a minor feature update. \e {import QtQuick 1.1} to use the new features. +QtQuick 1.1 is a minor feature update. \e {import QtQuick 1.1} to use the new +features. \section2 PinchArea @@ -39,7 +40,9 @@ PinchArea provides support for the common two finger pinch gesture. \section2 LayoutMirroring attached property -\l {LayoutMirroring}{Layout mirroring} is useful when you need to support both left-to-right and right-to-left layout versions of your application that target different language areas. +\l {LayoutMirroring}{Layout mirroring} is useful when you need to support both +left-to-right and right-to-left layout versions of your application that target +different language areas. \section2 Anchors @@ -150,21 +153,21 @@ Added the following methods and signal handlers: \section2 Component \list -\o The \l{Component::}{createObject()} method now accepts a map of initial property values for -the created object. +\o The \l{Component::}{createObject()} method now accepts a map of initial +property values for the created object. \endlist \section2 Qt \list -\o Added the \l {QML:Qt::application}{Qt.application} object to hold generic global application -properties. +\o Added the \l {QML:Qt::application}{Qt.application} object to hold generic +global application properties. \endlist \section2 Other changes \list -\o Functions can be \l{Binding Properties from JavaScript}{assigned to properties from JavaScript} +\o Functions can be \l{Property Binding#Property Binding}{assigned to properties from JavaScript} to create property bindings. \o QtQuick now supports Right to Left layout in positioners, views, anchors and text elements. \endlist @@ -174,13 +177,14 @@ to create property bindings. \section2 QtQuick namespace -In prior Qt releases, all the Qt Quick elements were available in the \e Qt namespace. -Starting with Qt 4.7.1, the elements are also available in the \e QtQuick namespace, -which improves naming consistency, and allows the development of Qt Quick to occur at -a faster rate than Qt's usual minor release schedule. +In prior Qt releases, all the Qt Quick elements were available in the \e Qt +namespace. Starting with Qt 4.7.1, the elements are also available in the +\e QtQuick namespace, which improves naming consistency, and allows the +development of Qt Quick to occur at a faster rate than Qt's usual minor release +schedule. -The change for developers is very simple - where you previously wrote \e {import Qt 4.7}, -just replace it with \e {import QtQuick 1.0}, like this: +The change for developers is very simple - where you previously wrote +\e {import Qt 4.7}, just replace it with \e {import QtQuick 1.0}, like this: \code import QtQuick 1.0 @@ -190,7 +194,7 @@ Text { } \endcode -\e {import Qt 4.7} continues to work so existing applications wont break even if they -aren't updated, but it is recommended that all import statements be modified to the new -form. +\e {import Qt 4.7} continues to work so existing applications won't break even +if they aren't updated, but it is recommended that all import statements be +modified to the new form. */ diff --git a/doc/src/development/qmake-manual.qdoc b/doc/src/development/qmake-manual.qdoc index 65879b3a02..494d129435 100644 --- a/doc/src/development/qmake-manual.qdoc +++ b/doc/src/development/qmake-manual.qdoc @@ -3512,11 +3512,11 @@ This can be useful to optionally enable or disable features. For example: - \snippet doc/src/snippets/code/doc_src_qmake-manual.qdoc 157 + \snippet doc/src/snippets/code/doc_src_qmake-manual.pro 157 And then, in the code: - \snippet doc/src/snippets/code/doc_src_qmake-manual.qdoc 158 + \snippet doc/src/snippets/code/doc_src_qmake-manual.pro 158 \section1 basename(variablename) diff --git a/doc/src/examples/codeeditor.qdoc b/doc/src/examples/codeeditor.qdoc index 23a2fd4140..c4c72c0278 100644 --- a/doc/src/examples/codeeditor.qdoc +++ b/doc/src/examples/codeeditor.qdoc @@ -190,6 +190,8 @@ used to implement parenthesis matching. In the \c highlightCurrentLine(), the data of the currentBlock() can be fetched with QTextBlock::userData(). Matching parentheses can be - highlighted with an extra selection. + highlighted with an extra selection. The "Matching Parentheses + with QSyntaxHighlighter" article in Qt Quarterly 31 implements + this. You find it here: \l{http://doc.qt.nokia.com/qq/}. */ diff --git a/doc/src/examples/syntaxhighlighter.qdoc b/doc/src/examples/syntaxhighlighter.qdoc index 4018be81a8..25119005bb 100644 --- a/doc/src/examples/syntaxhighlighter.qdoc +++ b/doc/src/examples/syntaxhighlighter.qdoc @@ -239,4 +239,14 @@ function. The QSyntaxHighlighter class also provides the \l {QSyntaxHighlighter::document()}{document()} function which returns the currently set document. + + \section1 Other Code Editor Features + + It is possible to implement parenthesis matching with + QSyntaxHighlighter. The "Matching Parentheses with + QSyntaxHighlighter" article in Qt Quarterly 31 + (\l{http://doc.qt.nokia.com/qq/}) implements this. We also have + the \l{Code Editor Example}, which shows how to implement line + numbers and how to highlight the current line. + */ diff --git a/doc/src/getting-started/examples.qdoc b/doc/src/getting-started/examples.qdoc index f988d03da0..b30fec3124 100644 --- a/doc/src/getting-started/examples.qdoc +++ b/doc/src/getting-started/examples.qdoc @@ -786,6 +786,13 @@ \row \o \l{webkit/simpleselector}{Simple Selector}\raisedaster \o A basic demonstration, showing how to use QWebElement to select elements in a Web page. + \row \o \l{webkit/simplewebplugin}{Simple Web Plugin}\raisedaster + \o Shows how to embed a widget into a Web page displayed using a QWebView + widget. + \row \o \l{webkit/webftpclient}{Web FTP Client}\raisedaster + \o Shows how to add support for a new protocol to QtWebKit-based applications. + \row \o \l{webkit/webplugin}{Web Plugin}\raisedaster + \o Shows how to communicate with a widget embedded into a Web page. \endtable Examples marked with an asterisk (*) are fully documented. |