1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>Wt: Wt::Chart::WChartPalette Class Reference</title>
<link href="doxygen.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="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<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 class="navpath"><a class="el" href="namespaceWt.html">Wt</a>::<a class="el" href="namespaceWt_1_1Chart.html">Chart</a>::<a class="el" href="classWt_1_1Chart_1_1WChartPalette.html">WChartPalette</a>
</div>
</div>
<div class="contents">
<h1>Wt::Chart::WChartPalette Class Reference<br>
<small>
[<a class="el" href="group__charts.html">Chart library</a>]</small>
</h1><!-- doxytag: class="Wt::Chart::WChartPalette" -->Abstract base class for styling rendered data series in charts.
<a href="#_details">More...</a>
<p>
<code>#include <Wt/Chart/WChartPalette></code>
<p>
<div class="dynheader">
Inheritance diagram for Wt::Chart::WChartPalette:</div>
<div class="dynsection">
<p><center><img src="classWt_1_1Chart_1_1WChartPalette__inherit__graph.png" border="0" usemap="#Wt_1_1Chart_1_1WChartPalette__inherit__map" alt="Inheritance graph"></center>
<map name="Wt_1_1Chart_1_1WChartPalette__inherit__map">
<area shape="rect" href="classWt_1_1Chart_1_1WStandardPalette.html" title="Standard styling for rendering series in charts." alt="" coords="5,80,195,107"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="classWt_1_1Chart_1_1WChartPalette-members.html">List of all members.</a><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"><a class="anchor" name="72e713c7e44024ebc5044bd2c67a3812"></a><!-- doxytag: member="Wt::Chart::WChartPalette::~WChartPalette" ref="72e713c7e44024ebc5044bd2c67a3812" args="()" -->
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Chart_1_1WChartPalette.html#72e713c7e44024ebc5044bd2c67a3812">~WChartPalette</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classWt_1_1WBrush.html">WBrush</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Chart_1_1WChartPalette.html#a7e88bb175f4f83b245076150e658e99">brush</a> (int index) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a brush from the palette. <a href="#a7e88bb175f4f83b245076150e658e99"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classWt_1_1WPen.html">WPen</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Chart_1_1WChartPalette.html#770025513b0e83146d54011743950726">borderPen</a> (int index) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a border pen from the palette. <a href="#770025513b0e83146d54011743950726"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classWt_1_1WPen.html">WPen</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Chart_1_1WChartPalette.html#b395b91af20d3171c0cbb0abca85d967">strokePen</a> (int index) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a stroke pen from the palette. <a href="#b395b91af20d3171c0cbb0abca85d967"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classWt_1_1WColor.html">WColor</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Chart_1_1WChartPalette.html#4968d1f875e0aedac02d7dbc312d085f">fontColor</a> (int index) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a font color from the palette. <a href="#4968d1f875e0aedac02d7dbc312d085f"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Abstract base class for styling rendered data series in charts.
<p>
This class provides an interface for a palette which sets strokes and fill strokes for data in a <a class="el" href="classWt_1_1Chart_1_1WAbstractChart.html">chart</a>. A palette is an ordered list of styles, which is indexed by the chart to get a suitable style for a particular series (in case of <a class="el" href="classWt_1_1Chart_1_1WCartesianChart.html" title="A cartesian chart.">WCartesianChart</a>) or data row (in case of <a class="el" href="classWt_1_1Chart_1_1WPieChart.html" title="A pie chart.">WPieChart</a>). Each style is defined by a brush, two pen styles (one for borders, and one for plain lines), and a font color that is appropriate for drawing text within the brushed area.<p>
To use a custom palette, you should reimplement this class, and then use <a class="el" href="classWt_1_1Chart_1_1WAbstractChart.html#044936e6358c8efc55699effc4b946d8" title="Set a palette for the chart.">WAbstractChart::setPalette()</a> to use an instance of the palette. <hr><h2>Member Function Documentation</h2>
<a class="anchor" name="a7e88bb175f4f83b245076150e658e99"></a><!-- doxytag: member="Wt::Chart::WChartPalette::brush" ref="a7e88bb175f4f83b245076150e658e99" args="(int index) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classWt_1_1WBrush.html">WBrush</a> Wt::Chart::WChartPalette::brush </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>index</em> </td>
<td> ) </td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns a brush from the palette.
<p>
Returns the brush for the style with given <em>index</em>.
<p>Implemented in <a class="el" href="classWt_1_1Chart_1_1WStandardPalette.html#43791f6f18e2986809d9ae8f062fc76e">Wt::Chart::WStandardPalette</a>.</p>
</div>
</div><p>
<a class="anchor" name="770025513b0e83146d54011743950726"></a><!-- doxytag: member="Wt::Chart::WChartPalette::borderPen" ref="770025513b0e83146d54011743950726" args="(int index) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classWt_1_1WPen.html">WPen</a> Wt::Chart::WChartPalette::borderPen </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>index</em> </td>
<td> ) </td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns a border pen from the palette.
<p>
Returns the pen for stroking borders around an area filled using the brush at the same <em>index</em>.<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1Chart_1_1WChartPalette.html#b395b91af20d3171c0cbb0abca85d967" title="Returns a stroke pen from the palette.">strokePen()</a>, <a class="el" href="classWt_1_1Chart_1_1WChartPalette.html#a7e88bb175f4f83b245076150e658e99" title="Returns a brush from the palette.">brush()</a> </dd></dl>
<p>Implemented in <a class="el" href="classWt_1_1Chart_1_1WStandardPalette.html#94ea33302229bc7ae115567ffb9acee4">Wt::Chart::WStandardPalette</a>.</p>
</div>
</div><p>
<a class="anchor" name="b395b91af20d3171c0cbb0abca85d967"></a><!-- doxytag: member="Wt::Chart::WChartPalette::strokePen" ref="b395b91af20d3171c0cbb0abca85d967" args="(int index) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classWt_1_1WPen.html">WPen</a> Wt::Chart::WChartPalette::strokePen </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>index</em> </td>
<td> ) </td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns a stroke pen from the palette.
<p>
Returns the pen for stroking lines for the style with given <em>index</em>.<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1Chart_1_1WChartPalette.html#b395b91af20d3171c0cbb0abca85d967" title="Returns a stroke pen from the palette.">strokePen()</a> </dd></dl>
<p>Implemented in <a class="el" href="classWt_1_1Chart_1_1WStandardPalette.html#e8465be7c23762aef801707a48df862e">Wt::Chart::WStandardPalette</a>.</p>
</div>
</div><p>
<a class="anchor" name="4968d1f875e0aedac02d7dbc312d085f"></a><!-- doxytag: member="Wt::Chart::WChartPalette::fontColor" ref="4968d1f875e0aedac02d7dbc312d085f" args="(int index) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classWt_1_1WColor.html">WColor</a> Wt::Chart::WChartPalette::fontColor </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>index</em> </td>
<td> ) </td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns a font color from the palette.
<p>
Returns a font color suitable for rendering text in the area filled with the brush at the same <em>index</em>.<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1Chart_1_1WChartPalette.html#a7e88bb175f4f83b245076150e658e99" title="Returns a brush from the palette.">brush()</a> </dd></dl>
<p>Implemented in <a class="el" href="classWt_1_1Chart_1_1WStandardPalette.html#980f085213550e9ae1365416cd385061">Wt::Chart::WStandardPalette</a>.</p>
</div>
</div><p>
</div>
<hr size="1"><address style="align: right;"><small>
Generated on Fri Mar 26 17:12:08 2010 for <a href="http://www.webtoolkit.eu/wt/">Wt</a> 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>
|