Merge branch 'master' into contiguouscache

3 files changed, 182 insertions, 20 deletions

diff --git a/doc/src/examples/basicgraphicslayouts.qdoc b/doc/src/examples/basicgraphicslayouts.qdoc
index 92571af..9696fb6 100644
--- a/doc/src/examples/basicgraphicslayouts.qdoc
+++ b/doc/src/examples/basicgraphicslayouts.qdoc
@@ -45,6 +45,7 @@
 
     The Basic Graphics Layouts example shows how to use the layout classes
     in QGraphicsView: QGraphicsLinearLayout and QGraphicsGridLayout.
+    In addition to that it shows how to write your own custom layout item.
 
     \image basicgraphicslayouts-example.png Screenshot of the Basic Layouts Example
 
@@ -115,26 +116,24 @@
 
     \section1 LayoutItem Class Definition
 
-    The \c LayoutItem class is a subclass of QGraphicsWidget. It has a
-    constructor, a destructor, and a reimplementation of the
-    {QGraphicsItem::paint()}{paint()} function.
+    The \c LayoutItem class is a subclass of QGraphicsLayoutItem and
+    QGraphicsItem. It has a constructor, a destructor, and some required
+    reimplementations.
+    Since it inherits QGraphicsLayoutItem it must reimplement
+    {QGraphicsLayoutItem::setGeometry()}{setGeometry()} and
+    {QGraphicsLayoutItem::sizeHint()}{sizeHint()}.
+    In addition to that it inherits QGraphicsItem, so it must reimplement
+    {QGraphicsItem::boundingRect()}{boundingRect()} and
+    {QGraphicsItem::paint()}{paint()}.
 
     \snippet examples/graphicsview/basicgraphicslayouts/layoutitem.h 0
 
-    The \c LayoutItem class also has a private instance of QPixmap, \c pix.
-
-    \note We subclass QGraphicsWidget so that \c LayoutItem objects can
-    be automatically plugged into a layout, as QGraphicsWidget is a
-    specialization of QGraphicsLayoutItem.
+    The \c LayoutItem class also has a private instance of QPixmap, \c m_pix.
 
     \section1 LayoutItem Class Implementation
 
-    In \c{LayoutItem}'s constructor, \c pix is instantiated and the
-    \c{QT_original_R.png} image is loaded into it. We set the size of
-    \c LayoutItem to be slightly larger than the size of the pixmap as we
-    require some space around it for borders that we will paint later.
-    Alternatively, you could scale the pixmap to prevent the item from
-    becoming smaller than the pixmap.
+    In \c{LayoutItem}'s constructor, \c m_pix is instantiated and the
+    \c{block.png} image is loaded into it.
 
     \snippet examples/graphicsview/basicgraphicslayouts/layoutitem.cpp 0
 
@@ -148,4 +147,32 @@
 
     \snippet examples/graphicsview/basicgraphicslayouts/layoutitem.cpp 2
 
+    The reimplementation of {QGraphicsItem::boundingRect()}{boundingRect()}
+    will set the top left corner at (0,0), and the size of it will be
+    the size of the layout items
+    {QGraphicsLayoutItem::geometry()}{geometry()}. This is the area that
+    we paint within.
+
+    \snippet examples/graphicsview/basicgraphicslayouts/layoutitem.cpp 3
+
+
+    The reimplementation of {QGraphicsLayoutItem::setGeometry()}{setGeometry()}
+    simply calls its baseclass implementation. However, since this will change
+    the boundingRect we must also call
+    {QGraphicsItem::prepareGeometryChange()}{prepareGeometryChange()}.
+    Finally, we move the item according to \c geom.topLeft().
+
+    \snippet examples/graphicsview/basicgraphicslayouts/layoutitem.cpp 4
+
+
+    Since we don't want the size of the item to be smaller than the pixmap, we
+    must make sure that we return a size hint that is larger than \c m_pix.
+    We also add some extra space around for borders that we will paint later.
+    Alternatively, you could scale the pixmap to prevent the item from
+    becoming smaller than the pixmap.
+    The preferred size is the same as the minimum size hint, while we set
+    maximum to be a large value
+
+    \snippet examples/graphicsview/basicgraphicslayouts/layoutitem.cpp 5
+
 */
\ No newline at end of file
diff --git a/doc/src/examples/extension.qdoc b/doc/src/examples/extension.qdoc
index 8a0ca3a..02e0698 100644
--- a/doc/src/examples/extension.qdoc
+++ b/doc/src/examples/extension.qdoc
@@ -80,9 +80,9 @@
     user type a word to search for, we need several  \l
     {QCheckBox}{QCheckBox}es to facilitate the search options, and we
     need three \l {QPushButton}{QPushButton}s: the \gui Find button to
-    start a search, the \gui More button to enable an advanced search,
-    and the \gui Close button to exit the application. Finally, we
-    need a QWidget representing the application's extension part.
+    start a search and the \gui More button to enable an advanced search.
+    Finally, we need a QWidget representing the application's extension
+    part.
 
     \section1 FindDialog Class Implementation
 
@@ -128,8 +128,7 @@
     the connection makes sure that the extension widget is shown
     depending on the state of \gui More button.
 
-    We also connect the \gui Close button to the QWidget::close()
-    slot, and we put the checkboxes associated with the advanced
+    We also put the check boxes associated with the advanced
     search options into a layout we install on the extension widget.
 
     \snippet examples/dialogs/extension/finddialog.cpp 4
@@ -137,7 +136,7 @@
     Before we create the main layout, we create several child layouts
     for the widgets: First we allign the QLabel ans its buddy, the
     QLineEdit, using a QHBoxLayout. Then we vertically allign the
-    QLabel and QLineEdit with the checkboxes associated with the
+    QLabel and QLineEdit with the check boxes associated with the
     simple search, using a QVBoxLayout. We also create a QVBoxLayout
     for the buttons. In the end we lay out the two latter layouts and
     the extension widget using a QGridLayout.
diff --git a/doc/src/examples/svggenerator.qdoc b/doc/src/examples/svggenerator.qdoc
new file mode 100644
index 0000000..32bb89a
--- /dev/null
+++ b/doc/src/examples/svggenerator.qdoc
@@ -0,0 +1,136 @@
+/****************************************************************************
+**
+** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
+** Contact: Qt Software Information (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 either Technology Preview License Agreement or the
+** Beta Release License Agreement.
+**
+** 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.0, included in the file LGPL_EXCEPTION.txt in this
+** package.
+**
+** GNU General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU
+** General Public License version 3.0 as published by the Free Software
+** Foundation and appearing in the file LICENSE.GPL included in the
+** packaging of this file.  Please review the following information to
+** ensure the GNU General Public License version 3.0 requirements will be
+** met: http://www.gnu.org/copyleft/gpl.html.
+**
+** If you are unsure which license is appropriate for your use, please
+** contact the sales department at qt-sales@nokia.com.
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+    \example painting/svggenerator
+    \title SVG Generator Example
+
+    The SVG Generator example shows how to add SVG file export to applications.
+
+    \image svggenerator-example.png
+
+    Scalable Vector Graphics (SVG) is an XML-based language for describing
+    two-dimensional vector graphics. Qt provides classes for rendering and
+    generating SVG drawings. This example allows the user to create a simple
+    picture and save it to an SVG file.
+
+    The example consists of two classes: \c Window and \c DisplayWidget.
+
+    The \c Window class contains the application logic and constructs the user
+    interface from a Qt Designer \c{.ui} file as described in the
+    \l{Using a Designer .ui File in Your Application#The Multiple Inheritance Approach}{Qt Designer manual}.
+    It also contains the code to write an SVG file.
+
+    The \c DisplayWidget class performs all the work of painting a picture on
+    screen. Since we want the SVG to resemble this picture as closely as
+    possible, we make this code available to the \c Window class so that it can
+    be used to generate SVG files.
+
+    \section1 The DisplayWidget Class
+
+    The \c DisplayWidget class displays a drawing consisting of a selection of
+    elements chosen by the user. These are defined using \c Shape and
+    \c Background enums that are included within the class definition:
+
+    \snippet examples/painting/svggenerator/displaywidget.h DisplayWidget class definition
+
+    Much of this class is used to configure the appearance of the drawing. The
+    \c paintEvent() and \c paint() functions are most relevant to the purpose
+    of this example, so we will describe these here and leave the reader to
+    look at the source code for the example to see how shapes and colors are
+    handled.
+
+    We reimplement the QWidget::paintEvent() function to display the drawing
+    on screen:
+
+    \snippet examples/painting/svggenerator/displaywidget.cpp paint event
+
+    Here, we only construct a QPainter object, begin painting on the device
+    and set a render hint for improved output quality before calling the
+    \c paint() function to perform the painting itself. When this returns,
+    we close the painter and return.
+
+    The \c paint() function is designed to be used for different painting
+    tasks. In this example, we use it to draw on a \c DisplayWidget instance
+    and on a QSvgGenerator object. We show how the painting is performed to
+    demonstrate that there is nothing device-specific about the process:
+
+    \snippet examples/painting/svggenerator/displaywidget.cpp paint function
+
+    \section1 The Window Class
+
+    The \c Window class represents the example's window, containing the user
+    interface, which has been created using Qt Designer:
+
+    \snippet examples/painting/svggenerator/window.h Window class definition
+
+    As with the \c DisplayWidget class, we concentrate on the parts of the code
+    which are concerned with painting and SVG generation. In the \c Window
+    class, the \c saveSvg() function is called whenever the \gui{Save As...}
+    button is clicked; this connection was defined in the \c{window.ui} file
+    using Qt Designer.
+
+    The start of the \c saveSvg() function performs the task of showing a file
+    dialog so that the user can specify a SVG file to save the drawing to.
+    
+    \snippet examples/painting/svggenerator/window.cpp save SVG
+
+    In the rest of the function, we set up the generator and configure it to
+    generate output with the appropriate dimensions and write to the
+    user-specified file. We paint on the QSvgGenerator object in the same way
+    that we paint on a widget, calling the \c DisplayWidget::paint() function
+    so that we use exactly the same code that we used to display the drawing.
+
+    The generation process itself begins with the call to the painter's
+    \l{QPainter::}{begin()} function and ends with call to its
+    \l{QPainter::}{end()} function. The QSvgGenerator paint device relies on
+    the explicit use of these functions to ensure that output is written to
+    the file.
+
+    \section1 Further Reading
+
+    The \l{SVG Viewer Example} shows how to display SVG drawings in an
+    application, and can be used to show the contents of SVG files created
+    by this example.
+
+    See the QtSvg module documentation for more information about SVG and Qt's
+    SVG classes.
+*/