aboutsummaryrefslogtreecommitdiffstats
path: root/examples/quick/text/doc/src/text.qdoc
blob: ea6a786e8ab4d0ccf0991634bc5fda0085c0a1ea (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
/****************************************************************************
**
** Copyright (C) 2015 The Qt Company Ltd.
** Contact: http://www.qt.io/licensing/
**
** This file is part of the documentation of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:FDL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see http://www.qt.io/terms-conditions. For further
** information use the contact form at http://www.qt.io/contact-us.
**
** GNU Free Documentation License Usage
** Alternatively, this file may be used under the terms of the GNU Free
** Documentation License version 1.3 as published by the Free Software
** Foundation and appearing in the file included in the packaging of
** this file. Please review the following information to ensure
** the GNU Free Documentation License version 1.3 requirements
** will be met: http://www.gnu.org/copyleft/fdl.html.
** $QT_END_LICENSE$
**
****************************************************************************/
/*!
    \title Qt Quick Examples - Text
    \example text
    \brief This is a collection of QML examples relating to text.
    \image qml-text-example.png
    \ingroup qtquickexamples

    \e Text is a collection of small QML examples relating to text. Each example
    is a small QML file, usually containing or emphasizing a particular type or
    feature. You can run and observe the behavior of each example.

    \section1 Hello

    \e Hello shows how to change and animate the letter spacing of a \l Text
    type. It uses a sequential animation to first animate the font.letterSpacing
    property from \c 0 to \c 50 over three seconds and then move the text to a
    random position on screen:
    \snippet text/fonts/hello.qml letterspacing

    \section1 Fonts

    \e Fonts shows different ways of using fonts with the \l Text type.
    Simply by name, using the font.family property directly:
    \snippet text/fonts/fonts.qml name

    or using a \l FontLoader type:
    \snippet text/fonts/fonts.qml fontloader

    or using a FontLoader and specifying a local font file:
    \snippet text/fonts/fonts.qml fontloaderlocal

    or finally using a FontLoader and specifying a remote font file:
    \snippet text/fonts/fonts.qml fontloaderremote

    \section1 Available Fonts

    \e{Available Fonts} shows how to use the \l [QML] {Qt} global object
    and a list view to display all the fonts available on the system.
    The \l ListView type uses the list of fonts available as its model:
    \snippet text/fonts/availableFonts.qml model

    Inside the delegate, the font family is set with the modelData:
    \snippet text/fonts/availableFonts.qml delegate

    \section1 Banner

    \e Banner is a simple example showing how to create a banner using a row of
    text types and a \l NumberAnimation.

    \section1 Img Tag

    \e{Img tag} shows different ways of displaying images in text objects using
    the \c{<img>} tag.

    \section1 Text Layout

    \e{Text Layout} shows how to create a more complex layout for a text item.
    This example lays out the text in two columns using the onLineLaidOut
    handler that allows you to position and resize each line:
    \snippet text/styledtext-layout.qml layout
*/