HG_REPOSITORIES/LPP/INSTRUMENTATION/USERS/JEANDET/qtcharts Commit - r1443:08af46f754b9

Began documenting the QML api

Tero Ahola -

r1443:08af46f754b9

parent child

Context file:

r1443:08af46f754b9

Collapse all files

doc/src/qml.qdoc created 644 +14 0

@@ -0,0 +1,14
	1	/*!
	2	\page qml.html
	3	\title QtCommercial Charts QML API
	4	\keyword Charts QML API
	5
	6	Charts QML API is an intuitive and simple way to use QtCommercial Charts in your QML applications.
	7
	8	\raw HTML
	9	<ul>
	10	<li><a href="qml-chartview.html">ChartView</a></li>
	11	<li><a href="qml-pieseries.html">PieSeries</a></li>
	12	</ul>
	13	\endraw
	14	*/

doc/qchart-html-template.qdocconf +1 0

             include(qchart-html.qdocconf)
             HTML.postheader = \
                 "<div class=\"header\" id=\"qtdocheader\">\n" \
                 "  <div class=\"content\"> \n" \
                 "    <img src=\"images/qcharts.png\" alt=\"qcharts\"/>\n" \
                 "    <p class=\"qtref\"> \n" \
                 "       <span>Reference Documentation</span>\n" \
                 "    </p>\n" \
                 "  </div>\n" \
                 "  <div class=\"breadcrumb toolblock\">\n" \
                 "    <ul>\n" \
                 "      <li class=\"first\"><a href=\"index.html\">About</a></li>\n" \
                 "      <li><a href=\"introduction.html\">Getting started</a></li>\n" \
                 "      <li><a href=\"classes.html\">API Classes</a></li>\n" \
+                "      <li><a href=\"qml.html\">QML API</a></li>\n" \
                 "      <li><a href=\"examples.html\">Examples</a></li>\n" \
                 "      <li><a href=\"demos.html\">Demos</a></li>\n" \
                 "      <!--  Breadcrumbs go here -->\n"
             HTML.postpostheader = \
                 "    </ul>\n" \
                 "  </div>\n" \
                 "</div>\n" \
                 "<div class=\"content mainContent\">\n"
             HTML.footer = \
                 "  <div class=\"ft\">\n" \
                 "    <span></span>\n" \
                 "  </div>\n" \
                 "</div> \n" \
                 "<div class=\"footer\">\n" \
                 "  <p>\n" \
                 "     <acronym title=\"Copyright\">&copy;</acronym> 2012 Digia ." \
                 "     Qt and Qt logos are trademarks of of Nokia Corporation \n" \
                 "     in Finland and/or other countries worldwide.</p>\n" \
                 "  <p>\n" \
                 "     All other trademarks are property of their respective owners.</p>\n" \
                 "  <br />\n" \
                 "  <p>\n" \
                 "    Licensees holding valid Qt Commercial licenses may use this document in accordance with the" \
                 "    Qt Commercial License Agreement provided with the Software or, alternatively, in accordance" \
                 "    with the terms contained in a written agreement between you and Digia.</p>\n" \
                 "  <p>\n" \
                 "     <img src=\"images/digia_logo.png\" alt=\"digia\" /></p>\n" \
                 "</div>\n" \
             # Files not referenced in any qdoc file.
             # See also extraimages.HTML
             qhp.QDoc.extraFiles = index.html \
                                   images/arrow_down.png \
                                   images/breadcrumb.png \
                                   images/bullet_gt.png \
                                   images/bullet_dn.png \
                                   images/bullet_sq.png \
                                   images/bullet_up.png \
                                   images/horBar.png \
                                   images/qcharts.png \
                                   style/offline.css

doc/qcharts.qdocconf +5 -3

             include(compat.qdocconf)
             include(macros.qdocconf)
             include(qchart-html-template.qdocconf)
             project = QtCommercialCharts
             description = Library for creating charts
             sourcedirs = ../src \
                          ../examples \
-                         ./src
+                         ./src \
+                         ../plugins/declarative
             headerdirs = ../src \
-                         ../examples
+                         ../examples \
+                         ../plugins/declarative
             exampledirs = ../ \
                           ../src \
                           ../examples
             excludefiles += ../examples/linechart/linechart.pro
             sources.fileextensions = *.cpp *.qdoc *.mm *.qml
             headers.fileextensions = *.h *.ch *.h++ *.hh *.hpp *.hxx
             examples.fileextensions = *.cpp *.h *.js *.xq *.svg *.xml *.ui *.qhp *.qhcp *.qml
             examples.imageextensions = *.png *.jpeg *.jpg *.gif *.mng
             imagedirs = ./images
             outputdir = ./html
             Cpp.ignoretokens        = QTCOMMERCIALCHART_EXPORT \
                                       QTCOMMERCIALCHART_END_NAMESPACE \
                                       QTCOMMERCIALCHART_BEGIN_NAMESPACE
             Cpp.ignoredirectives    = Q_DECLARE_HANDLE \
                                       Q_DECLARE_INTERFACE \
                                       Q_DECLARE_METATYPE \
                                       Q_DECLARE_OPERATORS_FOR_FLAGS \
                                       Q_DECLARE_PRIVATE \
                                       Q_DECLARE_PUBLIC \
                                       Q_DECLARE_SHARED \
                                       Q_DECLARE_TR_FUNCTIONS \
                                       Q_DECLARE_TYPEINFO \
                                       Q_DISABLE_COPY \
                                       QT_FORWARD_DECLARE_CLASS \
                                       Q_DUMMY_COMPARISON_OPERATOR \
                                       Q_ENUMS \
                                       Q_FLAGS \
                                       Q_INTERFACES \
-                                      __attribute__
  No newline at end of file
+                                      __attribute__

plugins/declarative/declarativechart.cpp +13 0

             /****************************************************************************
             **
             ** Copyright (C) 2012 Digia Plc
             ** All rights reserved.
             ** For any questions to Digia, please use contact form at http://qt.digia.com
             **
             ** This file is part of the Qt Commercial Charts Add-on.
             **
             ** $QT_BEGIN_LICENSE$
             ** Licensees holding valid Qt Commercial licenses may use this file in
             ** accordance with the Qt Commercial License Agreement provided with the
             ** Software or, alternatively, in accordance with the terms contained in
             ** a written agreement between you and Digia.
             **
             ** If you have questions regarding the use of this file, please use
             ** contact form at http://qt.digia.com
             ** $QT_END_LICENSE$
             **
             ****************************************************************************/
             #include "declarativechart.h"
             #include <QPainter>
             #include "declarativelineseries.h"
             #include "declarativeareaseries.h"
             #include "declarativebarseries.h"
             #include "declarativepieseries.h"
             #include "declarativesplineseries.h"
             #include "declarativescatterseries.h"
             QTCOMMERCIALCHART_BEGIN_NAMESPACE
+            /*!
+                \qmlclass ChartView DeclarativeChart
+                ChartView element is the parent that is responsible for showing different chart series types.
+                \section1 Example Usage
+                \beginfloatleft
+                \image demos_qmlchart1.png
+                \endfloat
+                \clearfloat
+            */
             DeclarativeChart::DeclarativeChart(QDeclarativeItem *parent)
                 : QDeclarativeItem(parent),
                   m_chart(new QChart(this))
             {
                 setFlag(QGraphicsItem::ItemHasNoContents, false);
             //    m_chart->axisX()->setNiceNumbersEnabled(false);
             }
             DeclarativeChart::~DeclarativeChart()
             {
                 delete m_chart;
             }
             void DeclarativeChart::childEvent(QChildEvent *event)
             {
                 if (event->type() == QEvent::ChildAdded) {
                     if (qobject_cast<QAbstractSeries *>(event->child())) {
                         m_chart->addSeries(qobject_cast<QAbstractSeries *>(event->child()));
                     }
                 }
             }
             void DeclarativeChart::componentComplete()
             {
             //    qDebug() << "DeclarativeChart::componentComplete(), maxX: " << axisX()->max();
                 foreach(QObject *child, children()) {
                     if (qobject_cast<QAbstractSeries *>(child)) {
             //            qDebug() << "DeclarativeChart::componentComplete(), add: " << child;
                         m_chart->addSeries(qobject_cast<QAbstractSeries *>(child));
                     }
                 }
             //    qDebug() << "DeclarativeChart::componentComplete(), maxX: " << axisX()->max();
                 QDeclarativeItem::componentComplete();
             }
             void DeclarativeChart::geometryChanged(const QRectF &newGeometry, const QRectF &oldGeometry)
             {
             //    qDebug() << "DeclarativeChart::geometryChanged" << newGeometry.width() << newGeometry.height();
                 if (newGeometry.isValid()) {
                     if (newGeometry.width() > 0 && newGeometry.height() > 0) {
                         m_chart->resize(newGeometry.width(), newGeometry.height());
                     }
                 }
                 QDeclarativeItem::geometryChanged(newGeometry, oldGeometry);
             }
             void DeclarativeChart::paint(QPainter *painter, const QStyleOptionGraphicsItem *option, QWidget *widget)
             {
                 Q_UNUSED(option)
                 Q_UNUSED(widget)
                 // TODO: optimized?
                 painter->setRenderHint(QPainter::Antialiasing, true);
             }
             void DeclarativeChart::setTheme(DeclarativeChart::Theme theme)
             {
                 QChart::ChartTheme chartTheme = (QChart::ChartTheme) theme;
                 if (chartTheme != m_chart->theme()) {
                     m_chart->setTheme(chartTheme);
                     themeChanged();
                 }
             }
             DeclarativeChart::Theme DeclarativeChart::theme()
             {
                 return (DeclarativeChart::Theme) m_chart->theme();
             }
             void DeclarativeChart::setAnimationOptions(DeclarativeChart::Animation animations)
             {
                 QChart::AnimationOption animationOptions = (QChart::AnimationOption) animations;
                 if (animationOptions != m_chart->animationOptions()) {
                     m_chart->setAnimationOptions(animationOptions);
                     animationOptionsChanged();
                 }
             }
             DeclarativeChart::Animation DeclarativeChart::animationOptions()
             {
                 if (m_chart->animationOptions().testFlag(QChart::AllAnimations))
                     return DeclarativeChart::AllAnimations;
                 else if (m_chart->animationOptions().testFlag(QChart::GridAxisAnimations))
                     return DeclarativeChart::GridAxisAnimations;
                 else if (m_chart->animationOptions().testFlag(QChart::SeriesAnimations))
                     return DeclarativeChart::SeriesAnimations;
                 else
                     return DeclarativeChart::NoAnimation;
             }
             void DeclarativeChart::setTitle(QString title)
             {
                 if (title != m_chart->title()) {
                     m_chart->setTitle(title);
                     emit titleChanged();
                 }
             }
             QString DeclarativeChart::title()
             {
                 return m_chart->title();
             }
             QAxis *DeclarativeChart::axisX()
             {
                 return m_chart->axisX();
             }
             QAxis *DeclarativeChart::axisY()
             {
                 return m_chart->axisY();
             }
             QLegend *DeclarativeChart::legend()
             {
                 return m_chart->legend();
             }
             QVariantList DeclarativeChart::axisXLabels()
             {
                 QVariantList labels;
                 foreach (qreal value, m_chart->axisX()->categories()->values()) {
                     labels.append(value);
                     labels.append(m_chart->axisX()->categories()->label(value));
                 }
                 return labels;
             }
             void DeclarativeChart::setAxisXLabels(QVariantList list)
             {
                 QVariant value(QVariant::Invalid);
                 foreach (QVariant element, list) {
                     if (value.isValid() && element.type() == QVariant::String) {
                         m_chart->axisX()->categories()->insert(value.toDouble(), element.toString());
                         value = QVariant(QVariant::Invalid);
                     } else {
                         if (element.canConvert(QVariant::Double))
                             value = element;
                     }
                 }
                 emit axisLabelsChanged();
             }
             void DeclarativeChart::setTitleColor(QColor color)
             {
                 QBrush b = m_chart->titleBrush();
                 if (color != b.color()) {
                     b.setColor(color);
                     m_chart->setTitleBrush(b);
                     emit titleColorChanged();
                 }
             }
             QColor DeclarativeChart::titleColor()
             {
                 return m_chart->titleBrush().color();
             }
             void DeclarativeChart::setBackgroundColor(QColor color)
             {
                 QBrush b = m_chart->backgroundBrush();
                 if (color != b.color()) {
                     b.setColor(color);
                     m_chart->setBackgroundBrush(b);
                     emit backgroundColorChanged();
                 }
             }
             QColor DeclarativeChart::backgroundColor()
             {
                 return m_chart->backgroundBrush().color();
             }
             int DeclarativeChart::count()
             {
                 return m_chart->series().count();
             }
             QAbstractSeries *DeclarativeChart::series(int index)
             {
                 if (index < m_chart->series().count()) {
                     return m_chart->series().at(index);
                 }
                 return 0;
             }
             QAbstractSeries *DeclarativeChart::series(QString seriesName)
             {
                 foreach(QAbstractSeries *series, m_chart->series()) {
                     if (series->name() == seriesName)
                         return series;
                 }
                 return 0;
             }
             QAbstractSeries *DeclarativeChart::createSeries(DeclarativeChart::SeriesType type, QString name)
             {
                 QAbstractSeries *series = 0;
                 switch (type) {
                 case DeclarativeChart::SeriesTypeLine:
                     series = new DeclarativeLineSeries();
                     break;
                 case DeclarativeChart::SeriesTypeArea:
                     series = new DeclarativeAreaSeries();
                     break;
                 case DeclarativeChart::SeriesTypeBar:
                     series = new DeclarativeBarSeries();
                     break;
                 case DeclarativeChart::SeriesTypeStackedBar:
                     // TODO
                     break;
                 case DeclarativeChart::SeriesTypePercentBar:
                     // TODO
                     break;
                 case DeclarativeChart::SeriesTypeGroupedBar:
                     series = new DeclarativeGroupedBarSeries();
                     break;
                 case DeclarativeChart::SeriesTypePie:
                     series = new DeclarativePieSeries();
                     break;
                 case DeclarativeChart::SeriesTypeScatter:
                     series = new DeclarativeScatterSeries();
                     break;
                 case DeclarativeChart::SeriesTypeSpline:
                     series = new DeclarativeSplineSeries();
                     break;
                 default:
                     qWarning() << "Illegal series type";
                 }
                 series->setName(name);
                 m_chart->addSeries(series);
                 return series;
             }
             #include "moc_declarativechart.cpp"
             QTCOMMERCIALCHART_END_NAMESPACE

plugins/declarative/declarativepieseries.cpp +47 0

             /****************************************************************************
             **
             ** Copyright (C) 2012 Digia Plc
             ** All rights reserved.
             ** For any questions to Digia, please use contact form at http://qt.digia.com
             **
             ** This file is part of the Qt Commercial Charts Add-on.
             **
             ** $QT_BEGIN_LICENSE$
             ** Licensees holding valid Qt Commercial licenses may use this file in
             ** accordance with the Qt Commercial License Agreement provided with the
             ** Software or, alternatively, in accordance with the terms contained in
             ** a written agreement between you and Digia.
             **
             ** If you have questions regarding the use of this file, please use
             ** contact form at http://qt.digia.com
             ** $QT_END_LICENSE$
             **
             ****************************************************************************/
             #include "declarativepieseries.h"
             #include "declarativechart.h"
             #include "qchart.h"
             #include <qdeclarativelist.h>
             #include <QVPieModelMapper>
             #include <QHPieModelMapper>
             QTCOMMERCIALCHART_BEGIN_NAMESPACE
+            /*!
+                \qmlclass PieSeries DeclarativePieSeries
+                \section1 Example Usage
+                \beginfloatleft
+                \image demos_qmlchart1.png
+                \endfloat
+                \clearfloat
+                The following QML shows how to create a simple pie chart.
+                \snippet ../demos/qmlchart/qml/qmlchart/View1.qml 1
+            */
+            /*!
+                \qmlproperty real PieSeries::horizontalPosition
+                \brief Defines the horizontal position of the pie.
+                The value is a relative value to the chart rectangle where:
+                \list
+                \o 0.0 is the absolute left.
+                \o 1.0 is the absolute right.
+                \endlist
+                Default value is 0.5 (center).
+                \sa verticalPosition
+            */
+            /*!
+                \qmlproperty real PieSeries::verticalPosition
+                \brief Defines the vertical position of the pie.
+                The value is a relative value to the chart rectangle where:
+                \list
+                \o 0.0 is the absolute top.
+                \o 1.0 is the absolute bottom.
+                \endlist
+                Default value is 0.5 (center).
+                \sa horizontalPosition
+            */
             DeclarativePieSeries::DeclarativePieSeries(QObject *parent) :
                 QPieSeries(parent)
             {
             }
             void DeclarativePieSeries::classBegin()
             {
             }
             void DeclarativePieSeries::componentComplete()
             {
                 foreach(QObject *child, children()) {
                     if (qobject_cast<QPieSlice *>(child)) {
                         QPieSeries::append(qobject_cast<QPieSlice *>(child));
                     } else if(qobject_cast<QVPieModelMapper *>(child)) {
                         QVPieModelMapper *mapper = qobject_cast<QVPieModelMapper *>(child);
                         mapper->setSeries(this);
                     } else if(qobject_cast<QHPieModelMapper *>(child)) {
                         QHPieModelMapper *mapper = qobject_cast<QHPieModelMapper *>(child);
                         mapper->setSeries(this);
                     }
                 }
             }
             QDeclarativeListProperty<QObject> DeclarativePieSeries::seriesChildren()
             {
                 return QDeclarativeListProperty<QObject>(this, 0, &DeclarativePieSeries::appendSeriesChildren);
             }
             void DeclarativePieSeries::appendSeriesChildren(QDeclarativeListProperty<QObject> * list, QObject *element)
             {
                 // Empty implementation; the children are parsed in componentComplete instead
                 Q_UNUSED(list);
                 Q_UNUSED(element);
             }
             QPieSlice *DeclarativePieSeries::at(int index)
             {
                 QList<QPieSlice*> sliceList = slices();
                 if (index < sliceList.count())
                     return sliceList[index];
                 return 0;
             }
             QPieSlice* DeclarativePieSeries::find(QString label)
             {
                 foreach (QPieSlice *slice, slices()) {
                     if (slice->label() == label)
                         return slice;
                 }
                 return 0;
             }
             QPieSlice* DeclarativePieSeries::append(QString label, qreal value)
             {
                 // TODO: parameter order is wrong, switch it:
                 QPieSlice *slice = new QPieSlice(this);
                 slice->setLabel(label);
                 slice->setValue(value);
                 QPieSeries::append(slice);
                 return slice;
             }
             #include "moc_declarativepieseries.cpp"
             QTCOMMERCIALCHART_END_NAMESPACE

General Comments 0

Write
Preview

You need to be logged in to leave comments. Login now

No TODOs yet

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages