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 177 178 179 180 181 182 183
|
<!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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>wxWidgets: wxDCTextColourChanger Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="extra_stylesheet.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="page_container">
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0" style="width: 100%;">
<tbody>
<tr>
<td id="projectlogo">
<a href="http://www.wxwidgets.org/" target="_new">
<img alt="wxWidgets" src="logo.png"/>
</a>
</td>
<td style="padding-left: 0.5em; text-align: right;">
<span id="projectnumber">Version: 3.0.2</span>
</td>
</tr>
</tbody>
</table>
</div>
<!-- Generated by Doxygen 1.8.2 -->
<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>Categories</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>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</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><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="classwx_d_c_text_colour_changer-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">wxDCTextColourChanger Class Reference<div class="ingroups"><a class="el" href="group__group__class__gdi.html">Graphics Device Interface (GDI)</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include <wx/dc.h></code></p>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p><a class="el" href="classwx_d_c_text_colour_changer.html" title="wxDCTextColourChanger is a small helper class for setting a foreground text colour on a wxDC and unse...">wxDCTextColourChanger</a> is a small helper class for setting a foreground text colour on a <a class="el" href="classwx_d_c.html" title="A wxDC is a "device context" onto which graphics and text can be drawn.">wxDC</a> and unsetting it automatically in the destructor, restoring the previous one. </p>
<h2></h2>
<div><span class="lib">Library:</span>  <span class="lib_text"><a class="el" href="page_libs.html#page_libs_wxcore">wxCore</a></span></div><div><span class="category">Category:</span>  <span class="category_text"><a class="el" href="group__group__class__gdi.html">Graphics Device Interface (GDI)</a></span></div><dl class="section see"><dt>See Also</dt><dd><a class="el" href="classwx_d_c.html#aeac811df9a1688ce875117f3049849d6" title="Sets the current text foreground colour for the DC.">wxDC::SetTextForeground()</a>, <a class="el" href="classwx_d_c_font_changer.html" title="wxDCFontChanger is a small helper class for setting a font on a wxDC and unsetting it automatically i...">wxDCFontChanger</a>, <a class="el" href="classwx_d_c_pen_changer.html" title="wxDCPenChanger is a small helper class for setting a pen on a wxDC and unsetting it automatically in ...">wxDCPenChanger</a>, <a class="el" href="classwx_d_c_brush_changer.html" title="wxDCBrushChanger is a small helper class for setting a brush on a wxDC and unsetting it automatically...">wxDCBrushChanger</a>, <a class="el" href="classwx_d_c_clipper.html" title="wxDCClipper is a helper class for setting a clipping region on a wxDC during its lifetime.">wxDCClipper</a> </dd></dl>
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ae9c21638cef0ad69be36a7359811965d"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_d_c_text_colour_changer.html#ae9c21638cef0ad69be36a7359811965d">wxDCTextColourChanger</a> (<a class="el" href="classwx_d_c.html">wxDC</a> &dc)</td></tr>
<tr class="memdesc:ae9c21638cef0ad69be36a7359811965d"><td class="mdescLeft"> </td><td class="mdescRight">Trivial constructor not changing anything. <a href="#ae9c21638cef0ad69be36a7359811965d"></a><br/></td></tr>
<tr class="separator:ae9c21638cef0ad69be36a7359811965d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0c0cc00023f4edd806220ac147e40784"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_d_c_text_colour_changer.html#a0c0cc00023f4edd806220ac147e40784">wxDCTextColourChanger</a> (<a class="el" href="classwx_d_c.html">wxDC</a> &dc, const <a class="el" href="classwx_colour.html">wxColour</a> &col)</td></tr>
<tr class="memdesc:a0c0cc00023f4edd806220ac147e40784"><td class="mdescLeft"> </td><td class="mdescRight">Sets <em>col</em> on the given <em>dc</em>, storing the old one. <a href="#a0c0cc00023f4edd806220ac147e40784"></a><br/></td></tr>
<tr class="separator:a0c0cc00023f4edd806220ac147e40784"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9f88532c95e96699397e0a5cd1c140fe"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_d_c_text_colour_changer.html#a9f88532c95e96699397e0a5cd1c140fe">Set</a> (const <a class="el" href="classwx_colour.html">wxColour</a> &col)</td></tr>
<tr class="memdesc:a9f88532c95e96699397e0a5cd1c140fe"><td class="mdescLeft"> </td><td class="mdescRight">Set the colour to use. <a href="#a9f88532c95e96699397e0a5cd1c140fe"></a><br/></td></tr>
<tr class="separator:a9f88532c95e96699397e0a5cd1c140fe"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2925157a3e2f8c0d1946ab4c3034cefe"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_d_c_text_colour_changer.html#a2925157a3e2f8c0d1946ab4c3034cefe">~wxDCTextColourChanger</a> ()</td></tr>
<tr class="memdesc:a2925157a3e2f8c0d1946ab4c3034cefe"><td class="mdescLeft"> </td><td class="mdescRight">Restores the colour originally selected in the DC passed to the ctor. <a href="#a2925157a3e2f8c0d1946ab4c3034cefe"></a><br/></td></tr>
<tr class="separator:a2925157a3e2f8c0d1946ab4c3034cefe"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="ae9c21638cef0ad69be36a7359811965d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">wxDCTextColourChanger::wxDCTextColourChanger </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classwx_d_c.html">wxDC</a> & </td>
<td class="paramname"><em>dc</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Trivial constructor not changing anything. </p>
<p>This constructor is useful if you don't know beforehand if the colour needs to be changed or not. It simply creates the object which won't do anything in its destructor unless <a class="el" href="classwx_d_c_text_colour_changer.html#a9f88532c95e96699397e0a5cd1c140fe" title="Set the colour to use.">Set()</a> is called – in which case it would reset the previous colour. </p>
</div>
</div>
<a class="anchor" id="a0c0cc00023f4edd806220ac147e40784"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">wxDCTextColourChanger::wxDCTextColourChanger </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classwx_d_c.html">wxDC</a> & </td>
<td class="paramname"><em>dc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classwx_colour.html">wxColour</a> & </td>
<td class="paramname"><em>col</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets <em>col</em> on the given <em>dc</em>, storing the old one. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">dc</td><td>The DC where the colour must be temporary set. </td></tr>
<tr><td class="paramname">col</td><td>The colour to set. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a2925157a3e2f8c0d1946ab4c3034cefe"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">wxDCTextColourChanger::~wxDCTextColourChanger </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Restores the colour originally selected in the DC passed to the ctor. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a9f88532c95e96699397e0a5cd1c140fe"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void wxDCTextColourChanger::Set </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classwx_colour.html">wxColour</a> & </td>
<td class="paramname"><em>col</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the colour to use. </p>
<p>This method is meant to be called once only and only on the objects created with the constructor overload not taking <a class="el" href="classwx_colour.html" title="A colour is an object representing a combination of Red, Green, and Blue (RGB) intensity values...">wxColour</a> argument and has the same effect as the other constructor, i.e. sets the colour to the given <em>col</em> and ensures that the old value is restored when this object is destroyed. </p>
</div>
</div>
</div><!-- contents -->
<address class="footer">
<small>
Generated on Thu Nov 27 2014 13:46:46 for wxWidgets by <a href="http://www.doxygen.org/index.html" target="_new">Doxygen</a> 1.8.2
</small>
</address>
<script src="wxwidgets.js" type="text/javascript"></script>
</div><!-- #page_container -->
</body>
</html>
|