src/gui/painting/qstylepainter.cpp
changeset 0 1918ee327afb
child 4 3b1da2848fc7
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/gui/painting/qstylepainter.cpp	Mon Jan 11 14:00:40 2010 +0000
@@ -0,0 +1,176 @@
+/****************************************************************************
+**
+** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
+** All rights reserved.
+** Contact: Nokia Corporation (qt-info@nokia.com)
+**
+** This file is part of the QtGui 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 "qstylepainter.h"
+
+QT_BEGIN_NAMESPACE
+
+/*!
+    \class QStylePainter
+
+    \brief The QStylePainter class is a convenience class for drawing QStyle
+    elements inside a widget.
+
+    \ingroup appearance
+    \ingroup painting
+
+    QStylePainter extends QPainter with a set of high-level \c
+    draw...() functions implemented on top of QStyle's API. The
+    advantage of using QStylePainter is that the parameter lists get
+    considerably shorter. Whereas a QStyle object must be able to
+    draw on any widget using any painter (because the application
+    normally has one QStyle object shared by all widget), a
+    QStylePainter is initialized with a widget, eliminating the need
+    to specify the QWidget, the QPainter, and the QStyle for every
+    function call.
+
+    Example using QStyle directly:
+
+    \snippet doc/src/snippets/styles/styles.cpp 1
+
+    Example using QStylePainter:
+
+    \snippet doc/src/snippets/styles/styles.cpp 0
+    \snippet doc/src/snippets/styles/styles.cpp 4
+    \snippet doc/src/snippets/styles/styles.cpp 6
+
+    \sa QStyle, QStyleOption
+*/
+
+/*!
+    \fn QStylePainter::QStylePainter()
+
+    Constructs a QStylePainter.
+*/
+
+/*!
+    \fn QStylePainter::QStylePainter(QWidget *widget)
+
+    Construct a QStylePainter using widget \a widget for its paint device.
+*/
+
+/*!
+    \fn QStylePainter::QStylePainter(QPaintDevice *pd, QWidget *widget)
+
+    Construct a QStylePainter using \a pd for its paint device, and
+    attributes from \a widget.
+*/
+
+
+/*!
+    \fn bool QStylePainter::begin(QWidget *widget)
+
+    Begin painting operations on the specified \a widget.
+    Returns true if the painter is ready to use; otherwise returns false.
+
+    This is automatically called by the constructor that takes a QWidget.
+*/
+
+/*!
+    \fn bool QStylePainter::begin(QPaintDevice *pd, QWidget *widget)
+    \overload
+
+    Begin painting operations on paint device \a pd as if it was \a
+    widget.
+
+    This is automatically called by the constructor that
+    takes a QPaintDevice and a QWidget.
+*/
+
+
+/*!
+    \fn void QStylePainter::drawPrimitive(QStyle::PrimitiveElement pe, const QStyleOption &option)
+
+    Use the widget's style to draw a primitive element \a pe specified by QStyleOption \a option.
+
+    \sa QStyle::drawPrimitive()
+*/
+
+/*!
+    \fn void QStylePainter::drawControl(QStyle::ControlElement ce, const QStyleOption &option)
+
+    Use the widget's style to draw a control element \a ce specified by QStyleOption \a option.
+
+    \sa QStyle::drawControl()
+*/
+
+/*!
+  \fn void QStylePainter::drawComplexControl(QStyle::ComplexControl cc,
+                                             const QStyleOptionComplex &option)
+
+    Use the widget's style to draw a complex control \a cc specified by the
+    QStyleOptionComplex \a option.
+
+    \sa QStyle::drawComplexControl()
+*/
+
+/*!
+    \fn void QStylePainter::drawItemText(const QRect &rect, int flags, const QPalette &pal,
+                                         bool enabled, const QString &text,
+                                         QPalette::ColorRole textRole = QPalette::NoRole)
+
+    Draws the \a text in rectangle \a rect and palette \a pal.
+    The text is aligned and wrapped according to \a
+    flags.
+
+    The pen color is specified with \a textRole. The \a enabled bool
+    indicates whether or not the item is enabled; when reimplementing
+    this bool should influence how the item is drawn.
+
+    \sa QStyle::drawItemText(), Qt::Alignment
+*/
+
+/*!
+    \fn void QStylePainter::drawItemPixmap(const QRect &rect, int flags, const QPixmap &pixmap)
+
+    Draws the \a pixmap in rectangle \a rect.
+    The pixmap is aligned according to \a flags.
+
+    \sa QStyle::drawItemPixmap(), Qt::Alignment
+*/
+
+/*!
+    \fn QStyle *QStylePainter::style() const
+
+    Return the current style used by the QStylePainter.
+*/
+
+QT_END_NAMESPACE