diff options
Diffstat (limited to 'doc/src/qtquick')
| -rw-r--r-- | doc/src/qtquick/qtquick-app-tutorial.qdoc | 4 | ||||
| -rw-r--r-- | doc/src/qtquick/qtquick-buttons.qdoc | 6 | ||||
| -rw-r--r-- | doc/src/qtquick/qtquick-components.qdoc | 20 | ||||
| -rw-r--r-- | doc/src/qtquick/qtquick-designer.qdoc | 8 | ||||
| -rw-r--r-- | doc/src/qtquick/qtquick-modules-with-plugins.qdoc | 11 | ||||
| -rw-r--r-- | doc/src/qtquick/qtquick-screens.qdoc | 126 | ||||
| -rw-r--r-- | doc/src/qtquick/qtquick-toolbars.qdoc | 11 |
7 files changed, 69 insertions, 117 deletions
diff --git a/doc/src/qtquick/qtquick-app-tutorial.qdoc b/doc/src/qtquick/qtquick-app-tutorial.qdoc index b362f77061..8bb8df685b 100644 --- a/doc/src/qtquick/qtquick-app-tutorial.qdoc +++ b/doc/src/qtquick/qtquick-app-tutorial.qdoc @@ -31,10 +31,10 @@ \title Creating a Qt Quick Application This tutorial uses built-in QML types and illustrates basic concepts of - \l {http://qt-project.org/doc/qt-5.0/qtquick/qtquick-index.html}{Qt Quick}. + \l{Qt Quick}. This tutorial describes how to use \QC to implement Qt states and transitions. We use - \l{http://qt-project.org/doc/qt-5.0/qtquick/animation.html}{Qt example code} to + \l{Animation}{Qt example code} to create an application that displays a Qt logo that moves between three rectangles on the page when you click them. diff --git a/doc/src/qtquick/qtquick-buttons.qdoc b/doc/src/qtquick/qtquick-buttons.qdoc index 96c8daa911..8aa8e06561 100644 --- a/doc/src/qtquick/qtquick-buttons.qdoc +++ b/doc/src/qtquick/qtquick-buttons.qdoc @@ -91,8 +91,7 @@ \endlist To create a graphical button that scales beautifully without using vector - graphics, use the \l{http://qt-project.org/doc/qt-5.0/qtquick/qml-qtquick2-borderimage.html} - {Border Image} type. For more information, see + graphics, use the \l{BorderImage} type. For more information, see \l{Creating Scalable Buttons and Borders}. */ @@ -108,8 +107,7 @@ \title Creating Scalable Buttons and Borders You can use the - \l{http://qt-project.org/doc/qt-5.0/qtquick/qml-qtquick2-borderimage.html} - {Border Image} type to display an image, such as a PNG file, as a border + \l{BorderImage} type to display an image, such as a PNG file, as a border and a background. Use two Border Image items and suitable graphics to make it look like the diff --git a/doc/src/qtquick/qtquick-components.qdoc b/doc/src/qtquick/qtquick-components.qdoc index a1af53241a..c71cea9486 100644 --- a/doc/src/qtquick/qtquick-components.qdoc +++ b/doc/src/qtquick/qtquick-components.qdoc @@ -41,36 +41,32 @@ \list - \li \l{http://qt-project.org/doc/qt-5.0/qtquick/qml-qtquick2-borderimage.html} - {Border Image} - uses an image as a border or background. + \li \l{BorderImage} uses an image as a border or background. - \li \l{http://qt-project.org/doc/qt-5.0/qtquick/qml-qtquick2-image.html}{Image} + \li \l{Image} adds a bitmap to the scene. You can stretch and tile images. - \li \l{http://qt-project.org/doc/qt-5.0/qtquick/qml-qtquick2-item.html}{Item} + \li \l{Item} is the most basic of all visual types in QML. Even though it has no visual appearance, it defines all the properties that are common across visual types, such as the x and y position, width and height, anchoring, and key handling. - \li \l{http://qt-project.org/doc/qt-5.0/qtquick/qml-qtquick2-rectangle.html}{Rectangle} + \li \l{Rectangle} adds a rectangle that is painted with a solid fill color and an optional border. You can also use the radius property to create rounded rectangles. - \li \l{http://qt-project.org/doc/qt-5.0/qtquick/qml-qtquick2-text.html}{Text} - adds formatted read-only text. + \li \l{Text} adds formatted read-only text. - \li \l{http://qt-project.org/doc/qt-5.0/qtquick/qml-qtquick2-textedit.html}{Text Edit} + \li \l{TextEdit} adds a single line of editable formatted text that can be validated. - \li \l{http://qt-project.org/doc/qt-5.0/qtquick/qml-qtquick2-textinput.html}{Text Input} + \li \l{TextInput} adds a single line of editable plain text that can be validated. \omit - \li \l{http://qt-project.org/doc/qt-5.0/qtwebkit/qml-qtwebkit3-webview.html}{Web View} - adds web content to a canvas. + \li \l{WebView} adds web content to a canvas. \endomit \endlist diff --git a/doc/src/qtquick/qtquick-designer.qdoc b/doc/src/qtquick/qtquick-designer.qdoc index 8553d4cea1..05a44cbc81 100644 --- a/doc/src/qtquick/qtquick-designer.qdoc +++ b/doc/src/qtquick/qtquick-designer.qdoc @@ -105,7 +105,7 @@ \section2 Setting the Stacking Order - The \l{http://qt-project.org/doc/qt-5.0/qtquick/qml-qtquick2-item.html#z-prop}{z property} of an + The \l{Item#z-prop}{z property} of an item determines its position in relation to its sibling items in the type hierarchy. By default, items with a higher stacking value are drawn on top of siblings with a lower stacking value. Items with the same @@ -334,8 +334,7 @@ transformations to an item. Each transformation is applied in order, one at a time. - For more information on Transform types, see - \l{http://qt-project.org/doc/qt-5.0/qtquick/qml-qtquick2-transform.html}{Transform}. + For more information on Transform types, see \l{Transform}. \section1 Adding States @@ -373,8 +372,7 @@ \endlist - The \gui State pane displays the different - \l{http://qt-project.org/doc/qt-5.0/qtquick/qml-qtquick2-state.html}{states} + The \gui State pane displays the different \l{State}{states} of the component in the Qt Quick Designer. \image qmldesigner-transitions.png "State pane" diff --git a/doc/src/qtquick/qtquick-modules-with-plugins.qdoc b/doc/src/qtquick/qtquick-modules-with-plugins.qdoc index 7536b1cba2..8849b865a1 100644 --- a/doc/src/qtquick/qtquick-modules-with-plugins.qdoc +++ b/doc/src/qtquick/qtquick-modules-with-plugins.qdoc @@ -36,11 +36,9 @@ information for code completion and the semantic checks to work correctly. When you write a QML module or use QML from a C++ application you typically - register new types with - \l{http://qt-project.org/doc/qt-5.0/qtqml/qqmlengine.html#qmlRegisterType} - {qmlRegisterType} or expose some class instances with - \l{http://qt-project.org/doc/qt-5.0/qtqml/qqmlcontext.html#setContextProperty} - {setContextProperty}. The \QC C++ code model now scans for these calls and + register new types with \l{QQmlEngine#qmlRegisterType-3}{qmlRegisterType()} or expose some + class instances with \l{QQmlContext::setContextProperty()}. The \QC C++ + code model now scans for these calls and tells the QML code model about them. This means that properties are displayed during code completion and the JavaScript code checker does not complain about unknown types. However, this works only when the source code @@ -55,8 +53,7 @@ For Qt 4.8 and later, one or more \c qmltypes files can be listed in the \c qmldir file under the \c typeinfo header. These files will be read in addition to \c{plugins.qmltypes}. For more information, see - \l{http://qt-project.org/doc/qt-5.0/qtqml/qtqml-modules-qmldir.html#writing-a-qmltypes-file} - {Writing a qmltypes File}. + \l{Writing a qmltypes File}. \section1 Generating qmltypes Files diff --git a/doc/src/qtquick/qtquick-screens.qdoc b/doc/src/qtquick/qtquick-screens.qdoc index 09651902a3..1dc04d2397 100644 --- a/doc/src/qtquick/qtquick-screens.qdoc +++ b/doc/src/qtquick/qtquick-screens.qdoc @@ -62,23 +62,19 @@ \section1 Using Data Models You can create the following types of views to organize items provided by - \l{http://qt-project.org/doc/qt-5.0/qtquick/qtquick-modelviewsdata-modelview.html}{data models}: + \l{Models and Views in Qt Quick}{data models}: \list - \li \l{http://qt-project.org/doc/qt-5.0/qtquick/qml-qtquick2-gridview.html}{Grid View} - provides a grid vizualization of a model. + \li GridView provides a grid vizualization of a model. - \li \l{http://qt-project.org/doc/qt-5.0/qtquick/qml-qtquick2-listview.html}{List View} - provides a list vizualization of a model. + \li ListView provides a list vizualization of a model. - \li \l{http://qt-project.org/doc/qt-5.0/qtquick/qml-qtquick2-pathview.html}{Path View} - visualizes the contents of a model along a path. + \li PathView visualizes the contents of a model along a path. \endlist - When you add a Grid View, List View, or Path View, the - \l{http://qt-project.org/doc/qt-5.0/qtquick/qml-qtquick2-listmodel.html}{ListModel} and the + When you add a GridView, ListView, or PathView, the ListModel and the delegate component that creates an instance for each item in the model are added automatically. You can edit item properties in the \gui Properties pane or @@ -89,7 +85,7 @@ The position of an item on the canvas can be either absolute or relative to other items. If you are designing a static user interface, - \l{http://dev.qt-project.org/doc/qt-5.0/qtquick-positioning-topic.html#manual-positioning} + \l{Important Concepts In Qt Quick - Positioning#manual-positioning} {manual positioning} provides the most efficient form of positioning items on the screen. For a dynamic user interface, you can employ the following positioning methods provided by Qt Quick: @@ -110,7 +106,7 @@ \section2 Setting Bindings - \l{http://qt-project.org/doc/qt-5.0/qtquick-positioning-topic.html#positioning-with-bindings} + \l{Positioning with Bindings} {Property binding} is a declarative way of specifying the value of a property. Binding allows a property value to be expressed as an JavaScript expression that defines the value relative to other property values or data accessible @@ -127,8 +123,7 @@ To remove bindings, select \gui Reset in the context menu. For more information on the JavaScript environment provided by QML, see - \l{http://qt-project.org/doc/qt-5.0/qtqml/qtqml-javascript-topic.html} - {Integrating QML and JavaScript}. + \l{Integrating QML and JavaScript}. \QMLD cannot show bindings and using them might have a negative impact on performance, so consider setting anchors and margins for items, instead. @@ -138,8 +133,7 @@ \section2 Setting Anchors and Margins - In an - \l{http://qt-project.org/doc/qt-5.0/qtquick-positioning-anchors.html} + In an \l{Important Concepts In Qt Quick - Positioning#anchors} {anchor-based} layout, each QML type can be thought of as having a set of invisible \e anchor lines: top, bottom, left, right, fill, horizontal center, vertical center, and baseline. @@ -191,7 +185,7 @@ \section2 Using Positioners - \l{http://qt-project.org/doc/qt-5.0/qtquick-positioning-layouts.html} + \l{Important Concepts In Qt Quick - Positioning#positioners} {Positioner items} are container items that manage the positions of items in a declarative user interface. Positioners behave in a similar way to the layout managers used with standard Qt widgets, except that they are also @@ -201,17 +195,15 @@ \list - \li \l{http://qt-project.org/doc/qt-5.0/qtquick/qml-qtquick2-column.html}{Column} - arranges its child items vertically. + \li \l{Column} arranges its child items vertically. - \li \l{http://qt-project.org/doc/qt-5.0/qtquick/qml-qtquick2-row.html}{Row} - arranges its child items horizontally. + \li \l{Row} arranges its child items horizontally. - \li \l{http://qt-project.org/doc/qt-5.0/qtquick/qml-qtquick2-grid.html}{Grid} + \li \l{Grid} arranges its child items so that they are aligned in a grid and are not overlapping. - \li \l{http://qt-project.org/doc/qt-5.0/qtquick/qml-qtquick2-flow.html}{Flow} + \li \l{Flow} arranges its child items side by side, wrapping as necessary. \endlist @@ -222,28 +214,23 @@ \section2 Using Layouts - From Qt 5.1, you can use QML types in the - \l{http://qt-project.org/doc/qt-5.1/qtquicklayouts/qtquicklayouts-index.html} - {Qt Quick Layouts module} to arrange Qt Quick items on screens. Unlike p - ositioners, they manage both the positions and sizes of items in a + From Qt 5.1, you can use QML types in the \l{qtquicklayouts-index.html} + {Qt Quick Layouts} module to arrange Qt Quick items on screens. Unlike + positioners, they manage both the positions and sizes of items in a declarative interface. They are well suited for resizable user interfaces. You can use the following layout types to arrange items on screens: \list - \li \l{http://qt-project.org/doc/qt-5.0/qml-qtquick-layouts-layout.html} - {Layout} provides attached properties for items pushed onto a + \li \l{Layout} provides attached properties for items pushed onto a \gui {Column Layout}, \gui {Row Layout}, or \gui {Grid Layout}. - \li \l{http://qt-project.org/doc/qt-5.0/qml-qtquick-layouts-columnlayout.html} - {Column Layout} provides a grid layout with only one column. + \li ColumnLayout provides a grid layout with only one column. - \li \l{http://qt-project.org/doc/qt-5.0/qml-qtquick-layouts-rowlayout.html} - {Row Layout} provides a grid layout with only one row. + \li RowLayout provides a grid layout with only one row. - \li \l{http://qt-project.org/doc/qt-5.0/qml-qtquick-layouts-gridlayout.html} - {Grid Layout} provides a way of dynamically arranging items in a + \li GridLayout provides a way of dynamically arranging items in a grid. \endlist @@ -259,9 +246,8 @@ \section2 Using Split Views - From Qt 5.1, you can use the - \l{http://qt-project.org/doc/qt-5.1/qtquickcontrols/qml-qtquick-controls1-splitview.html} - {Split View} Qt Quick Control to arrange items horizontally or vertically + From Qt 5.1, you can use the SplitView Qt Quick Control to arrange items + horizontally or vertically with a draggable splitter between each item. @@ -344,16 +330,14 @@ use different types of animated transitions. For example, you can animate changes to property values and colors. You can use rotation animation to control the direction of rotation. For more information, see - \l{http://qt-project.org/doc/qt-5.0/qtquick/qtquick-statesanimations-animations.html} - {Animation and Transitions in Qt Quick}. + \l{Animation and Transitions in Qt Quick}. You can use the \c ParallelAnimation type to start several animations at the same time. Or use the \c SequentialAnimation type to run them one after another. You can use the code editor to specify transitions. For more information, - see \l{http://qt-project.org/doc/qt-5.0/qtquick/qml-qtquick2-transition.html} - {Transition}. + see \l{Transition}. \section1 Adding User Interaction Methods @@ -362,85 +346,70 @@ \list - \li \l{http://qt-project.org/doc/qt-5.0/qtquick/qml-qtquick2-flickable.html}{Flickable} + \li \l{Flickable} items can be flicked horizontally or vertically. - \li \l{http://qt-project.org/doc/qt-5.0/qtquick/qml-qtquick2-flipable.html}{Flipable} + \li \l{Flipable} items can be flipped between their front and back sides by using rotation, state, and transition. - \li \l{http://qt-project.org/doc/qt-5.0/qtquick/qml-qtquick2-focusscope.html}{Focus Scope} + \li FocusScope assists in keyboard focus handling when building reusable QML components. - \li \l{http://qt-project.org/doc/qt-5.0/qtquick/qml-qtquick2-mousearea.html}{Mouse Area} - enables simple mouse handling. + \li MouseArea enables simple mouse handling. \endlist From Qt 5.1, you can also use the following - \l{http://qt-project.org/doc/qt-5.1/qtquickcontrols/qtquickcontrols-index.html} - {Qt Quick Controls} to present or receive input from the user: + \l{Qt Quick Controls} to present or receive input from the user: \list - \li \l{http://qt-project.org/doc/qt-5.1/qtquickcontrols/qml-qtquick-controls1-button.html} - {Button} provides a push button that you can associate with an + \li \l{Button} provides a push button that you can associate with an action. - \li \l{http://qt-project.org/doc/qt-5.1/qtquickcontrols/qml-qtquick-controls1-checkbox.html} - {Check Box} provides an option button that can be toggled on + \li CheckBox provides an option button that can be toggled on (checked) or off (unchecked). - \li \l{http://qt-project.org/doc/qt-5.1/qtquickcontrols/qml-qtquick-controls1-combobox.html} - {Combo Box} provides a drop-down list. Add items to the combo box by + \li ComboBox provides a drop-down list. Add items to the combo box by assigning it a ListModel, or a list of strings to the model property. - \li \l{http://qt-project.org/doc/qt-5.1/qtquickcontrols/qml-qtquick-controls1-groupbox.html} - {Group Box} provides a frame, a title on top, and place for various + \li GroupBox provides a frame, a title on top, and place for various other controls inside the frame. - \li \l{http://qt-project.org/doc/qt-5.1/qtquickcontrols/qml-qtquick-controls1-label.html} - {Label} provides a text label that follows the font and color scheme + \li \l{Label} provides a text label that follows the font and color scheme of the system. - \li \l{http://qt-project.org/doc/qt-5.1/qtquickcontrols/qml-qtquick-controls1-progressbar.html} - {Progress Bar} indicates the progress of an operation. + \li ProgressBar indicates the progress of an operation. - \li \l{http://qt-project.org/doc/qt-5.1/qtquickcontrols/qml-qtquick-controls1-radiobutton.html} - {Radio Button} provides an option button that can be switched on + \li RadioButton provides an option button that can be switched on (checked) or off (unchecked). - \li \l{http://qt-project.org/doc/qt-5.1/qtquickcontrols/qml-qtquick-controls1-slider.html} + \li \l{Slider} {Slider (Horizontal) and Slider (Vertical)} enable the user to move a slider handle along a horizontal or vertical groove and translate the handle's position into a value within the specified range. - \li \l{http://qt-project.org/doc/qt-5.1/qtquickcontrols/qml-qtquick-controls1-spinbox.html} - {Spin Box} enables the user to specify a value by clicking the up or + \li SpinBox enables the user to specify a value by clicking the up or down buttons, by pressing up or down on the keyboard, or by entering a value in the box. - \li \l{http://qt-project.org/doc/qt-5.1/qtquickcontrols/qml-qtquick-controls1-statusbar.html} - {Status Bar} contains status information in your application. It + \li StatusBar contains status information in your application. It does not provide a layout of its own, but requires you to position its contents, for instance by creating a \gui {Row Layout}. - \li \l{http://qt-project.org/doc/qt-5.1/qtquickcontrols/qml-qtquick-controls1-textarea.html} - {Text Area} displays multiple lines of editable formatted text. + \li TextArea displays multiple lines of editable formatted text. - \li \l{http://qt-project.org/doc/qt-5.1/qtquickcontrols/qml-qtquick-controls1-textfield.html} - {Text Field} displays a single line of editable plain text. + \li TextField displays a single line of editable plain text. - \li \l{http://qt-project.org/doc/qt-5.1/qtquickcontrols/qml-qtquick-controls1-toolbar.html} - {Tool Bar} provides styling for ToolButton as well as other controls + \li ToolBar provides styling for ToolButton as well as other controls that it can contain. However, it does not provide a layout of its own, but requires you to position its contents, for instance by creating a \gui {Row Layout}. - \li \l{http://qt-project.org/doc/qt-5.1/qtquickcontrols/qml-qtquick-controls1-toolbutton.html} - {Tool Button} provides a button that is functionally similar to + \li ToolButton provides a button that is functionally similar to \gui Button, but that looks more suitable on a \gui {Tool Bar}. \endlist @@ -450,12 +419,9 @@ A user interface is only a part of an application, and not really useful by itself. You can use Qt or JavaScript to implement the application logic. For more information on - using JavaScript, see - \l{http://qt-project.org/doc/qt-5.0/qtqml/qtqml-javascript-topic.html} - {Integrating QML and JavaScript}. + using JavaScript, see \l{Integrating QML and JavaScript}. For an example of how to use JavaScript to develop a game, see the - \l{http://qt-project.org/doc/qt-5.0/qtquick/qtquick2-qml-advtutorial.html} - {QML Advanced Tutorial}. + \l{QML Advanced Tutorial}. */ diff --git a/doc/src/qtquick/qtquick-toolbars.qdoc b/doc/src/qtquick/qtquick-toolbars.qdoc index 6679a7cd98..f1d8353c7d 100644 --- a/doc/src/qtquick/qtquick-toolbars.qdoc +++ b/doc/src/qtquick/qtquick-toolbars.qdoc @@ -48,8 +48,7 @@ \section1 Previewing Images The Qt Quick Toolbar for images allows you to edit the properties of - \l{http://qt-project.org/doc/qt-5.0/qtquick/qml-qtquick2-borderimage.html}{Border Image} - and \l{http://qt-project.org/doc/qt-5.0/qtquick/qml-qtquick2-image.html}{Image} items. + BorderImage and \l{Image} items. You can scale and tile the images, replace them with other images, preview them, and change the image margins. @@ -63,7 +62,7 @@ \section1 Formatting Text The Qt Quick Toolbar for text allows you to edit the properties of - \l{http://qt-project.org/doc/qt-5.0/qtquick/qml-qtquick2-text.html}{Text} items. + \l{Text} items. You can change the font family and size as well as text formatting, style, alignment, and color. @@ -79,8 +78,7 @@ \section1 Previewing Animation The Qt Quick Toolbar for animation allows you to edit the properties of - \l{http://qt-project.org/doc/qt-5.0/qtquick/qml-qtquick2-propertyanimation.html} - {PropertyAnimation} items and the items that inherit it. You can + PropertyAnimation items and the items that inherit it. You can change the easing curve type and duration. For some curves, you can also specify amplitude, period, and overshoot values. @@ -91,8 +89,7 @@ \section1 Editing Rectangles The Qt Quick Toolbar for rectangles allows you to edit the properties of - \l{http://qt-project.org/doc/qt-5.0/qtquick/qml-qtquick2-rectangle.html}{Rectangle} - items. You can change the fill and border colors and add + \l{Rectangle} items. You can change the fill and border colors and add gradients. \image qml-toolbar-rectangle.png "Qt Quick Toolbar for rectangles" |