HG_REPOSITORIES/LPP/INSTRUMENTATION/USERS/JEANDET/qtcharts Commit - r331:711d530eb260

Refactor documentation...

Michal Klocek -

r331:711d530eb260

parent child

Context file:

r331:711d530eb260

Expand all files

doc/qcharts.qdocconf +6 -8

             include(compat.qdocconf)
             include(macros.qdocconf)
-            include(qt-html-templates.qdocconf)
+            include(qchart-html-template.qdocconf)
             project = QtCommercialCharts
             description = Library for creating charts
                          ./src
             headerdirs = ../src \
                          ../example
-            exampledirs = ../src \
+            exampledirs = ../ \
-                          ../example
+                          ../src \
+                          ../example
-            HTML.templatedir = .
-            HTML.stylesheets = style/offline.css
+            excludefiles += ../example/linechart/linechart.pro
-            HTML.headerstyles= "<link rel=\"stylesheet\" type=\"text/css\" href=\"style/offline.css\" />\n"
-            HTML.nobreadcrumbs = true
             sources.fileextensions = *.cpp *.qdoc *.mm *.qml
             headers.fileextensions = *.h *.ch *.h++ *.hh *.hpp *.hxx

doc/src/index.qdoc +8 -47

@@ -1,51 +1,12
1	/*!	1	/*!
2	\page index.html	2	\page index.html
3	\title ~~QtCommercial~~ Charts	3	\title About QCharts
4	\keyword A~~ll Classes~~	4	\keyword About
5		5
6	TODO: restructure the document	6	\raw HTML
7		7	<div class="qchart">
8	QtCommercial Charts introduction...	8	<img src="images/qt_commercial_logo.png" alt="qtcommercial"/>
9	For example, to create a chart with line series using a widget based application:	9	<p>QCharts is a part of Qt Commercial addons package.</p>
10	\snippet ../example/chartview/main.cpp 1	10	</div>
11	\image chartview_example.jpg
12
13	Showing a few more series:
14	\snippet ../example/chartview/main.cpp 3
15	\image chartview_example_pie.jpg
16	\snippet ../example/chartview/main.cpp 4
17	\image chartview_example_scatter.jpg
18	\snippet ../example/chartview/main.cpp 5
19	\image chartview_example_bar.jpg
20
21	If you need to give a more professional touch to your chart you can switch to one of the
22	pre-defined themes:
23	\snippet ../example/chartview/main.cpp 2
24	\image chartview_example_theme.jpg
25
26	\raw HTML
27	<table cellpadding="2" cellspacing="1" border="0" width="100%" class="indextable">
28	<tr>
29	<th class="titleheader" width="33%">
30	List of classes
31	</th>
32	</tr>
33	<tr>
34	<td valign="top">
35	<ul>
36	<li><a href="qchart.html">QChart</a></li>
37	<li><a href="qchartview.html">QChartView</a></li>
38	<li><a href="qchartseries.html">QChartSeries</a></li>
39	<li><a href="qlinechartseries.html">QLineChartSeries</a></li>
40	<li><a href="qpieseries.html">QPieSeries</a></li>
41	<li><a href="qbarchartseries.html">QBarChartSeries</a></li>
42	<li><a href="qstackedbarchartseries.html">QStackedBarChartSeries</a></li>
43	<li><a href="qpercentbarchartseries.html">QPercentBarChartSeries</a></li>
44	<li><a href="qscatterseries.html">QScatterSeries</a></li>
45	</ul>
46	</td>
47	</tr>
48	</table>
49	\endraw	11	\endraw
50
51	*/	12	*/

doc/style/offline.css +30 -8

             @media screen
             {
+                .qchart img
+                {
+                 float:left;
+                }
             /* basic elements */
                 html
                 {
                 {
                     color: #00732F;
                     font-weight: bold;
-                    font-size: 130%;
+                    font-size: 100%;
+                 	text-align: center;
                 }
                 .header .content
                 {
-                    margin-bottom: 0.5em
+                  /*  margin-bottom: 0.5em*/
                 }
+                .header .content img
+                {
+                    display: block;
+            	margin-left: auto;
+            	margin-right: auto;
+            	width: 100px;
+                }
                 .naviNextPrevious
                 {
                     display: none
                 }
                 .header .breadcrumb
                 {
-                    font-size: 90%;
+                    font-size: 100%;
                     padding: 0.5em 0 0.5em 1em;
                     margin: 0;
-                    background-color: #fafafa;
+                    /*background-color: #393735;*/
-                    height: 1.35em;
+            	font-weight: bold;
+            	background: #ffffff url(../images/bg.png) repeat-x;
+                    height: 20px;
                     border-bottom: 1px solid #d1d1d1;
                 }
                 .header .breadcrumb ul li
                 {
                     float: left;
-                    background: url(../images/breadcrumb.png) no-repeat 0 3px;
+                    /*background: url(../images/breadcrumb.png) no-repeat 0 3px;*/
                     padding-left: 1.5em;
                     margin-left: 1.5em;
                 }
                 .header .breadcrumb ul li a
                 {
-                    color: #00732F;
+            	color: #ffffff;
                 }
+               .header .breadcrumb ul li a:hover
+                {
+            	 color: #00732F;
+                     text-decoration: none;
+                }
                 .header .breadcrumb ul li.first
                 {
                     background-image: none;
                 .content .toc h3 {
                     border-bottom: 0px;
-                    margin-top: 0px;
+                    margin-top: 10px;
                 }
                 .content .toc h3 a:hover {

example/linechart/main.cpp +20 -10

             QTCOMMERCIALCHART_USE_NAMESPACE
-            #define PI 3.14159265358979
             int main(int argc, char *argv[])
             {
                 QApplication a(argc, argv);
                 QMainWindow window;
+            //![1]
                 QLineChartSeries* series0 = new QLineChartSeries();
                 QPen blue(Qt::blue);
                 blue.setWidth(3);
                 series0->setPen(blue);
                 QLineChartSeries* series1 = new QLineChartSeries();
                 QPen red(Qt::red);
                 red.setWidth(3);
                 series1->setPen(red);
+            //![1]
-                int numPoints = 100;
+            //![2]
-                for (int x = 0; x <= numPoints; ++x) {
+                series0->add(0, 6);
-                	  series0->add(x, fabs(sin(PI/50*x)*100));
+                series0->add(2, 4);
-                	  series1->add(x, fabs(cos(PI/50*x)*100));
+                series0->add(3, 8);
+                series0->add(7, 4);
+                series0->add(10,5);
+                series1->add(1, 1);
+                series1->add(3, 3);
+                series1->add(7, 6);
+                series1->add(8, 3);
+                series1->add(10,2);
+            //![2]
+            //![3]
                 QChartView* chartView =  new QChartView(&window);
                 chartView->setRenderHint(QPainter::Antialiasing);
                 chartView->setChartTitle("Basic line chart example");
                 chartView->addSeries(series0);
                 chartView->addSeries(series1);
+            //![3]
                 window.setCentralWidget(chartView);
                 window.resize(400, 300);

src/linechart/qlinechartseries.cpp +112 -5

@@ -2,15 +2,75
2		2
3	QTCOMMERCIALCHART_BEGIN_NAMESPACE	3	QTCOMMERCIALCHART_BEGIN_NAMESPACE
4		4
		5	/*!
		6	\class QLineChartSeries
		7	\brief The QLineChartSeries class is used for making line charts.
		8
		9	\mainclass
		10
		11	A line chart is used to show information as a series of data points
		12	connected by straight lines.
		13
		14	\image linechart.png
		15
		16	To create line charts, users need to first QLineChartSeries object.
		17
		18	\snippet ../example/linechart/main.cpp 1
		19
		20	Populate with the data
		21
		22	\snippet ../example/linechart/main.cpp 2
		23
		24	Add created series objects to QChartView or QChart instance.
		25
		26	\snippet ../example/linechart/main.cpp 3
		27
		28	*/
		29
		30	/*!
		31	\fn virtual QChartSeriesType QLineChartSeries::type() const
		32	\brief Returns type of series.
		33	\sa QChartSeries, QChartSeriesType
		34	*/
		35
		36	/*!
		37	\fn QPen QLineChartSeries::pen() const
		38	\brief Returns the pen used to draw line for this series.
		39	\sa setPen()
		40	*/
		41
		42	/*!
		43	\fn bool isPointsVisible() const
		44	\brief Returns if the points are drawn for this series.
		45	\sa setPointsVisible()
		46	*/
		47
		48
		49	/*!
		50	\fn void QLineChartSeries::changed(int index)
		51	\brief \internal \a index
		52	*/
		53
		54	/*!
		55	Constructs empty series object which is a child of \a parent.
		56	When series object is added to QChartView or QChart instance ownerships is transfered.
		57	*/
5	QLineChartSeries::QLineChartSeries(QObject* parent):QChartSeries(parent),	58	QLineChartSeries::QLineChartSeries(QObject* parent):QChartSeries(parent),
6	m_pointsVisible(false)	59	m_pointsVisible(false)
7	{	60	{
8	}	61	}
9		62	/*!
		63	Destroys the object. Series added to QChartView or QChart instances are owned by those,
		64	and are deleted when mentioned object are destroyed.
		65	*/
10	QLineChartSeries::~QLineChartSeries()	66	QLineChartSeries::~QLineChartSeries()
11	{	67	{
12	}	68	}
13		69
		70	/*!
		71	Adds data point \a x \a y to the series. Points are connected with lines on the chart.
		72	Function returns index, which can be used to modify data.
		73	*/
14	int QLineChartSeries::add(qreal x,qreal y)	74	int QLineChartSeries::add(qreal x,qreal y)
15	{	75	{
16	m_x<<x;	76	m_x<<x;
@@ -18,6 +78,21 int QLineChartSeries::add(qreal x,qreal y)
18	return m_x.size()-1;	78	return m_x.size()-1;
19	}	79	}
20		80
		81	/*!
		82	This is an overloaded function.
		83	Adds data \a point to the series. Points are connected with lines on the chart.
		84	Function returns index, which can be used to modify data.
		85	*/
		86	int QLineChartSeries::add(const QPointF& point)
		87	{
		88	m_x<<point.x();
		89	m_y<<point.y();
		90	return m_x.size()-1;
		91	}
		92
		93	/*!
		94	Modifies data within \a index, sets new \a x and \a y values.
		95	*/
21	void QLineChartSeries::set(int index,qreal x,qreal y)	96	void QLineChartSeries::set(int index,qreal x,qreal y)
22	{	97	{
23	m_x[index]=x;	98	m_x[index]=x;
@@ -25,22 +100,46 void QLineChartSeries::set(int index,qreal x,qreal y)
25	emit changed(index);	100	emit changed(index);
26	}	101	}
27		102
		103	/*!
		104	This is an overloaded function.
		105	Modifies data within \a index, sets new \a point value.
		106	*/
		107	void QLineChartSeries::set(int index,const QPointF& point)
		108	{
		109	m_x[index]=point.x();
		110	m_y[index]=point.y();
		111	emit changed(index);
		112	}
		113
		114
		115	/*!
		116	Clears all the data.
		117	*/
28	void QLineChartSeries::clear()	118	void QLineChartSeries::clear()
29	{	119	{
30	m_x.clear();	120	m_x.clear();
31	m_y.clear();	121	m_y.clear();
32	}	122	}
33		123
		124	/*!
		125	\internal \a pos
		126	*/
34	qreal QLineChartSeries::x(int pos) const	127	qreal QLineChartSeries::x(int pos) const
35	{	128	{
36	return m_x.at(pos);	129	return m_x.at(pos);
37	}	130	}
38		131
		132	/*!
		133	\internal \a pos
		134	*/
39	qreal QLineChartSeries::y(int pos) const	135	qreal QLineChartSeries::y(int pos) const
40	{	136	{
41	return m_y.at(pos);	137	return m_y.at(pos);
42	}	138	}
43		139
		140	/*!
		141	Returns number of data points within series.
		142	*/
44	int QLineChartSeries::count() const	143	int QLineChartSeries::count() const
45	{	144	{
46	Q_ASSERT(m_x.size() == m_y.size());	145	Q_ASSERT(m_x.size() == m_y.size());
@@ -49,11 +148,22 int QLineChartSeries::count() const
49		148
50	}	149	}
51		150
		151	/*!
		152	Sets \a pen used for drawing given series..
		153	*/
52	void QLineChartSeries::setPen(const QPen& pen)	154	void QLineChartSeries::setPen(const QPen& pen)
53	{	155	{
54	m_pen=pen;	156	m_pen=pen;
55	}	157	}
56		158
		159	/*!
		160	Sets if data points are \a visible and should be drawn on line.
		161	*/
		162	void QLineChartSeries::setPointsVisible(bool visible)
		163	{
		164	m_pointsVisible=visible;
		165	}
		166
57	QDebug operator<< (QDebug debug, const QLineChartSeries series)	167	QDebug operator<< (QDebug debug, const QLineChartSeries series)
58	{	168	{
59	Q_ASSERT(series.m_x.size() == series.m_y.size());	169	Q_ASSERT(series.m_x.size() == series.m_y.size());
@@ -66,10 +176,7 QDebug operator<< (QDebug debug, const QLineChartSeries series)
66	return debug.space();	176	return debug.space();
67	}	177	}
68		178
69	void QLineChartSeries::setPointsVisible(bool visible)	179
70	{
71	m_pointsVisible=visible;
72	}
73	#include "moc_qlinechartseries.cpp"	180	#include "moc_qlinechartseries.cpp"
74		181
75	QTCOMMERCIALCHART_END_NAMESPACE	182	QTCOMMERCIALCHART_END_NAMESPACE

src/linechart/qlinechartseries.h +3 -1

             public: // from QChartSeries
                 virtual QChartSeriesType type() const { return QChartSeries::SeriesTypeLine;}
                 int add(qreal x, qreal y);
+                int add(const QPointF& point);
                 void set(int index,qreal x,qreal y);
+                void set(int index,const QPointF& point);
                 void clear();
                 void setPen(const QPen& pen);
-                const QPen& pen() const { return m_pen;}
+                QPen pen() const { return m_pen;}
                 void setPointsVisible(bool visible);
                 bool isPointsVisible() const {return m_pointsVisible;}

src/qchartaxis.cpp +142 0

             QTCOMMERCIALCHART_BEGIN_NAMESPACE
+            /*!
+                \class QChartAxis
+                \brief The QChartAxis class is used for manipulating chart's axis
+                and for adding optional axes to the chart.
+                \mainclass
+                There is only one x Axis, however there can be multiple y axes.
+                Each chart series can be bound to exactly one Y axis and the share common X axis.
+                Axis can be setup to show axis line with ticks, gird lines and shades.
+            */
+            /*!
+               \fn QPen QChartAxis::axisPen() const
+               \brief  Returns pen used to draw axis and ticks.
+                \sa setAxisPen()
+            */
+            /*!
+               \fn QPen QChartAxis::gridPen() const
+               \brief  Returns pen used to draw grid.
+                \sa setGridPen()
+            */
+            /*!
+               \fn QPen QChartAxis::labelsPen() const
+               \brief  Returns the pen used to labels.
+                \sa setLabelsPen()
+            */
+            /*!
+               \fn QBrush QChartAxis::labelsBrush() const
+               \brief  Returns brush used to draw labels.
+                \sa setLabelsBrush()
+            */
+            /*!
+               \fn QFont QChartAxis::labelsFont() const
+               \brief  Returns font used to draw labels.
+                \sa setLabelsFont()
+            */
+            /*!
+               \fn QFont QChartAxis::labelsAngle() const
+               \brief  Returns angle used to draw labels.
+                \sa setLabelsAngle()
+            */
+            /*!
+               \fn QPen QChartAxis::shadesPen() const
+               \brief  Returns pen used to draw shades.
+                \sa setShadesPen()
+            */
+            /*!
+               \fn QBrush QChartAxis::shadesBrush() const
+               \brief  Returns brush used to draw shades.
+                \sa setShadesBrush()
+            */
+            /*!
+                \fn void QChartAxis::update(QChartAxis*)
+                \brief \internal
+            */
+            /*!
+                \fn void QChartAxis::ticksChanged(QChartAxis*)
+                \brief \internal
+            */
+            /*!
+                Constructs new axis object which is a child of \a parent. Ownership is taken by
+                QChatView or QChart when axis added.
+            */
             QChartAxis::QChartAxis(QObject* parent):QObject(parent),
             m_axisVisible(true),
             m_gridVisible(true),
             }
+            /*!
+                Destructor of the axis object. When axis is added to chart, chart object takes ownership.
+            */
             QChartAxis::~QChartAxis()
             {
             }
+            /*!
+              Sets \a pen used to draw axis line and ticks.
+             */
             void QChartAxis::setAxisPen(const QPen& pen)
             {
                 m_axisPen=pen;
                 emit update(this);
             }
+            /*!
+              Sets if axis and ticks are \a visible.
+             */
             void QChartAxis::setAxisVisible(bool visible)
             {
                 m_axisVisible=visible;
                 emit update(this);
             }
+            /*!
+              Sets if grid is \a visible.
+             */
             void QChartAxis::setGridVisible(bool visible)
             {
                 m_gridVisible=visible;
                 emit update(this);
             }
+            /*!
+              Sets \a pen used to draw grid.
+             */
             void QChartAxis::setGridPen(const QPen& pen)
             {
                 m_gridPen=pen;
                 emit update(this);
             }
+            /*!
+              Sets if axis' labels are \a visible.
+             */
             void QChartAxis::setLabelsVisible(bool visible)
             {
                 m_labelsVisible=visible;
                 emit update(this);
             }
+            /*!
+              Sets \a pen used to draw labels.
+             */
             void QChartAxis::setLabelsPen(const QPen& pen)
             {
                 m_labelsPen=pen;
                 emit update(this);
             }
+            /*!
+              Sets \a brush used to draw labels.
+             */
             void QChartAxis::setLabelsBrush(const QBrush& brush)
             {
                 m_labelsBrush=brush;
                 emit update(this);
             }
+            /*!
+              Sets \a font used to draw labels.
+             */
             void QChartAxis::setLabelsFont(const QFont& font)
             {
                 m_labelsFont=font;
                 emit update(this);
             }
+            /*!
+              Sets \a angle for all the labels on given axis.
+             */
             void QChartAxis::setLabelsAngle(int angle)
             {
             	m_labelsAngle=angle;
             	 emit update(this);
             }
+            /*!
+              Sets if shades are \a visible.
+             */
             void QChartAxis::setShadesVisible(bool visible)
             {
                 m_shadesVisible=visible;
                 emit update(this);
             }
+            /*!
+              Sets \a pen used to draw shades.
+             */
             void QChartAxis::setShadesPen(const QPen& pen)
             {
                 m_shadesPen=pen;
                 emit update(this);
             }
+            /*!
+              Sets \a brush used to draw shades.
+             */
             void QChartAxis::setShadesBrush(const QBrush& brush)
             {
                 m_shadesBrush=brush;
                 emit update(this);
             }
+            /*!
+              Sets \a opacity of the shades.
+             */
             void QChartAxis::setShadesOpacity(qreal opacity)
             {
                 m_shadesOpacity=opacity;
                 emit update(this);
             }
+            /*!
+              Sets \a min value on the axis.
+             */
             void QChartAxis::setMin(qreal min)
             {
             	if(m_min!=min){
             	}
             }
+            /*!
+              Sets \a max value on the axis.
+             */
             void QChartAxis::setMax(qreal max)
             {
             	if(m_max!=max){
             	}
             }
+            /*!
+              Sets range from \a min to \a max on the axis.
+             */
             void QChartAxis::setRange(qreal min, qreal max)
             {
             	setMin(min);
             	setMax(max);
             }
+            /*!
+              Sets \a count for ticks on the axis.
+             */
             void QChartAxis::setTicksCount(int count)
             {
             	m_ticksCount=count;
             	emit ticksChanged(this);
             }
+            /*!
+              TODO: refactor me. Sets string \a label for \a value on the axis.
+             */
             void QChartAxis::addAxisTickLabel(qreal value,const QString& label)
             {
             	m_ticks.insert(value,label);
             	emit ticksChanged(this);
             }
+            /*!
+              TODO: refactor me. Removes label for \a value on the axis.
+             */
             void QChartAxis::removeAxisTickLabel(qreal value)
             {
             	m_ticks.remove(value);
             	emit ticksChanged(this);
             }
+            /*!
+              TODO: refactor me. Returns label for \a value on the axis.
+             */
             QString QChartAxis::axisTickLabel(qreal value) const
             {
             	return m_ticks.value(value);
             }
+            /*!
+              TODO: refactor me. Removes all the string labels for on the axis.
+             */
             void QChartAxis::clearAxisTickLabels()
             {
             	m_ticks.clear();

src/qchartaxis.h +1 -3

                 void setAxisVisible(bool visible);
                 void setAxisPen(const QPen& pen);
                 QPen axisPen() const { return m_axisPen;};
-                void setAxisBrush(const QBrush& brush);
-                QBrush axisBrush() const { return m_axisBrush;};
                 //grid handling
                 bool isGridVisible() const { return m_gridVisible;};
                 void setLabelsBrush(const QBrush& brush);
                 QBrush labelsBrush() const { return m_labelsBrush;}
                 void setLabelsFont(const QFont& font);
-                QFont labelFont() const { return m_labelsFont;}
+                QFont labelsFont() const { return m_labelsFont;}
                 void setLabelsAngle(int angle);
                 int labelsAngle() const { return m_labelsAngle;};

doc/images/bg_l.png removed binary 0 0