summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorQt Continuous Integration System <qt-info@nokia.com>2011-08-31 16:34:02 (GMT)
committerQt Continuous Integration System <qt-info@nokia.com>2011-08-31 16:34:02 (GMT)
commitf14bbde351d90bed520f9503500f922f7aa18c92 (patch)
tree86fe9e3930aa3edbc142c207891d5856921270c3 /doc
parente546ecd3afd6660432178f2e9f692f8fcd16a712 (diff)
parent9c5f08452da280a90de48d0fa3862748cc428df4 (diff)
downloadQt-f14bbde351d90bed520f9503500f922f7aa18c92.zip
Qt-f14bbde351d90bed520f9503500f922f7aa18c92.tar.gz
Qt-f14bbde351d90bed520f9503500f922f7aa18c92.tar.bz2
Merge branch 'master' of scm.dev.nokia.troll.no:qt/qt-doc-staging into master-integration
* 'master' of scm.dev.nokia.troll.no:qt/qt-doc-staging: (25 commits) qdoc3: Updates to qdoc to print error message in ALL CAPS Doc: Added a note to Code Editor example docs Doc: QItemDelegate->QStyledItemDelegate in Star Delegate docs Doc: Added a link in Symbian Intro to Required Capabilities Doc: Added info on ordered targets for VS to qmake manual Doc: Small addition to the QML anchor layout docs Doc: Internalized QDeclarativeTypeLoader Doc: Said that QIODevice::isSequential returns false by default Doc: Said that QList::clear deallocates memory Doc: Updated platform notes for MultiMedia and Phonon Doc: Added links to the plugin deployment guide. Doc: Fix doc bug in QMouseEvent Doc: Fixed doc bug in QMetaObject Doc: Fixed date format doc bug in QDateTime/Qt namespace Doc: Removed internal Phonon classes from doce qdoc3: Updates for QTBUG-20776; include fileToOpen path. qdoc3: Updates for QTBUG-20776; clear map between runs. qdoc3: Updates for QTBUG-20739 (no read-only for QML components) qdoc3: Updates for QTBUG-20776 and QTBUG-20777 qdoc: Check pointer for null before dereferencing. ...
Diffstat (limited to 'doc')
-rw-r--r--doc/src/classes/phonon-api.qdoc24
-rw-r--r--doc/src/declarative/anchor-layout.qdoc7
-rw-r--r--doc/src/deployment/deployment.qdoc14
-rw-r--r--doc/src/development/qmake-manual.qdoc23
-rw-r--r--doc/src/examples/addressbook.qdoc2
-rw-r--r--doc/src/examples/codeeditor.qdoc26
-rw-r--r--doc/src/examples/stardelegate.qdoc24
-rw-r--r--doc/src/platforms/platform-notes.qdoc27
-rw-r--r--doc/src/platforms/symbian-introduction.qdoc2
9 files changed, 118 insertions, 31 deletions
diff --git a/doc/src/classes/phonon-api.qdoc b/doc/src/classes/phonon-api.qdoc
index 95e20dd..d1b26f6 100644
--- a/doc/src/classes/phonon-api.qdoc
+++ b/doc/src/classes/phonon-api.qdoc
@@ -5131,6 +5131,30 @@
*/
/*!
+ \class Phonon::GlobalConfigPrivate
+ \inmodule Phonon
+ \internal
+*/
+
+/*!
+ \class Phonon::AudioDataOutputPrivate
+ \inmodule Phonon
+ \internal
+*/
+
+/*!
+ \class Phonon::AudioDataOutputInterface
+ \inmodule Phonon
+ \internal
+*/
+
+/*!
+ \class Phonon::SwiftSlider
+ \inmodule Phonon
+ \internal
+*/
+
+/*!
\fn Phonon::GlobalConfigPrivate::GlobalConfigPrivate()
\internal
*/
diff --git a/doc/src/declarative/anchor-layout.qdoc b/doc/src/declarative/anchor-layout.qdoc
index 41b04e8..e93e539 100644
--- a/doc/src/declarative/anchor-layout.qdoc
+++ b/doc/src/declarative/anchor-layout.qdoc
@@ -53,7 +53,12 @@ Rectangle { id: rect1; ... }
Rectangle { id: rect2; anchors.left: rect1.right; ... }
\endcode
-In this case, the left edge of \e rect2 is bound to the right edge of \e rect1, producing the following:
+Each Item has two properties for each anchor line: one to bind from and one to bind to. The properties to bind
+from are contained in the \l{Item::}{anchors} attached property (seen as \c {anchors.left} above).
+The properties to bind to are normal properties (seen as \c {rect1.right} above).
+This way, each item can have several bindings to the same anchor line. Note that the properties to bind to are
+not visible in the documentation for Item.
+So in the example above, the left edge of \e rect2 is bound to the right edge of \e rect1, producing the following:
\image edge1.png
diff --git a/doc/src/deployment/deployment.qdoc b/doc/src/deployment/deployment.qdoc
index a13e2b8..ecb9ec6 100644
--- a/doc/src/deployment/deployment.qdoc
+++ b/doc/src/deployment/deployment.qdoc
@@ -102,15 +102,16 @@
of the libraries used by the application. Using static linking,
however, the Qt run-time is compiled into the executable.
- In general, you should deploy all plugins that your build of Qt uses,
- excluding only those that you have identified as being unnecessary
- for your application and its users.
+ In general, you should \l{Deploying Plugins}{deploy all plugins}
+ that your build of Qt uses, excluding only those that you have
+ identified as being unnecessary for your application and its users.
For instance, you may need to deploy plugins for JPEG support and
SQL drivers, but you should also deploy plugins that your users may
require, including those for accessibility.
- For more information about plugins, see the
- \l{plugins-howto.html}{How to Create Qt Plugins} documentation.
+ For more information about plugins, see
+ \l{plugins-howto.html}{How to Create Qt Plugins} and
+ \l{Deploying Plugins}.
When deploying an application using the shared library approach
you must ensure that the Qt libraries will use the correct path to
@@ -501,7 +502,8 @@
The \l{How to Create Qt Plugins} document outlines the issues you
need to pay attention to when building and deploying plugins for
- Qt applications.
+ Qt applications. More information about deployment can be found in
+ \l{Deploying Plugins}.
*/
/*!
diff --git a/doc/src/development/qmake-manual.qdoc b/doc/src/development/qmake-manual.qdoc
index 2c7fda2..0f85469 100644
--- a/doc/src/development/qmake-manual.qdoc
+++ b/doc/src/development/qmake-manual.qdoc
@@ -3263,6 +3263,29 @@
\snippet doc/src/snippets/code/doc_src_qmake-manual.pro 150
+ \section2 Ordered Targets and Visual Studio Solution Files
+
+ The \c ordered option is not supported for Visual Studio. The following list describes how
+ you can get around without it--dependencies are generated automatically if:
+
+ \list
+ \o 1a) There is a Lib/DLL project of which TARGET (the .lib is used and not the .dll)
+ is used on the link line of another project in your solution (you can modify the link
+ line with LIBS).
+
+ \o 1b) There is an Exe project of which TARGET is used in a custom
+ build-step of another project in your solution.
+
+ \o 2) You don't use paths in the TARGET variable (use DESTDIR/DLLDESTDIR for that),
+ e.g, TARGET=$(SOME_VARIABLE)/myLib, won't work.
+
+ \o 3) If you have a special location for your libs, you specify the -Lmy/library/path and
+ LIBS += mylib, instead of just using LIBS += my/library/path/mylib
+
+ \o 4) The leaf projects are created before you generate the solution file. (You can use the
+ recursive flag for qmake to do this, like "qmake -tp vc -r [yourproject.pro]"
+ \endlist
+
\target SYMBIAN_VERSION
\section1 SYMBIAN_VERSION
diff --git a/doc/src/examples/addressbook.qdoc b/doc/src/examples/addressbook.qdoc
index 114c22b..f19582d 100644
--- a/doc/src/examples/addressbook.qdoc
+++ b/doc/src/examples/addressbook.qdoc
@@ -29,7 +29,7 @@
\example itemviews/addressbook
\title Address Book Example
- The address book example shows how to use proxy models to display
+ \brief The address book example shows how to use proxy models to display
different views onto data from a single model.
\image addressbook-example.png Screenshot of the Address Book example
diff --git a/doc/src/examples/codeeditor.qdoc b/doc/src/examples/codeeditor.qdoc
index 435f650..1718d52 100644
--- a/doc/src/examples/codeeditor.qdoc
+++ b/doc/src/examples/codeeditor.qdoc
@@ -194,4 +194,30 @@
with QSyntaxHighlighter" article in Qt Quarterly 31 implements
this. You find it here: \l{http://doc.qt.nokia.com/qq/}.
+ The line number area is now painted every time the cursor blinks
+ (because we connect \l{QPlainTextEdit::}{updateRequest()} to
+ \c updateLineNumberArea()). We can avoid this by introducing a new
+ member variable to CodeEditor that keeps track of when the update
+ request comes from a cursor blink (in which case we do not
+ repaint). The code below requires the \c m_countCache variable,
+ which is a QPair<int, int> initialized with \c -1 for both
+ \l{QPair::}{first} and \l{QPair::}{second}.
+
+ \code
+ void CodeEditor::updateLineNumberArea(const QRect &rect, int dy)
+ {
+ if (dy) {
+ lineNumberArea->scroll(0, dy);
+ } else if (m_countCache.first != blockCount()
+ || m_countCache.second != textCursor().block().lineCount()) {
+ lineNumberArea->update(0, rect.y(), lineNumberArea->width(), rect.height());
+ m_countCache.first = blockCount();
+ m_countCache.second = textCursor().block().lineCount();
+ }
+
+ if (rect.contains(viewport()->rect()))
+ updateLineNumberAreaWidth(0);
+ }
+ \endcode
*/
+
diff --git a/doc/src/examples/stardelegate.qdoc b/doc/src/examples/stardelegate.qdoc
index 3b009d5..ed3ae7e 100644
--- a/doc/src/examples/stardelegate.qdoc
+++ b/doc/src/examples/stardelegate.qdoc
@@ -42,12 +42,12 @@
editing takes place.
Delegates are subclasses of QAbstractItemDelegate. Qt provides
- QItemDelegate, which inherits QAbstractItemDelegate and handles
- the most common data types (notably \c int and QString). If we
- need to support custom data types, or want to customize the
+ QStyledItemDelegate, which inherits QAbstractItemDelegate and
+ handles the most common data types (notably \c int and QString).
+ If we need to support custom data types, or want to customize the
rendering or the editing for existing data types, we can subclass
- QAbstractItemDelegate or QItemDelegate. See \l{Delegate Classes}
- for more information about delegates, and \l{Model/View
+ QAbstractItemDelegate or QStyledItemDelegate. See \l{Delegate
+ Classes} for more information about delegates, and \l{Model/View
Programming} if you need a high-level introduction to Qt's
model/view architecture (including delegates).
@@ -62,9 +62,9 @@
expressed as stars, such as "2 out of 5 stars" or "5 out of
6 stars".
- \o \c StarDelegate inherits QItemDelegate and provides support
+ \o \c StarDelegate inherits QStyledItemDelegate and provides support
for \c StarRating (in addition to the data types already
- handled by QItemDelegate).
+ handled by QStyledItemDelegate).
\o \c StarEditor inherits QWidget and is used by \c StarDelegate
to let the user edit a star rating using the mouse.
@@ -80,20 +80,20 @@
\snippet examples/itemviews/stardelegate/stardelegate.h 0
All public functions are reimplemented virtual functions from
- QItemDelegate to provide custom rendering and editing.
+ QStyledItemDelegate to provide custom rendering and editing.
\section1 StarDelegate Class Implementation
- The \l{QAbstractItemDelegate::}{paint()} function is
- reimplemented from QItemDelegate and is called whenever the view
- needs to repaint an item:
+ The \l{QAbstractItemDelegate::}{paint()} function is reimplemented
+ from QStyledItemDelegate and is called whenever the view needs to
+ repaint an item:
\snippet examples/itemviews/stardelegate/stardelegate.cpp 0
The function is invoked once for each item, represented by a
QModelIndex object from the model. If the data stored in the item
is a \c StarRating, we paint it ourselves; otherwise, we let
- QItemDelegate paint it for us. This ensures that the \c
+ QStyledItemDelegate paint it for us. This ensures that the \c
StarDelegate can handle the most common data types.
In the case where the item is a \c StarRating, we draw the
diff --git a/doc/src/platforms/platform-notes.qdoc b/doc/src/platforms/platform-notes.qdoc
index 175cf1c..477f125 100644
--- a/doc/src/platforms/platform-notes.qdoc
+++ b/doc/src/platforms/platform-notes.qdoc
@@ -774,7 +774,7 @@
\row \o QtCore
\o \c PowerMgmt if QProcess::kill(...) or QProcess::terminate(...) is called.
\row \o QtCore
- \o \c AllFiles when \l{http://developer.symbian.org/wiki/index.php/Capabilities_%28Symbian_Signed%29/AllFiles_Capability}{accessing specific areas.}
+ \o \c AllFiles when \l{http://wiki.forum.nokia.com/index.php/Capabilities_%28Symbian_Signed%29/AllFiles_Capability}{accessing specific areas.}
\row \o QtDeclarative
\o \c NetworkServices is automatically added for this module if no capabilities are explicitly specified.
\row \o QtNetwork
@@ -798,22 +798,27 @@
\section1 Multimedia and Phonon Support
- Qt provides a backend for Qt's Phonon module, which supports
- video and sound playback through Symbian's Multimedia Framework, MMF.
+ Qt provides a high-level API for multimedia functionality with
+ (\l{http://doc.qt.nokia.com/qtmobility/multimedia.html}).
- In this release the support is experimental. Video playback may have
- flickering issues, and support for effects and playback queueing is
- incomplete.
+ Qt also provides a backend for Qt's Phonon module, which supports video and
+ sound playback through Symbian's Multimedia Framework, MMF. Note that Phonon
+ support is not being extended, and that Qt's multimedia module will
+ take over for Phonon at a later stage.
+
+ In this release the support is experimental. Video playback may show
+ artifacts when the video is moved or resized (for instance during
+ orientation flips). This problem is present on Symbian^1 and earlier
+ versions, and on Symbian^3 systems.
The audio and video formats that Phonon supports depends on what support
the platform provides for MMF. The emulator is known to have limited
codec support.
- In addition, there exists a backend for the Helix framework. However, due
- to it not shipping with Qt, its availability depends on the Symbian
- platform in use. If available, it is loaded in preference over the MMF
- plugin. If the Helix plugin fails to load, the MMF plugin, if present on
- the device, will be loaded instead.
+ In addition, there exists a backend for the Helix framework. However, since
+ it is not shipped with Qt, its availability depends on the Symbian platform
+ in use. If the MFF plugin fails to load, the Helix plugin, if present on the
+ device, will be loaded instead.
\section1 Hardware Accelerated Rendering
diff --git a/doc/src/platforms/symbian-introduction.qdoc b/doc/src/platforms/symbian-introduction.qdoc
index 9b1eea2..e5d4a16 100644
--- a/doc/src/platforms/symbian-introduction.qdoc
+++ b/doc/src/platforms/symbian-introduction.qdoc
@@ -74,6 +74,8 @@
Platform security capabilities are added via the
\l{qmake-variable-reference.html#target-capability}{TARGET.CAPABILITY}
qmake variable.
+
+ \sa {platform-notes-symbian.html#required-capabilities}{Required Capabilities}
*/
/*!