diff options
author | Jerome Pasion <jerome.pasion@nokia.com> | 2011-02-21 16:39:56 (GMT) |
---|---|---|
committer | Jerome Pasion <jerome.pasion@nokia.com> | 2011-02-21 16:39:56 (GMT) |
commit | 1d054b71a4a97d197f345e100e1dc9ed8712199a (patch) | |
tree | b2385d4b056b4bea002965319d1eda8d9b7a9589 | |
parent | 8cc0e2327eaffb14c135f229d49386f61f1e1cae (diff) | |
parent | d8b3a29279ff71a6415074872ec97dad6622c03d (diff) | |
download | Qt-1d054b71a4a97d197f345e100e1dc9ed8712199a.zip Qt-1d054b71a4a97d197f345e100e1dc9ed8712199a.tar.gz Qt-1d054b71a4a97d197f345e100e1dc9ed8712199a.tar.bz2 |
Merge branch '4.7' of scm.dev.nokia.troll.no:qt/qt-doc-team into 4.7
Conflicts:
doc/src/index.qdoc
doc/src/mainpage.qdoc
40 files changed, 947 insertions, 829 deletions
diff --git a/doc/src/declarative/animation.qdoc b/doc/src/declarative/animation.qdoc index 7247e73..129fa34 100644 --- a/doc/src/declarative/animation.qdoc +++ b/doc/src/declarative/animation.qdoc @@ -155,7 +155,7 @@ sequence or in parallel. A banner component may have several icons or slogans to display, one after the other. The \c opacity property could transform to \c 1.0 denoting an opaque object. Using the \l{SequentialAnimation} element, the opacity animations will -play after the preceding animation finishes. The \l{ParallelAnimation} element +play after the preceding animation finishes. The \l{ParallelAnimation} element will play the animations at the same time. \snippet doc/src/snippets/declarative/animation.qml sequential animation diff --git a/doc/src/declarative/basicelements.qdoc b/doc/src/declarative/basicelements.qdoc index c0df307..0146591 100644 --- a/doc/src/declarative/basicelements.qdoc +++ b/doc/src/declarative/basicelements.qdoc @@ -51,7 +51,7 @@ This is a list of some of the elements readily available for users. \o \l {MouseArea} \endlist -For a complete list of QML elements, please visit the \l {QML Elements} page. +For a complete list of QML elements, please visit the \l {QML Elements} page. \section1 Properties and Qt Declarative Module diff --git a/doc/src/declarative/basictypes.qdoc b/doc/src/declarative/basictypes.qdoc index 453af08..1d9e28c 100644 --- a/doc/src/declarative/basictypes.qdoc +++ b/doc/src/declarative/basictypes.qdoc @@ -402,7 +402,7 @@ \c child1, \c child2 and \c child3 will be added to the children list in the order in which they appear. - List \l {Adding Properties}{properties} can be created as a + List \l {Property Binding}{properties} can be created as a \c variant type, or as a \c list<Type> type, where \c Type is the type of the object in the list: diff --git a/doc/src/declarative/dynamicobjects.qdoc b/doc/src/declarative/dynamicobjects.qdoc index a8339e0..7c10760 100644 --- a/doc/src/declarative/dynamicobjects.qdoc +++ b/doc/src/declarative/dynamicobjects.qdoc @@ -59,7 +59,7 @@ creating an item from a string of QML is useful when the item QML itself is gene at runtime. -\section2 Creating a Component dynamically +\section2 Creating a Component Dynamically To dynamically load a component defined in a QML file, call the \l {QML:Qt::createComponent()}{Qt.createComponent()} function on the \l{QML Global Object}. @@ -112,11 +112,13 @@ Notice in both instances, \l {Component::createObject()}{createObject()} is call When using files with relative paths, the path should be relative to the file where \l {QML:Qt::createComponent()}{Qt.createComponent()} is executed. -To connect signals to (or receive signals from) dynamically created objects, use the signal -\c connect() method. See \l {Connecting signals to methods and other signals} for more information. +To connect signals to (or receive signals from) dynamically created objects, +use the signal \c connect() method. See +\l{QML Signal and Handler Event System#Connecting Signals to Methods and Signals} +{Connecting Signals to Methods and Signals} for more information. -\section2 Creating an object from a string of QML +\section2 Creating an Object from a String of QML If the QML is not defined until runtime, you can create a QML item from a string of QML using the \l{QML:Qt::createQmlObject()}{Qt.createQmlObject()} function, as in the following example: @@ -208,6 +210,4 @@ can similarly be destroyed using \c destroy(): \snippet doc/src/snippets/declarative/createQmlObject.qml 0 \snippet doc/src/snippets/declarative/createQmlObject.qml destroy - */ - diff --git a/doc/src/declarative/elements.qdoc b/doc/src/declarative/elements.qdoc index c087f17..ff8e201 100644 --- a/doc/src/declarative/elements.qdoc +++ b/doc/src/declarative/elements.qdoc @@ -55,7 +55,7 @@ To see the QML elements listed by functional area, see the \o \l {BorderImage} - Allows the use of images as borders \o \l {AnimatedImage} - For playing animations stored in a series of frames \o \l {Gradient} - For defining a color gradient -\o \l {GradientStop} - Used to define a color within a \l {Gradient} +\o \l {GradientStop} - Used to define a color within a \l {Gradient} \o \l {SystemPalette} - Provides access to the Qt palettes \endlist @@ -75,7 +75,7 @@ To see the QML elements listed by functional area, see the \o \l {MouseArea} - Sets up an area for mouse interaction \o \l {Keys} - Provides components with attached properties to handle key input. \o \l {FocusScope} - Element that mediate keyboard focus changes -\o \l {Flickable} - Provides a surface that can be "flicked" +\o \l {Flickable} - Provides a surface that can be "flicked" \o \l {Flipable} - Provides a surface that produces "flipping" effects \o \l {GestureArea} - Enables simple gesture handling \endlist diff --git a/doc/src/declarative/example-slideswitch.qdoc b/doc/src/declarative/example-slideswitch.qdoc index 54ee2c7..482a292 100644 --- a/doc/src/declarative/example-slideswitch.qdoc +++ b/doc/src/declarative/example-slideswitch.qdoc @@ -121,7 +121,7 @@ For more information on scripts see \l{Integrating JavaScript}. At this point, when the switch toggles between the two states the knob will instantly change its \c x position between 1 and 78. In order for the the knob to move smoothly we add a transition that will animate the \c x property with an easing curve for a duration of 200ms. -For more information on transitions see \l{qdeclarativeanimation.html#transitions}{QML Transitions}. +For more information on transitions see \l{QML Animation and Transitions}. \section1 Usage The switch can be used in a QML file, like this: diff --git a/doc/src/declarative/extending-tutorial.qdoc b/doc/src/declarative/extending-tutorial.qdoc index 09a8ad9..0ddc430 100644 --- a/doc/src/declarative/extending-tutorial.qdoc +++ b/doc/src/declarative/extending-tutorial.qdoc @@ -27,7 +27,7 @@ /*! \page qml-extending-tutorial-index.html -\title Tutorial: Writing QML extensions with C++ +\title Tutorial: Writing QML Extensions with C++ 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 @@ -45,7 +45,7 @@ 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}{Adding Property Bindings} +\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} @@ -286,7 +286,7 @@ int-type property to store an identifier for each chart: \endcode We can also use various other property types. QML has built-in support for the types -listed in the \l{Adding Properties} documentation, which includes the following: +listed in the \l{QML Basic Types} documentation, which includes the following: \list \o bool, unsigned int, int, float, double, qreal diff --git a/doc/src/declarative/extending.qdoc b/doc/src/declarative/extending.qdoc index 0cbdd11..0f69bdb 100644 --- a/doc/src/declarative/extending.qdoc +++ b/doc/src/declarative/extending.qdoc @@ -86,7 +86,7 @@ Types can be registered by libraries, application code, or by plugins Once registered, all \l {Qt's Property System}{properties} of the supported types are available in QML. QML has intrinsic support for -properties of the types listed in the \l{Adding Properties} +properties of the types listed in the \l{QML Basic Types} document, which includes the following: \list @@ -481,7 +481,7 @@ but different parameters cannot be distinguished. Signal parameters become accessible by name to the assigned script. An unnamed parameter cannot be accessed, so care should be taken to name all the signal parameters in the C++ class declaration. The intrinsic types -listed in \l {Adding Types}, as well registered object types are permitted as +listed in \l{Adding Types}, as well registered object types are permitted as signal parameter types. Using other types is not an error, but the parameter value will not be accessible from script. @@ -705,6 +705,4 @@ public: } }; \endcode - */ - diff --git a/doc/src/declarative/javascriptblocks.qdoc b/doc/src/declarative/javascriptblocks.qdoc index 65877f9..7ef7f9a 100644 --- a/doc/src/declarative/javascriptblocks.qdoc +++ b/doc/src/declarative/javascriptblocks.qdoc @@ -224,7 +224,8 @@ in \c script.js: The \c jsFunction() will now be called whenever MouseArea's \c clicked signal is emitted. -See \l {Connecting signals to methods and other signals} for more information. +See \l{QML Signal and Handler Event System#Connecting Signals to Methods and Signals} +{Connecting Signals to Methods and Signals} for more information. \section1 QML JavaScript Restrictions diff --git a/doc/src/declarative/mouseevents.qdoc b/doc/src/declarative/mouseevents.qdoc index 533f64b..ade6760 100644 --- a/doc/src/declarative/mouseevents.qdoc +++ b/doc/src/declarative/mouseevents.qdoc @@ -64,9 +64,9 @@ definable. The MouseArea element provides \l{QML Signal and Handler Event System}{signals and handlers} to detect different mouse events. The \l MouseArea element documentation describes these -gestures in greater detail. +gestures in greater detail: -\list Mouse Gestures +\list \o canceled \o clicked \o doubleClicked @@ -117,5 +117,4 @@ such as double clicking. To facilitate the classification of mouse clicks, the MouseEvent object has an \c accepted property to disable the event propagation. To learn more about QML's event system, please read the \l {QML Signal and Handler Event System} document. - */ diff --git a/doc/src/declarative/propertybinding.qdoc b/doc/src/declarative/propertybinding.qdoc index 22d14a8..afbbe4f 100644 --- a/doc/src/declarative/propertybinding.qdoc +++ b/doc/src/declarative/propertybinding.qdoc @@ -40,9 +40,8 @@ In QML, properties serve many purposes but their main function is to bind to values. Values may be a \l{QML Basic Types}{basic type}, or other QML elements. The syntax for properties is: -\qml - [default] property <type> <name>[: defaultValue] -\endqml + +\tt{[default] property <type> <name>[: defaultValue]} Elements already possess useful properties but, to create custom properties, precede the property name with the keyword \c property. @@ -58,6 +57,7 @@ property names must begin with a lowercase letter. names. \section1 Property Binding + Property binding is a declarative way of specifying the value of a property. Binding allows a property's value to be expressed as an JavaScript expression that defines the value relative to other property values or data accessible in the application. The property value is @@ -87,7 +87,7 @@ binding is created using the colon "\c {:}". The property binding causes the width of the \c Rectangle to update whenever the \c {parent}'s width changes. -Assigning a property value (using the equals sign "\c {=}") does not create a +Assigning a property value (using the equals sign "\c {=}") does not create a property binding. \snippet doc/src/snippets/declarative/properties.qml property assignment @@ -102,13 +102,15 @@ There is no way to create a property binding directly from imperative JavaScript although it is possible to use the \l {Using the Binding Element}{Binding} element. \section1 Types of Properties + 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. -\qml - property real volume: "four" //generates an error -\endqml + +\badcode +property real volume: "four" //generates an error +\endcode Certain properties bind to more complex types such as other elements and objects. @@ -150,7 +152,7 @@ The code snippet has a \l Gradient element that attempts to print its parent's \c width value. However, the \c Gradient element is bound to the \c gradient property, not the \c children property of the \c Rectangle. As a result, the \c Gradient does not have the \c Rectangle as its parent. Printing the value -of \c{parent.width} generates an error. Printing the \c Rectangle object's +of \c{parent.width} generates an error. Printing the \c Rectangle object's first child's \c name will print \c {childrectangle} because the second \c Rectangle is bound to the \c children property. @@ -224,9 +226,8 @@ the property, a property alias connects the newly declared property, called the in a read or write operations on the aliased property, respectively. A property alias declaration is similar to an ordinary property definition: -\code - [default] property alias <name>: <alias reference> -\endcode + +\tt{[default] property alias <name>: <alias reference>} As the aliasing property has the same type as the aliased property, an explicit type is omitted, and the special \c alias keyword is before the property name. @@ -319,6 +320,4 @@ The \l PropertyChanges element is for setting property bindings within a \snippet doc/src/snippets/declarative/properties.qml PropertyChanges element The rectangle's \c color property will bind to the \c warning component's \c color property when its \c state is set to the \c WARNING state. - */ - diff --git a/doc/src/declarative/qdeclarativestates.qdoc b/doc/src/declarative/qdeclarativestates.qdoc index b1a97d7..655b647 100644 --- a/doc/src/declarative/qdeclarativestates.qdoc +++ b/doc/src/declarative/qdeclarativestates.qdoc @@ -123,7 +123,7 @@ The \c bell component will change to the \c RINGING state whenever the \section1 Animating State Changes -State changes induce abrupt value changes. The \l Transitions element allow +State changes induce abrupt value changes. The \l Transition element allow smoother changes during state changes. In transitions, animations and interpolation behaviors are definable. The \l {QML Animation and Transitions}{Animation and Transitions} article has more diff --git a/doc/src/declarative/qmlevents.qdoc b/doc/src/declarative/qmlevents.qdoc index 7dfb1f9..566f71c 100644 --- a/doc/src/declarative/qmlevents.qdoc +++ b/doc/src/declarative/qmlevents.qdoc @@ -47,9 +47,7 @@ has been clicked within the area. The syntax for defining a new signal is: -\qml -signal <name>[([<type> <parameter name>[, ...]])] -\endqml +\tt{signal <name>[([<type> <parameter name>[, ...]])]} Attempting to declare two signals or methods with the same name in the same type block generates an error. However, a new signal may reuse the name of an existing signal on the type. (This should be done with caution, as the existing signal may be hidden and become inaccessible.) @@ -119,10 +117,11 @@ output: Because QML uses Qt, a signal defined in C++ also works as a QML signal. The signal may be emitted in QML code or called as a method. In addition, the QML runtime automatically creates signal handlers for the C++ signals. For more -signal control, the \c connect() method and the \l Connect element may connect a -C++ to another signal or method. +signal control, the \c connect() method and the \l Connections element may connect +a C++ signal to another signal or method. -For complete information on how to call C++ functions in QML, read the \l {Extending QML - Signal Support Example}. +For complete information on how to call C++ functions in QML, read the +\l{Extending QML - Signal Support Example}. */ diff --git a/doc/src/declarative/qmlreusablecomponents.qdoc b/doc/src/declarative/qmlreusablecomponents.qdoc index e6c3ec9..ee360eb 100644 --- a/doc/src/declarative/qmlreusablecomponents.qdoc +++ b/doc/src/declarative/qmlreusablecomponents.qdoc @@ -29,7 +29,7 @@ \page qmlreusablecomponents.html \ingroup qml-features \previouspage {QML Signal and Handler Event System}{Signal and Handler Event System} -\nextpage {QML States}{States} +\nextpage {QML States}{States} \contentspage QML Features \title Importing Reusable Components @@ -89,7 +89,7 @@ however, be in an imported path. A consequence of inline components is that initialization may be deferred or delayed. A component may be created during a MouseArea event or by using a \l Loader element. The component can create an object, which is addressable in a -similar way as an \l {qml-id-propert}{id property}. Thus, the created object may +similar way as an \l {qml-id-property}{id property}. Thus, the created object may have its bindings set and read like a normal QML object. \snippet doc/src/snippets/declarative/reusablecomponents/component.qml define inline component \snippet doc/src/snippets/declarative/reusablecomponents/component.qml create inline component @@ -103,7 +103,7 @@ Specifically, there are \l{attached-properties}{attached properties} and \l{attached-signalhandlers}{attached signal handlers} for setting properties during the lifetime of a component. -The \c{Component.onCompleted} attached signal handler is called when the +The \c{Component.onCompleted} attached signal handler is called when the component completes initialization. It is useful for executing any commands after component initialization. Similarly, the \c{Component.onDestruction} signal handler executes when the component finishes destruction. diff --git a/doc/src/declarative/qmlviews.qdoc b/doc/src/declarative/qmlviews.qdoc index 8b2ca96..4071d5d 100644 --- a/doc/src/declarative/qmlviews.qdoc +++ b/doc/src/declarative/qmlviews.qdoc @@ -44,7 +44,7 @@ graphical elements: \o \l{ListView} arranges items in a horizontal or vertical list \o \l{GridView} arranges items in a grid within the available space \o \l{PathView} arranges items on a path -\o \l{WebView}{WebView} - available from the \l {QtWebKit QML Module}. +\o \l{WebView}{WebView} - available from the \l {QtWebKit QML Module}. \endlist Unlike other views, \l WebView is not a fully-featured view item, and needs to be combined with a \l Flickable item to create a view that performs like @@ -103,12 +103,11 @@ the person belongs. \snippet doc/src/snippets/declarative/listview-sections.qml delegate The ListView element has the \c section -\l{qml-attached-properties}{attached property} that can combine adjacent -and related elements into a section. The section's \c property property is for -selecting which list element property to use as sections. The \c criteria -can dictate how the section names are displayed and the \c delegate is similar -to the views' \l {qml-view-delegate}{delegate} property. +\l{Property Binding#Attached Properties}{attached property} that can combine +adjacent and related elements into a section. The section's \c property +property is for selecting which list element property to use as sections. +The \c criteria can dictate how the section names are displayed and the +\c delegate is similar to the views' \l {qml-view-delegate}{delegate} property. \snippet doc/src/snippets/declarative/listview-sections.qml section \image listview-section.png - */ diff --git a/doc/src/declarative/qtquick-intro.qdoc b/doc/src/declarative/qtquick-intro.qdoc index 1bbae8f..02b2c44 100644 --- a/doc/src/declarative/qtquick-intro.qdoc +++ b/doc/src/declarative/qtquick-intro.qdoc @@ -109,7 +109,7 @@ system. \section1 Where to Go from Here -The \l {Qt Quick} page has links to various Qt Quick topics such as QML +The \l {Qt Quick} page has links to various Qt Quick topics such as QML features, addons, and tools. The \l {QML Examples and Demos} page has a gallery of QML applications. diff --git a/doc/src/declarative/tutorial.qdoc b/doc/src/declarative/tutorial.qdoc index 1ee5e61..dc08ba0 100644 --- a/doc/src/declarative/tutorial.qdoc +++ b/doc/src/declarative/tutorial.qdoc @@ -144,7 +144,7 @@ An \l Item is the most basic visual element in QML and is often used as a contai We declare a \c cellColor property. This property is accessible from \e outside our component, this allows us to instantiate the cells with different colors. -This property is just an alias to an existing property - the color of the rectangle that compose the cell (see \l{Adding Properties}). +This property is just an alias to an existing property - the color of the rectangle that compose the cell (see \l{Property Binding}). \snippet examples/declarative/tutorials/helloworld/Cell.qml 5 diff --git a/doc/src/development/qmake-manual.qdoc b/doc/src/development/qmake-manual.qdoc index da105e6..6cfe356 100644 --- a/doc/src/development/qmake-manual.qdoc +++ b/doc/src/development/qmake-manual.qdoc @@ -908,13 +908,13 @@ {deployment guide for Windows}. - \section1 Symbian platform + \section1 Symbian Platform Features specific to this platform include handling of static data, capabilities, stack and heap size, compiler specific options, and unique identifiers for the application or library. - \section2 Handling of static data + \section2 Handling of Static Data If the application uses any static data, the build system needs to be informed about it. This is because Symbian tries to save memory if no @@ -926,7 +926,7 @@ The default value is zero. - \section2 Stack and heap size + \section2 Stack and Heap Size The Symbian platform uses predefined sizes for stacks and heaps. If an application exceeds either limit, it may crash or fail to complete its @@ -941,10 +941,10 @@ \snippet doc/src/snippets/code/doc_src_qmake-manual.pro 130 The default values depend on the version of the Symbian SDK you're using, - however, the Qt toolchain sets this to the maximum possible value and this - should not be changed. + however, the Qt toolchain sets this to the maximum possible value and this + should not be changed. - \section2 Compiler specific options + \section2 Compiler-Specific Options General compiler options can as usual be set using \c QMAKE_CFLAGS and \c QMAKE_CXXFLAGS. In order to set specific compiler options, \c QMAKE_CFLAGS.<compiler> and @@ -956,7 +956,7 @@ \snippet doc/src/snippets/code/doc_src_qmake-manual.pro 131 - \section2 Unique identifiers + \section2 Unique Identifiers Symbian applications may have unique identifiers attached to them. Here is how to define them in a project file: @@ -969,19 +969,22 @@ If \c SID is not specified, it defaults to the same value as \c UID3. If \c UID3 is not specified, qmake will automatically generate a \c UID3 suitable for development and debugging. This value should be manually - specified for applications that are to be released. In order to obtain - an official UID, please contact \l{Symbian}{http:\\www.symbiansigned.com}. - Both \c SID and \c VID default to empty values. + specified for applications that are to be released. See the + \l{Symbian Signed} Web site for information about obtaining an official + UID. + + Both \c SID and \c VID default to empty values. There exists one UID1 too, but this should not be touched by any application. - - The UID2 has a specific value for different types of files - e.g. apps/exes - are always 0x100039CE. The toolchain will set this for value for the most common file types like, - EXE/APP and shared library DLL. - - For more information about unique identifiers and their meaning for Symbian applications, - please refer to the \l{Symbian SDK documentation}{http://developer.symbian.org/main/documentation/reference/s3/pdk/GUID-380A8C4F-3EB6-5E1C-BCFB-ED5B866136D9.html} - + + The UID2 has a specific value for different types of files - e.g. apps/exes + are always 0x100039CE. The toolchain will set this for value for the most common file types like, + EXE/APP and shared library DLL. + + For more information about unique identifiers and their meaning for + Symbian applications, please refer to the \l{UID Q&As (Symbian Signed)} + page in the \l{Forum Nokia Wiki} for more information. + \section2 Capabilities Capabilities define extra privileges for the application, such as the @@ -3122,8 +3125,34 @@ \e {This is only used on the Symbian platform.} - Specifies which platform capabilities the application should have. For more - information, please refer to the Symbian SDK documentation. + Specifies which platform capabilities the application should have. These + include the following basic capabilities, but others are also available + for signed applications. + + \table + \header \o Capability \o Description + \row \o LocalServices \o The ability to use local services running on the + phone or device, including those which provide + local connectivity to other devices. + \row \o Location \o Access to the service that provides information + about the user's location, from GPS, phone + network, or other sources. + \row \o NetworkServices \o Use of services that access the phone network, + such as dialling a phone number, sending an SMS, + or other operations that result in network + traffic. + \row \o ReadUserData \o Access to the user's private data, such as + contact information. + \row \o UserEnvironment \o The ability to use services that provide from the + user's physical environment, such as the camera or + microphone. + \row \o WriteUserData \o The ability to write or modify the user's private + data. + \endtable + + For more information, and a comprehensive list of capabilities, please refer + to the Symbian SDK documentation or the \l{Symbian Capabilities} page of + the \l{Forum Nokia Wiki}. \target TARGET.EPOCALLOWDLLDATA \section1 TARGET.EPOCALLOWDLLDATA @@ -4004,65 +4033,65 @@ \table \header - \o Member - \o Description - \row - \o commands - \o The commands used for for generating the output from the input. - \row - \o CONFIG - \o Specific configuration options for the custom compiler. See the CONFIG table for details. - \row - \o depend_command - \o Specifies a command used to generate the list of dependencies for the output. - \row - \o dependency_type - \o Specifies the type of file the output is, if it is a known type (such as TYPE_C, - TYPE_UI, TYPE_QRC) then it is handled as one of those type of files. - \row - \o depends - \o Specifies the dependencies of the output file. - \row - \o input - \o The variable that contains the files that should be processed with the custom compiler. - \row - \o name - \o A description of what the custom compiler is doing. This is only used in some backends. - \row - \o output - \o The filename that is created from the custom compiler. - \row - \o output_function - \o Specifies a custom qmake function that is used to specify the filename to be created. - \row - \o variables - \o Indicates that the variables specified here are replaced with $(QMAKE_COMP_VARNAME) when refered to - in the pro file as $(VARNAME). - \row - \o variable_out - \o The variable that the files created from the output should be added to. - \endtable - - List of members specific to the CONFIG option: - - \table - \header - \o Member - \o Description - \row - \o combine - \o Indicates that all of the input files are combined into a single output file. - \row - \o target_predeps - \o Indicates that the output should be added to the list of PRE_TARGETDEPS. - \row - \o explicit_dependencies - \o The dependencies for the output only get generated from the depends member and from - nowhere else. - \row - \o no_link - \o Indicates that the output should not be added to the list of objects to be linked in. - \endtable + \o Member + \o Description + \row + \o commands + \o The commands used for for generating the output from the input. + \row + \o CONFIG + \o Specific configuration options for the custom compiler. See the CONFIG table for details. + \row + \o depend_command + \o Specifies a command used to generate the list of dependencies for the output. + \row + \o dependency_type + \o Specifies the type of file the output is, if it is a known type (such as TYPE_C, + TYPE_UI, TYPE_QRC) then it is handled as one of those type of files. + \row + \o depends + \o Specifies the dependencies of the output file. + \row + \o input + \o The variable that contains the files that should be processed with the custom compiler. + \row + \o name + \o A description of what the custom compiler is doing. This is only used in some backends. + \row + \o output + \o The filename that is created from the custom compiler. + \row + \o output_function + \o Specifies a custom qmake function that is used to specify the filename to be created. + \row + \o variables + \o Indicates that the variables specified here are replaced with $(QMAKE_COMP_VARNAME) when refered to + in the pro file as $(VARNAME). + \row + \o variable_out + \o The variable that the files created from the output should be added to. + \endtable + + List of members specific to the CONFIG option: + + \table + \header + \o Member + \o Description + \row + \o combine + \o Indicates that all of the input files are combined into a single output file. + \row + \o target_predeps + \o Indicates that the output should be added to the list of PRE_TARGETDEPS. + \row + \o explicit_dependencies + \o The dependencies for the output only get generated from the depends member and from + nowhere else. + \row + \o no_link + \o Indicates that the output should not be added to the list of objects to be linked in. + \endtable \note Symbian platform specific: Generating objects to be linked in is not supported on the Symbian platform, so either the \c CONFIG option @@ -4202,10 +4231,10 @@ Generally, the \c : operator behaves like a logical AND operator, joining together a number of conditions, and requiring all of them to be true. - There is also the \c | operator to act like a logical OR operator, joining - together a number of conditions, and requiring only one of them to be true. + There is also the \c | operator to act like a logical OR operator, joining + together a number of conditions, and requiring only one of them to be true. - \snippet doc/src/snippets/qmake/scopes.pro 4 + \snippet doc/src/snippets/qmake/scopes.pro 4 You can also provide alternative declarations to those within a scope by using an \c else scope. Each \c else scope is processed if the conditions diff --git a/doc/src/external-resources.qdoc b/doc/src/external-resources.qdoc index 0fb7c52..1abeae9 100644 --- a/doc/src/external-resources.qdoc +++ b/doc/src/external-resources.qdoc @@ -455,7 +455,6 @@ */ /*! - \externalpage https://developer.mozilla.org/en/JavaScript/Reference/Reserved_Words \title JavaScript Reserved Words */ @@ -465,3 +464,22 @@ \title publicsuffix.org */ +/*! + \externalpage http://wiki.forum.nokia.com/index.php/Capabilities + \title Symbian Capabilities +*/ + +/*! + \externalpage http://wiki.forum.nokia.com/ + \title Forum Nokia Wiki +*/ + +/*! + \externalpage http://wiki.forum.nokia.com/index.php/UID_Q&As_(Symbian_Signed) + \title UID Q&As (Symbian Signed) +*/ + +/*! + \externalpage http://www.symbiansigned.com + \title Symbian Signed +*/ diff --git a/doc/src/getting-started/installation.qdoc b/doc/src/getting-started/installation.qdoc index 4e646e1..5dfea21 100644 --- a/doc/src/getting-started/installation.qdoc +++ b/doc/src/getting-started/installation.qdoc @@ -1189,7 +1189,7 @@ We hope you will enjoy using Qt. \list \o Development environment: \list - \o Microsoft Visual Studio 2005 (Standard Edition) or higher + \o Microsoft Visual Studio 2005 (Standard Edition) or higher \o ActivePerl \endlist \o Footprint @@ -1204,8 +1204,8 @@ We hope you will enjoy using Qt. \endlist \o Hardware Platform \list - \o Supported on ARM, x86 - \o (Compiles on SH4 and MIPS) + \o Supported on ARM, x86 + \o (Compiles on SH4 and MIPS) \endlist \endlist diff --git a/doc/src/howtos/qmlbestpractices/qmlbestpractices-coding.qdoc b/doc/src/howtos/qmlbestpractices/qmlbestpractices-coding.qdoc index e33ee13..ac3669d 100644 --- a/doc/src/howtos/qmlbestpractices/qmlbestpractices-coding.qdoc +++ b/doc/src/howtos/qmlbestpractices/qmlbestpractices-coding.qdoc @@ -90,8 +90,8 @@ Similar to JavaScript or C++, there are two ways of commenting QML code: \section1 Group Properties -Many QML properties are \l{attached-properties}{attached} or -\l {qml-grouped-properties}{group} properties. For convenience, you may treat +Many QML properties are \l{attached-properties}{attached} or +\l {qml-grouped-properties}{group} properties. For convenience, you may treat them as another element when dealing with multiple properties belonging to the same group. diff --git a/doc/src/howtos/scalabilityintro.qdoc b/doc/src/howtos/scalabilityintro.qdoc index 1abdc7a..d9c5658 100644 --- a/doc/src/howtos/scalabilityintro.qdoc +++ b/doc/src/howtos/scalabilityintro.qdoc @@ -24,6 +24,7 @@ ** $QT_END_LICENSE$ ** ****************************************************************************/ + /*! \title Scalability \page scalability.html diff --git a/doc/src/index.qdoc b/doc/src/index.qdoc index 3984574..726562f 100644 --- a/doc/src/index.qdoc +++ b/doc/src/index.qdoc @@ -38,7 +38,7 @@ \div {indexboxcont indexboxbar } \div {sectionlist normallist} \div {heading} - \l What is Qt + What is Qt \enddiv \image qt-logo_large.png Qt is a cross-platform application and UI framework. Using Qt, you can @@ -46,9 +46,6 @@ embedded operating systems without rewriting the source code. \enddiv \div {sectionlist normallist} - \div {heading} - \emptyspan - \enddiv \list \o \l{http://doc.qt.nokia.com/nokia-qtsdk-1.0/index.html}{Qt SDK} \o \l{http://developer.qt.nokia.com/wiki/QtCreatorWhitepaper}{Qt Creator} @@ -67,7 +64,7 @@ \enddiv \div {sectionlist normallist} \div {heading} - \l See Qt + See Qt \enddiv \image mobile.png \list @@ -83,7 +80,7 @@ \div {indexboxcont indexboxbar } \div {sectionlist normallist} \div {heading} - \l Develop with Qt + Develop with Qt \enddiv \image tools.png \list @@ -96,7 +93,7 @@ \enddiv \div {sectionlist normallist} \div {heading} - \l Featured Articles + Featured Articles \enddiv \image guide.png \list @@ -113,7 +110,7 @@ innovative solutions using Qt. \enddiv \div {sectionlist normallist} \div {heading} - \l UI Creation with Qt + UI Creation with Qt \enddiv \image qml.png \list diff --git a/doc/src/mainpage.qdoc b/doc/src/mainpage.qdoc index bcd4cda..9799247 100644 --- a/doc/src/mainpage.qdoc +++ b/doc/src/mainpage.qdoc @@ -26,9 +26,9 @@ ****************************************************************************/ /*! - \page gettingstarted-develop.html - \title Develop with Qt - \ingroup gettingstarted +\page gettingstarted-develop.html +\title Develop with Qt +\ingroup gettingstarted \div {indexboxcont indexboxbar} Developing a Qt application involves many different steps and stages. From @@ -68,13 +68,13 @@ Information regarding Qt Support on Different Platforms: \o \l{Installing Qt for the Symbian platform}{Symbian and Mobile Development} \o \l{Support for Windows}{Microsoft Windows} \o \l{Support for Windows CE and Windows Mobile}{Microsoft Windows CE} -\o \l{Support for Mac}{Apple Mac OS X} +\o \l{Support for Mac OS X}{Apple Mac OS X} \o \l{Support for Linux/X11}{Linux and X11 Platforms} \o \l{Support for Embedded Linux}{Qt for Embedded Linux} \endlist For more information about the platforms supported and their installation pages, view the \l {Supported Platforms} and the -\l {Cross-Platform and Platform-Specific Development} pages. +\l {Cross-Platform and Platform-Specific Development} pages. \enddiv \div {indexboxcont indexboxbar normallist} @@ -82,9 +82,9 @@ and their installation pages, view the \l {Supported Platforms} and the \section1 Qt Technologies Qt introduces an innovative alternative for inter-object communication, called -“signals and slots”, that replaces the old and unsafe callback technique used in +"signals and slots", that replaces the old and unsafe callback technique used in many legacy frameworks. Qt also provides a conventional event model for handling -mouse clicks, key presses, and other user input. Qt’s cross-platform GUI +mouse clicks, key presses, and other user input. Qt's cross-platform GUI applications can support all the user interface functionality required by modern applications, such as menus, context menus, drag and drop, and dockable toolbars. Desktop integration features provided by Qt can be used to extend @@ -159,7 +159,7 @@ Qt supports many utilities that work on multiple platforms. \o \l{Container Classes}{Containers} - Qt's implementation of various data structures such as linked lists and hash maps \o \l{Rich Text Processing} - for manipulating structured rich text documents \o \l{XML Processing} - high level manipulation of XML data using different interfaces -\o \l{Making Applications Scriptable} - provides Qt applications with ECMAScript processor. +\o \l{Making Applications Scriptable} - provides Qt applications with ECMAScript processor. \o \l{Qt Linguist Manual}{Qt Linguist} - for translating applications into local languages. \endlist For more information, visit the \l{Qt's Tools}{Qt Tools} page. @@ -170,7 +170,7 @@ For more information, visit the \l{Qt's Tools}{Qt Tools} page. Testing and debugging are part of the development process and Qt offers the developer multiple methods of testing their code. \list -\o \l{http://doc.qt.nokia.com/qtcreator-snapshot/creator-debugging.html} {Debugging Applications in Creator} - various debugging options in Creator +\o \l{http://doc.qt.nokia.com/qtcreator-snapshot/creator-debugging.html} {Debugging Applications in Creator} - various debugging options in Creator \o \l {http://doc.qt.nokia.com/qtsimulator/index.html}{Simulator} - testing mobile applications by simulating a mobile environment \o \l {QML Viewer} - an executable that is able to run QML files \o \l{QTestLib Manual}{QTestLib} - a unit testing framework built into Qt diff --git a/doc/src/overviews.qdoc b/doc/src/overviews.qdoc index 6835e17..73900c4 100644 --- a/doc/src/overviews.qdoc +++ b/doc/src/overviews.qdoc @@ -42,7 +42,7 @@ Qt is a cross-platform application and UI framework for writing web-enabled applications for desktop, mobile, and embedded operating systems. This page contains links to articles and overviews - explaining key components and techniques used in Qt development. + explaining key components and techniques used in Qt development. \generatelist {related} */ diff --git a/doc/src/platforms/supported-platforms.qdoc b/doc/src/platforms/supported-platforms.qdoc index 5b76a86..443c8b8 100644 --- a/doc/src/platforms/supported-platforms.qdoc +++ b/doc/src/platforms/supported-platforms.qdoc @@ -30,336 +30,334 @@ \title Support for Windows \brief Platform support for Windows. \ingroup platform-specific - \ingroup platform-details - - \section2 Qt on Windows - - Qt is a comprehensive application and UI framework for developing Windows - applications that can also be deployed across many other desktop and - embedded operating systems without rewriting the source code. Use the - code from one single code-base and rebuild for all - \l{Supported Platforms}{supported Windows versions and other platforms}. - - \section1 Getting Started on Windows - - \list - \o \l{Supported Platforms}{Supported Windows platforms} - Qt - supports a wide range of Windows platforms. - \o \l{Qt for Windows Requirements}{Qt for Windows Requirements} - - Requirements for developing with Qt on Windows. - \o \l{Installing Qt for Windows}{Installing Qt for Windows} - - Build Qt for Windows development. - \o \l{Platform and Compiler Notes - Windows}{Platform and Compiler Notes - Windows} - - Windows platform specific notes. + \ingroup platform-details + + \section1 Qt on Windows + + Qt is a comprehensive application and UI framework for developing Windows + applications that can also be deployed across many other desktop and + embedded operating systems without rewriting the source code. Use the + code from one single code-base and rebuild for all + \l{Supported Platforms}{supported Windows versions and other platforms}. + + \section1 Getting Started on Windows + + \list + \o \l{Supported Platforms}{Supported Windows platforms} - Qt + supports a wide range of Windows platforms. + \o \l{Qt for Windows Requirements}{Qt for Windows Requirements} + - Requirements for developing with Qt on Windows. + \o \l{Installing Qt for Windows}{Installing Qt for Windows} + - Build Qt for Windows development. + \o \l{Platform and Compiler Notes - Windows}{Platform and Compiler Notes - Windows} + - Windows platform specific notes. \o \l{Getting Started Guides}{Getting started} - Getting started developing for Windows - \endlist - - \section1 Key Features for Windows Development - - \section2 Rich Class Library - - The Qt class library includes all the functionality needed to build - advanced GUI applications. - - \list - \o Complete set of customizable \l{UI Design with Qt}{UI - controls/widgets} - \o 3D graphics support with \l{QtOpenGL Module}{OpenGL} - or Direct3D - \o Powerful \l{Thread Support in Qt}{multi-threading} features - \o \l{Graphics View Framework}{2D graphics canvas} capable of - handling millions of items - \o Integrated \l{Phonon multimedia framework}{Phonon multimedia - framework} - \o \l{WebKit in Qt}{WebKit} integration - \o \l{Network programming with Qt}{Networking}, \l{QtXml Module} - {XML} and \l{SQL in Qt}{database} functionality - \o \l{ECMAScript Reference}{ECMA standard} scripting engine - \endlist - - \section2 Integrated Development Tools - - Qt includes a set of integrated development tools to speed - development on the Windows platform. - - \list - \o \l{Qt Designer Manual}{Qt Designer} provides a drag and drop - visual GUI builder. - \o \l{Qt Linguist Manual}{Qt Linguist} provides internationalization - and translation features. - \o \l{Qt Assistant Manual}{Qt Assistant} is a customizable HTML help - file reader providing the complete Qt documentation offline. - \endlist - - \section2 Cross-platform development using Qt Creator - - \l{http://doc.qt.nokia.com/qtcreator-snapshot/index.html}{Qt Creator} is - a complete Cross-platform IDE included in the Qt SDK. The IDE allows - programmers to create, build, debug and run Qt applications accross all - supported platforms. - - \section2 Visual Studio Add-in. - - The Qt Visual Studio Add-in allows programmers to create, build, debug - and run Qt applications from within Microsoft Visual Studio 2005, 2008 - and 2010. The add-in contains project wizards, Qt project import/export - support, integrated Qt resource manager and automated build setup for - the Qt Meta-Object Compiler, User Interface Compiler, and Resource - Compiler. - - Additional \l{Cross-Platform and Platform-Specific Development - }{Cross-Platform and Platform-Specific Development} information. - - + \endlist + + \section1 Key Features for Windows Development + + \section2 Rich Class Library + + The Qt class library includes all the functionality needed to build + advanced GUI applications. + + \list + \o Complete set of customizable \l{UI Design with Qt}{UI + controls/widgets} + \o 3D graphics support with \l{QtOpenGL Module}{OpenGL} + or Direct3D + \o Powerful \l{Thread Support in Qt}{multi-threading} features + \o \l{Graphics View Framework}{2D graphics canvas} capable of + handling millions of items + \o Integrated \l{Phonon multimedia framework}{Phonon multimedia + framework} + \o \l{WebKit in Qt}{WebKit} integration + \o \l{Network programming with Qt}{Networking}, \l{QtXml Module} + {XML} and \l{SQL in Qt}{database} functionality + \o \l{ECMAScript Reference}{ECMA standard} scripting engine + \endlist + + \section2 Integrated Development Tools + + Qt includes a set of integrated development tools to speed + development on the Windows platform. + + \list + \o \l{Qt Designer Manual}{Qt Designer} provides a drag and drop + visual GUI builder. + \o \l{Qt Linguist Manual}{Qt Linguist} provides internationalization + and translation features. + \o \l{Qt Assistant Manual}{Qt Assistant} is a customizable HTML help + file reader providing the complete Qt documentation offline. + \endlist + + \section2 Cross-Platform Development using Qt Creator + + \l{http://doc.qt.nokia.com/qtcreator-snapshot/index.html}{Qt Creator} is + a complete Cross-platform IDE included in the Qt SDK. The IDE allows + programmers to create, build, debug and run Qt applications accross all + supported platforms. + + \section2 Visual Studio Add-in. + + The Qt Visual Studio Add-in allows programmers to create, build, debug + and run Qt applications from within Microsoft Visual Studio 2005, 2008 + and 2010. The add-in contains project wizards, Qt project import/export + support, integrated Qt resource manager and automated build setup for + the Qt Meta-Object Compiler, User Interface Compiler, and Resource + Compiler. + + Additional \l{Cross-Platform and Platform-Specific Development} + information. */ /*! \page linuxX11-support.html - \title Support for Linux/X11 + \title Support for Linux/X11 \brief Platform support for Linux/X11. \ingroup platform-specific - \ingroup platform-details - - \section2 Qt on Linux/X11 - - Qt is a comprehensive application and UI framework for developing - Linux/X11 applications that can also be deployed across many other - desktop and embedded operating systems without rewriting the source code. - Use the code from one single code-base and rebuild for all - \l{Supported Platforms}{supported X11 versions and other platforms}. - - \section1 Getting Started on Linux/X11 - - \list - \o \l{Supported Platforms}{Supported Linux/X11 platforms} - Qt - supports a wide range of Linux/X11 platforms. - \o \l{Qt for X11 Requirements}{Qt for X11 Requirements} - - Software required to run Qt on Linux/X11. - \o \l{Installing Qt for X11 Platforms}{Installing Qt for X11 Platforms} - - Build Qt for Linux/X11 development. - \o \l{Platform and Compiler Notes - X11}{Platform and Compiler Notes - X11} - - Platform specific notes. + \ingroup platform-details + + \section1 Qt on Linux/X11 + + Qt is a comprehensive application and UI framework for developing + Linux/X11 applications that can also be deployed across many other + desktop and embedded operating systems without rewriting the source code. + Use the code from one single code-base and rebuild for all + \l{Supported Platforms}{supported X11 versions and other platforms}. + + \section1 Getting Started on Linux/X11 + + \list + \o \l{Supported Platforms}{Supported Linux/X11 platforms} - Qt + supports a wide range of Linux/X11 platforms. + \o \l{Qt for X11 Requirements}{Qt for X11 Requirements} + - Software required to run Qt on Linux/X11. + \o \l{Installing Qt for X11 Platforms}{Installing Qt for X11 Platforms} + - Build Qt for Linux/X11 development. + \o \l{Platform and Compiler Notes - X11}{Platform and Compiler Notes - X11} + - Platform specific notes. \o \l{Getting Started Guides}{Getting started} - \endlist - - \section1 Key Features for Linux/X11 Development - - \section2 Integrated Development Tools - - Qt includes a set of integrated development tools to speed development - on X11 platforms. - - \list - \o \l{Qt Designer Manual}{Qt Designer} provides a drag and drop - visual GUI builder. - \o \l{Qt Linguist Manual}{Qt Linguist} provides internationalization - and translation features. - \o \l{Qt Assistant Manual}{Qt Assistant} is a customizable HTML help - file reader providing the complete Qt documentation offline. - \o Integration with - \l{http://doc.qt.nokia.com/qt-eclipse-1.6/index.html}{Eclipse} - and KDevelop IDEs are also available. - \endlist - - \section2 Cross-platform development using Qt Creator - - \l{http://doc.qt.nokia.com/qtcreator-snapshot/index.html}{Qt Creator} is - a complete Cross-platform IDE included in the Qt SDK. The IDE allows - programmers to create, build, debug and run Qt applications accross all - supported platforms. - - \section2 Rich Class Library - - The Qt class library includes all the functionality needed to build - advanced GUI applications. - - \list - \o Complete set of customizable \l{UI Design with Qt}{UI - controls/widgets} - \o 3D graphics support with \l{QtOpenGL Module}{OpenGL - integration} - \o Powerful \l{Thread Support in Qt}{multi-threading} features - \o \l{Graphics View Framework}{2D graphics canvas} capable of - handling millions of items - \o Integrated \l{Phonon multimedia framework}{Phonon multimedia - framework} - \o \l{WebKit in Qt}{WebKit} integration - \o \l{Network programming with Qt}{Networking}, \l{QtXml Module} - {XML} and \l{SQL in Qt}{database} functionality - \o \l{ECMAScript Reference}{ECMA standard} scripting engine - \endlist - - \section2 Qt is the Foundation of KDE - - Qt is best known in the Linux community as the basis for the KDE - desktop environment. Almost everything in KDE is based on Qt, and - Qt forms the foundation for thousands of open source KDE applications - developed by community members worldwide. - - Additional \l{Cross-Platform and Platform-Specific Development - }{Cross-Platform and Platform-Specific Development} information. + \endlist + + \section1 Key Features for Linux/X11 Development + + \section2 Integrated Development Tools + + Qt includes a set of integrated development tools to speed development + on X11 platforms. + + \list + \o \l{Qt Designer Manual}{Qt Designer} provides a drag and drop + visual GUI builder. + \o \l{Qt Linguist Manual}{Qt Linguist} provides internationalization + and translation features. + \o \l{Qt Assistant Manual}{Qt Assistant} is a customizable HTML help + file reader providing the complete Qt documentation offline. + \o Integration with + \l{http://doc.qt.nokia.com/qt-eclipse-1.6/index.html}{Eclipse} + and KDevelop IDEs are also available. + \endlist + + \section2 Cross-Platform Development using Qt Creator + + \l{http://doc.qt.nokia.com/qtcreator-snapshot/index.html}{Qt Creator} is + a complete Cross-platform IDE included in the Qt SDK. The IDE allows + programmers to create, build, debug and run Qt applications accross all + supported platforms. + + \section2 Rich Class Library + + The Qt class library includes all the functionality needed to build + advanced GUI applications. + + \list + \o Complete set of customizable \l{UI Design with Qt}{UI + controls/widgets} + \o 3D graphics support with \l{QtOpenGL Module}{OpenGL + integration} + \o Powerful \l{Thread Support in Qt}{multi-threading} features + \o \l{Graphics View Framework}{2D graphics canvas} capable of + handling millions of items + \o Integrated \l{Phonon multimedia framework}{Phonon multimedia + framework} + \o \l{WebKit in Qt}{WebKit} integration + \o \l{Network programming with Qt}{Networking}, \l{QtXml Module} + {XML} and \l{SQL in Qt}{database} functionality + \o \l{ECMAScript Reference}{ECMA standard} scripting engine + \endlist + + \section2 Qt is the Foundation of KDE + + Qt is best known in the Linux community as the basis for the KDE + desktop environment. Almost everything in KDE is based on Qt, and + Qt forms the foundation for thousands of open source KDE applications + developed by community members worldwide. + + Additional \l{Cross-Platform and Platform-Specific Development} + information. */ /*! \page mac-support.html - \title Support for Mac - \brief Platform support for Mac. + \title Support for Mac OS X + \brief Platform support for Mac OS X. \ingroup platform-specific - \ingroup platform-details - - \section2 Qt on Mac - - Qt is a comprehensive application and UI framework for developing Mac - applications that can also be deployed across many other desktop and - embedded operating systems without rewriting the source code. Use the - code from one single code-base and rebuild for all - \l{Supported Platforms}{supported Windows versions and other platforms}. - - \section1 Getting Started on Mac - - \list - \o \l{Supported Platforms}{Supported Mac OS X platforms} - Qt supports - a wide range of Mac platform variants. - \o \l{Qt for Mac OS X Requirements}{Qt for Mac OS X Requirements} - - Software required to run Qt on Mac OS X. - \o \l{Installing Qt for X11 Platforms}{Installing Qt for X11 Platforms} - - Build Qt for Mac OS X development. - \o \l{Platform and Compiler Notes - Mac OS X}{Platform and Compiler Notes - Mac OS X} - - Platform specific notes. + \ingroup platform-details + + \section1 Qt on Mac OS X + + Qt is a comprehensive application and UI framework for developing Mac + applications that can also be deployed across many other desktop and + embedded operating systems without rewriting the source code. Use the + code from one single code-base and rebuild for all + \l{Supported Platforms}{supported Windows versions and other platforms}. + + \section1 Getting Started on Mac + + \list + \o \l{Supported Platforms}{Supported Mac OS X platforms} - Qt supports + a wide range of Mac platform variants. + \o \l{Qt for Mac OS X Requirements}{Qt for Mac OS X Requirements} + - Software required to run Qt on Mac OS X. + \o \l{Installing Qt for X11 Platforms}{Installing Qt for X11 Platforms} + - Build Qt for Mac OS X development. + \o \l{Platform and Compiler Notes - Mac OS X}{Platform and Compiler Notes - Mac OS X} + - Platform specific notes. \o \l{Getting Started Guides}{Getting started} - \endlist - - \section1 Key Features for Mac OS X Development - - \section2 Integrated Development Tools - - Qt includes a set of integrated development tools to speed development - on the Mac platform. - - \list - \o \l{Qt Designer Manual}{Qt Designer} provides a drag and drop - visual GUI builder. - \o \l{Qt Linguist Manual}{Qt Linguist} provides internationalization - and translation features. - \o \l{Qt Assistant Manual}{Qt Assistant} is a customizable HTML help - file reader providing the complete Qt documentation offline. - \endlist - - \section2 Cross-platform development using Qt Creator - - \l{http://doc.qt.nokia.com/qtcreator-snapshot/index.html}{Qt Creator} is - a complete Cross-platform IDE included in the Qt SDK. The IDE allows - programmers to create, build, debug and run Qt applications accross all - supported platforms. - - \section2 Rich Class Library - - The Qt class library includes all the functionality needed to build - advanced GUI applications. - - \list - \o Complete set of customizable \l{UI Design with Qt}{UI - controls/widgets} - \o 3D graphics support with \l{QtOpenGL Module}{OpenGL - integration} - \o Powerful \l{Thread Support in Qt}{multi-threading} features - \o \l{Graphics View Framework}{2D graphics canvas} capable of - handling millions of items - \o Integrated \l{Phonon multimedia framework}{Phonon multimedia - framework} - \o \l{WebKit in Qt}{WebKit} integration - \o \l{Network programming with Qt}{Networking}, \l{QtXml Module} - {XML} and \l{SQL in Qt}{database} functionality - \o \l{ECMAScript Reference}{ECMA standard} scripting engine - \endlist - - \section3 Supports Intel Hardware and Universal Binaries - - Qt is written without making assumptions about the number representation, - endianness or architecture of the underlying processor. To support Intel - hardware on the Apple platforms, Qt customers simply need to recompile - their apps. - - Additional \l{Cross-Platform and Platform-Specific Development - }{Cross-Platform and Platform-Specific Development} information. - - \note Qt also provides support for 64-bit applications on top of Cocoa APIs. + \endlist + + \section1 Key Features for Mac OS X Development + + \section2 Integrated Development Tools + + Qt includes a set of integrated development tools to speed development + on the Mac platform. + + \list + \o \l{Qt Designer Manual}{Qt Designer} provides a drag and drop + visual GUI builder. + \o \l{Qt Linguist Manual}{Qt Linguist} provides internationalization + and translation features. + \o \l{Qt Assistant Manual}{Qt Assistant} is a customizable HTML help + file reader providing the complete Qt documentation offline. + \endlist + + \section2 Cross-Platform Development using Qt Creator + + \l{http://doc.qt.nokia.com/qtcreator-snapshot/index.html}{Qt Creator} is + a complete Cross-platform IDE included in the Qt SDK. The IDE allows + programmers to create, build, debug and run Qt applications accross all + supported platforms. + + \section2 Rich Class Library + + The Qt class library includes all the functionality needed to build + advanced GUI applications. + + \list + \o Complete set of customizable \l{UI Design with Qt}{UI + controls/widgets} + \o 3D graphics support with \l{QtOpenGL Module}{OpenGL + integration} + \o Powerful \l{Thread Support in Qt}{multi-threading} features + \o \l{Graphics View Framework}{2D graphics canvas} capable of + handling millions of items + \o Integrated \l{Phonon multimedia framework}{Phonon multimedia + framework} + \o \l{WebKit in Qt}{WebKit} integration + \o \l{Network programming with Qt}{Networking}, \l{QtXml Module} + {XML} and \l{SQL in Qt}{database} functionality + \o \l{ECMAScript Reference}{ECMA standard} scripting engine + \endlist + + \section3 Supports Intel Hardware and Universal Binaries + + Qt is written without making assumptions about the number representation, + endianness or architecture of the underlying processor. To support Intel + hardware on the Apple platforms, Qt customers simply need to recompile + their apps. + + Additional \l{Cross-Platform and Platform-Specific Development} + information. + + \note Qt also provides support for 64-bit applications on top of Cocoa APIs. */ /*! \page windowsCE-Mobile-support.html \title Support for Windows CE and Windows Mobile \brief Platform support for Windows CE and Windows Mobile. \ingroup platform-specific - \ingroup platform-details - - \section2 Qt on Windows CE and Windows Mobile - - Qt is a C++ application and UI framework. You can use Qt to write - rich and high performance applications using an intuitive API - available for a wide range of devices. Use the code from one single - code-base and rebuild for all \l{Supported Platforms}{supported - Windows CE/Mobile versions as well as other other platforms}. - - Supporting most existing Windows CE configurations and with minimal - hardware dependencies, Qt is easy to build even for custom hardware - configurations. Unused components and features can even be compiled out. - - \section1 Getting Started on Windows CE/Mobile - - \list - \o \l{Supported Platforms}{Supported Windows CE/Mobile platforms} - - Qt supports a wide range of Windows CE/Mobile platform variants. - \o \l{Qt for Windows CE Requirements}{Qt for Windows CE/Mobile - Requirements} - Software required to run Qt on Windows CE/Mobile. - \o \l{Installing Qt for Windows CE}{Installing Qt for - Windows CE/Mobile Platforms} - Build Qt for Windows CE/Mobile - development. - \o \l{Platform and Compiler Notes - Windows CE}{Platform and - Compiler Notes - Windows CE/Mobile} - Platform specific notes. + \ingroup platform-details + + \section1 Qt on Windows CE and Windows Mobile + + Qt is a C++ application and UI framework. You can use Qt to write + rich and high performance applications using an intuitive API + available for a wide range of devices. Use the code from one single + code-base and rebuild for all \l{Supported Platforms}{supported + Windows CE/Mobile versions as well as other other platforms}. + + Supporting most existing Windows CE configurations and with minimal + hardware dependencies, Qt is easy to build even for custom hardware + configurations. Unused components and features can even be compiled out. + + \section1 Getting Started on Windows CE/Mobile + + \list + \o \l{Supported Platforms}{Supported Windows CE/Mobile platforms} + - Qt supports a wide range of Windows CE/Mobile platform variants. + \o \l{Qt for Windows CE Requirements}{Qt for Windows CE/Mobile + Requirements} - Software required to run Qt on Windows CE/Mobile. + \o \l{Installing Qt for Windows CE}{Installing Qt for + Windows CE/Mobile Platforms} - Build Qt for Windows CE/Mobile + development. + \o \l{Platform and Compiler Notes - Windows CE}{Platform and + Compiler Notes - Windows CE/Mobile} - Platform specific notes. \o \l{Getting Started Guides}{Getting started} - \endlist - - \section1 Key Features for Windows CE/Mobile Development - - On top of all the tools and API and class libraries that Qt offers, - Qt for Windows CE provides you with added functionality for an - optimized embedded development environment. - - \section2 Native and Customizable Look and Feel - - Windows Mobile and Windows CE styles are available with Qt. At runtime, - Qt applications will detect which style to use. The look and feel of - your applications can also be easily customized in a fraction of - the time and lines of code required for traditional UI styling with - Qt Style Sheets. - - \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. Qts rich text - engine adds capabilities for complex text layouts including tables, - path tracing and text which flows around shapes. - - \section2 Qt for Windows CE/Mobile also provide support for: - - \list - \o Graphics Acceleration using \l{Qt for Windows CE and OpenGL - ES}{OpenGL ES} - \o \l{Graphics View Framework}{2D graphics canvas} capable of - handling millions of items. - \o \l{Qt Designer Manual}{Qt Designer} for GUI layout and - forms builder. - \o \l{Qt Linguist Manual}{Qt Linguist} provides internationalization - and translation features. - \endlist - - Applications created with Qt for Windows CE/Mobile can be ported to - Symbian, Maemo and any other OS that Qt supports. - - Additional \l{Cross-Platform and Platform-Specific Development - }{Cross-Platform and Platform-Specific Development} information. - + \endlist + + \section1 Key Features for Windows CE/Mobile Development + + On top of all the tools and API and class libraries that Qt offers, + Qt for Windows CE provides you with added functionality for an + optimized embedded development environment. + + \section2 Native and Customizable Look and Feel + + Windows Mobile and Windows CE styles are available with Qt. At runtime, + Qt applications will detect which style to use. The look and feel of + your applications can also be easily customized in a fraction of + the time and lines of code required for traditional UI styling with + Qt Style Sheets. + + \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. Qts rich text + engine adds capabilities for complex text layouts including tables, + path tracing and text which flows around shapes. + + \section2 Qt for Windows CE/Mobile also provide support for: + + \list + \o Graphics Acceleration using \l{Qt for Windows CE and OpenGL + ES}{OpenGL ES} + \o \l{Graphics View Framework}{2D graphics canvas} capable of + handling millions of items. + \o \l{Qt Designer Manual}{Qt Designer} for GUI layout and + forms builder. + \o \l{Qt Linguist Manual}{Qt Linguist} provides internationalization + and translation features. + \endlist + + Applications created with Qt for Windows CE/Mobile can be ported to + Symbian, Maemo and any other OS that Qt supports. + + Additional \l{Cross-Platform and Platform-Specific Development} + information. + */ /*! @@ -367,233 +365,232 @@ \title Support for Embedded Linux \brief Platform support for Embedded Linux. \ingroup platform-specific - \ingroup platform-details - - \section2 Qt on Embedded Linux - - Qt is the leading application and UI framework for devices powered - 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. Qts 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}. - - \section1 Getting Started on Embedded Linux - - \list - \o \l{Supported Platforms}{Supported Linux platforms} - - Qt supports a wide range of Linux platform variants. - \o \l{Qt for Embedded Linux Requirements}{Qt for Embedded Linux - Requirements} - Software required to run Qt on Embedded Linux. - \o \l{Installing Qt for Embedded Linux}{Installing Qt for Embedded - Linux} - Build Qt for development on Embedded Linux. - \o \l{Platform and Compiler Notes - Embedded Linux}{Platform and - Compiler Notes - Embedded Linux} - Platform specific notes. + \ingroup platform-details + + \section1 Qt on Embedded Linux + + Qt is the leading application and UI framework for devices powered + 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. Qts 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}. + + \section1 Getting Started on Embedded Linux + + \list + \o \l{Supported Platforms}{Supported Linux platforms} + - Qt supports a wide range of Linux platform variants. + \o \l{Qt for Embedded Linux Requirements}{Qt for Embedded Linux + Requirements} - Software required to run Qt on Embedded Linux. + \o \l{Installing Qt for Embedded Linux}{Installing Qt for Embedded + Linux} - Build Qt for development on Embedded Linux. + \o \l{Platform and Compiler Notes - Embedded Linux}{Platform and + Compiler Notes - Embedded Linux} - Platform specific notes. \o \l{Getting Started Guides}{Getting started} - \endlist - - \section1 Key Features for Embedded Linux Development - - On top of all the tools and API and class libraries that Qt offers, - such as WebKit, Qt for Embedded Linux provides you with key components - for an optimized embedded development environment. - - \section2 Compact and Efficient Windowing System \l{Qt for Embedded Linux Classes}{QWS} - - Qt builds on the standard API for embedded Linux devices with its own - compact window system. Qt-based applications write directly to the - Linux framebuffer, eliminating the need for the X11 windowing system. - - \section2 Virtual Frame Buffer (QVFb) - - Qt for Embedded Linux provides a \l{The Virtual Framebuffer}{virtual - 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 displays width, height and color depth. - - \section2 Inter-Process Communication (IPC) - - IPC allows for creation of rich multi-application user experiences. - Two main concepts define inter-process communication: channels and - messages. - - \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 - extended Unicode support including automatic data extraction at build - time and automatic update at runtime. - - Plug-ins for custom font formats are also available allowing new font - engines to be easily added at runtime. Font sharing capabilities - between applications allow for increased memory efficiency. - - Applications created with Qt for Embedded Linux can be ported to - Windows CE and any other OS that Qt supports. - - Additional \l{Cross-Platform and Platform-Specific Development - }{Cross-Platform and Platform-Specific Development} information. - + \endlist + + \section1 Key Features for Embedded Linux Development + + On top of all the tools and API and class libraries that Qt offers, + such as WebKit, Qt for Embedded Linux provides you with key components + for an optimized embedded development environment. + + \section2 Compact and Efficient Windowing System \l{Qt for Embedded Linux Classes}{QWS} + + Qt builds on the standard API for embedded Linux devices with its own + compact window system. Qt-based applications write directly to the + Linux framebuffer, eliminating the need for the X11 windowing system. + + \section2 Virtual Frame Buffer (QVFb) + + Qt for Embedded Linux provides a \l{The Virtual Framebuffer}{virtual + 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 displays width, height and color depth. + + \section2 Inter-Process Communication (IPC) + + IPC allows for creation of rich multi-application user experiences. + Two main concepts define inter-process communication: channels and + messages. + + \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 + extended Unicode support including automatic data extraction at build + time and automatic update at runtime. + + Plug-ins for custom font formats are also available allowing new font + engines to be easily added at runtime. Font sharing capabilities + between applications allow for increased memory efficiency. + + Applications created with Qt for Embedded Linux can be ported to + Windows CE and any other OS that Qt supports. + + Additional \l{Cross-Platform and Platform-Specific Development} + information. + */ /*! \page symbian-support.html \title Support for Symbian \brief Platform support for Symbian. \ingroup platform-specific - \ingroup platform-details - - \section2 Qt on Symbian - - Qt provides support for the Symbian platform with integration - to the S60 framework. If you are developing apps for the Symbian, - Maemo or MeeGo platforms in most cases, you can use Qt under the - free LGPL licensing option. Qt is cross-platform, and that means - that you can use the code from one single code-base and rebuild - for all \l{Supported Platforms}{supported platforms}. - - \section1 Getting Started on Symbian - - \list - \o \l{Supported Platforms}{Supported platform} - - Details on the Qt support for Symbian. - \o \l{Qt for the Symbian platform Requirements}{Qt for the - Symbian platform Requirements} - Software required to run Qt - on Symbian. - \o \l{Installing Qt for the Symbian platform}{Installing Qt - for the Symbian platform} - Build Qt for Symbian development. - \o \l{Platform Notes - Symbian}{Platform Notes - Symbian} - - Platform specific notes. + \ingroup platform-details + + \section1 Qt on Symbian + + Qt provides support for the Symbian platform with integration + to the S60 framework. If you are developing apps for the Symbian, + Maemo or MeeGo platforms in most cases, you can use Qt under the + free LGPL licensing option. Qt is cross-platform, and that means + that you can use the code from one single code-base and rebuild + for all \l{Supported Platforms}{supported platforms}. + + \section1 Getting Started on Symbian + + \list + \o \l{Supported Platforms}{Supported platform} + - Details on the Qt support for Symbian. + \o \l{Qt for the Symbian platform Requirements}{Qt for the + Symbian platform Requirements} - Software required to run Qt + on Symbian. + \o \l{Installing Qt for the Symbian platform}{Installing Qt + for the Symbian platform} - Build Qt for Symbian development. + \o \l{Platform and Compiler Notes - Symbian}{Platform Notes - Symbian} + - Platform specific notes. \o \l{Getting Started Guides}{Getting started} - \endlist - - \section1 Key Features for Symbian Development - - On top of all the tools and the API and class libraries that Qt - offers, Qt provides you with added functionality for an optimized - Symbian development experience. - - \section2 Native Look and Feel - - Qt will detect which theme the phone is running and applies the - style at runtime to your Qt application. The look and feel of your - applications can also be easily customized in a fraction of the - time and lines of code required for traditional UI styling with - Qt Style Sheets. - - \section2 Graphics Features - - Qt for Symbian contains a powerful paint engine that provides - features such as anti, aliasing, gradients, curves and transparency. - It also has animation support with timelines and easing curves. It - is already targeting future device technology by supporting hardware - acceleration using OpenVG. - - \section2 Device Configurations - - Using Qt for Symbian all supported Symbian devices provides automatic - support for swiching between landscape and portrait mode, different - screen resolutions as well as touch screen and key pad input. - - \section2 Cross-platform development using Qt Creator - - \l{http://doc.qt.nokia.com/qtcreator-snapshot/index.html}{Qt Creator} is - a complete Cross-platform IDE included in the Qt SDK. The IDE allows - programmers to create, build, debug and run Qt applications accross all - supported platforms. - - \section3 Licensing - - Qt for Symbian is available under the Qt Commercial License, the LGPL - v. 2.1 "LGPL") and the GPL v. 3.0. Symbian currently licenses their - software products under either the Symbian Foundation License or the - Eclipse Public License ("EPL"). While the LGPL and the EPL are not - compatible and may not be combined on a file-by-file basis, they may - be used in a common environment provided that the interaction between - Qt and Symbian is limited to: dynamic linking, inter-process - communication and data exchange. Therefore, most Symbian developers - can use Qt for Symbian under the LGPL. - - - Additional \l{Cross-Platform and Platform-Specific Development - }{Cross-Platform and Platform-Specific Development} information. + \endlist + + \section1 Key Features for Symbian Development + + On top of all the tools and the API and class libraries that Qt + offers, Qt provides you with added functionality for an optimized + Symbian development experience. + + \section2 Native Look and Feel + + Qt will detect which theme the phone is running and applies the + style at runtime to your Qt application. The look and feel of your + applications can also be easily customized in a fraction of the + time and lines of code required for traditional UI styling with + Qt Style Sheets. + + \section2 Graphics Features + + Qt for Symbian contains a powerful paint engine that provides + features such as anti, aliasing, gradients, curves and transparency. + It also has animation support with timelines and easing curves. It + is already targeting future device technology by supporting hardware + acceleration using OpenVG. + + \section2 Device Configurations + + Using Qt for Symbian all supported Symbian devices provides automatic + support for swiching between landscape and portrait mode, different + screen resolutions as well as touch screen and key pad input. + + \section2 Cross-Platform Development using Qt Creator + + \l{http://doc.qt.nokia.com/qtcreator-snapshot/index.html}{Qt Creator} is + a complete Cross-platform IDE included in the Qt SDK. The IDE allows + programmers to create, build, debug and run Qt applications accross all + supported platforms. + + \section3 Licensing + + Qt for Symbian is available under the Qt Commercial License, the LGPL + v. 2.1 "LGPL") and the GPL v. 3.0. Symbian currently licenses their + software products under either the Symbian Foundation License or the + Eclipse Public License ("EPL"). While the LGPL and the EPL are not + compatible and may not be combined on a file-by-file basis, they may + be used in a common environment provided that the interaction between + Qt and Symbian is limited to: dynamic linking, inter-process + communication and data exchange. Therefore, most Symbian developers + can use Qt for Symbian under the LGPL. + + Additional \l{Cross-Platform and Platform-Specific Development} + information. */ /*! - \page maemo-support.html \title Support for Maemo \brief Platform support for Maemo. \ingroup platform-specific - \ingroup platform-details - - \section2 Qt on Maemo - - Qt is a comprehensive application and UI framework for developing - Maemo applications that can also be deployed across major - device and desktop operating systems without rewriting the source code. - If you are developing apps for the Symbian, Mameo platforms - in most cases, you can use Qt under the free LGPL licensing option. - Qt is cross-platform, and that means that you can use the code from - one single code-base and rebuild for all \l{Supported Platforms} - {supported platforms}. Maemo 6 is now MeeGo. - - \section1 Getting Started on Maemo - \list - \o \l{Supported Platforms}{Supported Maemo platforms} - - Qt support for Maemo versions. - \o \l{Qt for Maemo Requirements}{Qt for Maemo - Requirements} - Software required to run Qt on Maemo. - \o \l{Installing Qt for Maemo}{Installing Qt for - Maemo} - Build Qt for Maemo development. - \o \l{Platform and Compiler Notes - Maemo}{Platform and - Compiler Notes - Maemo} - Platform specific notes. + \ingroup platform-details + + \section2 Qt on Maemo + + Qt is a comprehensive application and UI framework for developing + Maemo applications that can also be deployed across major + device and desktop operating systems without rewriting the source code. + If you are developing apps for the Symbian, Mameo platforms + in most cases, you can use Qt under the free LGPL licensing option. + Qt is cross-platform, and that means that you can use the code from + one single code-base and rebuild for all \l{Supported Platforms} + {supported platforms}. Maemo 6 is now MeeGo. + + \section1 Getting Started on Maemo + \list + \o \l{Supported Platforms}{Supported Maemo platforms} + - Qt support for Maemo versions. + \omit + \o \l{Qt for Maemo Requirements}{Qt for Maemo + Requirements} - Software required to run Qt on Maemo. + \o \l{Installing Qt for Maemo}{Installing Qt for + Maemo} - Build Qt for Maemo development. + \o \l{Platform and Compiler Notes - Maemo}{Platform and + Compiler Notes - Maemo} - Platform specific notes. + \endomit \o \l{Getting Started Guides}{Getting started} - \endlist - - \section1 Key Features for Maemo Development - - \section2 Native Look and Feel - - Qt will detect which theme the device is running and applies the - style at runtime to your Qt application. Widgets are optimized - for touch screen usage. - - \section2 Graphics Features - - Qt for Maemo provides a powerful paint engine that cotain - features such as anti aliasing, gradients, curves and transparency. - It also has animation support with timelines and easing curves. Qt - for Maemo also supports hardware acceleration using ARM NEON - and OpenGL ES 2.0. - - \section2 Device Configurations - - Applications developed with Qt for Maemo will across all - supported Maemo devices provide automatic support for switching - between landscape and portrait mode. They will support input methods, - including predictive text input and on-screen keyboard. The - applications will also have support for one finger touch events and - gestures, and have configurable kinetic scrolling. - - \section2 Maemo - Linux/X11 - - Qt supports a wide range of X11 platform variants, such as: Solaris, - AIX, HP-UX, Maemo 5 and MeeGo. Qt for Maemo contains all Qt modules - and features the same functionality as the Qt on X11 version. - - \section2 Cross-platform development using Qt Creator - - \l{http://doc.qt.nokia.com/qtcreator-snapshot/index.html}{Qt Creator} is - a complete Cross-platform IDE included in the Qt SDK. The IDE allows - programmers to create, build, debug and run Qt applications accross all - supported platforms. - - Additional \l{Cross-Platform and Platform-Specific Development - }{Cross-Platform and Platform-Specific Development} information. - + \endlist + + \section1 Key Features for Maemo Development + + \section2 Native Look and Feel + + Qt will detect which theme the device is running and applies the + style at runtime to your Qt application. Widgets are optimized + for touch screen usage. + + \section2 Graphics Features + + Qt for Maemo provides a powerful paint engine that cotain + features such as anti aliasing, gradients, curves and transparency. + It also has animation support with timelines and easing curves. Qt + for Maemo also supports hardware acceleration using ARM NEON + and OpenGL ES 2.0. + + \section2 Device Configurations + + Applications developed with Qt for Maemo will across all + supported Maemo devices provide automatic support for switching + between landscape and portrait mode. They will support input methods, + including predictive text input and on-screen keyboard. The + applications will also have support for one finger touch events and + gestures, and have configurable kinetic scrolling. + + \section2 Maemo - Linux/X11 + + Qt supports a wide range of X11 platform variants, such as: Solaris, + AIX, HP-UX, Maemo 5 and MeeGo. Qt for Maemo contains all Qt modules + and features the same functionality as the Qt on X11 version. + + \section2 Cross-Platform Development using Qt Creator + + \l{http://doc.qt.nokia.com/qtcreator-snapshot/index.html}{Qt Creator} is + a complete Cross-platform IDE included in the Qt SDK. The IDE allows + programmers to create, build, debug and run Qt applications accross all + supported platforms. + + Additional \l{Cross-Platform and Platform-Specific Development} + information. */ /*! @@ -602,115 +599,115 @@ \title Support for MeeGo \brief Platform support for MeeGo. \ingroup platform-specific - \ingroup platform-details - - \section2 Qt on MeeGo - - Qt is a comprehensive application and UI framework for developing - MeeGo applications that can also be deployed across major - device and desktop operating systems without rewriting the source code. - If you are developing apps for the Symbian, MeeGo platforms - in most cases, you can use Qt under the free LGPL licensing option. - Qt is cross-platform, and that means that you can use the code from - one single code-base and rebuild for all \l{Supported Platforms} - {supported platforms}. - - \section1 Getting Started on MeeGo - - \list - \o \l{Supported Platforms}{Supported MeeGo platforms} - - Qt support for MeeGo versions. - \o \l{Qt for MeeGo Requirements}{Qt for MeeGo - Requirements} - Software required to run Qt on MeeGo. - \o \l{Installing Qt for MeeGo}{Installing Qt for - MeeGo} - Build Qt for MeeGo development. - \o \l{Platform and Compiler Notes - MeeGo}{Platform and - Compiler Notes - MeeGo} - Platform specific notes. + \ingroup platform-details + + \section2 Qt on MeeGo + + Qt is a comprehensive application and UI framework for developing + MeeGo applications that can also be deployed across major + device and desktop operating systems without rewriting the source code. + If you are developing apps for the Symbian, MeeGo platforms + in most cases, you can use Qt under the free LGPL licensing option. + Qt is cross-platform, and that means that you can use the code from + one single code-base and rebuild for all \l{Supported Platforms} + {supported platforms}. + + \section1 Getting Started on MeeGo + + \list + \o \l{Supported Platforms}{Supported MeeGo platforms} + - Qt support for MeeGo versions. + \omit + \o \l{Qt for MeeGo Requirements}{Qt for MeeGo + Requirements} - Software required to run Qt on MeeGo. + \o \l{Installing Qt for MeeGo}{Installing Qt for + MeeGo} - Build Qt for MeeGo development. + \o \l{Platform and Compiler Notes - MeeGo}{Platform and + Compiler Notes - MeeGo} - Platform specific notes. + \endomit \o \l{Getting Started Guides}{Getting started} - \endlist - - \section1 Key Features for MeeGo Development - - \section2 Native Look and Feel - - Qt will detect which theme the device is running and applies the - style at runtime to your Qt application. Widgets are optimized - for touch screen usage. - - \section2 Graphics Features - - Qt for MeeGo provides a powerful paint engine that cotain - features such as anti aliasing, gradients, curves and transparency. - It also has animation support with timelines and easing curves. Qt - for MeeGo also supports hardware acceleration using ARM NEON, x86, - and OpenGL ES 2.0. - - \section2 Device Configurations - - Qt is the foundation of MeeGo UI and application development and - therefore Qt will be present in all upcoming MeeGo devices. Qt - can provide automatic support for: - \list - \o Switching between landscape and portrait mode - \o Input Methods, including predictive text input and on-screen - keyboard - \o Configurable kinetic scrolling - - \section2 Maemo - Linux/X11 - - Qt supports a wide range of X11 platform variants, such as: Solaris, - AIX, HP-UX, Maemo 5 and MeeGo. Qt for MeeGo contains all Qt modules - and features the same functionality as the Qt on X11 version. - - \section2 Cross-platform development using Qt Creator - - \l{http://doc.qt.nokia.com/qtcreator-snapshot/index.html}{Qt Creator} is - a complete Cross-platform IDE included in the Qt SDK. The IDE allows - programmers to create, build, debug and run Qt applications accross all - supported platforms. - - Additional \l{Cross-Platform and Platform-Specific Development - }{Cross-Platform and Platform-Specific Development} information. - - + \endlist + + \section1 Key Features for MeeGo Development + + \section2 Native Look and Feel + + Qt will detect which theme the device is running and applies the + style at runtime to your Qt application. Widgets are optimized + for touch screen usage. + + \section2 Graphics Features + + Qt for MeeGo provides a powerful paint engine that cotain + features such as anti aliasing, gradients, curves and transparency. + It also has animation support with timelines and easing curves. Qt + for MeeGo also supports hardware acceleration using ARM NEON, x86, + and OpenGL ES 2.0. + + \section2 Device Configurations + + Qt is the foundation of MeeGo UI and application development and + therefore Qt will be present in all upcoming MeeGo devices. Qt + can provide automatic support for: + \list + \o Switching between landscape and portrait mode + \o Input Methods, including predictive text input and on-screen + keyboard + \o Configurable kinetic scrolling + + \section2 Maemo - Linux/X11 + + Qt supports a wide range of X11 platform variants, such as: Solaris, + AIX, HP-UX, Maemo 5 and MeeGo. Qt for MeeGo contains all Qt modules + and features the same functionality as the Qt on X11 version. + + \section2 Cross-Platform Development using Qt Creator + + \l{http://doc.qt.nokia.com/qtcreator-snapshot/index.html}{Qt Creator} is + a complete Cross-platform IDE included in the Qt SDK. The IDE allows + programmers to create, build, debug and run Qt applications accross all + supported platforms. + + Additional \l{Cross-Platform and Platform-Specific Development} + information. */ - + /*! \page supported-platforms.html \title Supported Platforms \brief The platforms supported by Nokia for Qt. \ingroup platform-specific - \group platform-details - - Qt is a cross-platform application and UI framework. Using Qt, - you can write web-enabled applications once and deploy them - across desktop, mobile and embedded operating systems without - rewriting the source code. - - \section1 Qt is available for the following platforms: - - \table - \header - \o {2,1} Qt Cross Platform Support - \header - \o {1,1} Desktop - \o {1,1} Mobile/Embedded - \row - \o \l{Support for Windows}{Windows} - \o \l{Support for Windows CE and Windows Mobile.}{Windows CE and Windows Mobile.} - \row - \o \l{Support for Linux/X11}{Linux/X11} - \o \l{Support for Embedded Linux}{Embedded Linux} - \row - \o \l{Support for Mac}{Mac OS X} - \o \l{Support for Symbian}{Symbian} - \row - \o - \o\l{Support for MeeGo}{MeeGo} - \o\l{Support for Maemo}{Maemo} - \endtable - - \section1 Supported platform details + \group platform-details + + Qt is a cross-platform application and UI framework. Using Qt, + you can write web-enabled applications once and deploy them + across desktop, mobile and embedded operating systems without + rewriting the source code. + + \section1 Qt is Available for the Following Platforms + + \table + \header + \o {2,1} Qt Cross Platform Support + \header + \o {1,1} Desktop + \o {1,1} Mobile/Embedded + \row + \o \l{Support for Windows}{Windows} + \o \l{Support for Windows CE and Windows Mobile}{Windows CE and Windows Mobile} + \row + \o \l{Support for Linux/X11}{Linux/X11} + \o \l{Support for Embedded Linux}{Embedded Linux} + \row + \o \l{Support for Mac OS X}{Mac OS X} + \o \l{Support for Symbian}{Symbian} + \row + \o + \o\l{Support for MeeGo}{MeeGo} + \o\l{Support for Maemo}{Maemo} + \endtable + + \section1 Supported Platform Details The Qt team strives to provide support for the platforms most frequently used by Qt users. We have designed our internal testing procedure to @@ -751,7 +748,7 @@ \o MSVC 2008 \row \o Microsoft Windows 7 \o MSVC 2008 - \row \o Apple Mac OS X 10.6 "Snow Leopard" + \row \o Apple Mac OS X 10.6 "Snow Leopard" \o As provided by Apple \row \o Apple Mac OS X 10.5 "Leopard" x86_64 (Cocoa 32 and 64bit) \o As provided by Apple @@ -770,9 +767,9 @@ \section1 Tier 2 Platforms Tier 2 platforms are subject to ad hoc and internal testing. However, Qt users - should note that errors may be present in released product versions for Tier 2 - platforms and, subject to resource availability, known errors in Tier 2 platforms - may or may not be corrected prior to new version releases. + should note that errors may be present in released product versions for Tier 2 + platforms and, subject to resource availability, known errors in Tier 2 platforms + may or may not be corrected prior to new version releases. \table \header \o Platform @@ -805,9 +802,9 @@ \o RVCT 2.2 [build 686 or later], WINSCW 3.2.5 [build 482 or later], GCCE (for applications) \endtable - \note The PPC architecture on Mac has been downgraded from tier 1 to tier 2 for 4.7. - - \section1 Tier 3 Platforms (Not supported by Nokia) + \note The PPC architecture on Mac has been downgraded from tier 1 to tier 2 for 4.7. + + \section1 Tier 3 Platforms (Not Supported by Nokia) All platforms not specifically listed above are not supported by Nokia. Nokia does not run its unit test suite or perform any other internal tests on platforms not @@ -830,7 +827,7 @@ warranties and conditions, either express or implied, including, but not limited to, implied warranties of merchantability, fitness for a particular purpose, title and non-infringement with regard to the Licensed Software. - + \section1 Planned Changes for Qt 4.8 The following changes to the list of supported platforms are at time of publishing diff --git a/doc/src/snippets/declarative/animation.qml b/doc/src/snippets/declarative/animation.qml index 739d009..ae6142d 100644 --- a/doc/src/snippets/declarative/animation.qml +++ b/doc/src/snippets/declarative/animation.qml @@ -179,7 +179,7 @@ Rectangle { } //! [behavior animation] -//! [sequential animation] +//! [sequential animation] Rectangle { id: banner width: 150; height: 100; border.color: "black" @@ -216,7 +216,7 @@ Rectangle { NumberAnimation { target: deploy; property: "opacity"; to: 1.0; duration: 200} } } -//! [sequential animation] +//! [sequential animation] }//end of col //! [parent end] @@ -224,4 +224,3 @@ Rectangle { //! [parent end] //! [document] - diff --git a/doc/src/snippets/declarative/events.qml b/doc/src/snippets/declarative/events.qml index 52fc2bc..3dc44f2 100644 --- a/doc/src/snippets/declarative/events.qml +++ b/doc/src/snippets/declarative/events.qml @@ -63,7 +63,7 @@ onSend: { onPerform: console.log("perform signal emitted") //! [signal handler declaration] -//! [automatic signals] +//! [automatic signals] Rectangle { id: sprite width: 25; height: 25 @@ -72,7 +72,7 @@ Rectangle { onXChanged: console.log("x property changed, emitted xChanged signal") onYChanged: console.log("y property changed, emitted yChanged signal") } -//! [automatic signals] +//! [automatic signals] //! [signal emit] Rectangle { @@ -88,7 +88,7 @@ Rectangle { } //! [signal emit] -//! [connect method] +//! [connect method] Rectangle { id: relay @@ -112,9 +112,9 @@ Rectangle { console.log("Sending to email: " + person + ", " + notice) } } -//! [connect method] +//! [connect method] -//! [forward signal] +//! [forward signal] Rectangle { id: forwarder width: 100; height: 100 @@ -131,9 +131,9 @@ Rectangle { mousearea.clicked.connect(send) } } -//! [forward signal] +//! [forward signal] -//! [connect method] +//! [connect method] //![parent end] } //![parent end] diff --git a/doc/src/snippets/declarative/grid/grid.qml b/doc/src/snippets/declarative/grid/grid.qml new file mode 100644 index 0000000..758edde --- /dev/null +++ b/doc/src/snippets/declarative/grid/grid.qml @@ -0,0 +1,53 @@ +/**************************************************************************** +** +** 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:BSD$ +** You may use this file under the terms of the BSD license as follows: +** +** "Redistribution and use in source and binary forms, with or without +** modification, are permitted provided that the following conditions are +** met: +** * Redistributions of source code must retain the above copyright +** notice, this list of conditions and the following disclaimer. +** * Redistributions in binary form must reproduce the above copyright +** notice, this list of conditions and the following disclaimer in +** the documentation and/or other materials provided with the +** distribution. +** * Neither the name of Nokia Corporation and its Subsidiary(-ies) nor +** the names of its contributors may be used to endorse or promote +** products derived from this software without specific prior written +** permission. +** +** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE." +** $QT_END_LICENSE$ +** +****************************************************************************/ + +//! [document] +import QtQuick 1.0 + +Grid { + columns: 3 + spacing: 2 + Rectangle { color: "red"; width: 50; height: 50 } + Rectangle { color: "green"; width: 20; height: 50 } + Rectangle { color: "blue"; width: 50; height: 20 } + Rectangle { color: "cyan"; width: 50; height: 50 } + Rectangle { color: "magenta"; width: 10; height: 10 } +} +//! [document] diff --git a/doc/src/snippets/declarative/mousearea/mousearea-snippet.qml b/doc/src/snippets/declarative/mousearea/mousearea-snippet.qml index 99cdc8b..03473ba 100644 --- a/doc/src/snippets/declarative/mousearea/mousearea-snippet.qml +++ b/doc/src/snippets/declarative/mousearea/mousearea-snippet.qml @@ -47,7 +47,7 @@ Rectangle { width: 500; height: 500 color: "green" -Column { +Column { //! [anchor fill] Rectangle { id: button @@ -68,21 +68,21 @@ Rectangle { id: button width: 100; height: 100 -//! [enable handlers] +//! [enable handlers] MouseArea { hoverEnabled: true acceptedButtons: Qt.LeftButton | Qt.RightButton onEntered: console.log("mouse entered the area") onExited: console.log("mouse left the area") } -//! [enable handlers] +//! [enable handlers] } Rectangle { id: button width: 100; height: 100 -//! [mouse handlers] +//! [mouse handlers] MouseArea { anchors.fill: parent onClicked: console.log("area clicked") @@ -90,7 +90,7 @@ Rectangle { onEntered: console.log("mouse entered the area") onExited: console.log("mouse left the area") } -//! [mouse handlers] +//! [mouse handlers] } } //end of column diff --git a/src/corelib/io/qiodevice.cpp b/src/corelib/io/qiodevice.cpp index 43e0f0d..7134ae9 100644 --- a/src/corelib/io/qiodevice.cpp +++ b/src/corelib/io/qiodevice.cpp @@ -1628,10 +1628,11 @@ QString QIODevice::errorString() const \fn qint64 QIODevice::readData(char *data, qint64 maxSize) Reads up to \a maxSize bytes from the device into \a data, and - returns the number of bytes read or -1 if an error occurred. If - there are no bytes to be read, this function should return -1 if - there can never be more bytes available (for example: socket - closed, pipe closed, sub-process finished). + returns the number of bytes read or -1 if an error occurred. + + If there are no bytes to be read and there can never be more bytes + available (examples include socket closed, pipe closed, sub-process + finished), this function returns -1. This function is called by QIODevice. Reimplement this function when creating a subclass of QIODevice. diff --git a/src/declarative/graphicsitems/qdeclarativeitem.cpp b/src/declarative/graphicsitems/qdeclarativeitem.cpp index ffef61b..35de629 100644 --- a/src/declarative/graphicsitems/qdeclarativeitem.cpp +++ b/src/declarative/graphicsitems/qdeclarativeitem.cpp @@ -2561,7 +2561,7 @@ QDeclarativeListProperty<QDeclarativeState> QDeclarativeItemPrivate::states() } \endqml - \sa {qdeclarativeanimation.html#transitions}{QML Transitions} + \sa {QML Animation and Transitions}{Transitions} */ diff --git a/src/declarative/qml/qdeclarativecomponent.cpp b/src/declarative/qml/qdeclarativecomponent.cpp index 5840f70..2568240 100644 --- a/src/declarative/qml/qdeclarativecomponent.cpp +++ b/src/declarative/qml/qdeclarativecomponent.cpp @@ -137,7 +137,7 @@ class QByteArray; } \endcode - \sa {Using QML in C++ Applications}, {Integrating QML with existing Qt UI code} + \sa {Using QML Bindings in C++ Applications}, {Integrating QML Code with Existing Qt UI Code} */ /*! diff --git a/src/declarative/qml/qdeclarativetypeloader.cpp b/src/declarative/qml/qdeclarativetypeloader.cpp index 36cdde9..26f3996 100644 --- a/src/declarative/qml/qdeclarativetypeloader.cpp +++ b/src/declarative/qml/qdeclarativetypeloader.cpp @@ -629,7 +629,18 @@ QDeclarativeTypeLoader::~QDeclarativeTypeLoader() } /*! -Return a QDeclarativeTypeData for \a url. The QDeclarativeTypeData may be cached. +\enum QDeclarativeTypeLoader::Option + +This enum defines the options that control the way type data is handled. + +\value None The default value, indicating that no other options + are enabled. +\value PreserveParser The parser used to handle the type data is preserved + after the data has been parsed. +*/ + +/*! +Returns a QDeclarativeTypeData for the specified \a url. The QDeclarativeTypeData may be cached. */ QDeclarativeTypeData *QDeclarativeTypeLoader::get(const QUrl &url) { @@ -650,8 +661,10 @@ QDeclarativeTypeData *QDeclarativeTypeLoader::get(const QUrl &url) } /*! -Return a QDeclarativeTypeData for \a data with the provided base \a url. The +Returns a QDeclarativeTypeData for the given \a data with the provided base \a url. The QDeclarativeTypeData will not be cached. + +The specified \a options control how the loader handles type data. */ QDeclarativeTypeData *QDeclarativeTypeLoader::get(const QByteArray &data, const QUrl &url, Options options) { diff --git a/src/declarative/util/qdeclarativeanimation.cpp b/src/declarative/util/qdeclarativeanimation.cpp index a9a639b..e383d1e 100644 --- a/src/declarative/util/qdeclarativeanimation.cpp +++ b/src/declarative/util/qdeclarativeanimation.cpp @@ -74,7 +74,7 @@ QT_BEGIN_NAMESPACE /*! \qmlclass Animation QDeclarativeAbstractAnimation - \ingroup qml-animation-transition + \ingroup qml-animation-transition \since 4.7 \brief The Animation element is the base of all QML animations. diff --git a/src/declarative/util/qdeclarativepropertychanges.cpp b/src/declarative/util/qdeclarativepropertychanges.cpp index ccd122e..abbe4e2 100644 --- a/src/declarative/util/qdeclarativepropertychanges.cpp +++ b/src/declarative/util/qdeclarativepropertychanges.cpp @@ -118,12 +118,13 @@ QT_BEGIN_NAMESPACE \section2 Immediate property changes in transitions - When \l Transitions are used to animate state changes, they animate - properties from their values in the current state to those defined in the - new state (as defined by PropertyChanges objects). However, - it is sometimes desirable to set a property value \e immediately during a - \l Transition, without animation; in these cases, the PropertyAction - element can be used to force an immediate property change. + When \l{QML Animation and Transitions}{Transitions} are used to animate + state changes, they animate properties from their values in the current + state to those defined in the new state (as defined by PropertyChanges + objects). However, it is sometimes desirable to set a property value + \e immediately during a \l Transition, without animation; in these cases, + the PropertyAction element can be used to force an immediate property + change. See the PropertyAction documentation for more details. diff --git a/src/declarative/util/qdeclarativestate.cpp b/src/declarative/util/qdeclarativestate.cpp index 5a4e2b1..5718e29 100644 --- a/src/declarative/util/qdeclarativestate.cpp +++ b/src/declarative/util/qdeclarativestate.cpp @@ -152,14 +152,14 @@ QDeclarativeStateOperation::QDeclarativeStateOperation(QObjectPrivate &dd, QObje Notice the default state is referred to using an empty string (""). - States are commonly used together with \l {Transitions} to provide + States are commonly used together with \l{QML Animation and Transitions}{Transitions} to provide animations when state changes occur. \note Setting the state of an object from within another state of the same object is not allowed. \sa {declarative/animation/states}{states example}, {qmlstates}{States}, - {qdeclarativeanimation.html#transitions}{QML Transitions}, QtDeclarative + {QML Animation and Transitions}{Transitions}, QtDeclarative */ QDeclarativeState::QDeclarativeState(QObject *parent) : QObject(*(new QDeclarativeStatePrivate), parent) diff --git a/src/declarative/util/qdeclarativestategroup.cpp b/src/declarative/util/qdeclarativestategroup.cpp index f1d0997..6459bf9 100644 --- a/src/declarative/util/qdeclarativestategroup.cpp +++ b/src/declarative/util/qdeclarativestategroup.cpp @@ -88,7 +88,7 @@ public: /*! \qmlclass StateGroup QDeclarativeStateGroup - \ingroup qml-state-elements + \ingroup qml-state-elements \since 4.7 \brief The StateGroup element provides state support for non-Item elements. @@ -113,7 +113,7 @@ public: } \endqml - \sa {qmlstate}{States} {Transitions}, {QtDeclarative} + \sa {qmlstate}{States} {QML Animation and Transitions}{Transitions}, {QtDeclarative} */ QDeclarativeStateGroup::QDeclarativeStateGroup(QObject *parent) @@ -213,7 +213,7 @@ void QDeclarativeStateGroupPrivate::clear_states(QDeclarativeListProperty<QDecla } \endqml - \sa {Transitions} + \sa {QML Animation and Transitions}{Transitions} */ QDeclarativeListProperty<QDeclarativeTransition> QDeclarativeStateGroup::transitionsProperty() { diff --git a/src/declarative/util/qdeclarativeview.cpp b/src/declarative/util/qdeclarativeview.cpp index bfa2454..de61169 100644 --- a/src/declarative/util/qdeclarativeview.cpp +++ b/src/declarative/util/qdeclarativeview.cpp @@ -236,7 +236,7 @@ void QDeclarativeViewPrivate::itemGeometryChanged(QDeclarativeItem *resizeItem, If you're using your own QGraphicsScene-based scene with QDeclarativeView, remember to enable scene's sticky focus mode and to set itemIndexMethod to QGraphicsScene::NoIndex. - \sa {Integrating QML with existing Qt UI code}, {Using QML in C++ Applications} + \sa {Integrating QML Code with Existing Qt UI Code}, {Using QML Bindings in C++ Applications} */ diff --git a/tools/qdoc3/qdoc3.pro b/tools/qdoc3/qdoc3.pro index 2fedc0f..6f31c60 100644 --- a/tools/qdoc3/qdoc3.pro +++ b/tools/qdoc3/qdoc3.pro @@ -93,10 +93,24 @@ include($$QT_SOURCE_TREE/src/declarative/qml/parser/parser.pri) ### Documentation for qdoc3 ### qtPrepareTool(QDOC, qdoc3) +qtPrepareTool(QHELPGENERATOR, qhelpgenerator) -html-docs.commands = cd \"$$PWD/doc\" && $$QDOC qdoc-manual.qdocconf +$$unixstyle { + QDOC = QT_BUILD_TREE=$$QT_BUILD_TREE QT_SOURCE_TREE=$$QT_SOURCE_TREE $$QDOC +} else { + QDOC = set QT_BUILD_TREE=$$QT_BUILD_TREE&& set QT_SOURCE_TREE=$$QT_SOURCE_TREE&& $$QDOC + QDOC = $$replace(QDOC, "/", "\\") +} + +html-docs.commands = cd \"$$QT_BUILD_TREE/doc\" && $$QDOC $$QT_SOURCE_TREE/tools/qdoc3/doc/config/qdoc.qdocconf +html-docs.files = $$QT_BUILD_TREE/doc/html + +qch-docs.commands = cd \"$$QT_BUILD_TREE/doc\" && $$QHELPGENERATOR $$QT_BUILD_TREE/tools/qdoc3/doc/html/qdoc.qhp -o $$QT_BUILD_TREE/tools/qdoc3/doc/qch/qdoc.qch +qch-docs.files = $$QT_BUILD_TREE/tools/qdoc3/doc/qch +qch-docs.path = $$[QT_INSTALL_DOCS] +qch-docs.CONFIG += no_check_exist directory -QMAKE_EXTRA_TARGETS += html-docs +QMAKE_EXTRA_TARGETS += html-docs qch-docs target.path = $$[QT_INSTALL_BINS] -INSTALLS += target +INSTALLS += target qch-docs |