source: trunk/doc/src/examples/helloscript.qdoc@ 569

Last change on this file since 569 was 561, checked in by Dmitry A. Kuminov, 15 years ago

trunk: Merged in qt 4.6.1 sources.
File size: 5.8 KB
Line 
1/****************************************************************************
2**
3** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
4** All rights reserved.
5** Contact: Nokia Corporation ([email protected])
6**
7** This file is part of the documentation of the Qt Toolkit.
8**
9** $QT_BEGIN_LICENSE:LGPL$
10** Commercial Usage
11** Licensees holding valid Qt Commercial licenses may use this file in
12** accordance with the Qt Commercial License Agreement provided with the
13** Software or, alternatively, in accordance with the terms contained in
14** a written agreement between you and Nokia.
15**
16** GNU Lesser General Public License Usage
17** Alternatively, this file may be used under the terms of the GNU Lesser
18** General Public License version 2.1 as published by the Free Software
19** Foundation and appearing in the file LICENSE.LGPL included in the
20** packaging of this file. Please review the following information to
21** ensure the GNU Lesser General Public License version 2.1 requirements
22** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
23**
24** In addition, as a special exception, Nokia gives you certain additional
25** rights. These rights are described in the Nokia Qt LGPL Exception
26** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
27**
28** GNU General Public License Usage
29** Alternatively, this file may be used under the terms of the GNU
30** General Public License version 3.0 as published by the Free Software
31** Foundation and appearing in the file LICENSE.GPL included in the
32** packaging of this file. Please review the following information to
33** ensure the GNU General Public License version 3.0 requirements will be
34** met: http://www.gnu.org/copyleft/gpl.html.
35**
36** If you have questions regarding the use of this file, please contact
37** Nokia at [email protected].
38** $QT_END_LICENSE$
39**
40****************************************************************************/
41
42/*!
43 \example script/helloscript
44 \title Hello Script Example
45
46 The Hello Script example shows the basic use of Qt Script: How to embed
47 a script engine into the application, how to evaluate a script, and how
48 to process the result of the evaluation. The example also shows how to
49 apply internationalization to scripts.
50
51 \snippet examples/script/helloscript/main.cpp 0
52
53 The application will load the script file to evaluate from a resource, so
54 we first make sure that the resource is initialized.
55
56 \snippet examples/script/helloscript/main.cpp 1
57
58 We attempt to load a translation, and install translation functions in the
59 script engine. How to produce a translation is explained later.
60
61 \snippet examples/script/helloscript/main.cpp 2
62
63 A push button is created and exported to the script environment as a
64 global variable, \c button. Scripts will be able to access properties,
65 signals and slots of the button as properties of the \c button script
66 object; the script object acts as a proxy to the C++ button object.
67
68 \snippet examples/script/helloscript/main.cpp 3
69
70 The contents of the script file are read.
71
72 \snippet examples/script/helloscript/helloscript.js 0
73
74 The script sets the \c text (note that the qTr() function is used to allow
75 for translation) and \c styleSheet properties of the button, and calls the
76 button's \c show() slot.
77
78 \snippet examples/script/helloscript/main.cpp 4