HG_REPOSITORIES/LPP/INSTRUMENTATION/USERS/JEANDET/qtcharts Commit - r1361:4519c43323f7

Docs update for BarSeries and BarSet

Marek Rosa -

r1361:4519c43323f7

parent child

Context file:

r1361:4519c43323f7

Collapse all files

src/barchart/qbarseries.cpp +47 -1

@@ -47,6 +47,24 QTCOMMERCIALCHART_BEGIN_NAMESPACE
47	*/	47	*/
48		48
49	/*!	49	/*!
		50	\property QBarSeries::barMargin
		51	\brief Defines the margin around bars.
		52
		53	Value is from 0 to 1 and represents
		54	percentage of margin compared to bars
		55	*/
		56
		57	/*!
		58	\property QBarSeries::count
		59	\brief Holds the number of sets in series.
		60	*/
		61
		62	/*!
		63	\property QBarSeries::labelsVisible
		64	\brief Defines the visibility of the labels in series
		65	*/
		66
		67	/*!
50	\fn void QBarSeries::clicked(QBarSet *barset, int index)	68	\fn void QBarSeries::clicked(QBarSet *barset, int index)
51		69
52	The signal is emitted if the user clicks with a mouse on top of QBarSet \a barset.	70	The signal is emitted if the user clicks with a mouse on top of QBarSet \a barset.
@@ -62,6 +80,34 QTCOMMERCIALCHART_BEGIN_NAMESPACE
62	*/	80	*/
63		81
64	/*!	82	/*!
		83	\fn void QBarSeries::visibleChanged()
		84	*/
		85
		86	/*!
		87	\fn void QBarSeries::labelsVisibleChanged()
		88
		89	This signal is emitted when labels visibility have changed.
		90
		91	\sa labelsVisible(), setLabelsVisible()
		92	*/
		93
		94	/*!
		95	\fn void QBarSeries::barsetsAdded(QList<QBarSet*> sets)
		96
		97	This signal is emitted when \a sets have been added to the series.
		98
		99	\sa append(), insert()
		100	*/
		101
		102	/*!
		103	\fn void QBarSeries::barsetsRemoved(QList<QBarSet*> sets)
		104
		105	This signal is emitted when \a sets have been removed from the series.
		106
		107	\sa remove()
		108	*/
		109
		110	/*!
65	Constructs empty QBarSeries.	111	Constructs empty QBarSeries.
66	QBarSeries is QObject which is a child of a \a parent.	112	QBarSeries is QObject which is a child of a \a parent.
67	*/	113	*/
@@ -220,7 +266,7 void QBarSeries::setLabelsVisible(bool visible)
220	/*!	266	/*!
221	Returns the visibility of labels	267	Returns the visibility of labels
222	*/	268	*/
223	bool QBarSeries::~~isL~~abelsVisible() const	269	bool QBarSeries::labelsVisible() const
224	{	270	{
225	Q_D(const QBarSeries);	271	Q_D(const QBarSeries);
226	return d->m_labelsVisible;	272	return d->m_labelsVisible;

src/barchart/qbarseries.h +2 -2

                 Q_OBJECT
                 Q_PROPERTY(qreal barMargin READ barMargin WRITE setBarMargin)
                 Q_PROPERTY(int count READ barsetCount)
-                Q_PROPERTY(bool labelsVisible READ isLabelsVisible WRITE setLabelsVisible)
+                Q_PROPERTY(bool labelsVisible READ labelsVisible WRITE setLabelsVisible)
             public:
                 explicit QBarSeries(QObject *parent = 0);
                 void clear();
                 void setLabelsVisible(bool visible = true);
-                bool isLabelsVisible() const;
+                bool labelsVisible() const;
             protected:
                 explicit QBarSeries(QBarSeriesPrivate &d,QObject *parent = 0);

src/barchart/qbarset.cpp +104 -2

@@ -38,6 +38,107 QTCOMMERCIALCHART_BEGIN_NAMESPACE
38	*/	38	*/
39		39
40	/*!	40	/*!
		41	\property QBarSet::name
		42	\brief Defines the name of the barSet.
		43	*/
		44
		45	/*!
		46	\property QBarSet::pen
		47	\brief Defines the pen used by the barSet.
		48	*/
		49
		50	/*!
		51	\property QBarSet::brush
		52	\brief Defines the brush used by the barSet.
		53	*/
		54
		55	/*!
		56	\property QBarSet::labelBrush
		57	\brief Defines the brush used by the barSet's label.
		58	*/
		59
		60	/*!
		61	\property QBarSet::labelFont
		62	\brief Defines the font used by the barSet's label.
		63	*/
		64
		65	/*!
		66	\fn void QBarSet::nameChanged()
		67
		68	This signal is emitted when the name of the barSet has changed.
		69
		70	\sa name
		71	*/
		72
		73	/*!
		74	\fn void QBarSet::penChanged()
		75
		76	This signal is emitted when the pen of the barSet has changed.
		77
		78	\sa pen
		79	*/
		80
		81	/*!
		82	\fn void QBarSet::brushChanged()
		83
		84	This signal is emitted when the brush of the barSet has changed.
		85
		86	\sa brush
		87	*/
		88
		89	/*!
		90	\fn void QBarSet::labelChanged()
		91
		92	This signal is emitted when the label of the barSet has changed.
		93	*/
		94
		95	/*!
		96	\fn void QBarSet::labelBrushChanged()
		97
		98	This signal is emitted when the brush of the barSet's label has changed.
		99
		100	\sa labelBrush
		101	*/
		102
		103	/*!
		104	\fn void QBarSet::labelFontChanged()
		105
		106	This signal is emitted when the font of the barSet's label has changed.
		107
		108	\sa labelBrush
		109	*/
		110
		111	/*!
		112	\fn void QBarSet::valuesAdded(int index, int count)
		113
		114	This signal is emitted when new values have been added to the set.
		115	Parameter \a index indicates the position of the first inserted value.
		116	Parameter \a count is the number of iserted values.
		117
		118	\sa append(), insert()
		119	*/
		120
		121	/*!
		122	\fn void QBarSet::valuesRemoved(int index, int count)
		123
		124	This signal is emitted values have been removed from the set.
		125	Parameter \a index indicates the position of the first removed value.
		126	Parameter \a count is the number of removed values.
		127
		128	\sa remove()
		129	*/
		130
		131	/*!
		132	\fn void QBarSet::valueChanged(int index)
		133
		134	This signal is emitted values the value in the set has been modified.
		135	Parameter \a index indicates the position of the modified value.
		136
		137	\sa at()
		138	*/
		139	void valueChanged(int index);
		140
		141	/*!
41	Constructs QBarSet with a name of \a name and with parent of \a parent	142	Constructs QBarSet with a name of \a name and with parent of \a parent
42	*/	143	*/
43	QBarSet::QBarSet(const QString name, QObject *parent)	144	QBarSet::QBarSet(const QString name, QObject *parent)
@@ -106,7 +207,7 void QBarSet::append(const qreal value)
106	}	207	}
107		208
108	/*!	209	/*!
109	Appends a list of reals to set. Works like append with single real value. The values in list	210	Appends a list of reals to set. Works like append with single real value. The \a values in list
110	are converted to QPointF, where x coordinate is the index of point and y coordinate is the value.	211	are converted to QPointF, where x coordinate is the index of point and y coordinate is the value.
111	\sa append()	212	\sa append()
112	*/	213	*/
@@ -160,7 +261,8 void QBarSet::insert(const int index, const QPointF value)
160	}	261	}
161		262
162	/*!	263	/*!
163	Removes the value specified by \a index	264	Removes \a count number of values from the set starting at \a index.
		265	Returns true if remove operation was succesfull.
164	\sa insert()	266	\sa insert()
165	*/	267	*/
166	bool QBarSet::remove(const int index, const int count)	268	bool QBarSet::remove(const int index, const int count)

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