vtkQtChartHelpFormatter Class Reference

#include <vtkQtChartHelpFormatter.h>

List of all members.

---

Detailed Description

The vtkQtChartHelpFormatter class is used to generate help text from a format string.

Definition at line 37 of file vtkQtChartHelpFormatter.h.

Public Member Functions
	vtkQtChartHelpFormatter ()
	vtkQtChartHelpFormatter (const QString &format)
	Creates a help formatter instance.
	~vtkQtChartHelpFormatter ()
const QString &	getFormat () const
	Gets the help string format.
void	setFormat (const QString &format)
	Sets the help string format.
QString	getHelpText (const QString &series, const QStringList &data) const
	Creates a help string for the given parameters.

---

Constructor & Destructor Documentation

vtkQtChartHelpFormatter::vtkQtChartHelpFormatter

(

)

vtkQtChartHelpFormatter::vtkQtChartHelpFormatter

(

const QString &

format

)

Creates a help formatter instance.

Parameters:

format

The help string format.

vtkQtChartHelpFormatter::~vtkQtChartHelpFormatter

(

)

[inline]

Definition at line 46 of file vtkQtChartHelpFormatter.h.

---

Member Function Documentation

const QString& vtkQtChartHelpFormatter::getFormat

(

)

const [inline]

Gets the help string format.

Returns:

A reference to the help string format.

Definition at line 52 of file vtkQtChartHelpFormatter.h.

void vtkQtChartHelpFormatter::setFormat

(

const QString &

format

)

[inline]

Sets the help string format.

Parameters:

format

The help string format.

Definition at line 57 of file vtkQtChartHelpFormatter.h.

QString vtkQtChartHelpFormatter::getHelpText	(	const QString &	series,
		const QStringList &	data
	)			const

Creates a help string for the given parameters.

The series name replaces all instances of s in the format string. The data list replaces 1, 2, ... n in the format string. the list will only replace numbers up to its length.

Parameters:

	series	The series name.
	data	The list of data arguments.

Returns:

The formatted help string.

---

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

• dox/GUISupport/Qt/Chart/vtkQtChartHelpFormatter.h