From 47799adc0d1bfb9e0e592dbc9af3eb4680e0c81b Mon Sep 17 00:00:00 2001 From: Casper van Donderen Date: Wed, 9 May 2012 12:35:30 +0200 Subject: Doc: Move some remaining files over for modularization. The files in this change were still in qtbase/doc/src or required for it. qtbase/doc/src should now only contain example documentation and images for the example documentation. Change-Id: Ia7ca8e7fd2b316e77c706a08df71303bc8294213 Reviewed-by: Marius Storm-Olsen --- src/gui/doc/images/qrect-diagram-zero.png | Bin 0 -> 5198 bytes src/gui/doc/images/qrectf-diagram-one.png | Bin 0 -> 9594 bytes src/gui/doc/images/qrectf-diagram-three.png | Bin 0 -> 9392 bytes src/gui/doc/images/qrectf-diagram-two.png | Bin 0 -> 9387 bytes src/gui/doc/snippets/code/doc_src_coordsys.cpp | 87 +++++++++++++++++++++++++ src/gui/doc/src/coordsys.qdoc | 20 +++--- src/gui/kernel/qkeysequence.cpp | 38 +++++------ src/gui/text/qabstracttextdocumentlayout.cpp | 2 +- 8 files changed, 117 insertions(+), 30 deletions(-) create mode 100644 src/gui/doc/images/qrect-diagram-zero.png create mode 100644 src/gui/doc/images/qrectf-diagram-one.png create mode 100644 src/gui/doc/images/qrectf-diagram-three.png create mode 100644 src/gui/doc/images/qrectf-diagram-two.png create mode 100644 src/gui/doc/snippets/code/doc_src_coordsys.cpp (limited to 'src/gui') diff --git a/src/gui/doc/images/qrect-diagram-zero.png b/src/gui/doc/images/qrect-diagram-zero.png new file mode 100644 index 0000000000..90e3db0c41 Binary files /dev/null and b/src/gui/doc/images/qrect-diagram-zero.png differ diff --git a/src/gui/doc/images/qrectf-diagram-one.png b/src/gui/doc/images/qrectf-diagram-one.png new file mode 100644 index 0000000000..842289ce07 Binary files /dev/null and b/src/gui/doc/images/qrectf-diagram-one.png differ diff --git a/src/gui/doc/images/qrectf-diagram-three.png b/src/gui/doc/images/qrectf-diagram-three.png new file mode 100644 index 0000000000..e05106a7e1 Binary files /dev/null and b/src/gui/doc/images/qrectf-diagram-three.png differ diff --git a/src/gui/doc/images/qrectf-diagram-two.png b/src/gui/doc/images/qrectf-diagram-two.png new file mode 100644 index 0000000000..192d00df79 Binary files /dev/null and b/src/gui/doc/images/qrectf-diagram-two.png differ diff --git a/src/gui/doc/snippets/code/doc_src_coordsys.cpp b/src/gui/doc/snippets/code/doc_src_coordsys.cpp new file mode 100644 index 0000000000..b677d28a50 --- /dev/null +++ b/src/gui/doc/snippets/code/doc_src_coordsys.cpp @@ -0,0 +1,87 @@ +/**************************************************************************** +** +** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies). +** Contact: http://www.qt-project.org/ +** +** This file is part of the documentation of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:BSD$ +** You may use this file under the terms of the BSD license as follows: +** +** "Redistribution and use in source and binary forms, with or without +** modification, are permitted provided that the following conditions are +** met: +** * Redistributions of source code must retain the above copyright +** notice, this list of conditions and the following disclaimer. +** * Redistributions in binary form must reproduce the above copyright +** notice, this list of conditions and the following disclaimer in +** the documentation and/or other materials provided with the +** distribution. +** * Neither the name of Nokia Corporation and its Subsidiary(-ies) nor +** the names of its contributors may be used to endorse or promote +** products derived from this software without specific prior written +** permission. +** +** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE." +** +** $QT_END_LICENSE$ +** +****************************************************************************/ + +//! [0] +QPainter painter(this); + +painter.setPen(Qt::darkGreen); +painter.drawRect(1, 2, 6, 4); +//! [0] + + +//! [1] +QPainter painter(this); + +painter.setPen(Qt::darkGreen); +painter.drawLine(2, 7, 6, 1); +//! [1] + + +//! [2] +QPainter painter(this); +painter.setRenderHint( + QPainter::Antialiasing); +painter.setPen(Qt::darkGreen); +painter.drawRect(1, 2, 6, 4); +//! [2] + + +//! [3] +QPainter painter(this); +painter.setRenderHint( + QPainter::Antialiasing); +painter.setPen(Qt::darkGreen); +painter.drawLine(2, 7, 6, 1); +//! [3] + + +//! [4] +QPainter painter(this); +painter.setWindow(QRect(-50, -50, 100, 100)); +//! [4] + + +//! [5] +int side = qMin(width(), height()) +int x = (width() - side / 2); +int y = (height() - side / 2); + +painter.setViewport(x, y, side, side); +//! [5] diff --git a/src/gui/doc/src/coordsys.qdoc b/src/gui/doc/src/coordsys.qdoc index 655dbf7cf3..bfa046f7fb 100644 --- a/src/gui/doc/src/coordsys.qdoc +++ b/src/gui/doc/src/coordsys.qdoc @@ -97,10 +97,10 @@ \row \li - \snippet doc/src/snippets/code/doc_src_coordsys.cpp 0 + \snippet code/doc_src_coordsys.cpp 0 \li - \snippet doc/src/snippets/code/doc_src_coordsys.cpp 1 + \snippet code/doc_src_coordsys.cpp 1 \endtable When rendering with a pen with an even number of pixels, the @@ -163,10 +163,10 @@ \row \li - \snippet doc/src/snippets/code/doc_src_coordsys.cpp 2 + \snippet code/doc_src_coordsys.cpp 2 \li - \snippet doc/src/snippets/code/doc_src_coordsys.cpp 3 + \snippet code/doc_src_coordsys.cpp 3 \endtable \section1 Transformations @@ -238,7 +238,7 @@ \row \li {2,1} - \snippet examples/widgets/analogclock/analogclock.cpp 9 + \snippet widgets/analogclock/analogclock.cpp 9 First, we set up the painter. We translate the coordinate system so that point (0, 0) is in the widget's center, instead of being @@ -253,7 +253,7 @@ See also the \l {Window-Viewport Conversion} section. - \snippet examples/widgets/analogclock/analogclock.cpp 18 + \snippet widgets/analogclock/analogclock.cpp 18 We draw the clock's hour hand by rotating the coordinate system and calling QPainter::drawConvexPolygon(). Thank's to the @@ -268,14 +268,14 @@ the code guarantees that the code that follows won't be disturbed by the transformations we've used. - \snippet examples/widgets/analogclock/analogclock.cpp 24 + \snippet widgets/analogclock/analogclock.cpp 24 We do the same for the clock's minute hand, which is defined by the four points (1, 0), (0, 1), (-1, 0), and (0, -40). These coordinates specify a hand that is thinner and longer than the minute hand. - \snippet examples/widgets/analogclock/analogclock.cpp 27 + \snippet widgets/analogclock/analogclock.cpp 27 Finally, we draw the clock face, which consists of twelve short lines at 30-degree intervals. At the end of that, the painter is @@ -319,7 +319,7 @@ -50) to (50, 50) with (0, 0) in the center by calling the QPainter::setWindow() function: - \snippet doc/src/snippets/code/doc_src_coordsys.cpp 4 + \snippet code/doc_src_coordsys.cpp 4 Now, the logical coordinates (-50,-50) correspond to the paint device's physical coordinates (0, 0). Independent of the paint @@ -333,7 +333,7 @@ viewport and "window" maintain the same aspect ratio to prevent deformation: - \snippet doc/src/snippets/code/doc_src_coordsys.cpp 5 + \snippet code/doc_src_coordsys.cpp 5 If we make the logical coordinate system a square, we should also make the viewport a square using the QPainter::setViewport() diff --git a/src/gui/kernel/qkeysequence.cpp b/src/gui/kernel/qkeysequence.cpp index 635e3dadca..d03294f246 100644 --- a/src/gui/kernel/qkeysequence.cpp +++ b/src/gui/kernel/qkeysequence.cpp @@ -177,7 +177,7 @@ void Q_GUI_EXPORT qt_set_sequence_auto_mnemonic(bool b) { qt_sequence_no_mnemoni more modifiers, such as Qt::SHIFT, Qt::CTRL, Qt::ALT and Qt::META. \endlist - For example, \gui{Ctrl P} might be a sequence used as a shortcut for + For example, \uicontrol{Ctrl P} might be a sequence used as a shortcut for printing a document, and can be specified in any of the following ways: @@ -185,8 +185,8 @@ void Q_GUI_EXPORT qt_set_sequence_auto_mnemonic(bool b) { qt_sequence_no_mnemoni Note that, for letters, the case used in the specification string does not matter. In the above examples, the user does not need to - hold down the \key{Shift} key to activate a shortcut specified - with "Ctrl+P". However, for other keys, the use of \key{Shift} as + hold down the \uicontrol{Shift} key to activate a shortcut specified + with "Ctrl+P". However, for other keys, the use of \uicontrol{Shift} as an unspecified extra modifier key can lead to confusion for users of an application whose keyboards have different layouts to those used by the developers. See the \l{Keyboard Layout Issues} section @@ -207,9 +207,9 @@ void Q_GUI_EXPORT qt_set_sequence_auto_mnemonic(bool b) { qt_sequence_no_mnemoni as Qt::Key_A. \b{Note:} On Mac OS X, references to "Ctrl", Qt::CTRL, Qt::Control - and Qt::ControlModifier correspond to the \key Command keys on the + and Qt::ControlModifier correspond to the \uicontrol Command keys on the Macintosh keyboard, and references to "Meta", Qt::META, Qt::Meta and - Qt::MetaModifier correspond to the \key Control keys. Developers on + Qt::MetaModifier correspond to the \uicontrol Control keys. Developers on Mac OS X can use the same shortcut descriptions across all platforms, and their applications will automatically work as expected on Mac OS X. @@ -220,9 +220,9 @@ void Q_GUI_EXPORT qt_set_sequence_auto_mnemonic(bool b) { qt_sequence_no_mnemoni setting up actions in a typical application. The table below shows some common key sequences that are often used for these standard shortcuts by applications on four widely-used platforms. Note - that on Mac OS X, the \key Ctrl value corresponds to the \key - Command keys on the Macintosh keyboard, and the \key Meta value - corresponds to the \key Control keys. + that on Mac OS X, the \uicontrol Ctrl value corresponds to the \uicontrol + Command keys on the Macintosh keyboard, and the \uicontrol Meta value + corresponds to the \uicontrol Control keys. \table \header \li StandardKey \li Windows \li Mac OS X \li KDE \li GNOME @@ -302,23 +302,23 @@ void Q_GUI_EXPORT qt_set_sequence_auto_mnemonic(bool b) { qt_sequence_no_mnemoni Many key sequence specifications are chosen by developers based on the layout of certain types of keyboard, rather than choosing keys that - represent the first letter of an action's name, such as \key{Ctrl S} - ("Ctrl+S") or \key{Ctrl C} ("Ctrl+C"). + represent the first letter of an action's name, such as \uicontrol{Ctrl S} + ("Ctrl+S") or \uicontrol{Ctrl C} ("Ctrl+C"). Additionally, because certain symbols can only be entered with the help of modifier keys on certain keyboard layouts, key sequences intended for use with one keyboard layout may map to a different key, map to no keys at all, or require an additional modifier key to be used on different keyboard layouts. - For example, the shortcuts, \key{Ctrl plus} and \key{Ctrl minus}, are often + For example, the shortcuts, \uicontrol{Ctrl plus} and \uicontrol{Ctrl minus}, are often used as shortcuts for zoom operations in graphics applications, and these may be specified as "Ctrl++" and "Ctrl+-" respectively. However, the way these shortcuts are specified and interpreted depends on the keyboard layout. - Users of Norwegian keyboards will note that the \key{+} and \key{-} keys + Users of Norwegian keyboards will note that the \uicontrol{+} and \uicontrol{-} keys are not adjacent on the keyboard, but will still be able to activate both - shortcuts without needing to press the \key{Shift} key. However, users - with British keyboards will need to hold down the \key{Shift} key - to enter the \key{+} symbol, making the shortcut effectively the same as + shortcuts without needing to press the \uicontrol{Shift} key. However, users + with British keyboards will need to hold down the \uicontrol{Shift} key + to enter the \uicontrol{+} symbol, making the shortcut effectively the same as "Ctrl+Shift+=". Although some developers might resort to fully specifying all the modifiers @@ -327,9 +327,9 @@ void Q_GUI_EXPORT qt_set_sequence_auto_mnemonic(bool b) { qt_sequence_no_mnemoni For example, a developer using a British keyboard may decide to specify "Ctrl+Shift+=" as the key sequence in order to create a shortcut that - coincidentally behaves in the same way as \key{Ctrl plus}. However, the - \key{=} key needs to be accessed using the \key{Shift} key on Norwegian - keyboard, making the required shortcut effectively \key{Ctrl Shift Shift =} + coincidentally behaves in the same way as \uicontrol{Ctrl plus}. However, the + \uicontrol{=} key needs to be accessed using the \uicontrol{Shift} key on Norwegian + keyboard, making the required shortcut effectively \uicontrol{Ctrl Shift Shift =} (an impossible key combination). As a result, both human-readable strings and hard-coded key codes @@ -351,7 +351,7 @@ void Q_GUI_EXPORT qt_set_sequence_auto_mnemonic(bool b) { qt_sequence_no_mnemoni key codes, can be created by using the multiple argument constructor, or by passing a human-readable string of comma-separated key sequences. - For example, the key sequence, \key{Ctrl X} followed by \key{Ctrl C}, can + For example, the key sequence, \uicontrol{Ctrl X} followed by \uicontrol{Ctrl C}, can be specified using either of the following ways: \snippet code/src_gui_kernel_qkeysequence.cpp 1 diff --git a/src/gui/text/qabstracttextdocumentlayout.cpp b/src/gui/text/qabstracttextdocumentlayout.cpp index e14cfe0f82..45903f678c 100644 --- a/src/gui/text/qabstracttextdocumentlayout.cpp +++ b/src/gui/text/qabstracttextdocumentlayout.cpp @@ -120,7 +120,7 @@ QT_BEGIN_NAMESPACE and QTextObjectInterface. QObject must be the first class inherited. For instance: - \snippet examples/richtext/textobject/svgtextobject.h 1 + \snippet richtext/textobject/svgtextobject.h 1 The data of a text object is usually stored in the QTextCharFormat using QTextCharFormat::setProperty(), and then retrieved with -- cgit v1.2.3