From 4e0865200244b70e6d4be62b57bdf248342834ba Mon Sep 17 00:00:00 2001 From: Martin Smith Date: Fri, 12 Nov 2010 12:05:04 +0100 Subject: doc: Stated that the destructor does not call close(). Task-number: QTBUG-15277, QTBUG-8231 --- src/corelib/io/qiodevice.cpp | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/src/corelib/io/qiodevice.cpp b/src/corelib/io/qiodevice.cpp index 26e587d..68fb2bf 100644 --- a/src/corelib/io/qiodevice.cpp +++ b/src/corelib/io/qiodevice.cpp @@ -395,7 +395,10 @@ QIODevice::QIODevice(QIODevicePrivate &dd, QObject *parent) /*! - Destructs the QIODevice object. + The destructor is virtual, and QIODevice is an abstract base + class. This destructor does not call close(), but the subclass + destructor might. If you are in doubt, call close() before + destroying the QIODevice. */ QIODevice::~QIODevice() { -- cgit v0.12 From 96b1ea7088f8d541bc4c5fbc87baaf56b0b2fd43 Mon Sep 17 00:00:00 2001 From: Morten Engvoldsen Date: Mon, 15 Nov 2010 18:34:38 +0100 Subject: Doc: Correcting references to Qt Declarative module. --- doc/src/declarative/declarativeui.qdoc | 8 ++++---- doc/src/declarative/elements.qdoc | 2 +- doc/src/declarative/extending-tutorial.qdoc | 4 ++-- doc/src/declarative/qtbinding.qdoc | 12 ++++++------ doc/src/declarative/qtdeclarative.qdoc | 2 +- doc/src/getting-started/gettingstartedqml.qdoc | 2 +- doc/src/qt4-intro.qdoc | 2 +- 7 files changed, 16 insertions(+), 16 deletions(-) diff --git a/doc/src/declarative/declarativeui.qdoc b/doc/src/declarative/declarativeui.qdoc index 28a8a70..eb469d6 100644 --- a/doc/src/declarative/declarativeui.qdoc +++ b/doc/src/declarative/declarativeui.qdoc @@ -45,7 +45,7 @@ language for describing user interfaces and a language runtime. A collection of C++ APIs is used to integrate these high level features with classic Qt applications. -\section2 QML, Elements and the QtDeclarative Module +\section2 QML, Elements and the Qt Declarative Module User interfaces and their behavior are described using QML, an extension to \l{About JavaScript}{JavaScript} that lets developers and designers @@ -60,14 +60,14 @@ QObject-based type system, adds support for automatic \l{Property Binding}{property bindings} and provides \l{Network Transparency}{network transparency} at the language level. -The QtDeclarative module implements the interface between the QML language +The Qt Declarative module implements the interface between the QML language and the elements available to it. It also provides a C++ API that can be used to load and interact with QML files from within Qt applications. Qt Quick builds on \l{QML for Qt programmers}{Qt's existing strengths}. QML can be be used to incrementally extend an existing application or to build completely new applications. QML is fully -\l{Extending QML in C++}{extensible from C++} through the QtDeclarative +\l{Extending QML in C++}{extensible from C++} through the Qt Declarative Module. \section1 Getting Started @@ -139,7 +139,7 @@ Module. \o \l{QML Global Object} \o \l{QML Internationalization} \o \l{QML Security} -\o \l{QtDeclarative Module} +\o \l{Qt Declarative Module} \o \l{Debugging QML} \o \l{QML Viewer} \o \l{QML Performance} diff --git a/doc/src/declarative/elements.qdoc b/doc/src/declarative/elements.qdoc index 54f07a2..eaa6a82 100644 --- a/doc/src/declarative/elements.qdoc +++ b/doc/src/declarative/elements.qdoc @@ -32,7 +32,7 @@ \brief A dictionary of standard QML elements. This is a dictionary of all standard QML elements made available - in the QtDeclarative module. + in the Qt Declarative module. To see the QML elements listed by functional area, see the \l{Groups Of Related QML Elements} page. diff --git a/doc/src/declarative/extending-tutorial.qdoc b/doc/src/declarative/extending-tutorial.qdoc index 2bfe62e..dff1d9c 100644 --- a/doc/src/declarative/extending-tutorial.qdoc +++ b/doc/src/declarative/extending-tutorial.qdoc @@ -29,7 +29,7 @@ \page qml-extending-tutorial-index.html \title Tutorial: Writing QML extensions with C++ -The QtDeclarative module provides a set of APIs for extending QML through +The Qt Declarative module provides a set of APIs for extending QML through C++ extensions. You can write extensions to add your own QML types, extend existing Qt types, or call C/C++ functions that are not accessible from ordinary QML code. @@ -65,7 +65,7 @@ For example, this could be done to implement particular data models, or provide elements with custom painting and drawing capabilities, or access system features like network programming that are not accessible through built-in QML features. -In this tutorial, we will show how to use the C++ classes in the QtDeclarative +In this tutorial, we will show how to use the C++ classes in the Qt Declarative module to extend QML. The end result will be a simple Pie Chart display implemented by several custom QML types connected together through QML features like bindings and signals, and made available to the QML runtime through a plugin. diff --git a/doc/src/declarative/qtbinding.qdoc b/doc/src/declarative/qtbinding.qdoc index 8a969eb..cd50503 100644 --- a/doc/src/declarative/qtbinding.qdoc +++ b/doc/src/declarative/qtbinding.qdoc @@ -31,7 +31,7 @@ \title Using QML in C++ Applications QML is designed to be easily extensible from C++. The classes in the -QtDeclarative module allow QML components to be loaded and manipulated from C++, and through +Qt Declarative module allow QML components to be loaded and manipulated from C++, and through Qt's \l{The Meta-Object System}{meta-object system}, QML and C++ objects can easily communicate through Qt signals and slots. In addition, QML plugins can be written to create reusable QML components for distribution. @@ -41,20 +41,20 @@ 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 calling functions in a third-party C++ library) -\o To access functionality in the QtDeclarative module (for example, to dynamically generate +\o To access functionality in the Qt Declarative module (for example, to dynamically generate images using QDeclarativeImageProvider) \o To write your own QML elements (whether for your applications, or for distribution to others) \endlist -To use the QtDeclarative module, you must include and link to the module appropriately, as shown on +To use the Qt Declarative module, you must include and link to the module appropriately, as shown on the \l {QtDeclarative}{module index page}. The \l {Qt Declarative UI Runtime} documentation shows how to build a basic C++ application that uses this module. \section1 Core module classes -The QtDeclarative module provides a set of C++ APIs for extending your QML applications from C++ and -embedding QML into C++ applications. There are several core classes in the QtDeclarative module +The Qt Declarative module provides a set of C++ APIs for extending your QML applications from C++ and +embedding QML into C++ applications. There are several core classes in the Qt Declarative module that provide the essential capabilities for doing this. These are: \list @@ -520,7 +520,7 @@ a QColor-type property or to call a C++ function that requires a QColor paramete \section1 Writing QML plugins -The QtDeclarative module includes the QDeclarativeExtensionPlugin class, which is an abstract +The Qt Declarative module includes the QDeclarativeExtensionPlugin class, which is an abstract class for writing QML plugins. This allows QML extension types to be dynamically loaded into QML applications. diff --git a/doc/src/declarative/qtdeclarative.qdoc b/doc/src/declarative/qtdeclarative.qdoc index 7ecdc53..f2b2032 100644 --- a/doc/src/declarative/qtdeclarative.qdoc +++ b/doc/src/declarative/qtdeclarative.qdoc @@ -27,7 +27,7 @@ /*! \module QtDeclarative - \title QtDeclarative Module + \title Qt Declarative Module \ingroup modules \brief The Qt Declarative module provides a declarative framework diff --git a/doc/src/getting-started/gettingstartedqml.qdoc b/doc/src/getting-started/gettingstartedqml.qdoc index 54fa098..b767587 100644 --- a/doc/src/getting-started/gettingstartedqml.qdoc +++ b/doc/src/getting-started/gettingstartedqml.qdoc @@ -42,7 +42,7 @@ installation instructions and requirements for different platforms. Qt Quick includes a declarative language called - \l{Introduction to the QML language}{QML}, the \l{QtDeclarative Module}, and + \l{Introduction to the QML language}{QML}, the \l{Qt Declarative Module}, and \l{QML Viewer}. \section1 QML to Build User Interfaces diff --git a/doc/src/qt4-intro.qdoc b/doc/src/qt4-intro.qdoc index 2384051..62decbb 100644 --- a/doc/src/qt4-intro.qdoc +++ b/doc/src/qt4-intro.qdoc @@ -466,7 +466,7 @@ collaborate tightly and create animated and fluid user experiences, using existing knowledge in script language and design. - \i QtDeclarative is a C++ library that provides the underlying engine, + \i Qt Declarative is a C++ library that provides the underlying engine, which translates the declarative description of the UI in QML into items on a QGraphicsScene. The library also provides APIs to bind custom C++ types and elements to QML, and to connect the QML UI with -- cgit v0.12 From 013fe9236fbc54eb40a19461cfa65d5fb8334f06 Mon Sep 17 00:00:00 2001 From: Morten Engvoldsen Date: Mon, 15 Nov 2010 18:41:15 +0100 Subject: Doc: correcting heading - Beginning Qt Quick - into - Intro to Qt Quick --- doc/src/declarative/declarativeui.qdoc | 2 +- doc/src/declarative/qml-intro.qdoc | 2 +- doc/src/declarative/qmlinuse.qdoc | 499 +++++++++++++++++++++++++++++++++ 3 files changed, 501 insertions(+), 2 deletions(-) create mode 100644 doc/src/declarative/qmlinuse.qdoc diff --git a/doc/src/declarative/declarativeui.qdoc b/doc/src/declarative/declarativeui.qdoc index eb469d6..01e1302 100644 --- a/doc/src/declarative/declarativeui.qdoc +++ b/doc/src/declarative/declarativeui.qdoc @@ -77,7 +77,7 @@ Module. \o \l{Introduction to the QML language} \o \l{QML for Qt Programmers} \o \l{Getting Started Programming with QML} -\o \l{Beginning Qt Quick} +\o \l{Intro to Qt Quick} \endlist \list diff --git a/doc/src/declarative/qml-intro.qdoc b/doc/src/declarative/qml-intro.qdoc index f891e01..e02ce8f 100644 --- a/doc/src/declarative/qml-intro.qdoc +++ b/doc/src/declarative/qml-intro.qdoc @@ -29,7 +29,7 @@ /*! \page qml-intro.html -\title Beginning Qt Quick +\title Intro to Qt Quick \section1 Overview diff --git a/doc/src/declarative/qmlinuse.qdoc b/doc/src/declarative/qmlinuse.qdoc new file mode 100644 index 0000000..90ce02c --- /dev/null +++ b/doc/src/declarative/qmlinuse.qdoc @@ -0,0 +1,499 @@ +/**************************************************************************** +** +** Copyright (C) 2010 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$ +** Commercial Usage +** Licensees holding valid Qt Commercial licenses may use this file in +** accordance with the Qt Commercial License Agreement provided with the +** Software or, alternatively, in accordance with the terms contained in a +** written agreement between you and Nokia. +** +** 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. +** +** If you have questions regarding the use of this file, please contact +** Nokia at qt-info@nokia.com. +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/*! +\page qmlinuse.html +\title Using QML elements + +\raw HTML +
+
+
+

+ QML Elements

+ +
+
+
+

+ Groups Of Related QML Elements

+

+ QML Elements are grouped by their respective functionalities. Certain elements are + suited for building complex components while other elements strictly dictate appearances + and color.

+
+
+

+ add something about elements in use in general

+
+
+ +
+
+
+
+ +
+
+
+
+ +

+ image heading

+ +

+ img descr.

+
+ +
+
+

Basic QML Elements

+

+ Basic elements can be extended to form more complex elements.

+ Elements: +
    +
  • Item Element + - The Item is the most basic of all visual items in QML. Many visual elements inherit + properties from the Item element.
    • +
  • Component Element + - The Component element encapsulates a QML component definition.
    • +
+
+
+ +
+
+
+
+ +

+ image heading

+ +

+ img descr.

+
+ +
+
+

QML Visual Elements

+

+ Visual elements offer various interactive and graphical functionalities. Visual + elements can directly set properties that dictate appearances.

+ Elements: + +
+
+ +
+
+
+
+ +

+ image heading

+ +

+ img descr.

+
+ +
+
+

QML Animation and Transition Elements

+

+ Animation and transition elements control animation behaviors. Animations can run + in parallel or in series for different value types. +

+ Elements: + +
+
+ +
+
+
+
+ +

+ image heading

+ +

+ img descr.

+
+ +
+
+

QML Interaction Elements

+

+ These elements define basic interactions such as touch movements and focus management.

+ Elements: + +
+
+ +
+
+
+
+ +

+ image heading

+ +

+ img descr.

+
+ +
+
+

QML Event Elements

+

+ Key and mouse events information are provided in these event elements.

+ Elements: +
    +
  • KeyEvent Element - The KeyEvent + object provides information about a key event.
    • +
  • MouseEvent Element - The MouseEvent + object provides information about a mouse event.
    • +
+
+
+ +
+
+
+
+ +

+ image heading

+ +

+ img descr.

+
+ +
+
+

QML Positioning Elements

+

+ Using positioning elements, layouts can be defined and their children accessed through + an index.

+ Elements: +
    +
  • Column Element - The Column + item arranges its children vertically.
    • +
  • Flow Element - The Flow item + arranges its children side by side, wrapping as necessary.
    • +
  • Grid Element - The Grid item + positions its children in a grid.
    • +
  • Row Element - The Row item + arranges its children horizontally.
    • +
  • Repeater Element - The Repeater element allows you to repeat an Item-based component using a model.
    • +
+
+
+ +
+
+
+
+ +

+ image heading

+ +

+ img descr.

+
+ +
+
+ +

QML State Elements

+

+ States and groups of states are formed using state elements.

+ Elements: +
    +
  • AnchorChanges Element - The AnchorChanges element allows you to change the anchors of an item in a state.
    • +
  • ParentChange Element - The ParentChange element allows you to reparent an Item in a state change.
    • +
  • PropertyChanges Element - The PropertyChanges element describes new property bindings or values for a state.
    • +
  • State Element - The State + element defines configurations of objects and properties.
    • +
  • StateChangeScript Element - The StateChangeScript element allows you to run a script in a state.
    • +
  • StateGroup Element - The StateGroup element provides state support for non-Item elements.
    • +
+
+
+ +
+
+
+
+ +

+ image heading

+ +

+ img descr.

+
+ +
+
+

QML Transform Elements

+

+ Advanced handling of transformations is controlled in transform elements.

+ Elements: +
    +
  • Rotation Element - The Rotation object provides a way to rotate an Item.
    • +
  • Scale Element - The Scale element provides a way to scale an Item.
    • +
  • Transform Element - The Transform element provide a way of building advanced transformations on Items.
    • +
  • Translate Element - The Translate object provides a way to move an Item without changing its x or y properties.
    • +
+
+
+ +
+
+
+
+ +

+ image heading

+ +

+ img descr.

+
+ +
+
+

QML Utility Elements

+

+ These elements handle assorted operations such as event timing, Qt enumerations, + and font loading.

+ Elements: +
    +
  • Binding Element - The Binding element allows arbitrary property bindings to be created.
    • +
  • Connections Element - A Connections element describes generalized connections to signals.
    • +
  • DoubleValidator Element - Provides a validator for non-integer numbers.
    • +
  • FontLoader Element - The FontLoader element allows fonts to be loaded by name or URL.
    • +
  • IntValidator Element - This element provides a validator for integer values.
    • +
  • LayoutItem Element - The LayoutItem element allows declarative UI elements to be placed inside Qt's Graphics View layouts.
    • +
  • Loader Element - The Loader item allows dynamically loading an Item-based subtree from a URL or Component.
    • +
  • Package Element - Package provides a bundle for shared contexts in multiple views.
    • +
  • Qt Element - The QML global Qt object provides useful enums and functions from Qt.
    • +
  • QtObject Element - The QtObject element is the most basic element in QML.
    • +
  • RegExpValidator Element - This element provides a validator for regular expressions.
    • +
  • SystemPalette Element - The SystemPalette element provides access to the Qt palettes.
    • +
  • Timer Element - The Timer item triggers a handler at a specified interval.
    • +
  • WorkerScript Element - The WorkerScript element enables the use of threads in QML.
    • +
+
+
+ +
+
+
+
+ +

+ image heading

+ +

+ img descr.

+
+ +
+
+

Models and View Elements

+

+ Models and views are used to organize data and control their layouts using delegates. + Models dictate the data formation and views control the layouts of data in the model.

+ View Elements: +
    +
  • GridView Element - The GridView item provides a grid view of items provided by a model.
    • +
  • ListView Element - The ListView item provides a list view of items provided by a model.
    • +
  • PathView Element - The PathView element lays out model-provided items on a path.
    • +
  • WebView Element - The WebView item allows you to add Web content to a canvas.
    • +
+ Model Elements: + +
+
+ +
+
+
+
+ +

+ image heading

+ +

+ img descr.

+
+ +
+
+

Paths

+

+ QML components can be arranged along paths. Path elements allow control over different + path types.

+ Elements: + +
+
+ +
+
+
+
+ +

+ image heading

+ +

+ img descr.

+
+ +
+
+

Particle Elements

+

+ Particle effects are declared and controlled using particle elements.

+ Elements: + +
+
+ +
+
+
+
+ +

+ image heading

+ +

+ img descr.

+
+ +
+
+

Bridge Elements

+

+ Bridge elements allow direct communication between C++ and QML entities.

+ Elements: +
    +
  • LayoutItem Element - The LayoutItem element allows declarative UI elements to be placed inside Qt's Graphics View layouts.
    • +
+
+
+ +\endraw + + + +*/ + -- cgit v0.12 From 0b6adc944d7da5d4b943f1bd85666af82f1450de Mon Sep 17 00:00:00 2001 From: David Boddie Date: Wed, 17 Nov 2010 13:50:20 +0100 Subject: Doc: Updated the DirectFB documentation to reflect version changes. --- doc/src/platforms/emb-directfb-EmbLinux.qdoc | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/doc/src/platforms/emb-directfb-EmbLinux.qdoc b/doc/src/platforms/emb-directfb-EmbLinux.qdoc index dbe6c14..bcc06dc 100644 --- a/doc/src/platforms/emb-directfb-EmbLinux.qdoc +++ b/doc/src/platforms/emb-directfb-EmbLinux.qdoc @@ -39,11 +39,11 @@ and generally chip vendors start out with the official version and implement their own plugins to optimize the operations their hardware supports. -We recommend using Qt 4.6 with DirectFB. DirectFB support was introduced -already into Qt for Embedded Linux as a labs project for Qt 4.3 and folded +We recommend using Qt 4.6 or later with DirectFB. Support for DirectFB was +introduced into Qt for Embedded Linux as a labs project for Qt 4.3 and folded into Qt as a screen driver for Qt 4.4, but not supported fully. In Qt 4.5, major changes were made to make it work with the optimized raster paint -engine. And in Qt 4.6 these have been further improved. +engine. These changes were further improved in Qt 4.6. \tableofcontents -- cgit v0.12 From b5d26bfb348b6a99529ecf9ab66845e7eacd4732 Mon Sep 17 00:00:00 2001 From: David Boddie Date: Wed, 17 Nov 2010 13:51:05 +0100 Subject: Doc: Minor fixes to style. --- doc/src/platforms/emb-pointer.qdoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/src/platforms/emb-pointer.qdoc b/doc/src/platforms/emb-pointer.qdoc index 81e532f..506e9e0 100644 --- a/doc/src/platforms/emb-pointer.qdoc +++ b/doc/src/platforms/emb-pointer.qdoc @@ -105,7 +105,7 @@ {touch panels} in which case the driver must be specified explicitly to determine which device to use. - To manually specify which driver to use, set the QWS_MOUSE_PROTO + To manually specify which driver to use, set the \c QWS_MOUSE_PROTO environment variable. For example (if the current shell is bash, ksh, zsh or sh): @@ -156,7 +156,7 @@ \snippet doc/src/snippets/code/doc_src_emb-pointer.qdoc 8 To make \l{Qt for Embedded Linux} explicitly choose the tslib mouse - handler, set the QWS_MOUSE_PROTO environment variable as explained + handler, set the \c QWS_MOUSE_PROTO environment variable as explained above. \endtable -- cgit v0.12 From 9743d1ae8dcec6b64bf497e76bd49a029c8f3ecc Mon Sep 17 00:00:00 2001 From: David Boddie Date: Fri, 19 Nov 2010 20:12:04 +0100 Subject: Doc: Documented that border width does not affect rectangle geometry. Task-number: QTBUG-15458 --- src/declarative/graphicsitems/qdeclarativerectangle.cpp | 3 +++ 1 file changed, 3 insertions(+) diff --git a/src/declarative/graphicsitems/qdeclarativerectangle.cpp b/src/declarative/graphicsitems/qdeclarativerectangle.cpp index fc3954f..7686dde 100644 --- a/src/declarative/graphicsitems/qdeclarativerectangle.cpp +++ b/src/declarative/graphicsitems/qdeclarativerectangle.cpp @@ -260,6 +260,9 @@ void QDeclarativeRectangle::doUpdate() A width of 1 creates a thin line. For no line, use a width of 0 or a transparent color. + \note The width of the rectangle's border does not affect the geometry of the + rectangle itself or its position relative to other items if anchors are used. + If \c border.width is an odd number, the rectangle is painted at a half-pixel offset to retain border smoothness. Also, the border is rendered evenly on either side of the rectangle's boundaries, and the spare pixel is rendered to the right and below the -- cgit v0.12