<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>VTK: vtkQtChartHelpFormatter Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.6 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="classes.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="classes.html"><span>Alphabetical List</span></a></li>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>vtkQtChartHelpFormatter Class Reference</h1><!-- doxytag: class="vtkQtChartHelpFormatter" --><code>#include <<a class="el" href="a04525.html">vtkQtChartHelpFormatter.h</a>></code>
<p>
<p>
<a href="a13612.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
The <a class="el" href="a01351.html" title="The vtkQtChartHelpFormatter class is used to generate help text from a format string...">vtkQtChartHelpFormatter</a> class is used to generate help text from a format string.
<p>
<p>Definition at line <a class="el" href="a04525.html#l00037">37</a> of file <a class="el" href="a04525.html">vtkQtChartHelpFormatter.h</a>.</p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a01351.html#1d1f062df3b5c690b27affc6a784e69e">vtkQtChartHelpFormatter</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a01351.html#8a6d5b1bbb9c9c9ebda6d659548969d3">vtkQtChartHelpFormatter</a> (const QString &format)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates a help formatter instance. <a href="#8a6d5b1bbb9c9c9ebda6d659548969d3"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a01351.html#ed927fe73f182234abe200d7326a7641">~vtkQtChartHelpFormatter</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const QString & </td><td class="memItemRight" valign="bottom"><a class="el" href="a01351.html#e5b4a0b1bb593dbaf4d55799ab761793">getFormat</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the help string format. <a href="#e5b4a0b1bb593dbaf4d55799ab761793"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a01351.html#0adc855bf8a7459b3cdf4e1609ce794d">setFormat</a> (const QString &format)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the help string format. <a href="#0adc855bf8a7459b3cdf4e1609ce794d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="a01351.html#22d3447cf1cae2d6eba3326e69a80749">getHelpText</a> (const QString &series, const QStringList &data) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates a help string for the given parameters. <a href="#22d3447cf1cae2d6eba3326e69a80749"></a><br></td></tr>
</table>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="1d1f062df3b5c690b27affc6a784e69e"></a><!-- doxytag: member="vtkQtChartHelpFormatter::vtkQtChartHelpFormatter" ref="1d1f062df3b5c690b27affc6a784e69e" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">vtkQtChartHelpFormatter::vtkQtChartHelpFormatter </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="8a6d5b1bbb9c9c9ebda6d659548969d3"></a><!-- doxytag: member="vtkQtChartHelpFormatter::vtkQtChartHelpFormatter" ref="8a6d5b1bbb9c9c9ebda6d659548969d3" args="(const QString &format)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">vtkQtChartHelpFormatter::vtkQtChartHelpFormatter </td>
<td>(</td>
<td class="paramtype">const QString & </td>
<td class="paramname"> <em>format</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Creates a help formatter instance.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>format</em> </td><td>The help string format. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="ed927fe73f182234abe200d7326a7641"></a><!-- doxytag: member="vtkQtChartHelpFormatter::~vtkQtChartHelpFormatter" ref="ed927fe73f182234abe200d7326a7641" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">vtkQtChartHelpFormatter::~vtkQtChartHelpFormatter </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>Definition at line <a class="el" href="a04525.html#l00046">46</a> of file <a class="el" href="a04525.html">vtkQtChartHelpFormatter.h</a>.</p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="e5b4a0b1bb593dbaf4d55799ab761793"></a><!-- doxytag: member="vtkQtChartHelpFormatter::getFormat" ref="e5b4a0b1bb593dbaf4d55799ab761793" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const QString& vtkQtChartHelpFormatter::getFormat </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Gets the help string format.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A reference to the help string format. </dd></dl>
<p>Definition at line <a class="el" href="a04525.html#l00052">52</a> of file <a class="el" href="a04525.html">vtkQtChartHelpFormatter.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="0adc855bf8a7459b3cdf4e1609ce794d"></a><!-- doxytag: member="vtkQtChartHelpFormatter::setFormat" ref="0adc855bf8a7459b3cdf4e1609ce794d" args="(const QString &format)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void vtkQtChartHelpFormatter::setFormat </td>
<td>(</td>
<td class="paramtype">const QString & </td>
<td class="paramname"> <em>format</em> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Sets the help string format.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>format</em> </td><td>The help string format. </td></tr>
</table>
</dl>
<p>Definition at line <a class="el" href="a04525.html#l00057">57</a> of file <a class="el" href="a04525.html">vtkQtChartHelpFormatter.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="22d3447cf1cae2d6eba3326e69a80749"></a><!-- doxytag: member="vtkQtChartHelpFormatter::getHelpText" ref="22d3447cf1cae2d6eba3326e69a80749" args="(const QString &series, const QStringList &data) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">QString vtkQtChartHelpFormatter::getHelpText </td>
<td>(</td>
<td class="paramtype">const QString & </td>
<td class="paramname"> <em>series</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const QStringList & </td>
<td class="paramname"> <em>data</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Creates a help string for the given parameters.
<p>
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.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>series</em> </td><td>The series name. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>data</em> </td><td>The list of data arguments. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The formatted help string. </dd></dl>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li>dox/GUISupport/Qt/Chart/<a class="el" href="a04525.html">vtkQtChartHelpFormatter.h</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Wed Jun 3 19:28:15 2009 for VTK by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
</body>
</html>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
60f1dc962abad0f3b492991a4fbef9be
>
files
>
1354
