Provides the end-user with the tools to select and customise charts. More...

#include <gobchartstoolswidget.h>

Inheritance diagram for GobChartsToolsWidget:

Public Slots
void	receiveLabelDetails (GobChartsLabel label, QString text, QFont font, QColor colour, Qt::Alignment align)
	Receives label details.

Signals
void	clearChart ()
	Emitted when the user clicks the "Clear" button.

void	saveChart ()
	Emitted when the user clicks the "Save" button.

void	loadChart ()
	Emitted when the user clicks the "Load" button.

void	createChart (GobChartsType)
	Emitted when the user clicks on any of the chart tool buttons (BAR, PIE or LINE).

void	setFixedColour (QColor)
	Emitted when the user selects a fixed chart colour.

void	setRandomColours ()
	Emitted when the user wishes random colour selection to be re-enabled.

void	setAllowedDataRange (qreal, qreal)
	Emitted when the user chooses to restrict the chart's data range.

void	setShowTotalRange ()
	Emitted when the user chooses to display the entire data range (normally after a previous call to setAllowedDataRange).

void	setGridLineStyle (Qt::PenStyle)
	Emitted when the pen style used to draw the grid lines changes.

void	setVerticalGridLines (bool, int)
	Emitted when the user turns the display of the vertical grid lines "on" or "off" or when the number of vertical grid lines changes.

void	setHorizontalGridLines (bool, int)
	Emitted when the user turns the display of the horizontal grid lines "on" or "off" or when the number of horizontal grid lines changes.

void	setGridColour (QColor)
	Emits a user-selected grid colour.

void	setLabelDetails (GobChartsLabel, QString, QFont, QColor, Qt::Alignment)
	Emitted when a label's details changes.

void	requestLabelDetails (GobChartsLabel)
	Emitted when an update to a label's details is required.

Public Member Functions
	GobChartsToolsWidget (QWidget *parent=0)
	Constructor.

	~GobChartsToolsWidget ()
	Destructor.

QString	getStateXML () const
	Returns the tool widget's content and settings as an XML QString.

void	setStateXML (GobChartsType type, const QDomNode &toolNode)
	Used when saving or loading a chart to or from file.

void	emitStateSignals ()
	Emits all the tool's state signals after loading data from XML.

Friends
class	LabelDetails

Detailed Description

Provides the end-user with the tools to select and customise charts.

GobChartsToolsWidget keeps track of user preferences, emits signals relating to user decisions and updates itself on occasions where the user manipulates the chart directly.

Definition at line 43 of file gobchartstoolswidget.h.

Member Function Documentation

void GobChartsToolsWidget::clearChart ( )

signal

Emitted when the user clicks the "Clear" button.

void GobChartsToolsWidget::createChart ( GobChartsType )

signal

Emitted when the user clicks on any of the chart tool buttons (BAR, PIE or LINE).

void GobChartsToolsWidget::emitStateSignals ( )

Emits all the tool's state signals after loading data from XML.

See Also: getStateXML() and setStateXML()

Definition at line 774 of file gobchartstoolswidget.cpp.

QString GobChartsToolsWidget::getStateXML ( ) const

Returns the tool widget's content and settings as an XML QString.

This function takes all the tool settings, converts them to XML and returns the XML string.

See Also: setStateXML() and emitStateSignals()

Definition at line 521 of file gobchartstoolswidget.cpp.

void GobChartsToolsWidget::loadChart ( )

signal

Emitted when the user clicks the "Load" button.

See Also: saveChart()

void GobChartsToolsWidget::receiveLabelDetails	(	GobChartsLabel	label,
		QString	text,
		QFont	font,
		QColor	colour,
		Qt::Alignment	align
	)

slot

Receives label details.

Changing the label that is currently in focus (i.e when the user clicks on any of the three label buttons "H", "X" or "Y"), we wish to update the font in the dropdown, the text alignment, italics, bold and underlined buttons, etc in line with the chosen label. This is how we get that information from the main widget and we request that information be sent via requestLabelDetails().

Definition at line 468 of file gobchartstoolswidget.cpp.

void GobChartsToolsWidget::requestLabelDetails ( GobChartsLabel )

signal

Emitted when an update to a label's details is required.

See Also: setLabelDetails() and receiveLabelDetails()

void GobChartsToolsWidget::saveChart ( )

signal

Emitted when the user clicks the "Save" button.

See Also: loadChart()

void GobChartsToolsWidget::setAllowedDataRange	(	qreal	,
		qreal
	)

signal

Emitted when the user chooses to restrict the chart's data range.

Setting the allowed data range determines which categories will be shown in the final chart (i.e. only those data categories with values within the range will be shown). By default the entire value range is drawn. The first parameter contains the lowest allowed value to be displayed and the second the highest.

See Also: setShowTotalRange()

void GobChartsToolsWidget::setFixedColour ( QColor )

signal

Emitted when the user selects a fixed chart colour.

Fix the chart colour to "colour". This means that the different data categories will all be displayed in "colour" as opposed to having randomly generated (different) colours.

See Also: setRandomColours()

void GobChartsToolsWidget::setGridColour ( QColor )

signal

Emits a user-selected grid colour.

void GobChartsToolsWidget::setGridLineStyle ( Qt::PenStyle )

signal

Emitted when the pen style used to draw the grid lines changes.

See Qt API documentation for details on the enum.

void GobChartsToolsWidget::setHorizontalGridLines	(	bool	,
		int
	)

signal

Emitted when the user turns the display of the horizontal grid lines "on" or "off" or when the number of horizontal grid lines changes.

void GobChartsToolsWidget::setLabelDetails	(	GobChartsLabel	,
		QString	,
		QFont	,
		QColor	,
		Qt::Alignment
	)

signal

Emitted when a label's details changes.

See Also: requestLabelDetails() and receiveLabelDetails()

void GobChartsToolsWidget::setRandomColours ( )

signal

Emitted when the user wishes random colour selection to be re-enabled.

Re-enables random colour generation (the default) for chart items after a call to setFixedColour().

See Also: setFixedColour()

void GobChartsToolsWidget::setShowTotalRange ( )

signal

Emitted when the user chooses to display the entire data range (normally after a previous call to setAllowedDataRange).

See Also: setAllowedDataRange()

void GobChartsToolsWidget::setStateXML	(	GobChartsType	type,
		const QDomNode &	toolNode
	)

Used when saving or loading a chart to or from file.

After reading in the relevant data from the QDomNode, all the relevant state signals are emitted in succession to update the listener with the changes just loaded.

See Also: getStateXML() and emitStateSignals()

Definition at line 625 of file gobchartstoolswidget.cpp.

void GobChartsToolsWidget::setVerticalGridLines	(	bool	,
		int
	)

signal

Emitted when the user turns the display of the vertical grid lines "on" or "off" or when the number of vertical grid lines changes.

The documentation for this class was generated from the following files:

Public Slots

Signals

Public Member Functions

Friends

Detailed Description

Member Function Documentation