summaryrefslogtreecommitdiffstats
path: root/doc/src
diff options
context:
space:
mode:
authorCasper van Donderen <casper.vandonderen@nokia.com>2011-08-30 08:40:03 (GMT)
committerCasper van Donderen <casper.vandonderen@nokia.com>2011-08-30 08:40:03 (GMT)
commit7f27ebb0383414f15f391151655e5b09952f8ccd (patch)
tree8af7b866af6115924a13896013f5b6f5da686de6 /doc/src
parent3dccb66b3b81627fb70c7eeccdf32b96d8add8b7 (diff)
parent78c5825cfb7702350636b7624bf79311dbd0dbd5 (diff)
downloadQt-7f27ebb0383414f15f391151655e5b09952f8ccd.zip
Qt-7f27ebb0383414f15f391151655e5b09952f8ccd.tar.gz
Qt-7f27ebb0383414f15f391151655e5b09952f8ccd.tar.bz2
Merge remote branch 'mainline/4.8'
Diffstat (limited to 'doc/src')
-rw-r--r--doc/src/declarative/declarativeui.qdoc2
-rw-r--r--doc/src/declarative/modules.qdoc6
-rw-r--r--doc/src/declarative/network.qdoc7
-rw-r--r--doc/src/declarative/qdeclarativestates.qdoc22
-rw-r--r--doc/src/declarative/qtbinding.qdoc6
-rw-r--r--doc/src/declarative/qtquick-intro.qdoc2
-rw-r--r--doc/src/development/qmake-manual.qdoc17
-rw-r--r--doc/src/index.qdoc4
-rw-r--r--doc/src/platforms/supported-platforms.qdoc12
-rw-r--r--doc/src/qt-features.qdoc204
-rw-r--r--doc/src/qt4-intro.qdoc3
-rw-r--r--doc/src/snippets/code/doc_src_qmake-manual.pro4
-rw-r--r--doc/src/snippets/qcolumnview/main.cpp2
-rw-r--r--doc/src/snippets/textdocument-imagedrop/main.cpp2
-rw-r--r--doc/src/snippets/textdocument-imagedrop/textedit.h6
15 files changed, 73 insertions, 226 deletions
diff --git a/doc/src/declarative/declarativeui.qdoc b/doc/src/declarative/declarativeui.qdoc
index cecccf6..d89ca53 100644
--- a/doc/src/declarative/declarativeui.qdoc
+++ b/doc/src/declarative/declarativeui.qdoc
@@ -46,7 +46,7 @@ Qt applications.
\section1 Getting Started
\list
-\o \l{Introduction to Qt Quick}
+\o \l{Intro to Qt Quick}{Introduction to Qt Quick}
\o \l{QML for Qt Programmers}{QML Programming for Qt Programmers}
\o \l{Getting Started Programming with QML}
diff --git a/doc/src/declarative/modules.qdoc b/doc/src/declarative/modules.qdoc
index 80d83a4..efca620 100644
--- a/doc/src/declarative/modules.qdoc
+++ b/doc/src/declarative/modules.qdoc
@@ -407,7 +407,7 @@ In case you have to create a qmltypes file manually or need to adjust
an existing one, this is the file format:
\qml
-import QtQuick.tooling 1.0
+import QtQuick.tooling 1.1
// There always is a single Module object that contains all
// Component objects.
@@ -454,6 +454,8 @@ Module {
isPointer: true
// defaults to false: whether the type actually is a QDeclarativeListProperty<type>
isList: true
+ // defaults to 0: the minor version that introduced this property
+ revision: 1
}
Property { name: "loops"; type: "int" }
Property { name: "name"; type: "string" }
@@ -471,7 +473,7 @@ Module {
// declarations also support the isReadonly, isPointer and isList
// attributes which mean the same as for Property
Method { name: "restart" }
- Signal { name: "started" }
+ Signal { name: "started"; revision: 2 }
Signal {
name: "runningChanged"
Parameter { type: "bool" }
diff --git a/doc/src/declarative/network.qdoc b/doc/src/declarative/network.qdoc
index cb83542..0ebf8ae 100644
--- a/doc/src/declarative/network.qdoc
+++ b/doc/src/declarative/network.qdoc
@@ -134,10 +134,9 @@ One of the URL schemes built into Qt is the "qrc" scheme. This allows content to
the executable using \l{The Qt Resource System}. Using this, an executable can reference QML content
that is compiled into the executable:
-\code
- QDeclarativeView *canvas = new QDeclarativeView;
- canvas->setUrl(QUrl("qrc:/dial.qml"));
-\endcode
+\quotefromfile snippets/declarative/qtbinding/resources/main.cpp
+\skipto view
+\printuntil setSource
The content itself can then use relative URLs, and so be transparently unaware that the content is
compiled into the executable.
diff --git a/doc/src/declarative/qdeclarativestates.qdoc b/doc/src/declarative/qdeclarativestates.qdoc
index 55f38c3..9857894 100644
--- a/doc/src/declarative/qdeclarativestates.qdoc
+++ b/doc/src/declarative/qdeclarativestates.qdoc
@@ -133,4 +133,26 @@ The \l {declarative/animation/states}{States and Transitions example}
demonstrates how to declare a basic set of states and apply animated
transitions between them.
+\l{Using QML Behaviors with States} explains a common problem when using Behaviors
+to animate state changes.
+
+\section1 State Fast Forwarding
+
+In order for Transition to correctly animate state changes, it is sometimes necessary
+for the engine to fast forward and rewind a state (that is, internally set and unset the state)
+before it is finally applied. The process is as follows:
+
+\list 1
+\o The state is fast forwarded to determine the complete set of end values.
+\o The state is rewound.
+\o The state is fully applied, with transitions.
+\endlist
+
+In some cases this may cause unintended behavior. For example, a state that changes
+a view's \i model or a Loader's \i sourceComponent will set these properties
+multiple times (to apply, rewind, and then reapply), which can be relatively expensive.
+
+State fast forwarding should be considered an implementation detail,
+and may change in later versions.
+
*/
diff --git a/doc/src/declarative/qtbinding.qdoc b/doc/src/declarative/qtbinding.qdoc
index 0d99287..e342728 100644
--- a/doc/src/declarative/qtbinding.qdoc
+++ b/doc/src/declarative/qtbinding.qdoc
@@ -511,12 +511,16 @@ 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 and Method 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}.
+Likewise, invokable C++ methods parameters may be enumeration values providing that the enumeration and
+the method 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{QML Signal and Handler Event System#Connecting Signals to Methods and Signals}{connect()}
function, the enum type must be registered using qRegisterMetaType().
diff --git a/doc/src/declarative/qtquick-intro.qdoc b/doc/src/declarative/qtquick-intro.qdoc
index 4cd5db3..bdad2c3 100644
--- a/doc/src/declarative/qtquick-intro.qdoc
+++ b/doc/src/declarative/qtquick-intro.qdoc
@@ -27,7 +27,7 @@
/*!
\page qml-intro.html
-\title Introduction to Qt Quick
+\title Intro to Qt Quick
Qt Quick is a collection of technologies that are designed to help developers
create the kind of intuitive, modern, and fluid user interfaces that are
diff --git a/doc/src/development/qmake-manual.qdoc b/doc/src/development/qmake-manual.qdoc
index 184a881..329bac5 100644
--- a/doc/src/development/qmake-manual.qdoc
+++ b/doc/src/development/qmake-manual.qdoc
@@ -3116,6 +3116,23 @@
platform application shell. In addition it will make the application to
be launched in background.
+ From S60 version 5.4 onwards, you can specify \c graphics_memory value using \c RSS_RULES
+ to specify the graphics memory quota for the application. The value is in kilobytes and
+ defaults to 24576 (i.e. 24MB) for applications that link against QtGui. The default for all
+ other applications is zero.
+
+ The graphics memory quota tells the operating system how much graphics memory the
+ application is likely to need so that it can free up enough graphics memory prior to
+ application launch. If the value is too small, it can cause random slowdowns later when
+ the memory is freed on on-demand basis. On the other hand, too large values can delay
+ the application launch unnecessarily.
+
+ For example:
+
+ \snippet doc/src/snippets/code/doc_src_qmake-manual.pro 159
+
+ This example sets the graphics memory quota to 12MB.
+
For detailed list of possible \c APP_REGISTRATION_INFO statements, please refer to the
Symbian platform help.
diff --git a/doc/src/index.qdoc b/doc/src/index.qdoc
index af418e0..2490374 100644
--- a/doc/src/index.qdoc
+++ b/doc/src/index.qdoc
@@ -38,7 +38,9 @@
\list
\o \l{Qt Features Overview}
\o \l{How to Learn Qt}
- \o \l{Introduction to Qt Quick}
+ \o \l{Introduction to Qt Quick}{Qt Quick}
+ \o \l{Qt Whitepaper}{Qt C++ Framework}
+ \o \l{Intro to Qt Quick}{Qt Quick}
\o \l{external: Qt Mobility Manual}{Qt Mobility}
\o \l{Qt WebKit}
\endlist
diff --git a/doc/src/platforms/supported-platforms.qdoc b/doc/src/platforms/supported-platforms.qdoc
index ba59c37..9d47695 100644
--- a/doc/src/platforms/supported-platforms.qdoc
+++ b/doc/src/platforms/supported-platforms.qdoc
@@ -334,8 +334,8 @@
\section2 Advanced Text Layout Engine
- Qt for Windows CE supports TrueType and raster fonts. Qt also has
- extended Unicode support and right-to-left languages. Qt's rich text
+ Qt for Windows CE supports TrueType® and raster fonts. Qt also has
+ extended Unicode support and right-to-left languages. Qt’s rich text
engine adds capabilities for complex text layouts including tables,
path tracing and text which flows around shapes.
@@ -373,7 +373,7 @@
by embedded Linux. You can use Qt to create highly memory efficient
devices and applications that have completely unique user experiences.
- Qt runs anywhere Linux runs. Qt's intuitive API means fewer lines of
+ Qt runs anywhere Linux runs. Qt’s intuitive API means fewer lines of
code and higher level functionality in less time. Use the code from
one single code-base and rebuild for all \l{Supported Platforms}
{supported platforms}.
@@ -410,7 +410,7 @@
frame buffer} that will match the physical device display, pixel for
pixel. This gives the developer a realistic testing infrastructure
testing on the desktop where the frame buffer simulates the physical
- device display's width, height and color depth.
+ device display’s width, height and color depth.
\section2 Inter-Process Communication (IPC)
@@ -421,7 +421,7 @@
\section2 Extended Font Format
Qt supports a wide range of font formats on embedded Linux including:
- TrueType, Postscript Type1 and Qt pre-rendered fonts. Qt has
+ TrueType®, Postscript® Type1 and Qt pre-rendered fonts. Qt has
extended Unicode support including automatic data extraction at build
time and automatic update at runtime.
@@ -681,7 +681,7 @@
\group platform-details
Qt is a cross-platform application and UI framework. Using Qt,
- you can write GUI applications once and deploy them
+ you can write web-enabled applications once and deploy them
across desktop, mobile and embedded operating systems without
rewriting the source code.
diff --git a/doc/src/qt-features.qdoc b/doc/src/qt-features.qdoc
deleted file mode 100644
index 0ae00b0..0000000
--- a/doc/src/qt-features.qdoc
+++ /dev/null
@@ -1,204 +0,0 @@
-/****************************************************************************
-**
-** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
-** All rights reserved.
-** Contact: Nokia Corporation (qt-info@nokia.com)
-**
-** This file is part of the documentation of the Qt Toolkit.
-**
-** $QT_BEGIN_LICENSE:FDL$
-** GNU Free Documentation License
-** Alternatively, this file may be used under the terms of the GNU Free
-** Documentation License version 1.3 as published by the Free Software
-** Foundation and appearing in the file included in the packaging of
-** this file.
-**
-** Other Usage
-** Alternatively, this file may be used in accordance with the terms
-** and conditions contained in a signed written agreement between you
-** and Nokia.
-**
-**
-**
-**
-** $QT_END_LICENSE$
-**
-****************************************************************************/
-
-/*!
- \page qt-overview.html
- \title Qt Features Overview
-
- This document provides a summary of the most important features of Qt,
- providing links to other pages in the documentation that cover these
- features in more detail. It is not intended to be a comprehensive
- guide to Qt's features.
-
- \section1 Fundamental Technologies in Qt
-
- Qt is built upon a set of core technologies, provided by the \l QtCore
- and \l QtGui modules. These include the following:
-
- \list
- \o \l{The Tulip Container Classes}, a set of template container classes.
- \o \l{The Arthur Paint System}, the Qt 4 painting framework.
- \o \l{The Interview Framework}, a model/view architecture for item views
- and the \l{QtSQL Module}, which also uses this architecture.
- \o \l{The Scribe Classes}, a framework for creating text documents,
- performing low-level text layout and writing OpenDocument files.
- \o A collection of \l{Qt Widget Gallery}{common desktop widgets}, styled
- to fit in on each supported platform.
- \o \l{The Qt 4 Main Window Classes}, a main window, toolbar, menu, and
- docking architecture.
- \o The \l{Graphics View} framework provides a canvas for producing
- interactive graphics.
- \o The \l{QtNetwork Module} provides support for TCP, UDP and local
- sockets that are integrated with Qt's event model, including support
- for Secure Socket Layer (SSL) communications,
- \l{QNetworkProxy}{network proxy} servers and
- \l{Bearer Management}{network bearer management}.
- \o Enhanced \l{qt4-threads.html}{thread support} allows
- \l{Signals & Slots}{signal-slot} connections across threads and
- per-thread event loops.
- Additionally, \l{Thread Support in Qt}{a framework for concurrent programming}
- using Qt paradigms makes common threading tasks easier.
- \o A \l{resource system} for embedding images and other resource files
- into executable files makes it easier to deploy applications.
- \o A \l{QTestLib Manual}{unit testing framework} for Qt applications and
- libraries.
- \endlist
-
- The mature classes provided by these technologies have been used to build
- robust, cross-platform desktop applications. They are augmented by a number
- of additional technologies and improvements that have appeared over the
- lifetime of Qt 4.
-
- \section1 Graphical User Interfaces
-
- \div{class="float-right"}
- \inlineimage gtk-tabwidget.png
- \enddiv
- \div{class="float-right"}
- \inlineimage gtk-progressbar.png
- \br
- \inlineimage gtk-checkbox.png
- \br
- \inlineimage plastique-combobox.png
- \br
- \inlineimage plastique-radiobutton.png
- \enddiv
-
- Alongside the support for traditional desktop user interfaces, Qt includes
- support for declarative UI development with \l{Qt Quick}, a set of
- technologies for creating fluid, dynamic user interfaces. A starting point
- for exploring this approach can be found in the \l{Introduction to Qt Quick}
- guide.
-
- Qt provides a range of standard user interface elements, called widgets,
- for each supported platform. Widgets can be used as containers for other
- widgets, as windows, and as regular controls that the user interacts with.
- Where the platform supports it, widgets can be made to appear partially
- transparent, and may be styled with \l{Qt Style Sheets}.
-
- Support for \l{QTouchEvent}{touch input} and \l{Gestures Programming}{gestures}
- enable widgets to be used to create intuitive user interfaces for
- touch-enabled devices.
-
- User interfaces can also be created dynamically at run-time with the
- features provided by the \l{QtUiTools} module.
-
- A selection of available widgets are shown in the \l{Qt Widget Gallery}.
- An introduction to the concepts behind widgets can be found in the
- \l{Widgets Tutorial}.
-
- \clearfloat
- \section1 Painting, Printing and Rendering
-
- \div{class="float-left"}
- \inlineimage qpainter-affinetransformations.png
- \enddiv
-
- Widgets are just one of many kinds of paint device that Qt can render onto.
- This support for unified painting makes it possible for applications to use
- the same painting code for different tasks, as well as allowing Qt to be
- extended to support additional file formats.
-
- Qt provides support for common bitmap image formats,
- \l{QtSvg Module}{Scalable Vector Graphics} (SVG) drawings and animations,
- Postscript and Portable Document Format (PDF) files. Postscript and PDF are
- integrated with \l{Printing with Qt}{Qt's printing system}, which also
- allows printed output to be previewed.
-
- Interactive graphics can be created with the
- \l{The Animation Framework}{animation framework}, allowing animations to be
- used with both widgets and graphics items. Animations can be used with the
- \l{The State Machine Framework}{state machine framework}, which provides a
- way to express application logic and integrate it with the user interface.
- Animations can be enhanced with a collection of
- \l{QGraphicsEffect}{graphics effects} that operate on graphics items and
- can be applied individually or combined to create more complex effects.
-
- Qt supports integration with \l{QtOpenGL}{OpenGL} on a number of levels,
- providing convenience functions for handling textures and colors, as well
- as providing support for pixel and sample buffers. Future support for
- higher level 3D integration is provided by Qt3D enablers which include
- \l{QMatrix4x4}{matrix multiplication}, \l{QQuaternion}{quaternions}, and an
- API for \l{QGLShader}{vertex and fragment shaders}.
-
- Two APIs are provided for multimedia. The
- \l{Phonon Overview}{Phonon Multimedia Framework} has traditionally been
- used on desktop platforms. A set of
- \l{QtMultimedia Module}{multimedia services} provides low-level access to
- the system's audio system and is often used on mobile devices.
-
- \clearfloat
- \section1 Infrastructure
-
- \div{class="float-right"}
- \inlineimage qtscript-context2d.png
- \enddiv
-
- Facilities for Inter-Process Communication (IPC) and Remote Procedure
- Calling (RPC) mechanisms are available on platforms that support the
- \l{intro-to-dbus.html}{D-Bus} message bus system.
-
- An \l{Undo Framework}{Undo framework} based on the
- \l{Books about GUI Design#Design Patterns}{Command pattern} is designed to
- enable a consistent approach to handling data in editing applications.
-
- The \l{QtScript} and \l{QtScriptTools} modules provide support for
- application scripting and debugging using the ECMAScript language.
-
- The \l{QtHelp Module} provides the foundations of an interactive help
- system that can be used in conjunction with Qt Creator or integrated into
- applications directly.
-
- XML handling is supported in a number of places in Qt. The \l QtCore module
- provides classes for reading and writing XML streams. The \l QtXmlPatterns
- module includes XQuery, XPath and XSLT support, providing facilities for
- XML processing beyond that supported by the QtXml module, which contains
- SAX and DOM parsers. XML schema validation in the QtXmlPatterns module
- covers large parts of version 1.0 of the specification.
-
- \clearfloat
- \section1 Web Client Integration
-
- Integration between \l{Webkit in Qt}{Qt and WebKit} makes it possible for
- developers to use a fully-featured Web browser engine to display documents
- and access online services. Developers can access the browser's environment
- to create documents and run scripts within one or more browser widgets.
-
- A \l{QWebElement}{DOM access API} for QtWebKit provides a cleaner and safer
- way to access elements and structures of Web pages without the use of
- JavaScript.
-
- \section1 Further Reading
-
- Many of the technologies mentioned here, as well as other, more specific
- features, are listed in the \l{What's New in Qt 4} document. A complete
- list of Qt's modules can be found on the \l{All Modules} page, which
- also includes more domain-specific technologies.
-
- The tools that are supplied with Qt are covered by the listing in the
- \l{Qt's Tools} document.
-*/
diff --git a/doc/src/qt4-intro.qdoc b/doc/src/qt4-intro.qdoc
index 01103a8..17dc1af 100644
--- a/doc/src/qt4-intro.qdoc
+++ b/doc/src/qt4-intro.qdoc
@@ -138,7 +138,7 @@
In Qt 4.4:
\list
- \o \l{WebKit in Qt}{Qt WebKit integration}, making it possible for developers
+ \o \l{Webkit in QT}{Qt WebKit integration}, making it possible for developers
to use a fully-featured Web browser to display documents and access online
services.
\o A multimedia API provided by the \l{Phonon Overview}{Phonon Multimedia Framework}.
@@ -707,6 +707,7 @@
introduced in Qt 4.7.
\sincelist 4.7
+
*/
/*!
diff --git a/doc/src/snippets/code/doc_src_qmake-manual.pro b/doc/src/snippets/code/doc_src_qmake-manual.pro
index ee35b77..042ca0e 100644
--- a/doc/src/snippets/code/doc_src_qmake-manual.pro
+++ b/doc/src/snippets/code/doc_src_qmake-manual.pro
@@ -1023,3 +1023,7 @@ packagesExist(sqlite3 QtNetwork QtDeclarative) {
// Use the fancy UI, as we have extra packages available
#endif
#! [158]
+
+#! [159]
+RSS_RULES += "graphics_memory=12288;"
+#! [159]
diff --git a/doc/src/snippets/qcolumnview/main.cpp b/doc/src/snippets/qcolumnview/main.cpp
index c39a4bb..fecff12 100644
--- a/doc/src/snippets/qcolumnview/main.cpp
+++ b/doc/src/snippets/qcolumnview/main.cpp
@@ -76,4 +76,4 @@ int main(int argc, char *argv[])
columnView.show();
return app.exec();
-} \ No newline at end of file
+}
diff --git a/doc/src/snippets/textdocument-imagedrop/main.cpp b/doc/src/snippets/textdocument-imagedrop/main.cpp
index 24cd2de..0cdf3a1 100644
--- a/doc/src/snippets/textdocument-imagedrop/main.cpp
+++ b/doc/src/snippets/textdocument-imagedrop/main.cpp
@@ -49,4 +49,4 @@ int main(int argc, char * argv[])
textEdit->show();
return app.exec();
-} \ No newline at end of file
+}
diff --git a/doc/src/snippets/textdocument-imagedrop/textedit.h b/doc/src/snippets/textdocument-imagedrop/textedit.h
index 9e0492b..9db9f17 100644
--- a/doc/src/snippets/textdocument-imagedrop/textedit.h
+++ b/doc/src/snippets/textdocument-imagedrop/textedit.h
@@ -46,11 +46,11 @@
class TextEdit : public QTextEdit
{
Q_OBJECT
-
-public:
+
+public:
TextEdit(QWidget *parent=0);
bool canInsertFromMimeData( const QMimeData *source ) const;
void insertFromMimeData( const QMimeData *source );
};
-#endif \ No newline at end of file
+#endif