aboutsummaryrefslogtreecommitdiffstats
path: root/src/qml/doc/src/javascript/string.qdoc
blob: f896af3378d3f7b18103acbacf4b690c63f5d985 (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
/****************************************************************************
**
** Copyright (C) 2017 The Qt Company Ltd.
** Contact: https://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 https://www.qt.io/terms-conditions. For further
** information use the contact form at https://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: https://www.gnu.org/licenses/fdl-1.3.html.
** $QT_END_LICENSE$
**
****************************************************************************/

/*!
    \qmltype String
    \inqmlmodule QtQml
    \brief The String object represents a string value.

    The QML String object extends the JS String object with
    the arg() function.

    \sa {ECMA-262}{ECMAScript Language Specification}
*/

/*!
    \qmlmethod string String::arg(value)

    Returns a copy of this string with the lowest numbered place marker replaced by value,
    i.e., %1, %2, ..., %99.  The following example prints "There are 20 items"

    \code
    var message = "There are %1 items"
    var count = 20
    console.log(message.arg(count))
    \endcode
*/