diff options
author | David Boddie <dboddie@trolltech.com> | 2010-06-21 17:02:54 (GMT) |
---|---|---|
committer | David Boddie <dboddie@trolltech.com> | 2010-06-21 17:02:54 (GMT) |
commit | 84ce7cc25b925d493a048ce5b00290483cd974f4 (patch) | |
tree | 0f4e709ca90e9bf3e683668460734282f426089d /doc | |
parent | a2a5a8c5e203fe9d55f9addba1533a30c6f2ba19 (diff) | |
parent | 32e532743dc6243612ade017e8c326ca0e7e0dec (diff) | |
download | Qt-84ce7cc25b925d493a048ce5b00290483cd974f4.zip Qt-84ce7cc25b925d493a048ce5b00290483cd974f4.tar.gz Qt-84ce7cc25b925d493a048ce5b00290483cd974f4.tar.bz2 |
Merge branch '4.7' of scm.dev.nokia.troll.no:qt/oslo-staging-2 into 4.7
Diffstat (limited to 'doc')
49 files changed, 4357 insertions, 249 deletions
diff --git a/doc/doc.pri b/doc/doc.pri index 3180a61..f748f3d 100644 --- a/doc/doc.pri +++ b/doc/doc.pri @@ -5,9 +5,9 @@ DOCS_GENERATION_DEFINES = GENERATOR = $$QT_BUILD_TREE/bin/qhelpgenerator -win32:!win32-g++ { +win32:!win32-g++* { unixstyle = false -} else :win32-g++:isEmpty(QMAKE_SH) { +} else :win32-g++*:isEmpty(QMAKE_SH) { unixstyle = false } else { unixstyle = true @@ -36,9 +36,15 @@ QT_ZH_CN_DOCUMENTATION = ($$QDOC qt-api-only_zh_CN.qdocconf) && \ $$GENERATOR doc-build/html-qt_zh_CN/qt.qhp -o doc/qch/qt_zh_CN.qch \ ) -win32-g++:isEmpty(QMAKE_SH) { +QT_JA_JP_DOCUMENTATION = ($$QDOC qt-api-only_ja_JP.qdocconf) && \ + (cd $$QT_BUILD_TREE && \ + $$GENERATOR doc-build/html-qt_ja_JP/qt.qhp -o doc/qch/qt_ja_JP.qch \ + ) + +win32-g++*:isEmpty(QMAKE_SH) { QT_DOCUMENTATION = $$replace(QT_DOCUMENTATION, "/", "\\\\") QT_ZH_CN_DOCUMENTATION = $$replace(QT_ZH_CN_DOCUMENTATION, "/", "\\\\") + QT_JA_JP_DOCUMENTATION = $$replace(QT_JA_JP_DOCUMENTATION, "/", "\\\\") } # Build rules: @@ -52,6 +58,9 @@ docs.depends = sub-qdoc3 adp_docs qch_docs docs_zh_CN.depends = docs docs_zh_CN.commands = $$QT_ZH_CN_DOCUMENTATION +docs_ja_JP.depends = docs +docs_ja_JP.commands = $$QT_JA_JP_DOCUMENTATION + # Install rules htmldocs.files = $$QT_BUILD_TREE/doc/html htmldocs.path = $$[QT_INSTALL_DOCS] @@ -67,5 +76,5 @@ docimages.path = $$[QT_INSTALL_DOCS]/src sub-qdoc3.depends = sub-corelib sub-xml sub-qdoc3.commands += (cd tools/qdoc3 && $(MAKE)) -QMAKE_EXTRA_TARGETS += sub-qdoc3 adp_docs qch_docs docs docs_zh_CN +QMAKE_EXTRA_TARGETS += sub-qdoc3 adp_docs qch_docs docs docs_zh_CN docs_ja_JP INSTALLS += htmldocs qchdocs docimages diff --git a/doc/src/declarative/animation.qdoc b/doc/src/declarative/animation.qdoc index 6e98949..c320898 100644 --- a/doc/src/declarative/animation.qdoc +++ b/doc/src/declarative/animation.qdoc @@ -46,14 +46,14 @@ Animation in QML is done by animating properties of objects. Properties of type real, int, color, rect, point, size, and vector3d can all be animated. -QML supports three main forms of animation - basic property animation, +QML supports three main forms of animation: basic property animation, transitions, and property behaviors. \tableofcontents \section1 Basic Property Animation -The simplest form of animation is directly using \l PropertyAnimation, which can animate all of the property +The simplest form of animation is a \l PropertyAnimation, which can animate all of the property types listed above. If the property you are animating is a number or color, you can alternatively use NumberAnimation or ColorAnimation. These elements don't add any additional functionality, but will help enforce type correctness and are slightly more efficient. @@ -62,61 +62,23 @@ A property animation can be specified as a value source using the \e Animation \ for repeating animations. The following example creates a bouncing effect: -\qml -Rectangle { - id: rect - width: 120; height: 200; - Image { - id: img - source: "qt-logo.png" - x: 60-img.width/2 - y: 0 - SequentialAnimation on y { - loops: Animation.Infinite - NumberAnimation { to: 200-img.height; easing.type: Easing.OutBounce; duration: 2000 } - PauseAnimation { duration: 1000 } - NumberAnimation { to: 0; easing.type: Easing.OutQuad; duration: 1000 } - } - } -} -\endqml +\snippet doc/src/snippets/declarative/animation.qml property-anim-1 \image propanim.gif When you assign an animation as a value source, you do not need to specify \c property -or \c target; they are automatically selected for you. You do, however, need to specify \c to. +or \c target values; they are automatically selected for you. You do, however, need to specify a \c to value. An animation specified as a value source will be \c running by default. -\qml -Rectangle { - id: rect - width: 200; height: 200; - Rectangle { - color: "red" - width: 50; height: 50 - NumberAnimation on x { to: 50 } - } -} -\endqml +For example, here is a rectangle that uses a \l NumberAnimation value source to animate the movement +from its current position to an \c x value of 50. The animation starts immediately, and only the \c to +property is required: + +\snippet doc/src/snippets/declarative/animation.qml property-anim-2 A property animation can also be specified as a resource that is manipulated from script. -\qml -PropertyAnimation { - id: animation - target: image - property: "scale" - from: 1; to: .5 -} -Image { - id: image - source: "image.png" - MouseArea { - anchors.fill: parent - onPressed: animation.start() - } -} -\endqml +\snippet doc/src/snippets/declarative/animation.qml property-anim-3 As can be seen, when an animation is used like this (as opposed to as a value source) you will need to explicitly set the \c target and \c property to animate. @@ -131,50 +93,20 @@ can only be triggered by a state change. For example, a transition could describe how an item moves from its initial position to its new position: -\code -transitions: [ - Transition { - NumberAnimation { - properties: "x,y" - easing.type: Easing.OutBounce - duration: 200 - } - } -] -\endcode +\snippet doc/src/snippets/declarative/animation.qml transitions-1 As can be seen, transitions make use of the same basic animation classes introduced above. In the above example we have specified that we want to animate the \c x and \c y properties, but have not -specified the objects to animate or the \c to values. By default these values are supplied by the framework -- +specified the objects to animate or the \c to values. By default these values are supplied by the framework; the animation will animate any \c targets whose \c x and \c y have changed, and the \c to values will be those defined in the end state. You can always supply explicit values to override these implicit values when needed. -\code -Transition { - from: "*" - to: "MyState" - reversible: true - SequentialAnimation { - NumberAnimation { - duration: 1000 - easing.type: Easing.OutBounce - // animate myItem's x and y if they have changed in the state - target: myItem - properties: "x,y" - } - NumberAnimation { - duration: 1000 - // animate myItem2's y to 200, regardless of what happens in the state - target: myItem2 - property: "y" - to: 200 - } - } -} -\endcode +\snippet doc/src/snippets/declarative/animation.qml transitions-2 QML transitions have selectors to determine which state changes a transition should apply to. The following transition will only be triggered when we enter into the \c "details" state. +(The "*" value is a wildcard value that specifies the transition should be applied when changing +from \e any state to the "details" state.) \code Transition { @@ -188,30 +120,7 @@ Transitions can happen in parallel, in sequence, or in any combination of the tw animations in a transition will happen in parallel. The following example shows a rather complex transition making use of both sequential and parallel animations: -\code -Transition { - from: "*" - to: "MyState" - reversible: true - SequentialAnimation { - ColorAnimation { duration: 1000 } - PauseAnimation { duration: 1000 } - ParallelAnimation { - NumberAnimation { - duration: 1000 - easing.type: Easing.OutBounce - targets: box1 - properties: "x,y" - } - NumberAnimation { - duration: 1000 - targets: box2 - properties: "x,y" - } - } - } -} -\endcode +\snippet doc/src/snippets/declarative/animation.qml transitions-3 \section1 Property Behaviors @@ -219,24 +128,15 @@ A \l{Behavior}{property behavior} specifies a default animation to run whenever of what caused the change. The \c enabled property can be used to force a \l Behavior to only apply under certain circumstances. -In the following snippet, we specify that we want the x position of redRect to be animated -whenever it changes. The animation will last 300 milliseconds and use an InOutQuad easing curve. +In the following snippet, we specify that we want the \c x position of \c redRect to be animated +whenever it changes. The animation will last 300 milliseconds and use an \l{PropertyAnimation::easing.type}{Easing.InOutQuad} easing curve. -\qml -Rectangle { - id: redRect - color: "red" - width: 100; height: 100 - Behavior on x { NumberAnimation { duration: 300; easing.type: Easing.InOutQuad } } -} -\endqml +\snippet doc/src/snippets/declarative/animation.qml behavior Like using an animation as a value source, when used in a Behavior and animation does not need to specify a \c target or \c property. -To trigger this behavior, we could: -\list -\o Enter a state that changes x +To trigger this behavior, we could enter a state that changes \c x: \qml State { @@ -249,7 +149,7 @@ State { } \endqml -\o Update x from a script +Or, update \c x from a script: \qml MouseArea { @@ -257,11 +157,10 @@ MouseArea { onClicked: redRect.x = 24; } \endqml -\endlist -If x were bound to another property, triggering the binding would also trigger the behavior. +If \c x were bound to another property, triggering the binding would also trigger the behavior. -If a state change has a transition animation matching a property with a Behavior, the transition animation -will override the Behavior for that state change. +If a state change has a transition animation matching a property with a \l Behavior, the transition animation +will override the \l Behavior for that state change. */ diff --git a/doc/src/declarative/declarativeui.qdoc b/doc/src/declarative/declarativeui.qdoc index 1199b26..7a49d0a 100644 --- a/doc/src/declarative/declarativeui.qdoc +++ b/doc/src/declarative/declarativeui.qdoc @@ -118,6 +118,7 @@ application or to build completely new applications. QML is fully \l \o \l {QML Security} \o \l {QtDeclarative Module} \o \l {Debugging QML} +\o \l {QML Performance} \o \l {QML Coding Conventions} \endlist */ diff --git a/doc/src/declarative/elements.qdoc b/doc/src/declarative/elements.qdoc index aa48bcb..31fa948 100644 --- a/doc/src/declarative/elements.qdoc +++ b/doc/src/declarative/elements.qdoc @@ -211,6 +211,4 @@ The following table lists the QML elements provided by the \l {QtDeclarative}{Qt \endlist \endtable -\o - */ diff --git a/doc/src/declarative/examples.qdoc b/doc/src/declarative/examples.qdoc index 8f39685..ad8c10c 100644 --- a/doc/src/declarative/examples.qdoc +++ b/doc/src/declarative/examples.qdoc @@ -79,6 +79,7 @@ For example, from your build directory, run: \section2 Image Elements \list \o \l{declarative/imageelements/borderimage}{BorderImage} +\o \l{declarative/imageelements/image}{Image} \endlist \section2 Positioners @@ -117,6 +118,7 @@ For example, from your build directory, run: \o \l{declarative/modelviews/package}{Package} \o \l{declarative/modelviews/parallax}{Parallax} \o \l{declarative/modelviews/stringlistmodel}{String ListModel} +\o \l{declarative/modelviews/visualitemmodel}{VisualItemModel} \o \l{declarative/modelviews/webview}{WebView} \endlist diff --git a/doc/src/declarative/extending.qdoc b/doc/src/declarative/extending.qdoc index 574b0b2..03c0ec4 100644 --- a/doc/src/declarative/extending.qdoc +++ b/doc/src/declarative/extending.qdoc @@ -425,6 +425,9 @@ value will not be accessible from script. \l {Extending QML - Signal Support Example} shows the complete code used to implement the onPartyStarted signal property. +If you want to use signals from items not created in QML, you can access their +signals with the \l {Connections} element. + \section1 Property Value Sources \snippet examples/declarative/cppextensions/referenceexamples/valuesource/example.qml 0 @@ -896,9 +899,13 @@ in other projects without the use of C++. Components can also help to reduce duplication inside one project by limiting the need for large numbers of copy-and-pasted blocks. -Any snippet of QML code can become a component, just by placing it in the file -"<Name>.qml" where <Name> is the new element name, and begins with an uppercase -letter. These QML files automatically become available as new QML element types +Any snippet of QML code can become a component, just by placing it in the file "<Name>.qml" +where <Name> is the new element name, and begins with an uppercase letter. Note that +the case of all characters in the <Name> are significant on some filesystems, notably +UNIX filesystems. It is recommended that the case of the filename matches the case of +the component name in QML exactly, regardless of the platform the QML will be deployed to. + +These QML files automatically become available as new QML element types to other QML components and applications in the same directory. For example, here we show how a component named "Box" is defined and used diff --git a/doc/src/declarative/pics/anchorchanges.png b/doc/src/declarative/pics/anchorchanges.png Binary files differnew file mode 100644 index 0000000..4973e4e --- /dev/null +++ b/doc/src/declarative/pics/anchorchanges.png diff --git a/doc/src/declarative/pics/listmodel-nested.png b/doc/src/declarative/pics/listmodel-nested.png Binary files differnew file mode 100644 index 0000000..ee7ffba --- /dev/null +++ b/doc/src/declarative/pics/listmodel-nested.png diff --git a/doc/src/declarative/pics/listmodel.png b/doc/src/declarative/pics/listmodel.png Binary files differnew file mode 100644 index 0000000..7ab1771 --- /dev/null +++ b/doc/src/declarative/pics/listmodel.png diff --git a/doc/src/declarative/pics/parentchange.png b/doc/src/declarative/pics/parentchange.png Binary files differnew file mode 100644 index 0000000..93206fb --- /dev/null +++ b/doc/src/declarative/pics/parentchange.png diff --git a/doc/src/declarative/pics/repeater-simple.png b/doc/src/declarative/pics/repeater-simple.png Binary files differnew file mode 100644 index 0000000..6da6295 --- /dev/null +++ b/doc/src/declarative/pics/repeater-simple.png diff --git a/doc/src/declarative/qdeclarativedebugging.qdoc b/doc/src/declarative/qdeclarativedebugging.qdoc index 4ff7fde..99dd2d2 100644 --- a/doc/src/declarative/qdeclarativedebugging.qdoc +++ b/doc/src/declarative/qdeclarativedebugging.qdoc @@ -60,8 +60,35 @@ Rectangle { \section1 Debugging Transitions When a transition doesn't look quite right, it can be helpful to view it in slow -motion to see what is happening more clearly. The \l {Qt Declarative UI Runtime}{qml} tool provides a -"Slow Down Animations" menu option to facilitate this. +motion to see what is happening more clearly. This functionality is supported +in the \l {Qt Declarative UI Runtime}{qmlviewer} tool: to enable this, +click on the "Debugging" menu, then "Slow Down Animations". + + +\section1 Debugging module imports + +The \c QML_IMPORT_TRACE environment variable can be set to enable debug output +from QML's import loading mechanisms. + +For example, for a simple QML file like this: + +\qml +import Qt 4.7 + +Rectangle { width: 100; height: 100 } +\endqml + +If you set \c {QML_IMPORT_TRACE=1} before running the \l {Qt Declarative UI Runtime}{qmlviewer} +(or your QML C++ application), you will see output similar to this: + +\code +QDeclarativeImportDatabase::addImportPath "/qt-sdk/imports" +QDeclarativeImportDatabase::addImportPath "/qt-sdk/bin/QMLViewer.app/Contents/MacOS" +QDeclarativeImportDatabase::addToImport 0x106237370 "." -1.-1 File as "" +QDeclarativeImportDatabase::addToImport 0x106237370 "Qt" 4.7 Library as "" +QDeclarativeImportDatabase::resolveType "Rectangle" = "QDeclarativeRectangle" +\endcode + \section1 Debugging with Qt Creator diff --git a/doc/src/declarative/qdeclarativedocument.qdoc b/doc/src/declarative/qdeclarativedocument.qdoc index bc099ce..8336512 100644 --- a/doc/src/declarative/qdeclarativedocument.qdoc +++ b/doc/src/declarative/qdeclarativedocument.qdoc @@ -96,9 +96,6 @@ Once created, instances are not dependent on the component that created them, so operate on independent data. Here is an example of a simple "Button" component that is instantiated four times, each with a different value for its \c text property. -\table -\row -\o \raw HTML <table><tr><td> \endraw @@ -125,10 +122,19 @@ BorderImage { \raw HTML </td> </tr> </table> \endraw -\endtable -In addition to the top-level component that all QML documents define, documents may also -include additional \e inline components. Inline components are declared using the +Any snippet of QML code can become a component, just by placing it in the file "<Name>.qml" +where <Name> is the new element name, and begins with an uppercase letter. Note that +the case of all characters in the <Name> are significant on some filesystems, notably +UNIX filesystems. It is recommended that the case of the filename matches the case of +the component name in QML exactly, regardless of the platform the QML will be deployed to. + +These QML files automatically become available as new QML element types +to other QML components and applications in the same directory. + +In addition to the top-level component that all QML documents define, and any reusable +components placed in separate files, documents may also +include \e inline components. Inline components are declared using the \l Component element, as can be seen in the first example above. Inline components share all the characteristics of regular top-level components and use the same \c import list as their containing QML document. Components are one of the most basic building blocks in QML, and are diff --git a/doc/src/declarative/qdeclarativeperformance.qdoc b/doc/src/declarative/qdeclarativeperformance.qdoc new file mode 100644 index 0000000..b535e4b --- /dev/null +++ b/doc/src/declarative/qdeclarativeperformance.qdoc @@ -0,0 +1,120 @@ +/**************************************************************************** +** +** Copyright (C) 2010 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:LGPL$ +** No Commercial Usage +** This file contains pre-release code and may not be distributed. +** You may use this file in accordance with the terms and conditions +** contained in the Technology Preview License Agreement accompanying +** this package. +** +** GNU Lesser General Public License Usage +** Alternatively, this file may be used under the terms of the GNU Lesser +** General Public License version 2.1 as published by the Free Software +** Foundation and appearing in the file LICENSE.LGPL included in the +** packaging of this file. Please review the following information to +** ensure the GNU Lesser General Public License version 2.1 requirements +** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. +** +** In addition, as a special exception, Nokia gives you certain additional +** rights. These rights are described in the Nokia Qt LGPL Exception +** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. +** +** If you have questions regarding the use of this file, please contact +** Nokia at qt-info@nokia.com. +** +** +** +** +** +** +** +** +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/*! +\page qdeclarativeperformance.html +\title QML Performance + +\section1 Opaque Items + +Items hidden behind an opaque item incur a cost. If an item will be enitrely +obscured by an opaque item, set its opacity to 0. One common example of +this is when a "details" page is shown over the main application view. + +\section1 Clipping + +\e clip is set to false by default. Enable clipping only when necessary. + +\section1 Anchors vs. Binding + +It is more efficient to use anchors rather than bindings to position items +relative to each other. Consider this use of bindings to position rect2 +relative to rect1: + +\code +Rectangle { + id: rect1 + x: 20 + width: 200; height: 200 +} +Rectange { + id: rect2 + x: rect1.x + y: rect1.y + rect1.height + width: rect1.width - 20 + height: 200 +} +\endcode + +This is achieved more efficiently using anchors: + +\code +Rectangle { + id: rect1 + x: 20 + width: 200; height: 200 +} +Rectange { + id: rect2 + height: 200 + anchors.left: rect1.left + anchors.top: rect1.bottom + anchors.right: rect1.right + anchors.rightMargin: 20 +} +\endcode + +\section1 Images + +Images consume a great deal of memory and may also be costly to load. In order +to deal with large images efficiently it is recommended that the Image::sourceSize +property be set to a size no greater than that necessary to render it. Beware that +changing the sourceSize will cause the image to be reloaded. + +Images on the local filesystem are usually loaded synchronously. This is usually +the desired behavior for user interface elements, however for large images that +do not necessarily need to be visible immediately, set the Image::asynchronous +property to true. This will load the image in a low priority thread. + +\section1 View Delegates + +Delegates must be created quickly as the view is flicked. There are two important +aspects to maintaining a smooth view: + +\list +\o Small delegates - keep the amount of QML to a minimum. Have just enough +QML in the delegate to display the necessary information. Any additional functionality +that is only needed when the delegate is clicked, for example, should be created by +a Loader as needed. +\o Fast data access - ensure the data model is as fast as possible. +\endlist + +*/ diff --git a/doc/src/declarative/qdeclarativestates.qdoc b/doc/src/declarative/qdeclarativestates.qdoc index fd0c677..43b5c31 100644 --- a/doc/src/declarative/qdeclarativestates.qdoc +++ b/doc/src/declarative/qdeclarativestates.qdoc @@ -70,58 +70,30 @@ In QML: \o A state can affect the properties of other objects, not just the object owning the state (and not just that object's children). \endlist +To define a state for an item, add a \l State element to the \l{Item::states}{states} property. To +change the current state of an \l Item, set the \l{Item::state}{state} property to the name +of the required state. + Here is an example of using states. In the default state \c myRect is positioned at 0,0. In the 'moved' state it is positioned at 50,50. Clicking within the mouse area changes the state from the default state to the 'moved' state, thus moving the rectangle. -\qml -Item { - id: myItem - - Rectangle { - id: myRect - width: 100 - height: 100 - color: "red" - } - - states: [ - State { - name: "moved" - PropertyChanges { - target: myRect - x: 50 - y: 50 - } - } - ] - - MouseArea { - anchors.fill: parent - onClicked: myItem.state = 'moved' - } -} -\endqml +\snippet doc/src/snippets/declarative/states.qml 0 +\snippet doc/src/snippets/declarative/states.qml 1 State changes can be animated using \l{state-transitions}{Transitions}. -For example, adding this code to the above \c {Item {}} element animates the transition to the "moved" state: +For example, adding this code to the above \c Item element animates the transition to the "moved" state: -\qml - transitions: [ - Transition { - NumberAnimation { properties: "x,y"; duration: 500 } - } - ] -\endqml +\snippet doc/src/snippets/declarative/states.qml transitions See \l{state-transitions}{Transitions} for more information. Other things you can do in a state change: \list -\o override signal handlers with PropertyChanges -\o change an item's visual parent with ParentChange -\o change an item's anchors with AnchorChanges -\o run some script with StateChangeScript +\o Override signal handlers with PropertyChanges +\o Change an item's visual parent with ParentChange +\o Change an item's anchors with AnchorChanges +\o Run some script with StateChangeScript \endlist */ diff --git a/doc/src/declarative/qmlruntime.qdoc b/doc/src/declarative/qmlruntime.qdoc index cef5e63..66b4b2b 100644 --- a/doc/src/declarative/qmlruntime.qdoc +++ b/doc/src/declarative/qmlruntime.qdoc @@ -152,7 +152,7 @@ \section2 Runtime Object - All applications using the launcher will have access to the 'runtime' + All applications using the launcher will have access to the \c runtime property on the root context. This property contains several pieces of information about the runtime environment of the application. @@ -160,11 +160,19 @@ A special piece of dummy data which is integrated into the launcher is a simple orientation property. The orientation can be set via the - settings menu in the application, or by pressing Ctrl+T to toggle it. + settings menu in the application, or by pressing Ctrl+T to rotate it. - To use this from within your QML file, access runtime.orientation, - which can be either Orientation.Landscape or Orientation.Portrait and which can be bound to in your - application. An example is below: + To use this from within your QML file, access \c runtime.orientation, + which can be one of the following values: + + \list + \o \c Orientation.Portrait + \o \c Orientation.Landscape + \o \c Orientation.PortraitInverted (Portrait orientation, upside-down) + \o \c Orientation.LandscapeInverted (Landscape orientation, upside-down) + \endlist + + These values can be bound to in your application. For example: \code Item { @@ -172,13 +180,13 @@ } \endcode - This allows your application to respond to the orientation of the screen changing. The launcher + This allows your application to respond to changes in the screen's orientation. The launcher will automatically update this on some platforms (currently the N900 only) to match the physical screen's orientation. On other plaforms orientation changes will only happen when explictly asked for. \section3 Window Active - The runtime.isActiveWindow property tells whether the main window of the launcher is currently active + The \c runtime.isActiveWindow property tells whether the main window of the launcher is currently active or not. This is especially useful for embedded devices when you want to pause parts of your application, including animations, when your application loses focus or goes to the background. diff --git a/doc/src/declarative/qtbinding.qdoc b/doc/src/declarative/qtbinding.qdoc index 7d696d7..784c59a 100644 --- a/doc/src/declarative/qtbinding.qdoc +++ b/doc/src/declarative/qtbinding.qdoc @@ -269,5 +269,10 @@ For example: \c [project/main.qml] \snippet doc/src/snippets/declarative/qtbinding/resources/main.qml 0 +Note that the resource system cannot be accessed from QML directly. If the main QML file is +loaded as a resource, all files specifed as relative paths in QML will also be loaded from +the resource system. Using the resource system is completely transparent to the QML layer. +This also means that if the main QML file is not loaded as a resource then files in the resource +system cannot be accessed from QML. */ diff --git a/doc/src/examples/qml-examples.qdoc b/doc/src/examples/qml-examples.qdoc index 035628e..b6069f2 100644 --- a/doc/src/examples/qml-examples.qdoc +++ b/doc/src/examples/qml-examples.qdoc @@ -75,6 +75,15 @@ */ /*! + \title Image Elements: Image + \example declarative/imageelements/image + + This example shows how to use the Image element and its \l{Image::fillMode}{fillModes}. + + \image qml-image-example.png +*/ + +/*! \page declarative-cppextensions-reference.html \title C++ Extensions: Reference examples @@ -238,6 +247,13 @@ */ /*! + \title Models and Views: VisualItemModel + \example declarative/modelviews/visualitemmodel + + This example shows how to use the VisualItemModel element. +*/ + +/*! \title Models and Views: WebView \example declarative/modelviews/webview diff --git a/doc/src/images/qml-image-example.png b/doc/src/images/qml-image-example.png Binary files differnew file mode 100644 index 0000000..c1951c0 --- /dev/null +++ b/doc/src/images/qml-image-example.png diff --git a/doc/src/ja_JP/development/designer-manual.qdoc b/doc/src/ja_JP/development/designer-manual.qdoc new file mode 100644 index 0000000..585af16 --- /dev/null +++ b/doc/src/ja_JP/development/designer-manual.qdoc @@ -0,0 +1,175 @@ +/**************************************************************************** +** +** Copyright (C) 2010 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:LGPL$ +** No Commercial Usage +** This file contains pre-release code and may not be distributed. +** You may use this file in accordance with the terms and conditions +** contained in the Technology Preview License Agreement accompanying +** this package. +** +** GNU Lesser General Public License Usage +** Alternatively, this file may be used under the terms of the GNU Lesser +** General Public License version 2.1 as published by the Free Software +** Foundation and appearing in the file LICENSE.LGPL included in the +** packaging of this file. Please review the following information to +** ensure the GNU Lesser General Public License version 2.1 requirements +** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. +** +** In addition, as a special exception, Nokia gives you certain additional +** rights. These rights are described in the Nokia Qt LGPL Exception +** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. +** +** If you have questions regarding the use of this file, please contact +** Nokia at qt-info@nokia.com. +** +** +** +** +** +** +** +** +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/*! + \page designer-quick-start.html + + \title Qt Designer クイックガイド + + \QD を使うための基本的な手順は、以下の\bold{四つ}です。 + + \list 1 + \o フォームとオブジェクトを選択する + \o フォームにオブジェクトを配置する + \o スロットにシグナルを接続する + \o フォームをプレビューする + \endlist + + \image rgbController-screenshot.png + + Red、Green、Blue(RGB)の値を操作するために必要なコントロールを含む + 小さなウィジェット(上記スクリーンショット参照)を設計する場合を想定します。 + このウィジェットは、画像処理プログラム内のどこからでも表示できるウィジェットです。 + + \table + \row + \i \inlineimage designer-choosing-form.png + \i \bold{フォームを選択する} + + \gui{新しいフォーム} ダイアログから \gui Widget を選択して開始します。 + \endtable + + + \table + \row + \i \inlineimage rgbController-arrangement.png + \i \bold{フォームにウィジェットを配置する} + + 3つのラベル(Label)、スピンボックス(Spin Box)、垂直方向のスライダ(Vertical Slider)をフォーム上へドラッグします。 + ラベルの既定の文字列を変更するには、文字列をダブルクリックします。 + 希望するレイアウトに合わせて配置します。 + \endtable + + 画像のようにこれらのウィジェットを配置するには、 + レイアウトにウィジェットを配置する必要があります。 + これを3つグループに対して行います。 + まず "RED" ラベルを選択します。 + 次に、\key Ctrl (Mac OS X では \key Command)キーを押したまま、対応するスピンボックスとスライダを選択します。 + \gui{フォーム} メニューで、\gui{格子状に並べる}を選択します。 + + \table + \row + \i \inlineimage rgbController-form-gridLayout.png + \i \inlineimage rgbController-selectForLayout.png + \endtable + + 他の2つのラベルに対しても、対応するスピンボックスとスライダごとにこの手順を繰り返します。 + + 次の手順は、これら3つのレイアウトを組み合わせて、1つの\bold{メインレイアウト}を作成することです。 + メインレイアウトとは、トップレベルウィジェット(この場合は QWidget)のレイアウトです。 + トップレベルウィジェットにレイアウトを配置することは重要です。 + そうでなければ、ウィンドウをサイズ変更したときにウィンドウ上のウィジェットのサイズが変更されません。 + レイアウトを設定するには、フォーム上の3つのレイアウト以外の任意の場所で\gui{右クリック}し、\gui{水平に並べる}を選択します。 + または、\gui{格子状に並べる}を選択することもできます。 + そのどちらでも同じ配置(以下を参照)で表示されます。 + + \image rgbController-final-layout.png + + \note メインレイアウトはフォームに表示できません。 + メインレイアウトがインストールされているかどうかを確認するには、 + フォームをサイズ変更してみます。 + インストールされている場合は、各ウィジェットのサイズが適宜変更されます。 + または、\QD の \gui{Object Inspector} で確認することもできます。 + トップレベルウィジェットにレイアウトが配置されていない場合、 + その横に崩れたレイアウトのアイコン \inlineimage rgbController-no-toplevel-layout.png + が表示されます。 + + スライダをクリックして特定の値までドラッグするときに、 + スピンボックスにスライダの位置を反映させます。 + この操作を行うには、スライダの \l{QAbstractSlider::}{valueChanged()} + シグナルをスピンボックスの \l{QSpinBox::}{setValue()} + スロットに接続する必要があります。 + また、逆方向、すなわちスピンボックスの \l{QSpinBox::}{valueChanged()} + シグナルをスライダの \l{QAbstractSlider::value()}{setValue()} スロットに接続する必要があります。 + + この操作を行うには、\key{F4} キーを押すか、\gui{編集|シグナル/スロットの編集} を選択し、 + \gui{シグナル/スロットの編集}モードに切り替える必要があります。 + + \table + \row + \i \inlineimage rgbController-signalsAndSlots.png + \i \bold{シグナルをスロットに接続する} + + スライダをクリックし、カーソルをスピンボックスまでドラッグします。 + 以下のような \gui{シグナルスロットを設定} ダイアログがポップアップ表示されます。 + 適切なシグナルとスロットを選択し、\gui OK をクリックします。 + \endtable + + \image rgbController-configure-connection1.png + + 手順を(逆の順序で)繰り返し、 + スピンボックスをクリックしてカーソルをスライダまでドラッグし、 + スピンボックスの \l{QSpinBox::}{valueChanged()} シグナルを、 + スライダの \l{QAbstractSlider::value()}{setValue()} スロットに接続します。 + + 以下のスクリーンショットは、適切なシグナルとスロットを選択するためのガイドとして利用できます。 + + \image rgbController-configure-connection2.png + + RGBコントローラーの "RED" コンポーネントのオブジェクトが正常に接続されたので、 + "GREEN" および "BLUE" コンポーネントにも同じ手順を繰り返します。 + + RGB値の範囲は 0 ~ 255 であるため、 + スピンボックスとスライダを特定の範囲に制限する必要があります。 + + \table + \row + \i \inlineimage rgbController-property-editing.png + \i \bold{ウィジェットのプロパティを設定する} + + 最初のスピンボックスをクリックします。 + \gui{プロパティエディタ}に \l{QSpinBox} のプロパティが表示されます。 + \l{QSpinBox::}{maximum} のプロパティに、"255" と入力します。 + 次に、最初の垂直方向のスライダをクリックすると、 + \l{QAbstractSlider} のプロパティが表示されます。 + \l{QAbstractSlider::}{maximum} のプロパティにも、"255" と入力します。 + 残りのスピンボックスとスライダに対しても、この処理を繰り返します。 + \endtable + + ここで、フォームをプレビューし、アプリケーションの外観を確認します。 + この操作を行うには、\key{Ctrl + R} を押すか、 + \gui{フォーム}メニューから\gui{プレビュー}を選択します。 + スライダをドラッグすると、 + スピンボックスにその値が反映されます(逆の場合も同じ)。 + またサイズを変更し、子ウィジェットの管理に使用するレイアウトが + どのようにウィンドウのさまざまなサイズに対応しているか確認します。 +*/ + diff --git a/doc/src/ja_JP/development/qmake-manual.qdoc b/doc/src/ja_JP/development/qmake-manual.qdoc new file mode 100644 index 0000000..8c9297f --- /dev/null +++ b/doc/src/ja_JP/development/qmake-manual.qdoc @@ -0,0 +1,212 @@ +/**************************************************************************** +** +** Copyright (C) 2010 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:LGPL$ +** No Commercial Usage +** This file contains pre-release code and may not be distributed. +** You may use this file in accordance with the terms and conditions +** contained in the Technology Preview License Agreement accompanying +** this package. +** +** GNU Lesser General Public License Usage +** Alternatively, this file may be used under the terms of the GNU Lesser +** General Public License version 2.1 as published by the Free Software +** Foundation and appearing in the file LICENSE.LGPL included in the +** packaging of this file. Please review the following information to +** ensure the GNU Lesser General Public License version 2.1 requirements +** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. +** +** In addition, as a special exception, Nokia gives you certain additional +** rights. These rights are described in the Nokia Qt LGPL Exception +** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. +** +** If you have questions regarding the use of this file, please contact +** Nokia at qt-info@nokia.com. +** +** +** +** +** +** +** +** +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/*! + \page qmake-tutorial.html + \title qmake チュートリアル + + このチュートリアルでは \c qmake の使い方を説明します。 + このチュートリアルを読み終わったら \c qmake + のユーザガイドを読むことをお勧めします。 + + \section1 簡単な例 + + アプリケーションの基本的な実装は既に完了していて、 + 次のファイルが作成されていると仮定します。 + + \list + \o hello.cpp + \o hello.h + \o main.cpp + \endlist + + これらのファイルは Qt ディストリビューションの + \c{examples/qmake/tutorial} ディレクトリにあります。 + アプリケーションの設定について知っておくべきことは、 + それが Qt で書かれているということだけです。 + まず、テキストエディタで \c{examples/qmake/tutorial} に + \c hello.pro というファイルを作成します。 + 最初にすることは、開発プロジェクトに含まれるソースファイルとヘッダファイルを + \c qmake に教える行を追加することです。 + + ソースファイルをプロジェクトファイルに追加します。 + これには \l{qmake Variable Reference#SOURCES}{SOURCES} 変数を使います。 + 新しい行を作り、\c{SOURCES +=}、続いて hello.cpp を入力します。 + つまり、以下のようになります: + + \snippet doc/src/snippets/code/doc_src_qmake-manual.qdoc 108 + + これを以下のようになるまでプロジェクトの各ソースファイルに対して行います: + + \snippet doc/src/snippets/code/doc_src_qmake-manual.qdoc 109 + + make に似たシンタックスを使いたい場合は、 + 以下のように改行をエスケープしてすべてのファイルを 1 行に書きます: + + \snippet doc/src/snippets/code/doc_src_qmake-manual.qdoc 110 + + ソースファイルの一覧をプロジェクトファイルに追加しました。 + 次にヘッダファイルを追加します。 + ヘッダファイルはソースファイルと全く同じ方法で追加することができます。 + ただし変数は \l{qmake Variable Reference#HEADERS}{HEADERS} + を使います。 + + これを終えると、プロジェクトファイルは以下のようになるでしょう: + + \snippet doc/src/snippets/code/doc_src_qmake-manual.qdoc 111 + + ターゲットの名前は自動的に設定され、 + プロジェクトファイルと同じ名前になります。 + ただしプラットフォームに合わせたサフィックスがつけられます。 + 例えば、プロジェクトファイルが \c hello.pro である場合、 + ターゲットは Windows では \c hello.exe 、Unix では \c hello になります。 + プロジェクトファイルで別の名前を指定することもできます: + + \snippet doc/src/snippets/code/doc_src_qmake-manual.qdoc 112 + + 最後に \l{qmake Variable Reference#CONFIG}{CONFIG} 変数を設定します。 + このアプリケーションは Qt アプリケーションなので \c CONFIG に + \c qt を追加する必要があります。 + \c qmake は リンクの必要があるライブラリを追加し、 + \c moc と \c uic の実行コマンドが Makefile に含まれるようにします。 + + 最終的なプロジェクトファイルは以下のようになります: + + \snippet doc/src/snippets/code/doc_src_qmake-manual.qdoc 113 + + \c qmake を使って、このアプリケーションのための Makefile を生成します。 + プロジェクトのディレクトリでコマンドラインに次のように入力します: + + \snippet doc/src/snippets/code/doc_src_qmake-manual.qdoc 114 + + そして、使用するコンパイラによって \c make または \c nmake を入力します。 + + Visual Studio ユーザの場合、\c qmake は、以下のように + \c .dsp ファイルまたは \c .vcproj ファイルも作成できます: + + \snippet doc/src/snippets/code/doc_src_qmake-manual.qdoc 115 + + \section1 アプリケーションをデバッグできるようにする + + アプリケーションのリリースバージョンはデバッグシンボルなどのデバッグ情報を含みません。 + 開発中は、関連情報を含むアプリケーションのデバッグバージョンを作成するのが便利です。 + これは、プロジェクトファイルの \c CONFIG 変数に \c debug + を追加することで簡単に実現できます。 + + たとえば: + + \snippet doc/src/snippets/code/doc_src_qmake-manual.qdoc 116 + + 直前の例と同様に、Makefile を生成するには \c qmake を使います。 + アプリケーションをデバッグ環境で実行する際に役に立つ情報を得られるようになります。 + + \section1 プラットフォーム固有のソースファイルを追加する + + 数時間コーディングをしていると、 + アプリケーションにプラットフォーム固有な部分が出てきて + プラットフォーム固有のコードを別のファイルに分けたい場合があるかもしれません。 + ここでは 2 つのファイル \c hellowin.cpp と \c hellounix.cpp があるとして、 + これをプロジェクトファイルに追加します。 + これらのファイルをそのまま \c SOURCES 変数に追加することはできません。 + なぜなら、両方のファイルが Makefile に追加されてしまうからです。 + \c qmake が実行されたプラットフォームにしたがって処理されるスコープを使う必要があります。 + + Windows 用のファイルを追加するシンプルなスコープは以下のようになります: + + \snippet doc/src/snippets/code/doc_src_qmake-manual.qdoc 117 + + \c qmake が Windows 上で実行されると、ソースファイルのリストに + \c hellowin.cpp が追加されます。 + \c qmake が他のプラットフォームで実行された場合、この部分は無視されます。 + 次に Unix 用ファイルのスコープを作成します。 + + これを終えると、プロジェクトファイルは以下のようになります: + + \snippet doc/src/snippets/code/doc_src_qmake-manual.qdoc 118 + + これまでと同様に、Makefile を生成するには \c qmake を使います。 + + \section1 ファイルが存在しない場合に qmake を中止する + + 特定のファイルが存在しない場合に Makefile を作成したくない場合、 + exists() 関数を使ってファイルが存在するかどうかを確認することができます。 + また error() 関数を使って \c qmake の処理を中止させることができます。 + これらの関数はスコープとして動作します。 + 使い方はスコープの条件をこれらの関数で置き換えるだけです。 + \c main.cpp ファイルの確認は以下のようになります : + + \snippet doc/src/snippets/code/doc_src_qmake-manual.qdoc 119 + + 記号 \c{!} はテストを否定します。 + つまり \c{exists( main.cpp )} はファイルが存在する場合に真になり、 + \c{!exists( main.cpp )} はファイルが存在しない場合に真になります。 + + \snippet doc/src/snippets/code/doc_src_qmake-manual.qdoc 120 + + 前と同様に、\c qmake を実行して Makefile を生成します。 + 仮に \c main.cpp の名前を変更すると、上記のメッセージが表示され、 + \c qmake は処理を中止します。 + + \section1 複数の条件をチェックする + + Windows を使っていて、 + コマンドラインからこのアプリケーションを実行したときに + qDebug() の出力を見ることができるようにしたい場合、 + アプリケーションをコンソールの設定を追加してビルドする必要があります。 + Windows で Makefile をこの設定にするには、 + \c CONFIG に \c console を追加します。 + Windows で実行されていて、\e{かつ} \c CONFIG にすでに \c debug + がある場合にのみ \c CONFIG を追加したい場合があるかもしれません。 + このような場合、2 つのスコープをネストさせて使います。 + まず 1 つのスコープを作成し、その中にもう 1 つスコープを作成します。 + そして 2 つのスコープの中に設定を書きます。例えば: + + \snippet doc/src/snippets/code/doc_src_qmake-manual.qdoc 121 + + ネストされたスコープはコロンを使ってつなぐことができます。 + 最終的なプロジェクトファイルは以下のようになります: + + \snippet doc/src/snippets/code/doc_src_qmake-manual.qdoc 122 + + 以上です。\c qmake のチュートリアルが終了しました。 + それでは、あなたの開発プロジェクトのプロジェクトファイルを作成してみましょう。 +*/ + diff --git a/doc/src/ja_JP/development/qtestlib.qdoc b/doc/src/ja_JP/development/qtestlib.qdoc new file mode 100644 index 0000000..65c4c3f --- /dev/null +++ b/doc/src/ja_JP/development/qtestlib.qdoc @@ -0,0 +1,432 @@ +/**************************************************************************** +** +** Copyright (C) 2010 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:LGPL$ +** No Commercial Usage +** This file contains pre-release code and may not be distributed. +** You may use this file in accordance with the terms and conditions +** contained in the Technology Preview License Agreement accompanying +** this package. +** +** GNU Lesser General Public License Usage +** Alternatively, this file may be used under the terms of the GNU Lesser +** General Public License version 2.1 as published by the Free Software +** Foundation and appearing in the file LICENSE.LGPL included in the +** packaging of this file. Please review the following information to +** ensure the GNU Lesser General Public License version 2.1 requirements +** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. +** +** In addition, as a special exception, Nokia gives you certain additional +** rights. These rights are described in the Nokia Qt LGPL Exception +** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. +** +** If you have questions regarding the use of this file, please contact +** Nokia at qt-info@nokia.com. +** +** +** +** +** +** +** +** +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/*! + \page qtestlib-tutorial.html + \brief QTestLib を使ったテストの導入ガイド + \contentspage QTestLib マニュアル + \nextpage {第1章: ユニットテストの作成}{第1章} + + \title QTestLib チュートリアル + + このチュートリアルでは QTestLib フレームワークの機能の初歩的な使い方を説明します。 + このチュートリアルは全5章で構成されています: + + \list 1 + \o \l {第1章: ユニットテストの作成}{ユニットテストの作成} + \o \l {第2章: データドリブンテスト}{データドリブンテスト} + \o \l {第3章: GUI イベントのシミュレート}{GUI イベントのシミュレート} + \o \l {第4章: GUI イベントの再現}{GUI イベントの再現} + \o \l {第5章: ベンチマークの作成}{ベンチマークの作成} + \endlist + +*/ + + +/*! + \example qtestlib/tutorial1 + + \contentspage {QTestLib チュートリアル}{目次} + \nextpage {第2章: データドリブンテスト}{第2章} + + \title 第1章: ユニットテストの作成 + + 第1章では、クラスのテストを行うシンプルなユニットテストを作成して実行する方法を説明します。 + + \section1 テストを作成する + + QString クラスの挙動をテストすると仮定しましょう。 + まず、テスト関数を含むクラスが必要です。 + このクラスは、 QObject を継承する必要があります: + + \snippet examples/qtestlib/tutorial1/testqstring.cpp 0 + + QTest ヘッダーを include してください。 + それから、テストフレームワークがテスト関数を検索して実行できるよう、 + テスト関数を private slot として宣言する必要があります。 + + 次に、テスト関数を実装します。実装は以下のようになります: + + \snippet doc/src/snippets/code/doc_src_qtestlib.qdoc 8 + + \l QVERIFY() マクロは、引数として渡される式を評価します。 + 式が真と評価されるとテスト関数の実行が継続されます。 + そうでなければ、エラーメッセージがテストログに追加されテスト関数の実行が停止します。 + + テストログに詳細情報を追加したい場合は、 + \l QCOMPARE() マクロを代わりに使用してください: + + \snippet examples/qtestlib/tutorial1/testqstring.cpp 1 + + 文字列が等しくない場合、両方の文字列の内容がテストログに追加され、 + 比較に失敗した理由を直ちに確認できます。 + + 最後に、テストケースを実行可能にするために以下の2行が必要となります: + + \snippet examples/qtestlib/tutorial1/testqstring.cpp 2 + + \l QTEST_MAIN() マクロは、すべてのテスト関数を実行するシンプルな + \c main() 関数に展開されます。 + テストクラスの宣言と実装が \c .cpp ファイルに存在する場合、 + Qt のメタオブジェクト機能を動作させるために、 + 生成された moc ファイルを include する必要があります。 + + \section1 テストを実行する + + 作成したテストを実行してみましょう。 + テストが \c testqstring.cpp + として空のディレクトリに保存されていると仮定して、 + qmake を使用してプロジェクトを作成し、makefile を生成します。 + + \snippet doc/src/snippets/code/doc_src_qtestlib.qdoc 9 + + \bold {注:} Windows をお使いの場合、 \c make を \c nmake または、 + 任意のビルドツールに置き換えてください。 + + 作成した実行ファイルを実行すると、次の出力が表示されます: + + \snippet doc/src/snippets/code/doc_src_qtestlib.qdoc 10 + + おめでとうございます! + QTestLib フレームワークを使用して、 + 最初のユニットテストの作成と実行に成功しました。 +*/ + +/*! + \example qtestlib/tutorial2 + + \previouspage {第1章: ユニットテストの作成}{第1章} + \contentspage {QTestLib チュートリアル}{目次} + \nextpage {第3章: GUI イベントのシミュレート}{第3章} + + \title 第2章: データドリブンテスト + + 本章ではテストを複数回、それぞれ異なるテストデータを使用して行う方法について、 + 例を示しながら説明します。 + + これまでは、テストデータをテスト関数にハードコードしていました。 + この場合、テストデータを追加した関数は以下のようになります: + + \snippet doc/src/snippets/code/doc_src_qtestlib.qdoc 11 + + 関数が繰り返しを行うコードによって分散するのを防ぐために、 + QTestLib はテストデータのテスト関数への追加をサポートします。 + そのために、別の private slot をテストクラスに追加する必要があります: + + \snippet examples/qtestlib/tutorial2/testqstring.cpp 0 + + \section1 データ関数を記述する + + テスト関数に関連するデータ関数では、テスト関数と同じ関数名を使用して、 + 末尾に \c{_data} を追加します。 + データ関数は以下のようになります: + + \snippet examples/qtestlib/tutorial2/testqstring.cpp 1 + + まず、 \l QTest::addColumn() 関数を使用して、 + テストテーブルの2つの要素(テスト文字列(\c{"string"})および、 + QString::toUpper() 関数をその文字列に適用するときに予期された結果(\c{"result"})) + を定義します。 + + 次に、 \l QTest::newRow() 関数を使用して、 + データをテーブルに追加します。 + それぞれのデータセットは、テストテーブルでは別々の行(Row)になります。 + + \l QTest::newRow() は、データセット名をその引数として受け付けます。 + テストに失敗した場合、テストログでこのデータセット名が使用され、 + 失敗したデータの一覧が表示されます。 + 続いて、最初に任意の文字列(\c{"string"})を、次に + QString::toUpper() 関数をその文字列(\c{"string"})に適用するときに予期された結果(\c{"result"})の順に、 + テーブル行にデータセットをストリーミングします。 + + テストデータとは、二次元テーブルを指します。 + ここでは、\c string および \c result と呼ばれる2つの列と3つの行が含まれます。 + さらに、インデックスと同様に、各行に名前を関連付けます: + + \table + \header + \o index + \o name + \o string + \o result + \row + \o 0 + \o all lower + \o "hello" + \o HELLO + \row + \o 1 + \o mixed + \o "Hello" + \o HELLO + \row + \o 2 + \o all upper + \o "HELLO" + \o HELLO + \endtable + + \section1 テスト関数を書き換える + + ここで、テスト関数の書き換えを行います: + + \snippet examples/qtestlib/tutorial2/testqstring.cpp 2 + + TestQString::toUpper() 関数は 3 回実行されます。 + すなわち、関連する TestQString::toUpper_data() + 関数で作成したテストテーブルの各エントリ毎に一度実行されます。 + + TestQString::toUpper() 関数では + まず、 \l QFETCH() マクロを使用して、データセットの2つの要素を取得します。 + \l QFETCH() は、要素のデータタイプと要素名の、 + 2 つの引数を取ります。 + 次に \l QCOMPARE() マクロを使用して、テストを実行します。 + + このアプローチにより、テストの修正を行うことなく + テストに新規データを非常に簡単に追加できます。 + + このテストの場合も、テストケースを実行可能にするには、 + 同様に以下の2行が必要です: + + \snippet examples/qtestlib/tutorial2/testqstring.cpp 3 + + これまでと同様に、 \l QTEST_MAIN() マクロは + すべてのテスト関数を実行するシンプルな + \c main() 関数に展開されます。 + テストクラスの宣言と実装が \c .cpp ファイルに存在する場合、 + Qt のメタオブジェクト機能を動作させるために、 + 生成された moc ファイルを include する必要があります。 + +*/ + +/*! + \example qtestlib/tutorial3 + + \previouspage {第2章: データドリブンテスト}{第2章} + \contentspage {QTestLib チュートリアル}{目次} + \nextpage {第4章: GUI イベントの再現}{第4章} + + \title 第3章: GUI イベントのシミュレート + + QTestLib にはグラフィカルユーザインターフェースをテストするための機能があります。 + QTestLib は、ネイティブなウィンドウシステムのイベントをシミュレートする代わりに、 + Qt の内部で使われるイベントを送信します。 + このため、テストが実行されるコンピュータには + 副次的な悪影響が発生しません。 + + 本章では、シンプルな GUI テストを作成する方法を確認します。 + + \section1 GUI テストを作成する + + 今回は、 QLineEdit クラスの挙動をテストすると仮定しましょう。 + これまでと同様に、テスト関数を含むクラスが必要です: + + \snippet examples/qtestlib/tutorial3/testgui.cpp 0 + + 唯一の違いは、 QTest だけでなく、 QtGui クラスの宣言を + include する必要があることです。 + + \snippet examples/qtestlib/tutorial3/testgui.cpp 1 + + テスト関数を実装する際は、最初に QLineEdit を作成します。 + 次に、 \l QTest::keyClicks() 関数を使用して、 + "hello world" をラインエディットに入力する操作をシミュレートします。 + + \note キーボードショートカットを正しくテストするには、 + ウィジェットの表示も必要になります。 + + QTest::keyClicks() は、 + ウィジェットのキーシーケンスの入力をシミュレートします。 + 必要に応じてキーボード修飾子の指定や、 + 各キー入力後の遅延(ミリ秒単位)を指定することができます。 + 同様に、 QTest::keyClick() 、 QTest::keyPress() 、 QTest::keyRelease() 、 + QTest::mouseClick() 、 QTest::mouseDClick() 、 QTest::mouseMove() 、 + QTest::mousePress() 及び QTest::mouseRelease() 関数を使用して、 + 関連付けられた GUI イベントをシミュレートできます。 + + 最後に、 \l QCOMPARE() マクロを使用して、 + ラインエディットの文字列が正しいかどうか確認します。 + + これまでと同様に、 + テストケースを実行可能にするには、 + 以下の2行が必要です: + + \snippet examples/qtestlib/tutorial3/testgui.cpp 2 + + QTEST_MAIN() マクロは + すべてのテスト関数を実行するシンプルな + \c main() 関数に展開されます。 + テストクラスの宣言と実装が \c .cpp ファイルに存在する場合、 + Qt のメタオブジェクト機能を動作させるために、 + 生成された moc ファイルを include する必要があります。 +*/ + +/*! + \example qtestlib/tutorial4 + + \previouspage {第3章: GUI イベントのシミュレート}{第3章} + \contentspage {QTestLib チュートリアル}{目次} + \nextpage {第5章: ベンチマークの作成}{第5章} + + \title 第4章: GUI イベントの再現 + + 本章では、GUI イベントをシミュレートしたり、 + あるウィジェットで一連の GUI イベントを再生したり保存したりする方法について説明します。 + + 一連のイベントを保存して再生するアプローチは、 + \l{第2章: データドリブンテスト}{第2章} + で説明したアプローチとよく似ています。 + 必要な変更は、テストクラスにデータ関数を追加することです: + + \snippet examples/qtestlib/tutorial4/testgui.cpp 0 + + \section1 データ関数を記述する + + これまでと同様にテスト関数に関連するデータ関数では、 + テスト関数と同じ名前を使用して末尾に \c{_data} を追加します。 + + \snippet examples/qtestlib/tutorial4/testgui.cpp 1 + + まず、 QTest::addColumn() 関数を使用して、 + テーブルの2つの要素(GUI イベントのリスト(\c{"events"})および、 + QWidget のイベントのリストを適用するときに予期された結果(\c{"expected"}))を定義します。 + 最初の要素の型は \l QTestEventList であることに注意してください。 + + QTestEventList では、後で使用するテストデータの保存を行うために + GUI イベントを読み込んだり、 QWidget ウィジェットで再生したりできます。 + + 現在のデータ関数で、 \l QTestEventList を2つ作成します。 + 最初のリストには 'a' キーを一度だけ入力します。 + QTestEventList::addKeyClick() 関数を使用して、 + リストにイベントを追加します。 + 次に、QTest::newRow() 関数を使用してデータセットに名前を付けて、 + テーブルにイベントリストおよび予期された結果をストリーミングします。 + + 2つ目のリストには、2つのキー入力('a' に続いてバックスペース(Qt::Key_Backspace))を設定します。 + QTestEventList::addKeyClick() を使用してリストにイベントを追加し、 + QTest::newRow() を使用して名前を関連付けたテーブルにイベントリストおよび予期された結果を挿入します。 + + \section1 テスト関数を書き換える + + ここで、テストの書き換えを行います: + + \snippet examples/qtestlib/tutorial4/testgui.cpp 2 + + TestGui::testGui() 関数は2回実行されます。 + 関連する TestGui::testGui_data() + 関数で作成したテストデータの各エントリ毎にそれぞれ実行されます。 + + まず、\l QFETCH() マクロを使用して、データセットの2つの要素を取得します。 + \l QFETCH() は、要素のデータ型と要素名の2つの引数を取ります。 + 次に QLineEdit を作成し、 QTestEventList::simulate() 関数を使用して + ウィジェットにイベントのリストを適用します。 + + 最後に、 QCOMPARE() マクロを使用してラインエディットの文字列が正しいかどうか確認します。 + + これまでと同様に、 + テストケースを実行可能にするには、 + 以下の2行が必要です: + + \snippet examples/qtestlib/tutorial4/testgui.cpp 3 + + \l QTEST_MAIN() マクロは + すべてのテスト関数を実行するシンプルな + \c main() 関数に展開されます。 + テストクラスの宣言と実装が \c .cpp ファイルに存在する場合、 + Qt のメタオブジェクト機能を動作させるために、 + 生成された moc ファイルを include する必要があります。 +*/ + +/*! + \example qtestlib/tutorial5 + + \previouspage {第4章: GUI イベントの再現}{第4章} + \contentspage {QTestLib チュートリアル}{目次} + + \title 第5章: ベンチマークの作成 + + 最終章となる本章では QTestLib を使ってベンチマークを作成する方法について説明します。 + + \section1 ベンチマークの作成 + ベンチマークを作成するには QBENCHMARK マクロを用いてテスト関数を拡張します。 + ベンチマークテスト関数には通常、テストの準備コードと測定するコードを含む + QBENCHMARK マクロが一つ含まれます。 + QString::localeAwareCompare() のベンチマークを行う関数は以下のようになります。 + + \snippet examples/qtestlib/tutorial5/benchmarking.cpp 0 + + 測定の準備は関数の最初に行われています。 + この時点では測定は始まっていません。 + QBENCHMARK マクロで囲まれたブロックの中身のみが計測されます。 + このブロックの内部は正確な測定を行うために、何度か繰り返し実行される場合があります。 + + \l {testlib-benchmarking-measurement}{ベンチマークの方法}(バックエンド)は何種類か用意されており、 + コマンドライン引数から選択することが出来ます。 + + \section1 データ関数 + + データ関数は複数のデータでベンチマークを行うテストを作成するのに有用です。 + たとえば、ロケール準拠と標準的な比較を行う場合は以下のようになります。 + + \snippet examples/qtestlib/tutorial5/benchmarking.cpp 1 + + テスト関数ではデータに従ってベンチマークする手法を決定します。 + + \snippet examples/qtestlib/tutorial5/benchmarking.cpp 2 + + "if (useLocaleCompare)" 文はそのオーバヘッドを測定対象外とするために + QBENCHMARK マクロのブロックの外部にあります。 + ベンチマークの実行時にはそれぞれどちらか一つの QBENCHMARK マクロが実行されます。 + + \section1 外部ツール + + テストデータの可視化を行うためのツールが Qt Labs Web サイトの + \l{qtestlib-tools} プロジェクトに含まれています。 + そこには実行したテストの結果からパフォーマンスを比較したり、 + パフォーマンスのWeb用グラフを作成するツールが含まれています。 + + それらのツールの詳細と簡単なグラフの例は + \l{qtestlib-tools Announcement} を参照してください。 + +*/ + + + diff --git a/doc/src/ja_JP/examples/arrowpad.qdoc b/doc/src/ja_JP/examples/arrowpad.qdoc new file mode 100644 index 0000000..2518264 --- /dev/null +++ b/doc/src/ja_JP/examples/arrowpad.qdoc @@ -0,0 +1,248 @@ +/**************************************************************************** +** +** Copyright (C) 2010 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:LGPL$ +** No Commercial Usage +** This file contains pre-release code and may not be distributed. +** You may use this file in accordance with the terms and conditions +** contained in the Technology Preview License Agreement accompanying +** this package. +** +** GNU Lesser General Public License Usage +** Alternatively, this file may be used under the terms of the GNU Lesser +** General Public License version 2.1 as published by the Free Software +** Foundation and appearing in the file LICENSE.LGPL included in the +** packaging of this file. Please review the following information to +** ensure the GNU Lesser General Public License version 2.1 requirements +** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. +** +** In addition, as a special exception, Nokia gives you certain additional +** rights. These rights are described in the Nokia Qt LGPL Exception +** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. +** +** If you have questions regarding the use of this file, please contact +** Nokia at qt-info@nokia.com. +** +** +** +** +** +** +** +** +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/*! + \example linguist/arrowpad + \title サンプル: アローパッド + + この例では、\e {Qt Linguist} の主なコンセプトである"文脈"について、 + 少し詳しく取り上げて説明します。 + また、2つ以上の言語を使用する方法についても説明します。 + + \image linguist-arrowpad_en.png + + アプリケーションで使用可能な言語の数に制限はありませんが、 + ここではフランス語とオランダ語の2言語の翻訳を使用します。 + \c arrowpad.pro の関連する行は以下のとおりです。 + + \snippet examples/linguist/arrowpad/arrowpad.pro 0 + \codeline + \snippet examples/linguist/arrowpad/arrowpad.pro 1 + + \c lupdate を実行すると、2つの類似したメッセージファイル + \c arrowpad_fr.ts と \c arrowpad_nl.ts が作成されます。 + これらのファイルにはすべてのソーステキストとその文脈が含まれます。 + それらのテキストは \c tr() の呼び出しを通じて翻訳対象として + ソースコード内でマークされているものです。 + + Qt アプリケーションの翻訳の詳細については、 + \l{Qt Linguist manual}{Qt Linguist マニュアル} をご覧ください。 + + \section1 各行の簡単な解説 + + \c arrowpad.h では、 QWidget の派生クラスである \c ArrowPad + クラスを定義します。 + 上記のスクリーンショットで + 中央の 4 つのボタンを持つウィジェットが \c ArrowPad です。 + + \snippet examples/linguist/arrowpad/arrowpad.h 0 + \snippet examples/linguist/arrowpad/arrowpad.h 1 + \snippet examples/linguist/arrowpad/arrowpad.h 2 + + \c lupdate を実行するとソーステキストの抽出だけでなく、 + 文脈へのグループ化を行うことができます。 + ソーステキストが表示されるクラスの名前が文脈となります。 + 従って、この例では、"ArrowPad" が + \c ArrowPad クラスの文字列の文脈です。 + \c Q_OBJECT のマクロは、以下の内容で + \c ArrowPad に \c tr(x) を定義します: + + \snippet doc/src/snippets/code/doc_src_examples_arrowpad.qdoc 0 + + 各ソーステキストが表示されるクラスを把握しておくと、 + \e {Qt Linguist} で論理的に関連のある文字列をグループ化することが出来ます。 + 例えば、ダイアログ内のすべての文字列には + ダイアログのクラス名の文脈が含まれるため、同時に表示されます。 + 文字列が表示される文脈によって翻訳の内容が影響を受ける場合があるため、 + 翻訳者にとって有用な情報となります。 + 一部の翻訳では、キーボードショートカットを変更する必要があります。 + また、同じグループにまとめられた特定の文脈(クラス) + にすべてのソーステキストを含めることにより、 + 翻訳者はコンフリクトを起こすことなく、 + より簡単にショートカットを変更できます。 + + \c arrowpad.cpp で、\c ArrowPad クラスを実装します。 + + \snippet examples/linguist/arrowpad/arrowpad.cpp 0 + \snippet examples/linguist/arrowpad/arrowpad.cpp 1 + \snippet examples/linguist/arrowpad/arrowpad.cpp 2 + \snippet examples/linguist/arrowpad/arrowpad.cpp 3 + + ラベルはユーザ表示可能な文字列であるため、 + ボタンのラベルごとに \c ArrowPad::tr() を呼び出します。 + + \image linguist-arrowpad_en.png + + \snippet examples/linguist/arrowpad/mainwindow.h 0 + \snippet examples/linguist/arrowpad/mainwindow.h 1 + + 上記のスクリーンショットでは、ウィンドウ全体が \c MainWindow です。 + これは、\c mainwindow.h ヘッダーファイルで定義します。 + ここでも、\c MainWindow が \e {Qt Linguist} の文脈になるよう、 + \c Q_OBJECT を使用します。 + + \snippet examples/linguist/arrowpad/mainwindow.cpp 0 + + \c MainWindow と \c mainwindow.cpp を実装する際に、 + \c ArrowPad クラスのインスタンスを作成します。 + + \snippet examples/linguist/arrowpad/mainwindow.cpp 1 + + また、\c MainWindow::tr() を、 + アクションおよびショートカット用に、計 2 回呼び出します。 + + \c tr() を使用して、言語によって異なるキーをサポートします。 + 英語の場合、"Ctrl+Q" は Quit (終了) に適していますが、 + オランダ語の翻訳者は "Ctrl+A" (Afsluiten の場合) を、 + ドイツ語の翻訳者は "Strg+E" (Beenden の場合) を使うといいでしょう。 + \key Ctrl キーショートカットを \c tr() で使用する場合は + 引数を 2 つ使用して、 + ショートカットが実行する機能を2番目の引数に記述してください。 + + \c main.cpp で定義した標準的な \c main() 関数は、以下のようになります。 + + \snippet examples/linguist/arrowpad/main.cpp 2 + \snippet examples/linguist/arrowpad/main.cpp 3 + + 現在のロケールに基づいて、使用する翻訳を選択します。 + 例えば、QLocale::system() は、 + \c LANG 環境変数の設定によって影響を受ける場合があります。 + \c .qm メッセージファイル(および TS ファイル)の命名規則に + ロケールを使用すると、 + 簡単にロケールに基づいて翻訳ファイルを選択することが + できるようになります。 + + 選択したロケールに QM メッセージファイルが存在しない場合、 + 元のソーステキストが使用され、エラーは生成されません。 + + \section1 フランス語からオランダ語に翻訳する + + ここでは、サンプルアプリケーションをフランス語に翻訳することから始めます。 + \e {Qt Linguist} を起動し、\c arrowpad_fr.ts の作業を行います。 + 2つの文脈 ("ArrowPad" および "MainWindow") + にグループ化された7つのソーステキスト ("\&Up", "\&Left" 等) + が含まれているはずです。 + + 次に、以下の翻訳を入力します: + + \list + \o \c ArrowPad + \list + \o \&Up - \&Haut + \o \&Left - \&Gauche + \o \&Right - \&Droite + \o \&Down - \&Bas + \endlist + \o \c MainWindow + \list + \o E\&xit - \&Quitter + \o Ctrl+Q - Ctrl+Q + \o \&File - \&Fichier + \endlist + \endlist + + 翻訳の入力が終わったら、 \key{Ctrl+Return} (もしくは\gui {完了にして次へ} + ボタン)を押すと、 + 翻訳が完了とマークされ次のソーステキストに移動するため便利です。 + + ファイルを保存して、オランダ語の翻訳でも同じ手順を実行し、 + \c arrowpad_nl.ts の作業を行います: + + \list + \o \c ArrowPad + \list + \o \&Up - \&Omhoog + \o \&Left - \&Links + \o \&Right - \&Rechts + \o \&Down - Omlaa\&g + \endlist + \o \c MainWindow + \list + \o E\&xit - \&Afsluiten + \o Ctrl+Q - Ctrl+A + \o File - \&Bestand + \endlist + \endlist + + \c tt1_fr.ts と \c tt1_nl.ts の翻訳ソースファイルは + QM ファイルに変換する必要があります。 + 以前と同様の方法で \e {Qt Linguist} を使用して変換できますが、 + コマンドラインツール \c lrelease を使うと + \e {Qt Linguist} から個々の \gui {ファイル|リリース} を読み込まなくても、 + アプリケーションの\e{すべての} QM ァイルを作成できます。 + + 以下を入力します: + + \snippet doc/src/snippets/code/doc_src_examples_arrowpad.qdoc 1 + + これにより、\c arrowpad_fr.qm と \c arrowpad_nl.qm が作成されます。 + \c LANG 環境変数を \c fr に設定します。 + Unix では、以下の2つのコマンドのいずれかが機能します。 + + \snippet doc/src/snippets/code/doc_src_examples_arrowpad.qdoc 2 + + Windows では、\c autoexec.bat を修正するか、以下を実行します。 + + \snippet doc/src/snippets/code/doc_src_examples_arrowpad.qdoc 3 + + プログラムを実行すると、フランス語版が表示されます: + + \image linguist-arrowpad_fr.png + + \c LANG=nl を設定し、オランダ語でも同じ手順を実行します。 + これで、オランダ語版が表示されます: + + \image linguist-arrowpad_nl.png + + \section1 エクササイズ + + \e {Qt Linguist} で未完了の翻訳を行います。 + 例えば、各テキストのチェックマークをクリックして翻訳を未完了の状態にして保存します。 + その後、 \c lupdate 、\c lrelease 、サンプルの順に実行します。 + この変更がどのような影響を及ぼしましたか。 + + \c LANG=fr_CA (フランス語(カナダ))に設定し、 + サンプルプログラムを再実行します。 + \c LANG=fr の場合と同じ結果になる理由を説明してください。 + + オランダ語翻訳のショートカットのいずれかを変更し、 + \e \&Bestand と \e \&Boven の競合を解消します。 +*/ diff --git a/doc/src/ja_JP/examples/hellotr.qdoc b/doc/src/ja_JP/examples/hellotr.qdoc new file mode 100644 index 0000000..cc01b81 --- /dev/null +++ b/doc/src/ja_JP/examples/hellotr.qdoc @@ -0,0 +1,200 @@ +/**************************************************************************** +** +** Copyright (C) 2010 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:LGPL$ +** No Commercial Usage +** This file contains pre-release code and may not be distributed. +** You may use this file in accordance with the terms and conditions +** contained in the Technology Preview License Agreement accompanying +** this package. +** +** GNU Lesser General Public License Usage +** Alternatively, this file may be used under the terms of the GNU Lesser +** General Public License version 2.1 as published by the Free Software +** Foundation and appearing in the file LICENSE.LGPL included in the +** packaging of this file. Please review the following information to +** ensure the GNU Lesser General Public License version 2.1 requirements +** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. +** +** In addition, as a special exception, Nokia gives you certain additional +** rights. These rights are described in the Nokia Qt LGPL Exception +** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. +** +** If you have questions regarding the use of this file, please contact +** Nokia at qt-info@nokia.com. +** +** +** +** +** +** +** +** +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/*! + \example linguist/hellotr + \title サンプル: こんにちは tr() + + これは、小さな Hello World プログラムを日本語に翻訳する例です。 + 以下のスクリーンショットは英語版です。 + + \image linguist-hellotr_en.png + + Qt アプリケーションの翻訳に関する詳細は、\l{Qt Linguist manual} + をご覧ください。 + + \section1 各行の簡単な解説 + + \snippet examples/ja_JP/linguist/hellotr/main.cpp 0 + + この行では、 QTranslator クラスの宣言を読み込みます。 + QTranslator クラスのオブジェクトは、 + ユーザに表示する文字列を翻訳します。 + + \snippet examples/ja_JP/linguist/hellotr/main.cpp 5 + + 親をもたない QTranslator オブジェクトを作成します。 + + \snippet examples/ja_JP/linguist/hellotr/main.cpp 6 + + プログラムで使用するソーステキストの日本語の翻訳を含む、 + \c hellotr_ja.qm ( \c .qm というファイル拡張子は省略します) + と呼ばれるファイルを読み込みます。 + ファイルが見つからなくてもエラーは発生しません。 + + \snippet examples/ja_JP/linguist/hellotr/main.cpp 7 + + \c hellotr_ja.qm の翻訳を、プログラムで使用する翻訳プールに追加します。 + + \snippet examples/ja_JP/linguist/hellotr/main.cpp 8 + + "Hello world!" を表示するプッシュボタンを作成します。 + 検索した \c hellotr_ja.qm に "Hello world!" の翻訳が含まれている場合、 + その翻訳が表示されます。 + 含まれていない場合、翻訳前のテキストがそのまま表示されます。 + + QObject を継承するすべてのクラスには、\c tr() 関数が含まれます。 + QObject クラスのメンバ関数内では、\c QPushButton::tr("Hello world!") + や \c QObject::tr("Hello world!") の代わりに、シンプルに + \c tr("Hello world!") を使います。 + + \section1 英語版のアプリケーションを実行する + + 翻訳ファイル \c hellotr_ja.qm の作成が終わっていないため、 + 以下のアプリケーションを起動したときに元の文字列が表示されます。 + + \image linguist-hellotr_en.png + + \section1 日本語のメッセージファイルを作成する + + 最初のステップは、プロジェクトのすべてのソースファイルを列挙する + \c hellotr.pro を作成することです。 + プロジェクトファイルは、qmake プロジェクトファイルまたは、通常の + makefile である可能性があります。 + 以下の記述を含むプロジェクトファイルを作成してください。 + + \snippet examples/ja_JP/linguist/hellotr/hellotr.pro 0 + \snippet examples/ja_JP/linguist/hellotr/hellotr.pro 1 + + \c TRANSLATIONS は、管理するメッセージファイルを指します。 + この例では、日本語の翻訳のみ管理します。 + + ファイル拡張子は、\c .qm ではなく、\c .ts であることにご注意ください。 + \c .ts は翻訳のソースファイルのフォーマットであり、 + アプリケーションの開発時に使用します。 + プログラマーまたはリリースマネージャーは \c lupdate プログラムを実行し、 + ソースコードから抽出したソーステキストを使用して + TS ファイルの生成と更新を行います。 + 翻訳者は、 \e {Qt Linguist} を使用して TS ファイルの読み取りと更新を行い、 + 翻訳の追加と編集を行います。 + + TS の形式は、ユーザが直接閲覧可能な XML 形式であるため、 + 直接Eメールで送信したり、簡単にバージョン管理の対象にすることが出来ます。 + このファイルを手動で編集する場合、XML の既定のエンコードは UTF-8 で、 + Latin1(ISO 8859-1)ではないことに気をつけてください。 + '\oslash'(ノルウェー語の o にスラッシュが付いたもの)などの + Latin1 文字を入力する1つの方法は、XML エンティティ "ø" + を使用することです。 + これはすべての Unicode 4.0 文字に対して有効です。 + + 翻訳が完了したら、\c lrelease プログラムを使用して、 + TS ファイルを QM ファイル(Qt Message ファイル)形式に変換します。 + QM 形式は、極めて高速な検索性能を実現するようにデザインされた + コンパクトなライブラリ形式です。 + \c lupdate と \c lrelease はどちらも、 + プロジェクト全体のソースファイルとヘッダーファイル + (プロジェクトファイルの HEADERS および SOURCES 行で指定されている) + を読み取り、\c tr() 関数呼び出しの際に表示される文字列を抽出します。 + + \c lupdate は、メッセージファイル(この場合は \c hellotr_ja.ts) + の作成と更新を行い、これらをソースコードと同期させるために使用します。 + \c lupdate にはデータの削除機能がないため、 + \c lupdate はいつでも安全に実行できます。 + 例えば、ソースが変更されるたびに TS ファイルが更新されるよう、 + makefile に記述できます。 + + それでは、以下のように \c lupdate を実行してみましょう: + + \snippet doc/src/ja_JP/snippets/code/doc_src_examples_hellotr.qdoc 0 + + (\c -verbose オプションは、操作を説明するメッセージを表示するよう + \c lupdate に指示します。) + 現在のディレクトリに、以下の内容で + \c hellotr_ja.ts ファイルが作成されていると思います: + + \snippet doc/src/ja_JP/snippets/code/doc_src_examples_hellotr.qdoc 1 + + ツール (\c lupdate、 \e {Qt Linguist}、\c lrelease) + を使用して読み取りと更新を行うため、 + ファイル形式を理解する必要はありません。 + + \section1 Qt Linguist を使用して日本語に翻訳する + + XML やテキストエディタを使用して、TS ファイルを翻訳することも出来ますが、 + ここでは \e {Qt Linguist} を使用して翻訳を行います。 + + \e {Qt Linguist} を起動するには、以下を入力します。 + + \snippet doc/src/ja_JP/snippets/code/doc_src_examples_hellotr.qdoc 2 + + 左上のペインに "QPushButton" が表示されるはずです。 + これをダブルクリックし、次に "Hello world!" をクリックして、 + \gui Translation ペイン (ウィンドウ右中央)に + "こんにちは、世界!" と入力します。 + 感嘆符(!)を忘れないように付けてください! + + \gui{完了} チェックボックスをオンにして、 + メニューバーから \gui{ファイル|保存} を選択します。 + TS ファイルから、以下の記述がなくなります。 + + \snippet doc/src/ja_JP/snippets/code/doc_src_examples_hellotr.qdoc 3 + + その代わりに以下が含まれます。 + + \snippet doc/src/ja_JP/snippets/code/doc_src_examples_hellotr.qdoc 4 + + \section1 日本語版のアプリケーションを実行する + + 日本語版のアプリケーションを実行する前に、 + TS ファイルから QM ファイルを生成する必要があります。 + QM ファイルは、\e {Qt Linguist}(単一の TS ファイルの場合)のメニューから、 + もしくは、コマンドラインプログラム \c lrelease を使用して生成できます。 + \c lrelease を使用する場合、 + プロジェクトファイルに列挙されている TS ファイルごとに + 1 つの QM ファイルを作成することが出来ます。 + \e {Qt Linguist} のメニューバーから \gui{ファイル|リリース} を選択し、 + ポップアップ表示される \gui{ファイルの保存} ダイアログで\gui{保存}を選択し、 + \c hellotr_ja.ts から \c hellotr_ja.qm を生成します。 + 今すぐ \c hellotr プログラムを再実行してみましょう。 + これで、ボタンに "こんにちは、世界!" と表示されます。 + + \image linguist-hellotr_ja.png +*/ diff --git a/doc/src/ja_JP/examples/trollprint.qdoc b/doc/src/ja_JP/examples/trollprint.qdoc new file mode 100644 index 0000000..1686774 --- /dev/null +++ b/doc/src/ja_JP/examples/trollprint.qdoc @@ -0,0 +1,286 @@ +/**************************************************************************** +** +** Copyright (C) 2010 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:LGPL$ +** No Commercial Usage +** This file contains pre-release code and may not be distributed. +** You may use this file in accordance with the terms and conditions +** contained in the Technology Preview License Agreement accompanying +** this package. +** +** GNU Lesser General Public License Usage +** Alternatively, this file may be used under the terms of the GNU Lesser +** General Public License version 2.1 as published by the Free Software +** Foundation and appearing in the file LICENSE.LGPL included in the +** packaging of this file. Please review the following information to +** ensure the GNU Lesser General Public License version 2.1 requirements +** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. +** +** In addition, as a special exception, Nokia gives you certain additional +** rights. These rights are described in the Nokia Qt LGPL Exception +** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. +** +** If you have questions regarding the use of this file, please contact +** Nokia at qt-info@nokia.com. +** +** +** +** +** +** +** +** +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/*! + \example linguist/trollprint + \title サンプル: トロールプリント + + トロールプリント(Troll Print)は、 + ユーザがプリンタの設定をするためのサンプルアプリケーションです。 + これには、英語とポルトガル語の2つのバージョンが用意されています。 + + \image linguist-trollprint_10_en.png + + この例では、いくつかのポルトガル語の翻訳を含む翻訳ファイル + \c trollprint_pt.ts を用意しました。 + + 同じアプリケーションの2つのバージョン、 + Troll Print 1.0 と 1.1 をリリースすることを想定します。 + 1つのバージョンで作成した翻訳を次のリリースで再利用する方法を習得します。 + (このチュートリアルでは、いくつかのソースファイルの編集が必要です。 + 新しい一時ディレクトリにすべてのファイルをコピーして、 + ここで作業を行うのがベストでしょう。) + + Qtアプリケーションの翻訳の詳細については、 + \l{Qt Linguist manual}{Qt Linguist マニュアル} をご覧ください。 + + \section1 各行の簡単な解説 + + \c PrintPanel クラスを \c printpanel.h で宣言します。 + + \snippet examples/linguist/trollprint/printpanel.h 0 + + \c PrintPanel は QWidget の派生クラスです。 + \c tr() が正しく動作するには、\c Q_OBJECT マクロが必要です。 + + 実装ファイルは \c printpanel.cpp です。 + + \snippet examples/linguist/trollprint/printpanel.cpp 0 + + Troll Print 1.0 で一部のコードがコメントアウトされています。 + Troll Print 1.1 にバージョンアップする際に、 + コメントから戻してください。 + + \snippet examples/linguist/trollprint/printpanel.cpp 1 + \snippet examples/linguist/trollprint/printpanel.cpp 2 + + PrintPanel では、\c tr("Enabled") と \c tr("Disabled") + を2回ずつ使用することに注意してください。 + "Enabled" と "Disabled" はどちらも同じ文脈で表示されるため、 + \e {Qt Linguist} では、それぞれ1回目の使用に対してのみ表示され、 + 2回目以降の使用に対しては翻訳が流用されるため表示されません。 + これは便利な時間短縮ツールですが、ポルトガル語などの一部の言語では、 + 2回目の使用に対して異なる翻訳が必要になります。 + これから、\e {Qt Linguist}で、 + すべての \c tr() に対して異なる翻訳を表示できるように設定する方法を学習します。 + + \c MainWindow, \c mainwindow.h はシンプルなヘッダーファイルです。 + \c mainwindow.cpp の実装には、翻訳対象としてマークする必要のある + ユーザに表示するソーステキストがあります。 + + \snippet examples/linguist/trollprint/mainwindow.cpp 0 + + ウィンドウのタイトルは翻訳する必要があります。 + + \snippet examples/linguist/trollprint/mainwindow.cpp 1 + \snippet examples/linguist/trollprint/mainwindow.cpp 3 + + また、アクションとメニューも翻訳する必要があります。 + キーボードショートカット "Ctrl+Q" に対して使用している \c tr() + の第 2 引数は、このショートカットがどのような機能を有しているかを + 翻訳者に示す唯一の情報であることに注意してください。 + + \snippet examples/linguist/trollprint/main.cpp 0 + + \c main.cpp の \c main() 関数は、 + \l{linguist/arrowpad}{アローパッド} の例の場合と同じになります。 + 具体的には、現在のロケールに基づいて、翻訳ファイルを選択します。 + + \section1 英語とポルトガル語で Troll Print 1.0 を実行する + + 既存の \c trollprint_pt.ts ファイルの翻訳を使用します。 + + \c LANG 環境変数を \c pt に設定して、\c trollprint を実行します。 + QM ファイルがないため、スクリーンショットは英語版のままです。 + ここで、\c lrelease (例: \c {lrelease trollprint.pro})を実行し、 + サンプルを再実行します。 + これで、ポルトガル語版(Troll Imprimir 1.0)になりました: + + \image linguist-trollprint_10_pt_bad.png + + 翻訳は正しく表示されていますが、誤りがあります。 + 文法的に正しいポルトガル語では、 + "Enabled" が2回目に使用されるときの正しい翻訳は、 + "Ativado" ではなく "Ativadas" であり、 + "Disabled" が2回目に翻訳されるときも、 + 語尾を同様に変化させる必要があります。 + + \e {Qt Linguist} で \c trollprint_pt.ts を開くと、 + ソースコードには "Enabled" と "Disabled" が2回ずつ使われていますが、 + 翻訳ソースファイルでは1回ずつしか使われていません。 + これは、\e {Qt Linguist} では、 + ソーステキストが重複する場合は翻訳を流用することにより、 + 翻訳者の作業を最小限に抑えようとするためです。 + このように類似した翻訳に誤りがある場合、 + プログラマは繰り返し使用する際に翻訳の曖昧さを排除する必要があります。 + これは、2個の引数を取る\c tr() を使用することにより、 + 容易に実行できます。 + + 実際には、翻訳者の"文脈"は変更する必要のある文字列が表示されるクラスに対するクラス名であるため、 + どのファイルを変更すべきか簡単に特定できます。 + この場合、ファイルは \c printpanel.cpp であり、 + 変更すべき行は4行あります。 + ラジオボタンの最初のペアの \c tr() 呼び出しに、2つ目の引数 "two-sided"(両面) をに追加します: + + \snippet doc/src/snippets/code/doc_src_examples_trollprint.qdoc 0 + + そして、ラジオボタンの2番目のペアの \c tr() 呼び出しに、 + 2つ目の引数 "colors"(色) を追加します。 + + \snippet doc/src/snippets/code/doc_src_examples_trollprint.qdoc 1 + + ここで、\c lupdate を実行し、\e {Qt Linguist} で + \c trollprint_pt.ts を開きます。2 つの変更個所がわかるはずです。 + + まず、翻訳ソースファイルには、\e{3組}の "Enabled" と + "Disabled" のペアが含まれています。 + 最初のペアは、既に利用されていないテキストであることを意味する灰色になっています。 + これは、 \c tr() 内の文字列が第二引数を追加した新たな + \c tr() の文字列で置き換えられたからです。 + 2番目のペアには、"two-sided"(両面) というコメントが含まれており、 + 3番目のペアには、"colors"(色) というコメントが含まれています。 + これらのコメントは、\e {Qt Linguist} に + \gui {開発者のコメント} として表示されます。 + + 次に、翻訳者の作業を最小限に抑えるために、 + 新たに使用される "Enabled" と "Disabled" の文字列に対して、 + 訳語 "Ativado" と "Desativado" が自動的に使用されます。 + これらの訳語は、これらの原語が2回目に使用される場合の正しい翻訳ではありません。 + ここからが、チュートリアルの出発点です。 + + 2番目の "Ativado" を "Ativadas" に、 + 2番目の "Desativado" を "Desativadas" に変更し、保存して終了します。 + \c lrelease を実行して最新のバイナリ \c trollprint_pt.qm ファイルを作成し、 + Troll Print (または Troll Imprimir) を実行します。 + + \image linguist-trollprint_10_pt_good.png + + \e {Qt Linguist} では "comments" と呼ばれる + \c tr() 呼び出しの2つ目の引数は、 + 同じ文脈(クラス)で発生する類似したソーステキストを識別します。 + コメントは、たとえば Ctrl キーによるキーボードショートカットが + ショートカットによって実行される機能を伝達する唯一の手段である場合等に、 + 翻訳者に情報を提供するのに便利です。 + + 翻訳者に情報を提供する他の手段は、 + 翻訳の必要があるソーステキストを含むアプリケーションの + 特定の部分への移動方法に関する情報を提供することです。 + これにより、翻訳者は、翻訳が表示される文脈を確認し、 + 翻訳を検索してテストを行うことができます。 + これは、ソースコードで \c TRANSLATOR + コメントを使用して行います: + + \snippet doc/src/snippets/code/doc_src_examples_trollprint.qdoc 2 + + 一部のソースファイル、特にダイアログクラスのコメントに + ダイアログに到達するまでに必要な操作を記述します。 + また、\c mainwindow.cpp や \c printpanel.cpp など、 + 適切なサンプルファイルにこれらを追加することもできます。 + \c lupdate を実行して \e {Qt Linguist} を起動し、 + \c trollprint_pt.ts を読み込みます。 + ソーステキストの一覧を参照する際に、 + \gui{ソーステキスト}と\gui{開発者のコメント} + の領域に表示されるコメントを確認できます。 + + 特に大きなプログラムでは、翻訳者が自分の翻訳を探し、 + それが適切かどうかを確認することが困難な場合があります。 + コメントは役立つナビゲーション情報を提供するため、 + 翻訳に要する時間を節約できます: + + \snippet doc/src/snippets/code/doc_src_examples_trollprint.qdoc 3 + + \section1 Troll Print 1.1 + + これから、Troll Print のバージョン 1.1 のリリースの準備を行います。 + テキストエディターを起動して、次の手順に従って変更を行ってください: + + \list + \o \c printpanel.cpp の文字列 "\<b\>TROLL PRINT\</b\>" を引数に + QLabel を作成する2つの行のコメントを解除します。 + \o ソースの変更: \c printpanel.cpp で、"2-sided" を + "Two-sided" に置き換えます。 + \o \c mainwindow.cpp で、すべての "1.0" を "1.1" に置き換えます。 + \o \c mainwindow.cpp で、著作権表示の年号を 1999-2000 に更新します。 + \endlist + + (実際のアプリケーションでは、バージョン番号と著作権表示の年号は + const または #define をつかって定義するでしょう。) + + 終了したら、\c lupdate を実行し、\e {Qt Linguist} で + \c trollprint_pt.ts を開きます。以下の項目は、特別なコンテンツです: + + \list + \o \c MainWindow + \list + \o Troll Print 1.0 - 古いテキストとして灰色でマーク + \o About Troll Print 1.0 - 古いテキストとして灰色でマーク + \o Troll Print 1.0. Copyright 1999 Software, Inc. - + 古いテキストとして灰色でマーク + \o Troll Print 1.1 - 自動的に "Troll Imprimir 1.1" に翻訳(未完了) + \o About Troll Print 1.1 - 自動的に "Troll Imprimir 1.1" に翻訳(未完了) + \o Troll Print 1.1. Copyright 1999-2000 Software, + Inc. - 自動的に "Troll Imprimir 1.1. + Copyright 1999-2000 Software, Inc." に翻訳(未完了) + \endlist + \o \c PrintPanel + \list + \o 2-sided - 古いテキストとして灰色でマーク + \o \<b\>TROLL PRINT\</b\> - 未翻訳のテキストとして"?"マーク + \o Two-sided - 未翻訳のテキストとして"?"マーク + \endlist + \endlist + + \c lupdate は、修正を容易に行い、数字の処理を効率的に行うために、 + 様々な処理を行っています。 + + \c MainWindow の翻訳の見直しを行います。 + "\<b\>TROLL PRINT\</b\>" を "\<b\>TROLL IMPRIMIR\</b\>" と翻訳します。 + "Two-sided" を翻訳する際には、\gui{フレーズと推測} の欄から + "2-lados" をダブルクリックして訳に選択した後に、 + "2" を "Dois" に変更します。 + + 保存して終了し、\c lrelease を実行します。 + ポルトガル語版の表示は以下のようになります: + + \image linguist-trollprint_11_pt.png + + \gui{Ajuda|Sobre} (\gui{Help|About}) を選択し、 + バージョン情報ボックスを確認します。 + + \gui{Ajuda|Sobre Qt} (\gui{Help|About Qt}) を選択した場合、 + 英語版のダイアログが表示されます。 + Qt の翻訳はまだ終わっていません。 + 詳細については、\l{Internationalization with Qt} を参照してください。 + + ここで、\c LANG=en を設定し、元の英語版を実行してみてください: + + \image linguist-trollprint_11_en.png +*/ diff --git a/doc/src/ja_JP/getting-started/tutorials.qdoc b/doc/src/ja_JP/getting-started/tutorials.qdoc new file mode 100644 index 0000000..701ba88 --- /dev/null +++ b/doc/src/ja_JP/getting-started/tutorials.qdoc @@ -0,0 +1,101 @@ +/**************************************************************************** +** +** Copyright (C) 2010 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:LGPL$ +** No Commercial Usage +** This file contains pre-release code and may not be distributed. +** You may use this file in accordance with the terms and conditions +** contained in the Technology Preview License Agreement accompanying +** this package. +** +** GNU Lesser General Public License Usage +** Alternatively, this file may be used under the terms of the GNU Lesser +** General Public License version 2.1 as published by the Free Software +** Foundation and appearing in the file LICENSE.LGPL included in the +** packaging of this file. Please review the following information to +** ensure the GNU Lesser General Public License version 2.1 requirements +** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. +** +** In addition, as a special exception, Nokia gives you certain additional +** rights. These rights are described in the Nokia Qt LGPL Exception +** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. +** +** If you have questions regarding the use of this file, please contact +** Nokia at qt-info@nokia.com. +** +** +** +** +** +** +** +** +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/*! + \page tutorials.html + \title チュートリアル + + \contentspage How to Learn Qt + \nextpage Qt Examples + + \brief Qt の学習を助けるチュートリアルやガイドの概要 + + \nextpage Qt Examples + + Qt で提供されているこれらのチュートリアルやガイドは + 新たに Qt の開発を始めるユーザの良い助けとなります。 + これらのドキュメントでは ウィジェットの基本的な使い方から始まり + ステップバイステップでアプリケーションの使い方を学ぶことが出来ます。 + + \table + \row + \o{2,1} \l{ウィジェットのチュートリアル}{\bold ウィジェット} + \o{2,1} \l{チュートリアル: アドレス帳}{\bold {アドレス帳}} + \row + \o \image widget-examples.png Widgets + \o + ウィジェットとレイアウトを使って GUI アプリケーションを作成する + 初心者向けのガイドです。 + + \o \image addressbook-tutorial.png AddressBook + \o + 完全な機能を持つアドレス帳アプリケーションを作成する 7 章で構成されたガイドです。 + + \row + \o{2,1} \l{Qt Designer クイックガイド}{\bold{Qt Designer}} + \o{2,1} \l{Qt Linguist Manual: Programmers#Tutorials}{\bold {Qt Linguist}} + \row + \o \image designer-examples.png QtDesigner + \o + \QD を使ってフォームを生成する基本的な手順を説明するクイックガイドです。 + + \o \image linguist-examples.png QtLinguist + \o + \l{サンプル: こんにちは tr()}{こんにちは tr()}、 + \l{サンプル: アローパッド}{アローパッド}、 + \l{サンプル: トロールプリント}{トロールプリント} + の三例を通じて翻訳の方法を説明します。 + + \row + \o{2,1} \l{QTestLib チュートリアル}{\bold QTestLib} + \o{2,1} \l{qmake チュートリアル}{\bold qmake} + \row + \o{2,1} + Qt のユニットテストフレームワークである QTestLib の機能の初歩的な使い方を説明するチュートリアルです。 + このチュートリアルは4章で構成されています。 + + \o{2,1} + \c qmake の使い方を説明するチュートリアルです。 + このチュートリアルを卒業した後は \l{qmake Manual}{qmake user guide}(英語) + を読むことをお勧めします。 + + \endtable +*/ diff --git a/doc/src/ja_JP/images/linguist-hellotr_en.png b/doc/src/ja_JP/images/linguist-hellotr_en.png Binary files differnew file mode 100644 index 0000000..05aa945 --- /dev/null +++ b/doc/src/ja_JP/images/linguist-hellotr_en.png diff --git a/doc/src/ja_JP/images/linguist-hellotr_ja.png b/doc/src/ja_JP/images/linguist-hellotr_ja.png Binary files differnew file mode 100644 index 0000000..d9beb01 --- /dev/null +++ b/doc/src/ja_JP/images/linguist-hellotr_ja.png diff --git a/doc/src/ja_JP/snippets/code/doc_src_examples_hellotr.qdoc b/doc/src/ja_JP/snippets/code/doc_src_examples_hellotr.qdoc new file mode 100644 index 0000000..e05cd12 --- /dev/null +++ b/doc/src/ja_JP/snippets/code/doc_src_examples_hellotr.qdoc @@ -0,0 +1,72 @@ +/**************************************************************************** +** +** Copyright (C) 2010 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:LGPL$ +** No Commercial Usage +** This file contains pre-release code and may not be distributed. +** You may use this file in accordance with the terms and conditions +** contained in the Technology Preview License Agreement accompanying +** this package. +** +** GNU Lesser General Public License Usage +** Alternatively, this file may be used under the terms of the GNU Lesser +** General Public License version 2.1 as published by the Free Software +** Foundation and appearing in the file LICENSE.LGPL included in the +** packaging of this file. Please review the following information to +** ensure the GNU Lesser General Public License version 2.1 requirements +** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. +** +** In addition, as a special exception, Nokia gives you certain additional +** rights. These rights are described in the Nokia Qt LGPL Exception +** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. +** +** If you have questions regarding the use of this file, please contact +** Nokia at qt-info@nokia.com. +** +** +** +** +** +** +** +** +** $QT_END_LICENSE$ +** +****************************************************************************/ + +//! [0] +lupdate -verbose hellotr.pro +//! [0] + + +//! [1] +<!DOCTYPE TS><TS> +<context> + <name>QPushButton</name> + <message> + <source>Hello world!</source> + <translation type="unfinished"></translation> + </message> +</context> +</TS> +//! [1] + + +//! [2] +linguist hellotr_ja.ts +//! [2] + + +//! [3] +<translation type='unfinished'></translation> +//! [3] + + +//! [4] +<translation>こんにちは、世界!</translation> +//! [4] diff --git a/doc/src/ja_JP/tutorials/addressbook.qdoc b/doc/src/ja_JP/tutorials/addressbook.qdoc new file mode 100644 index 0000000..9fb1059 --- /dev/null +++ b/doc/src/ja_JP/tutorials/addressbook.qdoc @@ -0,0 +1,1070 @@ +/**************************************************************************** +** +** Copyright (C) 2010 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:LGPL$ +** No Commercial Usage +** This file contains pre-release code and may not be distributed. +** You may use this file in accordance with the terms and conditions +** contained in the Technology Preview License Agreement accompanying +** this package. +** +** GNU Lesser General Public License Usage +** Alternatively, this file may be used under the terms of the GNU Lesser +** General Public License version 2.1 as published by the Free Software +** Foundation and appearing in the file LICENSE.LGPL included in the +** packaging of this file. Please review the following information to +** ensure the GNU Lesser General Public License version 2.1 requirements +** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. +** +** In addition, as a special exception, Nokia gives you certain additional +** rights. These rights are described in the Nokia Qt LGPL Exception +** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. +** +** If you have questions regarding the use of this file, please contact +** Nokia at qt-info@nokia.com. +** +** +** +** +** +** +** +** +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/*! + \page tutorials-addressbook.html + + \title チュートリアル: アドレス帳 + \brief シンプルだが、完全な機能を持つアプリケーションの作成を通じた + GUI プログラミングへの導入。 + + このチュートリアルでは、Qt クロスプラットフォームフレームワークを使用した + GUI プログラミングの概要について説明しています。 + + \image addressbook-tutorial-screenshot.png + + \omit + It doesn't cover everything; the emphasis is on teaching the programming + philosophy of GUI programming, and Qt's features are introduced as needed. + Some commonly used features are never used in this tutorial. + \endomit + + このチュートリアルでは以下に示す Qt の基本的な機能を学ぶことが出来ます: + + \list + \o ウィジェットとレイアウトマネージャ + \o コンテナクラス + \o シグナル/スロット + \o 入力デバイスと出力デバイス + \endlist + + Qt を初めて利用する方は、最初に \l{How to Learn Qt} をご覧ください。 + + チュートリアルの目次: + + \list 1 + \o \l{tutorials/addressbook/part1}{ユーザインターフェースの設計} + \o \l{tutorials/addressbook/part2}{アドレスの追加} + \o \l{tutorials/addressbook/part3}{項目間のナビゲーション} + \o \l{tutorials/addressbook/part4}{アドレスの編集と削除} + \o \l{tutorials/addressbook/part5}{検索機能の追加} + \o \l{tutorials/addressbook/part6}{読み込みと保存} + \o \l{tutorials/addressbook/part7}{その他の機能} + \endlist + + このチュートリアルのソースコードは、Qt の + \c examples/tutorials/addressbook ディレクトリに置かれています。 + + この小さなアプリケーションは本格的な最新の GUI + アプリケーションのようには見えませんが、 + 複雑なアプリケーションで使用される多くの基本的な技術が採用されています。 + このチュートリアルが終わったら、 + メニューやツールバー、ステータスバーなどを表示する + 小さな GUI アプリケーションである + \l{mainwindows/application}{Application} + のサンプルをチェックすることをお勧めします。 + +*/ + +/*! + \page tutorials-addressbook-part1.html + + \example tutorials/addressbook/part1 + \title 第1章 - ユーザインターフェースのデザイン + + 本チュートリアルの第1章では + アドレス帳アプリケーションで使用する基本的なインターフェース + (GUI) の設計について説明します。 + + GUI プログラム作成の最初のステップは、 + ユーザインターフェースを設計することです。 + 本章の目標は、基本的なアドレス帳アプリケーションを実装するのに必要な + ラベルと入力フィールドを設定することです。 + 下図は、ここで作成しようとしているアドレス帳のスクリーンショットです。 + + \image addressbook-tutorial-part1-screenshot.png + + ユーザがアドレス帳に名前や住所を入力できるようにするには、 + 2つの QLabel のオブジェクトである \c nameLabel 及び \c addressLabel と、 + 入力フィールドとして QLineEdit オブジェクトの \c nameLine と + QTextEdit オブジェクトの \c addressText が必要です。 + 使用するウィジェットとその配置は下図に示してあります。 + + \image addressbook-tutorial-part1-labeled-screenshot.png + + 以下の3つのファイルを使用してこのアドレス帳を実装します: + + \list + \o \c{addressbook.h} - \c AddressBook クラスを宣言するファイル、 + \o \c{addressbook.cpp} - \c AddressBook クラスを実装するファイル、 + \o \c{main.cpp} - \c AddressBook クラスのインスタンスを持つ + \c main() 関数を含むファイル。 + \endlist + + \section1 Qt プログラミング - 派生クラスの作成 + + Qt プログラムを作成する際は、 + 通常 Qt オブジェクトの派生クラスを作成して機能を追加します。 + これは、カスタムウィジットや標準的なウィジェットの集合体を作成する場合の + 重要なコンセプトの1つです。 + ウィジェットの挙動の拡張や変更のために派生クラスを作成することには + 以下のような利点があります: + + \list + \o 仮想関数または純粋仮想関数の実装を行って要求される機能を実装できます。 + 必要によっては基底クラスの実装にフォールバックして利用できます。 + + \o これにより、アプリケーションのその他の部分が + ユーザインターフェースの個々のウィジェットを指定する必要がないよう、 + ユーザインターフェースの一部をクラス内にカプセル化できます。 + + \o 派生クラスは、同一のアプリケーションまたはライブラリに + 複数のカスタムウィジットを作成するために使用できます。 + また、派生クラスのコードは、他のプロジェクトで再利用可能です。 + + \endlist + + Qt ではアドレス帳ウィジェットを提供していないため、 + 標準的な Qt ウィジェットクラスを継承して機能を追加します。 + 本チュートリアルで作成する \c AddressBook クラスは、 + 基本的なアドレス帳ウィジェットが必要な場合に再利用できます。 + + \section1 AddressBook クラスの宣言 + + \l{tutorials/addressbook/part1/addressbook.h}{\c addressbook.h} + ファイルは、 \c AddressBook クラスを宣言するために使用します。 + + ここでは \c AddressBook を QWidget の派生クラスとし、 + コンストラクタを宣言することから始めます。 + また、 Q_OBJECT マクロを使用して、クラスで多言語化機能及び、 + Qt のシグナル/スロット機能が使われていることを示します。 + ただし、現段階ではこれらの機能の全てを使わない場合もあります。 + + \snippet tutorials/addressbook/part1/addressbook.h class definition + + クラスは、 前述した QLineEdit と QTextEdit のプライベートなインスタンス + \c nameLine と \c addressText の宣言を保有します。 + 後述の章で、 \c nameLine 及び \c addressText に保存したデータが、 + 多くのアドレス帳の機能で必要になることがわかるでしょう。 + + 我々が使用する QLabel オブジェクトは、 + 一旦作成すると後で参照する必要がないため、宣言する必要はありません。 + Qt でオブジェクトの所有権を追跡する方法については、次節で説明します。 + + Q_OBJECT マクロ自体は、Qt のより高度な機能を実装します。 + ここでは、 Q_OBJECT マクロを、 \l{QObject::}{tr()} 及び + \l{QObject::}{connect()} 関数を使用可能にする + ショートカットとみなしたほうが良いでしょう。 + + これで、 \c addressbook.h ファイルが完成しました。 + 次は対応する \c addressbook.cpp ファイルの実装を行います。 + + \section1 AddressBook クラスの実装 + + \c AddressBook のコンストラクタは、 \a{parent} パラメータとして + QWidget を受け取ります。 + 慣例により、このパラメータを基底クラスのコンストラクタに渡します。 + 親が複数の子を所有できるというこの所有概念は、 + Qt でウィジェットのグループ化を行う場合に有用です。 + 例えば、親を削除すると、親に属する子も全て削除されます。 + + \snippet tutorials/addressbook/part1/addressbook.cpp constructor and input fields + + このコンストラクタ内で、 \c nameLine と \c addressText のインスタンスを生成し、 + 2つのローカル QLabel オブジェクトの \c nameLabel と \c addressLabel + を宣言し、そのインスタンスを生成します。 + \l{QObject::tr()}{tr()} 関数は、 + 翻訳した文字列が存在する場合にそれを返します。 + そうでない場合は、引数の文字列自体を返します。 + この関数は文字列が他の言語に翻訳されるようにマークする役目を持ちます。 + 翻訳可能な文字列を使用するたびに、マークしてください。 + + Qt を使用してプログラミングを行う場合、 + レイアウトが機能する仕組みを理解していると便利です。 + Qt は主に、以下の3つのレイアウトクラスを提供します。 + ウィジェットの配置を処理するための QHBoxLayout 、 QVBoxLayout 及び + QGridLayout です。 + + \image addressbook-tutorial-part1-labeled-layout.png + + ここでは、 QGridLayout を使って、 + ラベルと入力フィールドを配置します。 + QGridLayout は、有効なスペースを格子状に分割し、 + 行/列番号により指定するセルに、ウィジェットを配置します。 + 上図は、レイアウトセルとウィジェットの位置を示しており、 + 以下のコードを使用して、この配置を指定します: + + \snippet tutorials/addressbook/part1/addressbook.cpp layout + + \c addressLabel は、追加引数として Qt::AlignTop を用いて配置されていることに注意してください。 + これは、セル(1,0) で縦方向の中央に配置されないようにするためです。 + Qt のレイアウトにおける基本概念については、 + \l{Layout Management} のドキュメントをご覧ください。 + + ウィジェットにレイアウトオブジェクトをインストールするには、 + ウィジェットの \l{QWidget::setLayout()}{setLayout()} + 関数を呼び出す必要があります。 + + \snippet tutorials/addressbook/part1/addressbook.cpp setting the layout + + 最後に、ウィジェットのタイトルを "Simple Address Book" とします。 + + \section1 アプリケーションを実行する + + 別のファイル \c main.cpp に、 \c main() 関数に実装します。 + この関数内で、QApplication である \c app のインスタンスを生成します。 + QApplication は、既定のフォントやカーソルなど + アプリケーションに共通な複数のリソース及び、 + イベントループの実行に関与しています。 + 従って、Qt を使用する全ての GUI アプリケーションでは、 + 必ず QApplication が存在します。 + + \snippet tutorials/addressbook/part1/main.cpp main function + + スタックに新しい \c AddressBook ウィジェットを生成し、 + \l{QWidget::show()}{show()} 関数を呼び出して表示します。 + ただし、ウィジェットはアプリケーションのイベントループが + 開始されるまで表示されません。 + アプリケーションの \l{QApplication::}{exec()} 関数を呼び出して、 + イベントループを開始します。 + この関数により返された結果は、 \c main() 関数の戻り値として使用されます。 + この時点で、スタックで \c AddressBook + をインスタンス化した理由が明らかになります。 + イベントループが終了すると \c main() 関数のスコープの外に移動します。 + それに伴って \c AddressBook 及び、 + これに属する全ての子ウィジェットが削除されるため、 + メモリリークを防ぐことができます。 +*/ + +/*! + \page tutorials-addressbook-part2.html + + \example tutorials/addressbook/part2 + \title 第2章 - アドレスの追加 + + 基本的なアドレス帳アプリケーションを作成するための次の手順は、 + ユーザからの操作を可能にすることです。 + + \image addressbook-tutorial-part2-add-contact.png + + 新しい連絡先を追加するために、 + ユーザがクリックするプッシュボタンを作成します。 + また、これらの連絡先を整理して保存するために、 + 何らかのデータ構造が必要になります。 + + \section1 AddressBook クラスの宣言 + + ラベルと入力フィールドの設定が完了しているため、 + 連絡先を追加する際に必要なプッシュボタンを追加します。 + \c addressbook.h ファイルに、 + 3つの QPushButton オブジェクトを宣言し、 + 対応する3つの public slot を作成します。 + + \snippet tutorials/addressbook/part2/addressbook.h slots + + スロットとは特定のシグナルに応答して呼び出される関数をいいます。 + このコンセプトについては、 \c AddressBook + クラスを実装する際にさらに詳細に取り上げます。 + なお、Qt のシグナル/スロットのコンセプトの概要については、 + \l{Signals and Slots} のドキュメントを参照してください。 + + 3つの QPushButton オブジェクト \c addButton 、 \c submitButton 、 + \c cancelButton は、前章の \c nameLine と \c addressText とともに、 + プライベート変数宣言に含まれています。 + + \snippet tutorials/addressbook/part2/addressbook.h pushbutton declaration + + アドレス帳の連絡先を横断して表示するには、 + 連絡先保持用のコンテナが必要です。 + QMap のオブジェクトである \c contacts をこの目的に使用します。 + \c contacts にはキーとして連絡先の名前 \e key + とそれに対応する値として連絡先の住所 \e value を格納します。 + + \snippet tutorials/addressbook/part2/addressbook.h remaining private variables + + QString の2つのプライベートオブジェクトとして \c oldName と \c oldAddress + も宣言します。 + これらのオブジェクトは、ユーザが \gui Add + をクリックする前に最後に表示した連絡先の名前と住所が含まれている必要があります。 + ユーザが \gui Cancel + をクリックすると、最後に表示した連絡先の詳細に戻って表示することが出来ます。 + + \section1 AddressBook クラスの実装 + + \c AddressBook のコンストラクタ内で、連絡先の詳細を編集することなく + 表示のみを行えるよう、 \c nameLine と \c addressText + を読み取り専用に設定します。 + + \dots + \snippet tutorials/addressbook/part2/addressbook.cpp setting readonly 1 + \dots + \snippet tutorials/addressbook/part2/addressbook.cpp setting readonly 2 + + 次に、プッシュボタン \c addButton 、 \c submitButton 、 \c cancelButton + のインスタンスを生成します。 + + \snippet tutorials/addressbook/part2/addressbook.cpp pushbutton declaration + + \c addButton を、 \l{QPushButton::show()} 関数を呼び出して表示します。 + \c submitButton と \c cancelButton は、 + \l{QPushButton::hide()}{hide()} を呼び出して非表示にします。 + これら2つのプッシュボタンはユーザが \gui Add + をクリックした場合にのみ表示され、後に説明する + \c addContact() によって処理されます。 + + \snippet tutorials/addressbook/part2/addressbook.cpp connecting signals and slots + + 各プッシュボタンの \l{QPushButton::clicked()}{clicked()} を、 + それぞれのスロットに接続します。 + 下図はこれを説明したものです。 + + \image addressbook-tutorial-part2-signals-and-slots.png + + 次に、 QVBoxLayout を使用して、 + アドレス帳ウィジェットの右側にプッシュボタンを + 上下一列に配置します。 + + \snippet tutorials/addressbook/part2/addressbook.cpp vertical layout + + \l{QBoxLayout::addStretch()}{addStretch()} 関数は、 + プッシュボタンを等間隔に並べるのではなく、 + ウィジェット上部に近づけて配置するために使用します。 + 下図は、\l{QBoxLayout::addStretch()}{addStretch()} を使用した場合と、 + 使用しない場合の違いを示しています。 + + \image addressbook-tutorial-part2-stretch-effects.png + + 次に、\l{QGridLayout::addLayout()}{addLayout()} を使用して、 + \c buttonLayout1 を \c mainLayout に追加します。 + \c buttonLayout1 は \c mainLayout の子となり、 + レイアウトが入れ子になりました。 + + \snippet tutorials/addressbook/part2/addressbook.cpp grid layout + + レイアウトの配置は以下のようになります: + + \image addressbook-tutorial-part2-labeled-layout.png + + \c addContact() では、最後に表示した連絡先の詳細を、 + \c oldName と \c oldAddress に保存します。 + 次に、これらの入力フィールドをクリアし、読み取り専用モードを解除します。 + \c nameLine にフォーカスをセットして、 \c submitButton と \c cancelButton を表示します。 + + \snippet tutorials/addressbook/part2/addressbook.cpp addContact + + \c submitContact() 関数は、以下の次の3つの要素から成ります: + + \list 1 + + \o \c nameLine 及び \c addressText から連絡先の詳細を抽出し、 + QString オブジェクトに保存します。 + また、ユーザが入力フィールドに何も入力せずに + \gui Submit をクリックしないよう確認します。 + どちらかのフィールドが空であれば、ユーザに名前と住所の入力を求める + QMessageBox が表示されます。 + + \snippet tutorials/addressbook/part2/addressbook.cpp submitContact part1 + + \o 続けて、連絡先が既に存在するかどうか確認します。 + 存在しない場合は \c contacts に連絡先を追加して QMessageBox を表示し、 + 連絡先が追加されたことをユーザに知らせます。 + + \snippet tutorials/addressbook/part2/addressbook.cpp submitContact part2 + + 連絡先が既に存在する場合、 QMessageBox を表示し、 + 連絡先が重複して追加されないように + 連絡先が存在することをユーザに知らせます。 + \c contacts オブジェクトは、名前と住所のキー値のペアで構成されているため、 + \e key が一意であることを確認します。 + + \o 上記の両方の事例に対処したら、 + 以下のコードを使ってプッシュボタンを通常の状態に戻します: + + \snippet tutorials/addressbook/part2/addressbook.cpp submitContact part3 + + \endlist + + 以下のスクリーンショットは、ユーザに情報メッセージを表示するために使用する + QMessageBox オブジェクトです。 + + \image addressbook-tutorial-part2-add-successful.png + + \c cancel() 関数は、最後に表示した連絡先の詳細を復元して + \c addButton を有効にし、 \c submitButton と \c cancelButton + を非表示にします。 + + \snippet tutorials/addressbook/part2/addressbook.cpp cancel + + 連絡先を追加する際の概念は、ユーザがいつでも自由に + \gui{送信} または \gui{キャンセル} をクリックできるようにすることです。 + 以下のフローチャートは、この概念を詳細に説明しています: + + \image addressbook-tutorial-part2-add-flowchart.png +*/ + +/*! + \page tutorials-addressbook-part3.html + + \example tutorials/addressbook/part3 + \title 第3章 - 項目間のナビゲーション + + アドレス帳アプリケーションは、半分完成しました。 + 次に表示する連絡先を変更するために、いくつかの関数を追加します。 + しかし、最初に、これらの連絡先を保存するために使用するデータ構造の種類を決める必要があります。 + + 第2章では、連絡先の名前 \e key 及び、連絡先の住所 \e value + の鍵と値のペアで QMap を使用しました。 + これは、この事例で使用するのに適した構造です。 + ただし、各項目間を移動して表示するには、多少の機能拡張が必要です。 + + QMap を、最初の要素と最後の要素を含むすべての要素が接続された + 循環リストに似たデータ構造に、機能拡張します。 + 下図はこのデータ構造を説明したものです。 + + \image addressbook-tutorial-part3-linkedlist.png + + \section1 AddressBook クラスの宣言 + + アドレス帳アプリケーションにナビゲーション機能を追加するには、 + \c AddressBook クラスに2つのスロットを追加する必要があります。 + next() 及び \c previous() を + \c addressbook.h ファイルに追加します。 + + \snippet tutorials/addressbook/part3/addressbook.h navigation functions + + また、新たに2つの QPushButton オブジェクトが必要になります。 + プライベート変数として + \c nextButton と \c previousButton を宣言します。 + + \snippet tutorials/addressbook/part3/addressbook.h navigation pushbuttons + + \section1 AddressBook クラスの実装 + + \c addressbook.cpp の \c AddressBook コンストラクタでは、 + \c nextButton と \c previousButton のインスタンスを生成し + 初期設定で無効にします。 + これは、アドレス帳に複数の連絡先が存在しない場合、 + ナビゲーションを有効にしないためです。 + + \snippet tutorials/addressbook/part3/addressbook.cpp navigation pushbuttons + + これらのプッシュボタンを、それぞれスロットに接続します: + + \snippet tutorials/addressbook/part3/addressbook.cpp connecting navigation signals + + 以下の画像は、ここで作成しようとしている + グラフィカルユーザインターフェースです。 + 最終アプリケーションが完成間近であることがわかるでしょう。 + + \image addressbook-tutorial-part3-screenshot.png + + \c next() と \c previous() では基本的な規約に従って、 + \c nextButton を右側に、 \c previousButton を左側に配置します。 + 直感的でわかりやすいレイアウトに仕上げるために、 + QHBoxLayout を使用してウィジェットを横に並べて配置します: + + \snippet tutorials/addressbook/part3/addressbook.cpp navigation layout + + 次に、 \c mainLayout に、QHBoxLayout のオブジェクトである + \c buttonLayout2 を追加します。 + + \snippet tutorials/addressbook/part3/addressbook.cpp adding navigation layout + + 下図は、 \c mainLayout のウィジェットの配置を示します。 + \image addressbook-tutorial-part3-labeled-layout.png + + \c addContact() 関数内部では、 + ユーザが連絡先を追加しているときに移動しないよう、 + これらのボタンを無効にする必要があります。 + + \snippet tutorials/addressbook/part3/addressbook.cpp disabling navigation + + また、 \c submitContact() 関数では、 \c contacts のサイズに応じて、 + ナビゲーションボタン \c nextButton 及び \c previousButton を有効にします。 + 前述のように、アドレス帳に複数の連絡先が存在しない場合は、 + ナビゲーションを有効にできません。 + 以下のコードは、その処理方法を示しています。 + + \snippet tutorials/addressbook/part3/addressbook.cpp enabling navigation + + \c cancel() 関数にも、これらの処理を含めます。 + + ここで、QMap のオブジェクト \c contacts を使って、 + 循環リストをエミュレートしましょう。 + \c next() 関数で、 \c contacts のイテレータを作成し、次に: + + \list + \o イテレータが \c contacts の末尾にない場合は、次の項目に移動します。 + + \o イテレータが \c contacts の末尾にある場合は、 + \c contacts の先頭に移動します。 + これによって、QMap が循環リストのように機能するという印象を与えます。 + \endlist + + \snippet tutorials/addressbook/part3/addressbook.cpp next() function + + \c contacts 内の正しいオブジェクトに移動したら、 + \c nameLine と \c addressText に内容を表示します。 + + 同様に、 \c previous() 関数で、 \c contacts のイテレータを作成し、次に: + \list + \o イテレータが \c contacts の末尾にある場合は、 + 表示をクリアして戻ります。 + + \o イテレータが \c contacts の先頭にある場合は、末尾に移動します。 + + \o イテレータを直前の項目に移動します。 + \endlist + + \snippet tutorials/addressbook/part3/addressbook.cpp previous() function + + もう一度、 \c contacts に現在のオブジェクトの内容を表示します。 +*/ + +/*! + \page tutorials-addressbook-part4.html + + \example tutorials/addressbook/part4 + \title 第4章 - アドレスの編集と削除 + + 本章では、アドレス帳アプリケーションに保存されている + 連絡先の内容を変更する方法について説明します。 + + \image addressbook-tutorial-screenshot.png + + ここでは、連絡先を整理して保存するだけでなく、 + ナビゲーションが可能なアドレス帳を作成します。 + 必要に応じて連絡先の詳細を変更できるよう、 + 編集・削除機能を追加すると便利です。 + ただし、列挙型書式の若干の改善が必要になります。 + 前章では、次の2つのモードを扱いました: + \c AddingMode 及び \c NavigationMode - + ただし、これらは列挙型として定義しませんでした。 + 代わりに、対応するボタンを手動で有効または無効にし、 + 複数行のコードを繰り返します。 + + 本章では、以下のような2つの異なる値を持つ \c Mode 列挙型を定義します: + + \list + \o \c{NavigationMode} + \o \c{AddingMode} + \o \c{EditingMode} + \endlist + + \section1 AddressBook クラスの宣言 + + \c addressbook.h ファイルをアップデートし、 \c Mode 列挙型を追加します: + + \snippet tutorials/addressbook/part4/addressbook.h Mode enum + + また、public slot として2つの新しいスロット + \c editContact() 及び \c removeContact() を追加します。 + + \snippet tutorials/addressbook/part4/addressbook.h edit and remove slots + + モードを切り替えるために、すべての QPushButton オブジェクトの + 有効化/無効化を制御する \c updateInterface() 関数を導入します。 + また、前述の編集と削除を行うスロット用に、2つの新しいボタン + \c editButton 及び \c removeButton を追加します。 + + \snippet tutorials/addressbook/part4/addressbook.h updateInterface() declaration + \dots + \snippet tutorials/addressbook/part4/addressbook.h buttons declaration + \dots + \snippet tutorials/addressbook/part4/addressbook.h mode declaration + + 最後に、現在のモードを保持する列挙型の \c currentMode を宣言します。 + + \section1 AddressBook クラスの実装 + + ここで、アドレス帳アプリケーションのモード変更機能を実装する必要があります。 + アドレス帳をはじめて起動するときは、 + メモリに連絡先が保存されていないため、 + コンストラクタでは、 \c editButton 及び \c removeButton + のインスタンスの生成と無効化を行います。 + + \snippet tutorials/addressbook/part4/addressbook.cpp edit and remove buttons + + また、ボタンをそれぞれのスロット \c editContact() 及び \c removeContact() + に接続し、 \c buttonLayout1 に追加します。 + + \snippet tutorials/addressbook/part4/addressbook.cpp connecting edit and remove + \dots + \snippet tutorials/addressbook/part4/addressbook.cpp adding edit and remove to the layout + + \c editContact() は、モードを \c EditingMode に切り替える前に、 + 連絡先の古い詳細情報を、 \c oldName と \c oldAddress に保存します。 + このモードでは、 \c submitButton と \c cancelButton + の両方が有効になるため、ユーザは連絡先の詳細を変更し、 + どちらか一方のボタンをクリックできます。 + + \snippet tutorials/addressbook/part4/addressbook.cpp editContact() function + + \c submitContact() 関数は、 \c{if-else} ステートメントにより、 + 2つの処理に分割しています。 + \c currentMode が \c AddingMode であるかどうかを確認します。 + その場合、連絡先追加の処理を行います。 + + \snippet tutorials/addressbook/part4/addressbook.cpp submitContact() function beginning + \dots + \snippet tutorials/addressbook/part4/addressbook.cpp submitContact() function part1 + + \c AddingMode でない場合、 \c currentMode が \c EditingMode + であるかどうか確認します。 + その場合、 \c oldName を \c name と比較します。 + 名前を変更した場合、 \c contacts から古い連絡先を削除し、 + 新たに更新した連絡先を挿入します。 + + \snippet tutorials/addressbook/part4/addressbook.cpp submitContact() function part2 + + 住所のみを変更した場合 (たとえば、 \c oldAddress は \c address と異なる)、 + 連絡先の住所を更新します。 + 最後に、 \c currentMode を \c NavigationMode に設定します。 + これは、無効にしたプッシュボタンをすべて再び有効にするための重要なステップです。 + + アドレス帳から連絡先の削除を行う + \c removeContact() 関数を実装します。 + この関数では、まず連絡先が \c contacts に存在するかどうか確認します。 + + \snippet tutorials/addressbook/part4/addressbook.cpp removeContact() function + + 存在する場合、ユーザに削除を確認するために、QMessageBox を表示します。 + ユーザが確認したら、 \c previous() を呼び出して、 + ユーザインターフェースで他の連絡先を表示できることを確認し、 + QMap の \l{QMap::remove()}{remove()} 関数を使用して連絡先を削除します。 + 念のため、QMessageBox を表示してユーザに知らせます。 + この関数で使用するメッセージボックスを以下に示します: + + \image addressbook-tutorial-part4-remove.png + + \section2 ユーザインターフェースを更新する + + 既に、 \c updateInterface() 関数が + 現在のモードに応じてプッシュボタンの有効化と無効化を行うための + 手段であることを説明しました。 + この関数は、渡される \c mode 引数に応じて現在のモードを更新します。 + なお、引数の値を確認する前に \c currentMode に代入しています。 + + このとき、それぞれのプッシュボタンは、 + 現在のモードに応じて有効または無効になります。 + \c AddingMode 及び \c EditingMode でのコードを以下に示します: + + \snippet tutorials/addressbook/part4/addressbook.cpp update interface() part 1 + + \c NavigationMode の場合、 QPushButton::setEnabled() + 関数のパラメータに条件を含めます。 + これは、アドレス帳に少なくとも1つ以上の連絡先が存在する場合に、 + \c editButton と \c removeButton が有効であることを確認するためのものです。 + \c nextButton と \c previousButton は、 + アドレス帳に少なくとも2つ以上の連絡先が存在する場合にのみ有効になります。 + + \snippet tutorials/addressbook/part4/addressbook.cpp update interface() part 2 + + モードの設定及び、同一関数内でのユーザインターフェースの更新を行うタスクを実行することにより、 + アプリケーションの内部状態により + ユーザインターフェースが「非同期」になる可能性を防ぎます。 +*/ + +/*! + \page tutorials-addressbook-part5.html + + \example tutorials/addressbook/part5 + \title 第5章 - 検索機能の追加 + + 本章では、アドレス帳アプリケーションの連絡先と住所を + 検索する方法について説明します。 + + \image addressbook-tutorial-part5-screenshot.png + + アドレス帳アプリケーションへ連絡先の追加を繰り返すと、 + \e Next 及び \e Previous ボタンによる連絡先のナビゲートが面倒になります。 + この場合、\e{検索(Find)}機能を使うと、 + 連絡先の検索をより効率的に行うことができます。 + 上記スクリーンショットは、\e Find ボタン及び、 + パネル上のボタンの位置を示します。 + + ユーザーが \e Find ボタンをクリックすると、 + 連絡先の名前の入力を求めるダイアログを表示します。 + Qt が提供する QDialog クラスを継承して \c FindDialog クラスを導入します。 + + \section1 FindDialog クラスの宣言 + + \image addressbook-tutorial-part5-finddialog.png + + QDialog を継承するには、最初に、QDialog のヘッダーを + \c finddialog.h ファイルで include する必要があります。 + また、これらのウィジェットをダイアログクラスで使用するため、 + 前方宣言を使用して QLineEdit と QPushButton を宣言します。 + + \c AddressBook クラスと同様に、 \c FindDialog クラスには Q_OBJECT + マクロが含まれ、ダイアログが別のウィンドウとして開かれる場合でも、 + コンストラクタは親 QWidget を取るように定義されます。 + + \snippet tutorials/addressbook/part5/finddialog.h FindDialog header + + \c FindDialog のインスタンスを保持するクラスにより使用される + パブリック関数 \c getFindText() を定義します。 + この関数を経由してユーザが入力した検索文字列を取得します。 + また、ユーザが \gui Find ボタンをクリックしたときに検索文字列を処理するために、 + public slot として \c findClicked() を定義します。 + + 最後に、\gui Find ボタンに対応するプライベート変数として \c findButton 、 + ユーザが検索文字列を入力するラインエディット \c lineEdit 及び、 + 後の作業で使用する検索文字列を保存するために使用する内部文字列として + \c findText の定義を行います。 + + \section1 FindDialog クラスの実装 + + \c FindDialog のコンストラクタ内で、プライベート変数の + \c lineEdit 、 \c findButton 及び \c findText を設定します。 + QHBoxLayout を用いてウィジェットを配置します。 + + \snippet tutorials/addressbook/part5/finddialog.cpp constructor + + シグナルをそれぞれのスロットに接続し、 + レイアウトとウィンドウのタイトルを設定します。 + \c findButton の \l{QPushButton::clicked()} シグナルは、 + \c findClicked() と \l{QDialog::accept()}{accept()} + に接続されていることがわかります。 + QDialog により提供される \l{QDialog::accept()}{accept()} スロットは + ダイアログを非表示にして、結果コードを \l{QDialog::}{Accepted} + に設定します。 + この関数を使用して、 \c AddressBook の \c findContact() 関数に、 + \c FindDialog オブジェクトが閉じていることを知らせます。 + この論理については、 \c findContact() 関数について取り上げる際に、 + さらに詳細に説明します。 + + \image addressbook-tutorial-part5-signals-and-slots.png + + \c findClicked() で、ユーザが連絡先の名前を入力せずに + \gui Find ボタンをクリックしたかどうか確認するために + \c lineEdit を検証します。 + 次に、 \c lineEdit から抽出した検索文字列を \c findText に設定します。 + その後、 \c lineEdit のコンテンツをクリアし、ダイアログを非表示にします。 + + \snippet tutorials/addressbook/part5/finddialog.cpp findClicked() function + + \c findText 変数用のパブリックな取得関数 + \c getFindText() を実装します。 + コンストラクタ及び \c findClicked() 関数でのみ + \c findText を直接設定するため、 + \c getFindText() に対応する設定関数は作成しません。 + \c getFindText() はパブリックであるため、インスタンスを生成し + \c FindDialog を使用するクラスは、 + ユーザが入力して確定した検索文字列にいつでもアクセスできます。 + + \snippet tutorials/addressbook/part5/finddialog.cpp getFindText() function + + \section1 AddressBook クラスの宣言 + + \c AddressBook クラス内部から \c FindDialog を使用できるよう、 + \c addressbook.h ファイルに \c finddialog.h を含めます。 + + \snippet tutorials/addressbook/part5/addressbook.h include finddialog's header + + これまでのところ、アドレス帳の全機能に、 + QPushButton とそのボタンに対応するスロットが含まれています。 + 同様に、\gui{検索(Find)}機能には、 + \c findButton 及び \c findContact() が含まれています。 + + \c findButton はプライベート変数として宣言され、 + \c findContact() 関数は public slot として宣言されます。 + + \snippet tutorials/addressbook/part5/addressbook.h findContact() declaration + \dots + \snippet tutorials/addressbook/part5/addressbook.h findButton declaration + + 最後に、 \c FindDialog のインスタンスを参照するためのプライベート変数 + \c dialog を宣言します。 + + \snippet tutorials/addressbook/part5/addressbook.h FindDialog declaration + + インスタンス化されたダイアログは複数回使用します。 + プライベート変数を使用すると、 + クラスの複数の場所から参照できるようになります。 + + \section1 AddressBook クラスの実装 + + \c AddressBook クラスのコンストラクタ内で、 + プライベートオブジェクトの \c findButton と \c findDialog + のインスタンスを生成します: + + \snippet tutorials/addressbook/part5/addressbook.cpp instantiating findButton + \dots + \snippet tutorials/addressbook/part5/addressbook.cpp instantiating FindDialog + + 次に、 \c findButton の \l{QPushButton::clicked()}{clicked()} シグナルを、 + \c findContact() に接続します。 + + \snippet tutorials/addressbook/part5/addressbook.cpp signals and slots for find + + 後は、 \c findContact() 関数のコードだけです: + + \snippet tutorials/addressbook/part5/addressbook.cpp findContact() function + + \c FindDialog インスタンスの \c dialog を表示することから始めます。 + これは、ユーザが検索用に連絡先の名前を入力するためのものです。 + ユーザがダイアログの \c findButton をクリックすると + ダイアログが非表示になり、結果コードが QDialog::Accepted に設定されます。 + これにより、 \c if ステートメントが常に真になります。 + + 続けて、検索文字列の抽出を行います。 + この場合、検索文字列は \c contactName で、 + \c FindDialog の \c getFindText() 関数を使用して取得します。 + アドレス帳に連絡先が存在する場合、直ちに表示します。 + 存在しない場合、検索が失敗したことを示す以下の QMessageBox が表示されます。 + + \image addressbook-tutorial-part5-notfound.png +*/ + +/*! + \page tutorials-addressbook-part6.html + + \example tutorials/addressbook/part6 + \title 第6章 - 読み込みと保存 + + 本章では、アドレス帳アプリケーションの読み込みと保存処理で使用する、 + Qt のファイル処理機能について説明します。 + + \image addressbook-tutorial-part6-screenshot.png + + 連絡先の参照及び検索機能は便利な機能ですが、 + 連絡先の保存と読み込みが可能になるまではアドレス帳は完成しません。 + + Qt は \l{Input/Output and Networking}{入出力} + 用のクラスを様々提供していますが、 + 今回は簡単に組み合わせて使用できる QFile と QDataStream の2つのクラスを選択しました。 + + QFile のオブジェクトは、 + 読み込みと書き込みが可能なディスク上のファイルを表します。 + QFile は、さまざまなデバイスを表すより一般的な QIODevice クラスの派生クラスです。 + + QDataStream オブジェクトは、バイナリデータを QIODevice に保存して、 + 後でもう一度取得できるようシリアライズするために使用します。 + パラメータとしてそれぞれのデバイスを使用すると、 + ストリームを開くのと同じくらい簡単に、 QIODevice + からの読み込みと書き込みを行うことができます。 + + \section1 AddressBook クラスの宣言 + + 2つの QPushButton オブジェクトの \c loadButton と \c saveButton + に加えて、2つの public slot の \c saveToFile() と \c loadFromFile() + を宣言します。 + + \snippet tutorials/addressbook/part6/addressbook.h save and load functions declaration + \dots + \snippet tutorials/addressbook/part6/addressbook.h save and load buttons declaration + + \section1 AddressBook クラスの実装 + + コンストラクタで、 \c loadButton と \c saveButton のインスタンスを生成します。 + 理想的には、プッシュボタンのラベルを、 + "Load contacts from a file"(「ファイルから連絡先を読み込む」)及び、 + "Save contacts to a file"(「連絡先をファイルに保存する」) + に設定するほうがよりユーザーフレンドリーです。 + ただし、他のプッシュボタンのサイズを考慮して、 + \gui{Load...}及び\gui{Save...}に設定します。 + Qt は、 \l{QWidget::setToolTip()}{setToolTip()} を使用して + ツールチップを簡単に設定する方法を提供していますので、 + 以下のコードでプッシュボタンにツールチップを設定します: + + \snippet tutorials/addressbook/part6/addressbook.cpp tooltip 1 + \dots + \snippet tutorials/addressbook/part6/addressbook.cpp tooltip 2 + + ここには記載していませんが、 + これまで実装した他の機能のように右側のレイアウトパネル + \c button1Layout にプッシュボタンを追加し、 + プッシュボタンの \l{QPushButton::clicked()}{clicked()} + シグナルをそれぞれのスロットに接続します。 + + 保存機能の場合、最初に QFileDialog::getSaveFileName() を使用して、 + \c fileName を取得します。 + これは、QFileDialog により提供される簡易関数で、 + モーダルなファイルダイアログをポップアップ表示させ、 + ユーザはファイル名を入力したり、既存の \c{.abk} ファイルを選択することが出来ます。 + \c{.abk} ファイルは、 + 連絡先を保存したときに作成されるアドレス帳の拡張子です。 + + \snippet tutorials/addressbook/part6/addressbook.cpp saveToFile() function part1 + + 以下のスクリーンショットのようなネイティブのファイルダイアログが表示されます: + + \image addressbook-tutorial-part6-save.png + + \c fileName が空ではない場合、 \c fileName を用いて + QFile のオブジェクト \c file を作成します。 + QFile は QIODevice の派生クラスであるため、 + QDataStream から使用できます。 + + 次に、ファイルを \l{QIODevice::}{WriteOnly} モードでオープンします。 + オープンに失敗した場合、 QMessageBox を表示してユーザに知らせます。 + + \snippet tutorials/addressbook/part6/addressbook.cpp saveToFile() function part2 + + オープンに成功した場合、 QDataStream のインスタンス \c out を生成して、 + 開いているファイルに書き込みます。 + QDataStream では、同じバージョンのストリームを使用して、 + 読み込みと書き込みを行う必要があります。 + \c file にシリアライズする前に、 + \l{QDataStream::Qt_4_5}{Qt 4.5で導入されたバージョン} + を今回使用するバージョンとして設定します。 + + \snippet tutorials/addressbook/part6/addressbook.cpp saveToFile() function part3 + + 読み込み機能の場合も QFileDialog::getOpenFileName() を使用して + \c fileName を取得します。 + この関数は QFileDialog::getSaveFileName() に対応するものであり、 + モーダルなファイルダイアログをポップアップ表示させ、 + ユーザはファイル名を入力したり、既存の \c{.abk} + ファイルを選択してアドレス帳に読み込ことができます。 + + \snippet tutorials/addressbook/part6/addressbook.cpp loadFromFile() function part1 + + たとえば、 Windows では、この関数は、以下のスクリーンショットのような + ネイティブのファイルダイアログをポップアップ表示させます。 + + \image addressbook-tutorial-part6-load.png + + \c fileName が空ではない場合、 QFile のオブジェクト + \c file を使用して、 \l{QIODevice::}{ReadOnly} モードでオープンします。 + \c saveToFile() の実装の場合と同様に、オープンに失敗した場合は + QMessageBox を表示して、ユーザに知らせます。 + + \snippet tutorials/addressbook/part6/addressbook.cpp loadFromFile() function part2 + + オープンに成功した場合、 + QDataStream のインスタンス \c in を生成して前記のようにバージョン設定を行い、 + シリアライズしたデータを \c contacts のデータ構造に読み込みます。 + \c contacts オブジェクトはデータが読み込まれる前に空にするので、 + ファイルの読み込みプロセスは簡素化されます。 + より高度な方法では、一時オブジェクトの QMap に読み込んで、 + 重複していない連絡先を \c contacts にコピーします。 + + \snippet tutorials/addressbook/part6/addressbook.cpp loadFromFile() function part3 + + ファイルから読み込んだ連絡先を表示するには、 + 最初に取得したデータを検証し、 + 読み込んだファイルにアドレス帳の連絡先が実際に含まれているか確認します。 + 含まれている場合、最初の連絡先を表示します。 + 含まれていない場合、QMessageBox を表示して、 + 問題があることをユーザに知らせます。 + 最後にインターフェースを更新し、適宜 + プッシュボタンの有効化と無効化を行います。 +*/ + +/*! + \page tutorials-addressbook-part7.html + + \example tutorials/addressbook/part7 + \title 第7章 - 追加機能 + + 本章では、アドレス帳アプリケーションを + 普段の生活で便利に使用するための追加機能について説明します。 + + \image addressbook-tutorial-part7-screenshot.png + + アドレス帳アプリケーションは、それ自体で便利ですが、 + 他のアプリケーションとデータの交換ができればなお便利です。 + vCard 形式は、この目的で使用可能な一般的なファイル形式です。 + 本章では、連絡先を vCard ファイル(\c{.vcf}) + にエクスポートできるよう、アドレス帳クライアントを拡張します。 + + \section1 AddressBook クラスの宣言 + + QPushButton のオブジェクト \c exportButton 及び、 + 対応する public slot の \c exportAsVCard() を + \c addressbook.h ファイルの \c AddressBook クラスに追加します。 + + \snippet tutorials/addressbook/part7/addressbook.h exportAsVCard() declaration + \dots + \snippet tutorials/addressbook/part7/addressbook.h exportButton declaration + + \section1 AddressBook クラスの実装 + + \c AddressBook のコンストラクタで、 \c exportButton の + \l{QPushButton::clicked()}{clicked()} シグナルを + \c exportAsVCard() に接続します。 + このボタンも、右側のボタンのパネルの処理を行うレイアウトである + \c buttonLayout1 に追加します。 + + \c exportAsVCard() 関数では、 + 連絡先の名前を \c name に抽出することから始めます。 + \c firstName 、 \c lastName 及び \c nameList を宣言します。 + 次に \c name を検索し、最初の空白のインデックスを取得します。 + 空白が存在する場合、連絡先の名前を \c firstName と + \c lastName に分割します。 + 次に、空白をアンダースコア ("_") に置き換えます。 + 空白が存在しない場合は、連絡先にファーストネーム(名) + しか保存されていない可能性があります。 + + \snippet tutorials/addressbook/part7/addressbook.cpp export function part1 + + \c saveToFile() 関数と同様に、ユーザがファイルの場所を選択できるよう + ファイルダイアログを開きます。 + 選択したファイル名を使用して、 + 書き込みを行うための QFile のインスタンスを生成します。 + + ファイルを \l{QIODevice::}{WriteOnly} モードでオープンします。 + オープンに失敗した場合、 QMessageBox を表示して、 + 問題があることをユーザに知らせて戻ります。 + オープンに成功した場合、 QTextStream のオブジェクト \c out へ + パラメータファイルを渡します。 + QDataStream のように、QTextStream クラスは、 + プレーンテキストファイルの読み込みと書き込みを行う機能を提供します。 + 結果として、生成された \c{.vcf} は + テキストエディターで開いて編集することができます。 + + \snippet tutorials/addressbook/part7/addressbook.cpp export function part2 + + まず \c{BEGIN:VCARD} タグ、次に \c{VERSION:2.1} タグの順に + vCard ファイルに書き込みます。 + 連絡先の名前は、 \c{N:} タグを使用して書き込みます。 + vCard の "File as" プロパティを設定する \c{FN:} タグを書き込む際は、 + 連絡先にラストネーム(姓)が含まれているかどうかを確認する必要があります。 + 含まれている場合、 \c nameList の情報を使用して入力します。 + 含まれていない場合、 \c firstName のみを書き込みます。 + + \snippet tutorials/addressbook/part7/addressbook.cpp export function part3 + + 続けて連絡先の住所の書き込みを行います。 + 住所のセミコロンには、"\\" をエスケープ文字として追加する必要があります。 + 改行はセミコロンに置き換えられ、コンマはスペースに置き換えられます。 + 次に、 \c{ADR;HOME:;} タグ、 \c address 、 + \c{END:VCARD} タグの順に書き込みます。 + + \snippet tutorials/addressbook/part7/addressbook.cpp export function part4 + + 最後に、vCard のエクスポートに成功したことをユーザに知らせるために、 + QMessageBox が表示されます。 + + \e{vCard は、\l{http://www.imc.org}{Internet Mail Consortium} の登録商標です。} +*/ diff --git a/doc/src/ja_JP/tutorials/widgets-tutorial.qdoc b/doc/src/ja_JP/tutorials/widgets-tutorial.qdoc new file mode 100644 index 0000000..6a6b1a2 --- /dev/null +++ b/doc/src/ja_JP/tutorials/widgets-tutorial.qdoc @@ -0,0 +1,257 @@ +/**************************************************************************** +** +** Copyright (C) 2010 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:LGPL$ +** No Commercial Usage +** This file contains pre-release code and may not be distributed. +** You may use this file in accordance with the terms and conditions +** contained in the Technology Preview License Agreement accompanying +** this package. +** +** GNU Lesser General Public License Usage +** Alternatively, this file may be used under the terms of the GNU Lesser +** General Public License version 2.1 as published by the Free Software +** Foundation and appearing in the file LICENSE.LGPL included in the +** packaging of this file. Please review the following information to +** ensure the GNU Lesser General Public License version 2.1 requirements +** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. +** +** In addition, as a special exception, Nokia gives you certain additional +** rights. These rights are described in the Nokia Qt LGPL Exception +** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. +** +** If you have questions regarding the use of this file, please contact +** Nokia at qt-info@nokia.com. +** +** +** +** +** +** +** +** +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/*! + \page widgets-tutorial.html + \title ウィジェットのチュートリアル + \brief 本チュートリアルではウィジェットとレイアウトの基本的な使い方を説明し、それらが GUI アプリケーションの開発でどのように使われるかを説明します。 + + \section1 はじめに + + ウィジェットは Qt によるグラフィカルユーザインターフェース(GUI)アプリケーションの基本構成要素です。 + ボタン、ラベル、テキストエディターなどの各 GUI コンポーネントはウィジェットであり、 + 既存のウィンドウのユーザーインタフェース内に配置したり、独立したウィンドウとして表示することができます。 + それぞれのコンポーネントは QWidget の派生クラスとして実装されます。 + QWidget 自体は QObject の派生クラスです。 + + QWidget は抽象クラスではなく、 + 他のウィジェット用のコンテナとして使用されたり、 + カスタムウィジェットを作る場合の基底クラスとして使用されます。 + 他のウィジェットを配置するウィンドウとしてもよく使われます。 + + \l{QObject} と同様に QWidget は所有権を示すために親オブジェクトを指定して生成できるため、 + 親オブジェクトが使用されなくなった場合には破棄されます。 + ウィジェットではこの親子関係が他の意味も持ちます。 + 子ウィジェットは親ウィジェットが使用する領域内に表示されます。 + これは、ウィンドウを削除するとそのウィンドウに含まれる全てのウィジェットが自動的に破棄されることを意味します。 + + \section1 main 関数の記述 + + Qt の GUI サンプルの多くは標準的なアプリケーションの初期化コードを含む + \c{main.cpp} ファイルと、アプリケーションのロジックやカスタム + GUI コンポーネントを含むいくつかのソース/ヘッダファイルから構成されています。 + + \c{main.cpp} 内の典型的な \c main() 関数は以下のようになります: + + \snippet doc/src/snippets/widgets-tutorial/template.cpp main.cpp body + + 最初に、コマンドラインから渡される引数を渡して QApplication のオブジェクトを生成します。 + ウィジェットを生成して表示した後、 QApplication::exec() を呼び出して Qt のイベントループを開始します。 + この関数から戻ってくるまでアプリケーションの制御は Qt 側にて行われます。最後に、\c{main()} は QApplication::exec() から取得された値を返します。 + + \section1 簡単なウィジェットのサンプル + + 以下の簡単なウィジェットのサンプルでは \c main() 関数の中にコードを記述しています。 + + \list + \o \l {tutorials/widgets/toplevel}{ウィンドウの作成} + + \o \l {tutorials/widgets/childwidget}{子ウィジェット} + + \o \l {tutorials/widgets/windowlayout}{レイアウトの利用} + + \o \l {tutorials/widgets/nestedlayouts}{複雑なレイアウト} + \endlist + + \section1 複雑なウィジェットのサンプル + + \l{Widgets examples}{より高度なサンプル} の場合、ウィジェットやレイアウトのためのコードは他のファイルに記述されています。 + 例えば、メインウインドウ用の GUI は、 QMainWindow 派生クラスのコンストラクタで作成されるでしょう。 + + \section1 サンプルのビルド + + Qt のバイナリパッケージを取得してインストールするか、Qt を自分でコンパイルした場合には既にこのチュートリアルで説明されているサンプルはビルドされ、実行する準備ができています。 + これらを変更し再コンパイルをしたい場合は、次の手順に従う必要があります: + + \list 1 + \o コマンドラインで、再コンパイルしたいサンプルを含むディレクトリに移動します。 + \o \c qmake と入力し、\key{Return} キーを押します。 + うまくいかない場合は、現在のパス内にこの実行ファイルが存在することを確認するか、 + フルパスを指定して実行してください。 + \o Linux/Unix および Mac OS X の場合、\c make と入力し、\key{Return} キーを押します。 + Windows 上の Visual Studio の場合、\c nmake と入力し、\key{Return} キーを押します。 + \endlist + + 現在のディレクトリに実行ファイルが生成されます。 + Windows では、このファイルは \c debug または \c release + ディレクトリに配置されているかもしれません。 + このファイルを実行すると、作業中のサンプルコードの動作を確認できます。 +*/ + +/*! + \example tutorials/widgets/toplevel + \title ウィジェットのチュートリアル - ウィンドウの作成 + + 親を持たないウィジェットを作成した場合、そのウィジェットは表示時にウィンドウ(\e{トップレベルウィジェット})として扱われます。 + このウィジェットが必要なくなった場合にそれを破棄してくれる親ウィジェットがないため、トップレベルウィジェットの管理は開発者が行ってください。 + + 以下のサンプルでは QWidget を使用してウィンドウを作成し、サイズを指定して表示します: + + \raw HTML + <table align="left" width="100%"> + <tr class="qt-code"><td> + \endraw + \snippet tutorials/widgets/toplevel/main.cpp main program + \raw HTML + </td><td align="right"> + \endraw + \inlineimage widgets-tutorial-toplevel.png + \raw HTML + </td></tr> + </table> + \endraw + + 実際の GUI を作成するには、ウィンドウ内にウィジェットを配置する必要があります。 + これは、ウィジェットのコンストラクタに QWidget のインスタンスを渡すことで実現します。 + 詳細は本チュートリアルの次の章で示します。 +*/ + +/*! + \example tutorials/widgets/childwidget + \title ウィジェットのチュートリアル - 子ウィジェット + + 前のサンプルで作成したウィンドウに子ウィジェットを追加するために、 + 親として \c window を子ウィジェットのコンストラクタに渡します。 + ここでは、ウィンドウにボタンを追加し特定の場所に配置します: + + \raw HTML + <table align="left" width="100%"> + <tr class="qt-code"><td> + \endraw + \snippet tutorials/widgets/childwidget/main.cpp main program + \raw HTML + </td><td align="right"> + \endraw + \inlineimage widgets-tutorial-childwidget.png + \raw HTML + </td></tr> + </table> + \endraw + + このボタンはウィンドウの子になり、 + ウィンドウが破棄された場合にはボタンも破棄されるでしょう。 + ウィンドウを非表示化したり閉じた際には、自動的に破棄はされません。 + サンプルが終了する場合には破棄されるでしょう。 +*/ + +/*! + \example tutorials/widgets/windowlayout + \title ウィジェットのチュートリアル - レイアウトの利用 + + 一般的に子ウィジェットは、位置とサイズを明確に指定するのではなく、 + レイアウトオブジェクトを使用してウィンドウ内に配置します。 + ここでは、ラベルとラインエディットを生成し、横に並べて配置します。 + + \raw HTML + <table align="left" width="100%"> + <tr class="qt-code"><td> + \endraw + \snippet tutorials/widgets/windowlayout/main.cpp main program + \raw HTML + </td><td align="right"> + \endraw + \inlineimage widgets-tutorial-windowlayout.png + \raw HTML + </td></tr> + </table> + \endraw + + 生成する \c layout オブジェクトは、 \l{QHBoxLayout::}{addWidget()} 関数を使って設定されたウィジェットの位置とサイズを管理します。 + また、\l{QWidget::}{setLayout()} を使用してレイアウトをウィンドウに設定します。 + レイアウトはそれ自体は目には見えない存在です。 + レイアウトの管理対象となっているウィジェット(や他のレイアウト)に対しての効果としてのみ、その存在を確認できます。 + + 上記サンプルにおいて、各ウィジェットの所有権はあまり明確ではありません。 + 親オブジェクトのない3つのウィジェットと1つのレイアウトを作成するため、 + 空のウィンドウと、ラベルとラインエディットをそれぞれ含む別々のウィンドウが表示されるように見えるかもしれません。 + しかし、レイアウトにラベルとラインエディットを管理するように指定すると、 + ウィンドウにそのレイアウトを設定した際に「親の再指定」が行われるため、 + ウィジェットおよびレイアウト自体がそのウィンドウの子になります。 +*/ + +/*! + \example tutorials/widgets/nestedlayouts + \title ウィジェットのチュートリアル - 複雑なレイアウト + + ウィジェットの中に他のウィジェットを含めることができるように、 + レイアウトは異なるレベルでのウィジェットのグループ化にも使用されます。 + ここではウィンドウ上部にラベルとラインエディットを隣り合わせに配置し、 + その下に検索結果が表示されるテーブルビューを表示します。 + + これは、レイアウトを2つ作成して行います。\c{queryLayout} は、QLabel と QLineEdit を左右に並べて表示する QHBoxLayout です。 + \c{mainLayout} は、\c{queryLayout} と QTableView を上下に並べて表示する QVBoxLayout です。 + + \raw HTML + <table align="left" width="100%"> + <tr class="qt-code"><td> + \endraw + \snippet tutorials/widgets/nestedlayouts/main.cpp first part + \snippet tutorials/widgets/nestedlayouts/main.cpp last part + \raw HTML + </td><td align="right"> + \endraw + \inlineimage widgets-tutorial-nestedlayouts.png + \raw HTML + </td></tr> + </table> + \endraw + + \c{mainLayout} の \l{QBoxLayout::}{addLayout()} 関数にて追加された + \c{queryLayout} と \c{resultView} は追加された順番で上から並べられます。 + + ここでは QTableView ウィジェット \c resultView に表示されるデータを含むモデルの設定のコードは省略していますが、 + 後ほど示します。 + + QHBoxLayout や QVBoxLayout と共に Qt から提供される QGridLayout および QFormLayout を使用することにより、 + より複雑なユーザインターフェースの構築が可能になります。 + これらのレイアウトの効果は、\l{Qt Designer} を実行して確認できます。 + + \section1 モデルを設定する + + 上記のコードでは、レイアウトの有効利用に重点を置いていたため、 + テーブルのデータについては示していませんでした。 + 以下のコードで、モデルには行に対応する項目が含まれ、それぞれの行には2つの列のデータが設定されていることがわかるでしょう。 + + \snippet tutorials/widgets/nestedlayouts/main.cpp set up the model + + モデルとビューの有効利用については、\l{Item Views Examples} および + \l{Model/View Programming} の概要に含まれています。 +*/ diff --git a/doc/src/platforms/symbian-introduction.qdoc b/doc/src/platforms/symbian-introduction.qdoc index 9563a8e..fb84f05 100644 --- a/doc/src/platforms/symbian-introduction.qdoc +++ b/doc/src/platforms/symbian-introduction.qdoc @@ -134,6 +134,7 @@ \row \o \c run \o Run the application on the emulator. \row \o \c runonphone \o Run the application on a device. \row \o \c sis \o Create signed \c .sis file for project. + \row \o \c unsigned_sis \o Create unsigned \c .sis file for project. \row \o \c installer_sis \o Create signed \l{Smart Installer}{smart installer} \c .sis file for project. Smart installer will attempt to download @@ -211,6 +212,7 @@ \row \o -p \o Only preprocess the template \c .pkg file. \row \o -c <file> \o Read certificate information from a file. \row \o -u \o Preserves unsigned package. + \row \o -o \o Creates only unsigned package. \row \o -s \o Generates stub sis for ROM. \row \o -n <name> \o Specifies the final sis name. \endtable diff --git a/doc/src/snippets/declarative/anchorchanges.qml b/doc/src/snippets/declarative/anchorchanges.qml new file mode 100644 index 0000000..993618b --- /dev/null +++ b/doc/src/snippets/declarative/anchorchanges.qml @@ -0,0 +1,69 @@ +/**************************************************************************** +** +** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies). +** All rights reserved. +** Contact: Nokia Corporation (qt-info@nokia.com) +** +** This file is part of the QtDeclarative module of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:LGPL$ +** No Commercial Usage +** This file contains pre-release code and may not be distributed. +** You may use this file in accordance with the terms and conditions +** contained in the Technology Preview License Agreement accompanying +** this package. +** +** GNU Lesser General Public License Usage +** Alternatively, this file may be used under the terms of the GNU Lesser +** General Public License version 2.1 as published by the Free Software +** Foundation and appearing in the file LICENSE.LGPL included in the +** packaging of this file. Please review the following information to +** ensure the GNU Lesser General Public License version 2.1 requirements +** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. +** +** In addition, as a special exception, Nokia gives you certain additional +** rights. These rights are described in the Nokia Qt LGPL Exception +** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. +** +** If you have questions regarding the use of this file, please contact +** Nokia at qt-info@nokia.com. +** +** +** +** +** +** +** +** +** $QT_END_LICENSE$ +** +****************************************************************************/ +//![0] +import Qt 4.7 + +Rectangle { + id: window + width: 120; height: 120 + color: "black" + + Rectangle { id: myRect; width: 50; height: 50; color: "red" } + + states: State { + name: "reanchored" + + AnchorChanges { + target: myRect + anchors.top: window.top + anchors.bottom: window.bottom + } + PropertyChanges { + target: myRect + anchors.topMargin: 10 + anchors.bottomMargin: 10 + } + } + + MouseArea { anchors.fill: parent; onClicked: window.state = "reanchored" } +} +//![0] + diff --git a/doc/src/snippets/declarative/animation.qml b/doc/src/snippets/declarative/animation.qml new file mode 100644 index 0000000..65acd36 --- /dev/null +++ b/doc/src/snippets/declarative/animation.qml @@ -0,0 +1,181 @@ +/**************************************************************************** +** +** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies). +** All rights reserved. +** Contact: Nokia Corporation (qt-info@nokia.com) +** +** This file is part of the QtDeclarative module of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:LGPL$ +** No Commercial Usage +** This file contains pre-release code and may not be distributed. +** You may use this file in accordance with the terms and conditions +** contained in the Technology Preview License Agreement accompanying +** this package. +** +** GNU Lesser General Public License Usage +** Alternatively, this file may be used under the terms of the GNU Lesser +** General Public License version 2.1 as published by the Free Software +** Foundation and appearing in the file LICENSE.LGPL included in the +** packaging of this file. Please review the following information to +** ensure the GNU Lesser General Public License version 2.1 requirements +** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. +** +** In addition, as a special exception, Nokia gives you certain additional +** rights. These rights are described in the Nokia Qt LGPL Exception +** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. +** +** If you have questions regarding the use of this file, please contact +** Nokia at qt-info@nokia.com. +** +** +** +** +** +** +** +** +** $QT_END_LICENSE$ +** +****************************************************************************/ +import Qt 4.7 + +Row { + +//![property-anim-1] +Rectangle { + id: rect + width: 120; height: 200 + + Image { + id: img + source: "pics/qt.png" + x: 60 - img.width/2 + y: 0 + + SequentialAnimation on y { + loops: Animation.Infinite + NumberAnimation { to: 200 - img.height; easing.type: Easing.OutBounce; duration: 2000 } + PauseAnimation { duration: 1000 } + NumberAnimation { to: 0; easing.type: Easing.OutQuad; duration: 1000 } + } + } +} +//![property-anim-1] + +//![property-anim-2] +Rectangle { + width: 200; height: 200 + + Rectangle { + color: "red" + width: 50; height: 50 + NumberAnimation on x { to: 50 } + } +} +//![property-anim-2] + + +Item { +//![property-anim-3] +PropertyAnimation { + id: animation + target: image + property: "scale" + from: 1; to: 0.5 +} + +Image { + id: image + source: "pics/qt.png" + MouseArea { + anchors.fill: parent + onPressed: animation.start() + } +} +//![property-anim-3] +} + + +//![transitions-1] +transitions: [ + Transition { + NumberAnimation { + properties: "x,y" + easing.type: Easing.OutBounce + duration: 200 + } + } +] +//![transitions-1] + + +//![transitions-2] +Transition { + from: "*" + to: "MyState" + reversible: true + + SequentialAnimation { + NumberAnimation { + duration: 1000 + easing.type: Easing.OutBounce + + // animate myItem's x and y if they have changed in the state + target: myItem + properties: "x,y" + } + + NumberAnimation { + duration: 1000 + + // animate myItem2's y to 200, regardless of what happens in the state + target: myItem2 + property: "y" + to: 200 + } + } +} +//![transitions-2] + + +//![transitions-3] +Transition { + from: "*" + to: "MyState" + reversible: true + + SequentialAnimation { + ColorAnimation { duration: 1000 } + PauseAnimation { duration: 1000 } + + ParallelAnimation { + NumberAnimation { + duration: 1000 + easing.type: Easing.OutBounce + targets: box1 + properties: "x,y" + } + NumberAnimation { + duration: 1000 + targets: box2 + properties: "x,y" + } + } + } +} +//![transitions-3] + +//![behavior] +Rectangle { + id: redRect + color: "red" + width: 100; height: 100 + + Behavior on x { + NumberAnimation { duration: 300; easing.type: Easing.InOutQuad } + } +} +//![behavior] + +} diff --git a/doc/src/snippets/declarative/createQmlObject.qml b/doc/src/snippets/declarative/createQmlObject.qml index f2ac6e6..f274e40 100644 --- a/doc/src/snippets/declarative/createQmlObject.qml +++ b/doc/src/snippets/declarative/createQmlObject.qml @@ -42,7 +42,7 @@ import Qt 4.7 Rectangle { - id: targetItem + id: parentItem property QtObject newObject width: 100 @@ -51,7 +51,7 @@ Rectangle { function createIt() { //![0] newObject = Qt.createQmlObject('import Qt 4.7; Rectangle {color: "red"; width: 20; height: 20}', - targetItem, "dynamicSnippet1"); + parentItem, "dynamicSnippet1"); //![0] } diff --git a/doc/src/snippets/declarative/listmodel-modify.qml b/doc/src/snippets/declarative/listmodel-modify.qml new file mode 100644 index 0000000..03fb314 --- /dev/null +++ b/doc/src/snippets/declarative/listmodel-modify.qml @@ -0,0 +1,97 @@ +/**************************************************************************** +** +** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies). +** All rights reserved. +** Contact: Nokia Corporation (qt-info@nokia.com) +** +** This file is part of the QtDeclarative module of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:LGPL$ +** No Commercial Usage +** This file contains pre-release code and may not be distributed. +** You may use this file in accordance with the terms and conditions +** contained in the Technology Preview License Agreement accompanying +** this package. +** +** GNU Lesser General Public License Usage +** Alternatively, this file may be used under the terms of the GNU Lesser +** General Public License version 2.1 as published by the Free Software +** Foundation and appearing in the file LICENSE.LGPL included in the +** packaging of this file. Please review the following information to +** ensure the GNU Lesser General Public License version 2.1 requirements +** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. +** +** In addition, as a special exception, Nokia gives you certain additional +** rights. These rights are described in the Nokia Qt LGPL Exception +** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. +** +** If you have questions regarding the use of this file, please contact +** Nokia at qt-info@nokia.com. +** +** +** +** +** +** +** +** +** $QT_END_LICENSE$ +** +****************************************************************************/ +import Qt 4.7 + +Rectangle { + width: 200; height: 200 + +ListModel { + id: fruitModel + + ListElement { + name: "Apple" + cost: 2.45 + attributes: [ + ListElement { description: "Core" }, + ListElement { description: "Deciduous" } + ] + } + ListElement { + name: "Orange" + cost: 3.25 + attributes: [ + ListElement { description: "Citrus" } + ] + } + ListElement { + name: "Banana" + cost: 1.95 + attributes: [ + ListElement { description: "Tropical" }, + ListElement { description: "Seedless" } + ] + } +} + +//![delegate] + Component { + id: fruitDelegate + Item { + width: 200; height: 50 + Text { text: name } + Text { text: '$' + cost; anchors.right: parent.right } + + // Double the price when clicked. + MouseArea { + anchors.fill: parent + onClicked: fruitModel.setProperty(index, "cost", cost * 2) + } + } + } +//![delegate] + +ListView { + width: 200; height: 200 + model: fruitModel + delegate: fruitDelegate +} + +} diff --git a/doc/src/snippets/declarative/listmodel-nested.qml b/doc/src/snippets/declarative/listmodel-nested.qml new file mode 100644 index 0000000..4ae43ff --- /dev/null +++ b/doc/src/snippets/declarative/listmodel-nested.qml @@ -0,0 +1,103 @@ +/**************************************************************************** +** +** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies). +** All rights reserved. +** Contact: Nokia Corporation (qt-info@nokia.com) +** +** This file is part of the QtDeclarative module of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:LGPL$ +** No Commercial Usage +** This file contains pre-release code and may not be distributed. +** You may use this file in accordance with the terms and conditions +** contained in the Technology Preview License Agreement accompanying +** this package. +** +** GNU Lesser General Public License Usage +** Alternatively, this file may be used under the terms of the GNU Lesser +** General Public License version 2.1 as published by the Free Software +** Foundation and appearing in the file LICENSE.LGPL included in the +** packaging of this file. Please review the following information to +** ensure the GNU Lesser General Public License version 2.1 requirements +** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. +** +** In addition, as a special exception, Nokia gives you certain additional +** rights. These rights are described in the Nokia Qt LGPL Exception +** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. +** +** If you have questions regarding the use of this file, please contact +** Nokia at qt-info@nokia.com. +** +** +** +** +** +** +** +** +** $QT_END_LICENSE$ +** +****************************************************************************/ +import Qt 4.7 + +Rectangle { + width: 200; height: 200 + + +//![model] +ListModel { + id: fruitModel + + ListElement { + name: "Apple" + cost: 2.45 + attributes: [ + ListElement { description: "Core" }, + ListElement { description: "Deciduous" } + ] + } + ListElement { + name: "Orange" + cost: 3.25 + attributes: [ + ListElement { description: "Citrus" } + ] + } + ListElement { + name: "Banana" + cost: 1.95 + attributes: [ + ListElement { description: "Tropical" }, + ListElement { description: "Seedless" } + ] + } +} +//![model] + +//![delegate] +Component { + id: fruitDelegate + Item { + width: 200; height: 50 + Text { id: nameField; text: name } + Text { text: '$' + cost; anchors.left: nameField.right } + Row { + anchors.top: nameField.bottom + spacing: 5 + Text { text: "Attributes:" } + Repeater { + model: attributes + Text { text: description } + } + } + } +} +//![delegate] + +ListView { + width: 200; height: 200 + model: fruitModel + delegate: fruitDelegate +} + +} diff --git a/doc/src/snippets/declarative/listmodel-simple.qml b/doc/src/snippets/declarative/listmodel-simple.qml new file mode 100644 index 0000000..00b8cb0 --- /dev/null +++ b/doc/src/snippets/declarative/listmodel-simple.qml @@ -0,0 +1,80 @@ +/**************************************************************************** +** +** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies). +** All rights reserved. +** Contact: Nokia Corporation (qt-info@nokia.com) +** +** This file is part of the QtDeclarative module of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:LGPL$ +** No Commercial Usage +** This file contains pre-release code and may not be distributed. +** You may use this file in accordance with the terms and conditions +** contained in the Technology Preview License Agreement accompanying +** this package. +** +** GNU Lesser General Public License Usage +** Alternatively, this file may be used under the terms of the GNU Lesser +** General Public License version 2.1 as published by the Free Software +** Foundation and appearing in the file LICENSE.LGPL included in the +** packaging of this file. Please review the following information to +** ensure the GNU Lesser General Public License version 2.1 requirements +** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. +** +** In addition, as a special exception, Nokia gives you certain additional +** rights. These rights are described in the Nokia Qt LGPL Exception +** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. +** +** If you have questions regarding the use of this file, please contact +** Nokia at qt-info@nokia.com. +** +** +** +** +** +** +** +** +** $QT_END_LICENSE$ +** +****************************************************************************/ +//![0] +import Qt 4.7 + +Rectangle { + width: 200; height: 200 + + ListModel { + id: fruitModel +//![0] + ListElement { + name: "Apple" + cost: 2.45 + } + ListElement { + name: "Orange" + cost: 3.25 + } + ListElement { + name: "Banana" + cost: 1.95 + } +//![1] + } + + Component { + id: fruitDelegate + Row { + spacing: 10 + Text { text: name } + Text { text: '$' + cost } + } + } + + ListView { + anchors.fill: parent + model: fruitModel + delegate: fruitDelegate + } +} +//![1] diff --git a/doc/src/snippets/declarative/repeater-modeldata.qml b/doc/src/snippets/declarative/listmodel.qml index 3b4cc6d..91b8230 100644 --- a/doc/src/snippets/declarative/repeater-modeldata.qml +++ b/doc/src/snippets/declarative/listmodel.qml @@ -38,15 +38,23 @@ ** $QT_END_LICENSE$ ** ****************************************************************************/ - +//![0] import Qt 4.7 -//! [0] -Column { - Repeater { - model: ["apples", "oranges", "pears"] - Text { text: "Data: " + modelData } +ListModel { + id: fruitModel + + ListElement { + name: "Apple" + cost: 2.45 + } + ListElement { + name: "Orange" + cost: 3.25 + } + ListElement { + name: "Banana" + cost: 1.95 } } -//! [0] - +//![0] diff --git a/doc/src/snippets/declarative/parentchange.qml b/doc/src/snippets/declarative/parentchange.qml new file mode 100644 index 0000000..7f5718a --- /dev/null +++ b/doc/src/snippets/declarative/parentchange.qml @@ -0,0 +1,69 @@ +/**************************************************************************** +** +** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies). +** All rights reserved. +** Contact: Nokia Corporation (qt-info@nokia.com) +** +** This file is part of the QtDeclarative module of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:LGPL$ +** No Commercial Usage +** This file contains pre-release code and may not be distributed. +** You may use this file in accordance with the terms and conditions +** contained in the Technology Preview License Agreement accompanying +** this package. +** +** GNU Lesser General Public License Usage +** Alternatively, this file may be used under the terms of the GNU Lesser +** General Public License version 2.1 as published by the Free Software +** Foundation and appearing in the file LICENSE.LGPL included in the +** packaging of this file. Please review the following information to +** ensure the GNU Lesser General Public License version 2.1 requirements +** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. +** +** In addition, as a special exception, Nokia gives you certain additional +** rights. These rights are described in the Nokia Qt LGPL Exception +** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. +** +** If you have questions regarding the use of this file, please contact +** Nokia at qt-info@nokia.com. +** +** +** +** +** +** +** +** +** $QT_END_LICENSE$ +** +****************************************************************************/ +//![0] +import Qt 4.7 + +Rectangle { + width: 200 + height: 100 + + Rectangle { + id: redRect + width: 100; height: 100 + color: "red" + } + + Rectangle { + id: blueRect + x: redRect.width + width: 50; height: 50 + color: "blue" + + states: State { + name: "reparented" + ParentChange { target: blueRect; parent: redRect; x: 10; y: 10 } + } + + MouseArea { anchors.fill: parent; onClicked: blueRect.state = "reparented" } + } +} +//![0] + diff --git a/doc/src/snippets/declarative/repeater.qml b/doc/src/snippets/declarative/repeater.qml index 8b4d9cb..be5d62d 100644 --- a/doc/src/snippets/declarative/repeater.qml +++ b/doc/src/snippets/declarative/repeater.qml @@ -39,19 +39,52 @@ ** ****************************************************************************/ +//! [import] import Qt 4.7 +//! [import] -Rectangle { - width: 220; height: 20; color: "white" +Row { -//! [0] - Row { - Rectangle { width: 10; height: 20; color: "red" } - Repeater { - model: 10 - Rectangle { width: 20; height: 20; radius: 10; color: "green" } +//! [simple] +Row { + Repeater { + model: 3 + Rectangle { + width: 100; height: 40 + border.width: 1 + color: "yellow" } - Rectangle { width: 10; height: 20; color: "blue" } } -//! [0] +} +//! [simple] + +//! [index] +Column { + Repeater { + model: 10 + Text { text: "I'm item " + index } + } +} +//! [index] + +//! [modeldata] +Column { + Repeater { + model: ["apples", "oranges", "pears"] + Text { text: "Data: " + modelData } + } +} +//! [modeldata] + +//! [layout] +Row { + Rectangle { width: 10; height: 20; color: "red" } + Repeater { + model: 10 + Rectangle { width: 20; height: 20; radius: 10; color: "green" } + } + Rectangle { width: 10; height: 20; color: "blue" } +} +//! [layout] + } diff --git a/doc/src/snippets/declarative/rotation.qml b/doc/src/snippets/declarative/rotation.qml index 0fb9a61..5437292 100644 --- a/doc/src/snippets/declarative/rotation.qml +++ b/doc/src/snippets/declarative/rotation.qml @@ -38,37 +38,33 @@ ** $QT_END_LICENSE$ ** ****************************************************************************/ - +//! [0] import Qt 4.7 -Rectangle { - width: 360; height: 80 - color: "white" -//! [0] - Row { - x: 10; y: 10 - spacing: 10 - Image { source: "pics/qt.png" } - Image { - source: "pics/qt.png" - transform: Rotation { origin.x: 30; origin.y: 30; axis { x: 0; y: 1; z: 0 } angle: 18 } - smooth: true - } - Image { - source: "pics/qt.png" - transform: Rotation { origin.x: 30; origin.y: 30; axis { x: 0; y: 1; z: 0 } angle: 36 } - smooth: true - } - Image { - source: "pics/qt.png" - transform: Rotation { origin.x: 30; origin.y: 30; axis { x: 0; y: 1; z: 0 } angle: 54 } - smooth: true - } - Image { - source: "pics/qt.png" - transform: Rotation { origin.x: 30; origin.y: 30; axis { x: 0; y: 1; z: 0 } angle: 72 } - smooth: true - } +Row { + x: 10; y: 10 + spacing: 10 + + Image { source: "pics/qt.png" } + Image { + source: "pics/qt.png" + transform: Rotation { origin.x: 30; origin.y: 30; axis { x: 0; y: 1; z: 0 } angle: 18 } + smooth: true + } + Image { + source: "pics/qt.png" + transform: Rotation { origin.x: 30; origin.y: 30; axis { x: 0; y: 1; z: 0 } angle: 36 } + smooth: true + } + Image { + source: "pics/qt.png" + transform: Rotation { origin.x: 30; origin.y: 30; axis { x: 0; y: 1; z: 0 } angle: 54 } + smooth: true + } + Image { + source: "pics/qt.png" + transform: Rotation { origin.x: 30; origin.y: 30; axis { x: 0; y: 1; z: 0 } angle: 72 } + smooth: true } -//! [0] } +//! [0] diff --git a/doc/src/snippets/declarative/state.qml b/doc/src/snippets/declarative/state.qml new file mode 100644 index 0000000..a99c2e2 --- /dev/null +++ b/doc/src/snippets/declarative/state.qml @@ -0,0 +1,69 @@ +/**************************************************************************** +** +** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies). +** All rights reserved. +** Contact: Nokia Corporation (qt-info@nokia.com) +** +** This file is part of the QtDeclarative module of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:LGPL$ +** No Commercial Usage +** This file contains pre-release code and may not be distributed. +** You may use this file in accordance with the terms and conditions +** contained in the Technology Preview License Agreement accompanying +** this package. +** +** GNU Lesser General Public License Usage +** Alternatively, this file may be used under the terms of the GNU Lesser +** General Public License version 2.1 as published by the Free Software +** Foundation and appearing in the file LICENSE.LGPL included in the +** packaging of this file. Please review the following information to +** ensure the GNU Lesser General Public License version 2.1 requirements +** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. +** +** In addition, as a special exception, Nokia gives you certain additional +** rights. These rights are described in the Nokia Qt LGPL Exception +** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. +** +** If you have questions regarding the use of this file, please contact +** Nokia at qt-info@nokia.com. +** +** +** +** +** +** +** +** +** $QT_END_LICENSE$ +** +****************************************************************************/ +//![0] +import Qt 4.7 + +Rectangle { + id: myRect + width: 100; height: 100 + color: "black" + + states: [ + State { + name: "clicked" + PropertyChanges { + target: myRect + color: "red" + } + } + ] + + MouseArea { + anchors.fill: parent + onClicked: { + if (myRect.state == "") // i.e. the default state + myRect.state = "clicked"; + else + myRect.state = ""; + } + } +} +//![0] diff --git a/doc/src/snippets/declarative/states.qml b/doc/src/snippets/declarative/states.qml new file mode 100644 index 0000000..c3b1796 --- /dev/null +++ b/doc/src/snippets/declarative/states.qml @@ -0,0 +1,81 @@ +/**************************************************************************** +** +** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies). +** All rights reserved. +** Contact: Nokia Corporation (qt-info@nokia.com) +** +** This file is part of the QtDeclarative module of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:LGPL$ +** No Commercial Usage +** This file contains pre-release code and may not be distributed. +** You may use this file in accordance with the terms and conditions +** contained in the Technology Preview License Agreement accompanying +** this package. +** +** GNU Lesser General Public License Usage +** Alternatively, this file may be used under the terms of the GNU Lesser +** General Public License version 2.1 as published by the Free Software +** Foundation and appearing in the file LICENSE.LGPL included in the +** packaging of this file. Please review the following information to +** ensure the GNU Lesser General Public License version 2.1 requirements +** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. +** +** In addition, as a special exception, Nokia gives you certain additional +** rights. These rights are described in the Nokia Qt LGPL Exception +** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. +** +** If you have questions regarding the use of this file, please contact +** Nokia at qt-info@nokia.com. +** +** +** +** +** +** +** +** +** $QT_END_LICENSE$ +** +****************************************************************************/ +//![0] +import Qt 4.7 + +Item { + id: myItem + width: 200; height: 200 + + Rectangle { + id: myRect + width: 100; height: 100 + color: "red" + } + + states: [ + State { + name: "moved" + PropertyChanges { + target: myRect + x: 50 + y: 50 + } + } + ] + + MouseArea { + anchors.fill: parent + onClicked: myItem.state = 'moved' + } +//![0] + +//![transitions] +transitions: [ + Transition { + NumberAnimation { properties: "x,y"; duration: 500 } + } +] +//![transitions] + +//![1] +} +//![1] diff --git a/doc/src/snippets/declarative/repeater-index.qml b/doc/src/snippets/declarative/systempalette.qml index 3eee742..98b333e 100644 --- a/doc/src/snippets/declarative/repeater-index.qml +++ b/doc/src/snippets/declarative/systempalette.qml @@ -38,19 +38,18 @@ ** $QT_END_LICENSE$ ** ****************************************************************************/ - +//![0] import Qt 4.7 Rectangle { - width: 50; height: childrenRect.height; color: "white" + SystemPalette { id: myPalette; colorGroup: SystemPalette.Active } + + width: 640; height: 480 + color: myPalette.window -//! [0] - Column { - Repeater { - model: 10 - Text { text: "I'm item " + index } - } + Text { + anchors.fill: parent + text: "Hello!"; color: myPalette.windowText } -//! [0] } - +//![0] diff --git a/doc/src/snippets/declarative/visualdatamodel.qml b/doc/src/snippets/declarative/visualdatamodel.qml new file mode 100644 index 0000000..cdde513 --- /dev/null +++ b/doc/src/snippets/declarative/visualdatamodel.qml @@ -0,0 +1,65 @@ +/**************************************************************************** +** +** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies). +** All rights reserved. +** Contact: Nokia Corporation (qt-info@nokia.com) +** +** This file is part of the QtDeclarative module of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:LGPL$ +** No Commercial Usage +** This file contains pre-release code and may not be distributed. +** You may use this file in accordance with the terms and conditions +** contained in the Technology Preview License Agreement accompanying +** this package. +** +** GNU Lesser General Public License Usage +** Alternatively, this file may be used under the terms of the GNU Lesser +** General Public License version 2.1 as published by the Free Software +** Foundation and appearing in the file LICENSE.LGPL included in the +** packaging of this file. Please review the following information to +** ensure the GNU Lesser General Public License version 2.1 requirements +** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. +** +** In addition, as a special exception, Nokia gives you certain additional +** rights. These rights are described in the Nokia Qt LGPL Exception +** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. +** +** If you have questions regarding the use of this file, please contact +** Nokia at qt-info@nokia.com. +** +** +** +** +** +** +** +** +** $QT_END_LICENSE$ +** +****************************************************************************/ +//![0] +import Qt 4.7 + +Rectangle { + width: 200; height: 100 + + VisualDataModel { + id: visualModel + model: ListModel { + ListElement { name: "Apple" } + ListElement { name: "Orange" } + } + delegate: Rectangle { + height: 25 + width: 100 + Text { text: "Name: " + name} + } + } + + ListView { + anchors.fill: parent + model: visualModel + } +} +//![0] diff --git a/doc/src/snippets/declarative/visualdatamodel_rootindex/main.cpp b/doc/src/snippets/declarative/visualdatamodel_rootindex/main.cpp new file mode 100644 index 0000000..174adee --- /dev/null +++ b/doc/src/snippets/declarative/visualdatamodel_rootindex/main.cpp @@ -0,0 +1,63 @@ +/**************************************************************************** +** +** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies). +** All rights reserved. +** Contact: Nokia Corporation (qt-info@nokia.com) +** +** This file is part of the QtDeclarative module of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:LGPL$ +** No Commercial Usage +** This file contains pre-release code and may not be distributed. +** You may use this file in accordance with the terms and conditions +** contained in the Technology Preview License Agreement accompanying +** this package. +** +** GNU Lesser General Public License Usage +** Alternatively, this file may be used under the terms of the GNU Lesser +** General Public License version 2.1 as published by the Free Software +** Foundation and appearing in the file LICENSE.LGPL included in the +** packaging of this file. Please review the following information to +** ensure the GNU Lesser General Public License version 2.1 requirements +** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. +** +** In addition, as a special exception, Nokia gives you certain additional +** rights. These rights are described in the Nokia Qt LGPL Exception +** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. +** +** If you have questions regarding the use of this file, please contact +** Nokia at qt-info@nokia.com. +** +** +** +** +** +** +** +** +** $QT_END_LICENSE$ +** +****************************************************************************/ +#include <QDeclarativeView> +#include <QDeclarativeContext> + +#include <QApplication> +#include <QDirModel> + +//![0] +int main(int argc, char ** argv) +{ + QApplication app(argc, argv); + + QDeclarativeView view; + + QDirModel model; + view.rootContext()->setContextProperty("dirModel", &model); + + view.setSource(QUrl::fromLocalFile("view.qml")); + view.show(); + + return app.exec(); +} +//![0] + diff --git a/doc/src/snippets/declarative/visualdatamodel_rootindex/view.qml b/doc/src/snippets/declarative/visualdatamodel_rootindex/view.qml new file mode 100644 index 0000000..e623faa --- /dev/null +++ b/doc/src/snippets/declarative/visualdatamodel_rootindex/view.qml @@ -0,0 +1,66 @@ +/**************************************************************************** +** +** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies). +** All rights reserved. +** Contact: Nokia Corporation (qt-info@nokia.com) +** +** This file is part of the QtDeclarative module of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:LGPL$ +** No Commercial Usage +** This file contains pre-release code and may not be distributed. +** You may use this file in accordance with the terms and conditions +** contained in the Technology Preview License Agreement accompanying +** this package. +** +** GNU Lesser General Public License Usage +** Alternatively, this file may be used under the terms of the GNU Lesser +** General Public License version 2.1 as published by the Free Software +** Foundation and appearing in the file LICENSE.LGPL included in the +** packaging of this file. Please review the following information to +** ensure the GNU Lesser General Public License version 2.1 requirements +** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. +** +** In addition, as a special exception, Nokia gives you certain additional +** rights. These rights are described in the Nokia Qt LGPL Exception +** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. +** +** If you have questions regarding the use of this file, please contact +** Nokia at qt-info@nokia.com. +** +** +** +** +** +** +** +** +** $QT_END_LICENSE$ +** +****************************************************************************/ +//![0] +import Qt 4.7 + +ListView { + id: view + width: 300 + height: 400 + + model: VisualDataModel { + model: dirModel + + delegate: Rectangle { + width: 200; height: 25 + Text { text: filePath } + + MouseArea { + anchors.fill: parent + onClicked: { + if (hasModelChildren) + view.model.rootIndex = view.model.modelIndex(index) + } + } + } + } +} +//![0] diff --git a/doc/src/snippets/declarative/visualdatamodel_rootindex/visualdatamodel_rootindex.pro b/doc/src/snippets/declarative/visualdatamodel_rootindex/visualdatamodel_rootindex.pro new file mode 100644 index 0000000..fec070c --- /dev/null +++ b/doc/src/snippets/declarative/visualdatamodel_rootindex/visualdatamodel_rootindex.pro @@ -0,0 +1,4 @@ +TEMPLATE = app +QT += gui declarative + +SOURCES += main.cpp |