<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Wt: Wt::Chart::WChartPalette Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
</head>
<body>
<div id="top"><!-- do not remove this div! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Wt
 <span id="projectnumber">3.2.3</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- Generated by Doxygen 1.7.5.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<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>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceWt.html">Wt</a> </li>
<li class="navelem"><a class="el" href="namespaceWt_1_1Chart.html">Chart</a> </li>
<li class="navelem"><a class="el" href="classWt_1_1Chart_1_1WChartPalette.html">WChartPalette</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">Wt::Chart::WChartPalette Class Reference<div class="ingroups"><a class="el" href="group__charts.html">Charts (Wt::Chart)</a></div></div> </div>
</div>
<div class="contents">
<!-- doxytag: class="Wt::Chart::WChartPalette" -->
<p>Abstract base class for styling rendered data series in charts.
<a href="classWt_1_1Chart_1_1WChartPalette.html#details">More...</a></p>
<p><code>#include <Wt/Chart/WChartPalette></code></p>
<div class="dynheader">
Inheritance diagram for Wt::Chart::WChartPalette:</div>
<div class="dyncontent">
<div class="center"><img src="classWt_1_1Chart_1_1WChartPalette__inherit__graph.png" border="0" usemap="#Wt_1_1Chart_1_1WChartPalette_inherit__map" alt="Inheritance graph"/></div>
<map name="Wt_1_1Chart_1_1WChartPalette_inherit__map" id="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,197,107"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classWt_1_1Chart_1_1WChartPalette-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a72e713c7e44024ebc5044bd2c67a3812"></a><!-- doxytag: member="Wt::Chart::WChartPalette::~WChartPalette" ref="a72e713c7e44024ebc5044bd2c67a3812" args="()" -->
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Chart_1_1WChartPalette.html#a72e713c7e44024ebc5044bd2c67a3812">~WChartPalette</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <br/></td></tr>
<tr><td class="memItemLeft" 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#aa7e88bb175f4f83b245076150e658e99">brush</a> (int index) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a brush from the palette. <a href="#aa7e88bb175f4f83b245076150e658e99"></a><br/></td></tr>
<tr><td class="memItemLeft" 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#a770025513b0e83146d54011743950726">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="#a770025513b0e83146d54011743950726"></a><br/></td></tr>
<tr><td class="memItemLeft" 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#ab395b91af20d3171c0cbb0abca85d967">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="#ab395b91af20d3171c0cbb0abca85d967"></a><br/></td></tr>
<tr><td class="memItemLeft" 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#a4968d1f875e0aedac02d7dbc312d085f">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="#a4968d1f875e0aedac02d7dbc312d085f"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Abstract base class for styling rendered data series in charts. </p>
<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>
<p>To use a custom palette, you should reimplement this class, and then use <a class="el" href="classWt_1_1Chart_1_1WAbstractChart.html#a044936e6358c8efc55699effc4b946d8" title="Set a palette for the chart.">WAbstractChart::setPalette()</a> to use an instance of the palette. </p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a770025513b0e83146d54011743950726"></a><!-- doxytag: member="Wt::Chart::WChartPalette::borderPen" ref="a770025513b0e83146d54011743950726" 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>
<p>Returns the pen for stroking borders around an area filled using the brush at the same <em>index</em>.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1Chart_1_1WChartPalette.html#ab395b91af20d3171c0cbb0abca85d967" title="Returns a stroke pen from the palette.">strokePen()</a>, <a class="el" href="classWt_1_1Chart_1_1WChartPalette.html#aa7e88bb175f4f83b245076150e658e99" title="Returns a brush from the palette.">brush()</a> </dd></dl>
<p>Implemented in <a class="el" href="classWt_1_1Chart_1_1WStandardPalette.html#a94ea33302229bc7ae115567ffb9acee4">Wt::Chart::WStandardPalette</a>.</p>
</div>
</div>
<a class="anchor" id="aa7e88bb175f4f83b245076150e658e99"></a><!-- doxytag: member="Wt::Chart::WChartPalette::brush" ref="aa7e88bb175f4f83b245076150e658e99" 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>
<p>Returns the brush for the style with given <em>index</em>. </p>
<p>Implemented in <a class="el" href="classWt_1_1Chart_1_1WStandardPalette.html#a43791f6f18e2986809d9ae8f062fc76e">Wt::Chart::WStandardPalette</a>.</p>
</div>
</div>
<a class="anchor" id="a4968d1f875e0aedac02d7dbc312d085f"></a><!-- doxytag: member="Wt::Chart::WChartPalette::fontColor" ref="a4968d1f875e0aedac02d7dbc312d085f" 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>
<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"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1Chart_1_1WChartPalette.html#aa7e88bb175f4f83b245076150e658e99" title="Returns a brush from the palette.">brush()</a> </dd></dl>
<p>Implemented in <a class="el" href="classWt_1_1Chart_1_1WStandardPalette.html#a980f085213550e9ae1365416cd385061">Wt::Chart::WStandardPalette</a>.</p>
</div>
</div>
<a class="anchor" id="ab395b91af20d3171c0cbb0abca85d967"></a><!-- doxytag: member="Wt::Chart::WChartPalette::strokePen" ref="ab395b91af20d3171c0cbb0abca85d967" 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>
<p>Returns the pen for stroking lines for the style with given <em>index</em>.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1Chart_1_1WChartPalette.html#ab395b91af20d3171c0cbb0abca85d967" 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#ae8465be7c23762aef801707a48df862e">Wt::Chart::WStandardPalette</a>.</p>
</div>
</div>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<hr size="1"><address style="text-align: right; margin: 3px"><small>
Generated on Thu Nov 1 2012 for <a href="http://www.webtoolkit.eu/wt">the
C++ Web Toolkit (Wt)</a> by <a
href="http://www.doxygen.org/index.html"><img src="doxygen.png"
alt="doxygen" border="0" style="vertical-align: middle; display:
inline-block; height: 2em"></a> 1.7.5.1</small></address>
</body>
</html>
