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 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta content="text/html; charset=ISO-8859-1"
http-equiv="content-type">
<title>GTK+ Foundation Classes</title>
<link href="gfc.css" rel="stylesheet" type="text/css">
<meta content="The GFC Development Team" name="author">
<meta content="Core Library Reference Manual" name="description">
</head>
<body style="color: rgb(0, 0, 0); background-color: rgb(243, 244, 248);"
alink="#000099" link="#000099" vlink="#990099">
<table style="text-align: left; width: 1227px; height: 117px;"
border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td
style="text-align: center; background-color: rgb(255, 255, 255); width: 220px; vertical-align: top;"><img
alt="GFC Logo" src="../images/gfc.png"
style="width: 207px; height: 92px;"></td>
<td
style="text-align: center; background-color: rgb(87, 107, 152); vertical-align: middle;"><img
alt="GFC Title Logo" src="../images/gfc-title.png"
style="width: 418px; height: 76px;"><br>
</td>
</tr>
<tr>
<td
style="text-align: center; background-color: rgb(65, 77, 104); vertical-align: middle;"><big><span
style="color: rgb(255, 255, 153); font-weight: bold;">Reference Manual</span></big><br>
</td>
<td
style="text-align: center; background-color: rgb(148, 164, 200); vertical-align: middle;"><small
style="font-family: helvetica,arial,sans-serif;"><a
href="../html/index.html">Main Page</a> | <a
href="../html/namespaces.html">Namespace List</a> | <a
href="classes.html">Alphabetical List</a> | <a
href="../html/annotated.html">Class List</a> | <a
href="../html/files.html">File List</a></small><br>
</td>
</tr>
</tbody>
</table>
<small> </small>
</body>
</html>
<!-- Generated by Doxygen 1.3.8 -->
<h1>GFC::Gtk::Curve Class Reference</h1>A GtkCurve C++ wrapper class.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="curve_8hh-source.html">gfc/gtk/curve.hh</a>></code>
<p>
<p>Inheritance diagram for GFC::Gtk::Curve:
<p><center><img src="classGFC_1_1Gtk_1_1Curve.png" usemap="#GFC::Gtk::Curve_map" border="0" alt=""></center>
<map name="GFC::Gtk::Curve_map">
<area href="classGFC_1_1Gtk_1_1DrawingArea.html" alt="GFC::Gtk::DrawingArea" shape="rect" coords="76,280,219,304">
<area href="classGFC_1_1Gtk_1_1Widget.html" alt="GFC::Gtk::Widget" shape="rect" coords="76,224,219,248">
<area href="classGFC_1_1Gtk_1_1Object.html" alt="GFC::Gtk::Object" shape="rect" coords="0,168,143,192">
<area href="classGFC_1_1Atk_1_1Implementor.html" alt="GFC::Atk::Implementor" shape="rect" coords="153,168,296,192">
<area doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Object.html" alt="GFC::G::Object" shape="rect" coords="0,112,143,136">
<area doxygen="gfccore.tag:" href="classGFC_1_1G_1_1TypeInterface.html" alt="GFC::G::TypeInterface" shape="rect" coords="153,112,296,136">
<area doxygen="gfccore.tag:" href="classGFC_1_1G_1_1TypeInstance.html" alt="GFC::G::TypeInstance" shape="rect" coords="0,56,143,80">
<area doxygen="gfccore.tag:" href="classGFC_1_1G_1_1TypeInstance.html" alt="GFC::G::TypeInstance" shape="rect" coords="153,56,296,80">
<area doxygen="gfccore.tag:" href="classGFC_1_1Trackable.html" alt="GFC::Trackable" shape="rect" coords="0,0,143,24">
<area doxygen="gfccore.tag:" href="classGFC_1_1Trackable.html" alt="GFC::Trackable" shape="rect" coords="153,0,296,24">
</map>
<a href="classGFC_1_1Gtk_1_1Curve-members.html">List of all members.</a><h2>Signal Prototypes</h2>
<ul>
<li>const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Signal.html">CurveTypeChangedSignalType</a> <a class="el" href="classGFC_1_1Gtk_1_1Curve.html#z466_2">curve_type_changed_signal</a>
<dl class="el"><dd class="mdescRight"><a class="el" href="classGFC_1_1Gtk_1_1Curve.html">Curve</a> type changed signal (see <a class="el" href="classGFC_1_1Gtk_1_1Curve.html#z470_0">sig_curve_type_changed()</a>). <a href="#z466_2"></a><br></dl></ul>
<h2>Public Member Functions</h2>
<tr><td colspan="2"><div class="groupHeader">Constructors</div></td></tr>
<ul>
<li><a class="anchor" name="z467_0" doxytag="GFC::Gtk::Curve::Curve" ></a>
<a class="el" href="classGFC_1_1Gtk_1_1Curve.html#z467_0">Curve</a> ()
<dl class="el"><dd class="mdescRight">Construct a new <a class="el" href="classGFC_1_1Gtk_1_1Curve.html">Curve</a>. <br></dl><li><a class="anchor" name="z467_1" doxytag="GFC::Gtk::Curve::~Curve" ></a>
virtual <a class="el" href="classGFC_1_1Gtk_1_1Curve.html#z467_1">~Curve</a> ()
<dl class="el"><dd class="mdescRight">Destructor. <br></dl></ul>
<tr><td colspan="2"><div class="groupHeader">Accessors</div></td></tr>
<ul>
<li><a class="anchor" name="z468_0" doxytag="GFC::Gtk::Curve::gtk_curve" ></a>
GtkCurve * <a class="el" href="classGFC_1_1Gtk_1_1Curve.html#z468_0">gtk_curve</a> () const
<dl class="el"><dd class="mdescRight">Get a pointer to the GtkCurve structure. <br></dl><li><a class="anchor" name="z468_1" doxytag="GFC::Gtk::Curve::operator GtkCurve *" ></a>
<a class="el" href="classGFC_1_1Gtk_1_1Curve.html#z468_1">operator GtkCurve *</a> () const
<dl class="el"><dd class="mdescRight">Conversion operator; safely converts a <a class="el" href="classGFC_1_1Gtk_1_1Curve.html">Curve</a> to a GtkCurve pointer. <br></dl><li>void <a class="el" href="classGFC_1_1Gtk_1_1Curve.html#z468_2">get_vector</a> (int count, float data[]) const
<dl class="el"><dd class="mdescRight">Returns a vector of points representing the curve. <a href="#z468_2"></a><br></dl></ul>
<tr><td colspan="2"><div class="groupHeader">Methods</div></td></tr>
<ul>
<li><a class="anchor" name="z469_0" doxytag="GFC::Gtk::Curve::reset" ></a>
void <a class="el" href="classGFC_1_1Gtk_1_1Curve.html#z469_0">reset</a> ()
<dl class="el"><dd class="mdescRight">Resets the curve to a straight line from the minimum x and y values to the maximum x and y values (from the bottom-left to the top-right corners); the curve type is not changed. <br></dl><li>void <a class="el" href="classGFC_1_1Gtk_1_1Curve.html#z469_1">set_gamma</a> (float gamma)
<dl class="el"><dd class="mdescRight">Recomputes the entire curve using the given gamma value. <a href="#z469_1"></a><br></dl><li>void <a class="el" href="classGFC_1_1Gtk_1_1Curve.html#z469_2">set_range</a> (float min_x, float max_x, float min_y, float max_y)
<dl class="el"><dd class="mdescRight">Sets the minimum and maximum x and y values of the curve. <a href="#z469_2"></a><br></dl><li>void <a class="el" href="classGFC_1_1Gtk_1_1Curve.html#z469_3">set_vector</a> (int count, float data[])
<dl class="el"><dd class="mdescRight">Sets the vector of points on the curve; the curve type is set to CURVE_TYPE_FREE. <a href="#z469_3"></a><br></dl><li>void <a class="el" href="classGFC_1_1Gtk_1_1Curve.html#z469_4">set_curve_type</a> (<a class="el" href="namespaceGFC_1_1Gtk.html#a312">CurveType</a> <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1TypeInstance.html#z121_2">type</a>)
<dl class="el"><dd class="mdescRight">Sets the type of the curve. <a href="#z469_4"></a><br></dl></ul>
<tr><td colspan="2"><div class="groupHeader">Signal Proxies</div></td></tr>
<ul>
<li><a class="anchor" name="z470_0" doxytag="GFC::Gtk::Curve::sig_curve_type_changed" ></a>
const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1SignalProxy.html">CurveTypeChangedSignalProxy</a> <a class="el" href="classGFC_1_1Gtk_1_1Curve.html#z470_0">sig_curve_type_changed</a> ()
<dl class="el"><dd class="mdescRight">Connect to the curve_type_changed_signal; emitted when the curve type changes. <br></dl></ul>
<h2>Protected Member Functions</h2>
<tr><td colspan="2"><div class="groupHeader">Constructors</div></td></tr>
<ul>
<li><a class="el" href="classGFC_1_1Gtk_1_1Curve.html#z465_0">Curve</a> (GtkCurve *curve, bool <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1Trackable.html#z143_1">owns_reference</a>=false)
<dl class="el"><dd class="mdescRight">Construct a new <a class="el" href="classGFC_1_1Gtk_1_1Curve.html">Curve</a> from an existing GtkCurve. <a href="#z465_0"></a><br></dl></ul>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A GtkCurve C++ wrapper class.
<p>
<a class="el" href="classGFC_1_1Gtk_1_1Curve.html">Curve</a> is a widget that allows the user to edit a curve covering a range of values. It is typically used to fine-tune color balances in graphics applications like the Gimp. <a class="el" href="classGFC_1_1Gtk_1_1Curve.html">Curve</a> has 3 modes of operation - spline, linear and free. In spline mode the user places points on the curve which are automatically connected together into a smooth curve. In linear mode the user places points on the curve which are connected by straight lines. In free mode the user can draw the points of the curve freely, and they are not connected at all.<p>
NOTE this widget is considered too specialized/little-used for GTK+, and will in the future be moved to some other package. If your application needs this widget, feel free to use it, as the widget does work and is useful in some applications; it's just not of general interest.
<p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="z465_0" doxytag="GFC::Gtk::Curve::Curve" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> GFC::Gtk::Curve::Curve </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">GtkCurve * </td>
<td class="mdname" nowrap> <em>curve</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>bool </td>
<td class="mdname" nowrap> <em>owns_reference</em> = <code>false</code></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [explicit, protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Construct a new <a class="el" href="classGFC_1_1Gtk_1_1Curve.html">Curve</a> from an existing GtkCurve.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>curve</em> </td><td>A pointer to a GtkCurve. </td></tr>
<tr><td></td><td valign=top><em>owns_reference</em> </td><td>Set false if the initial reference count is floating, set true if it's not.</td></tr>
</table>
</dl>
<br>
The <em>curve</em> can be a newly created GtkCurve or an existing GtkCurve. (see <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Object.html#z68_0">G::Object::Object</a>). </td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="z468_2" doxytag="GFC::Gtk::Curve::get_vector" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void GFC::Gtk::Curve::get_vector </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">int </td>
<td class="mdname" nowrap> <em>count</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>float </td>
<td class="mdname" nowrap> <em>data</em>[]</td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Returns a vector of points representing the curve.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>count</em> </td><td>The number of points to calculate. </td></tr>
<tr><td></td><td valign=top><em>data</em> </td><td>The points. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="z469_4" doxytag="GFC::Gtk::Curve::set_curve_type" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void GFC::Gtk::Curve::set_curve_type </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="namespaceGFC_1_1Gtk.html#a312">CurveType</a> </td>
<td class="mdname1" valign="top" nowrap> <em>type</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Sets the type of the curve.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>type</em> </td><td>The type of the curve.</td></tr>
</table>
</dl>
<br>
The curve will remain unchanged except when changing from a free curve to a linear or spline curve, in which case the curve will be changed as little as possible. </td>
</tr>
</table>
<a class="anchor" name="z469_1" doxytag="GFC::Gtk::Curve::set_gamma" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void GFC::Gtk::Curve::set_gamma </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">float </td>
<td class="mdname1" valign="top" nowrap> <em>gamma</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Recomputes the entire curve using the given gamma value.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>gamma</em> </td><td>The gamma value.</td></tr>
</table>
</dl>
<br>
A gamma value of 1 results in a straight line. Values greater than 1 result in a curve above the straight line. Values less than 1 result in a curve below the straight line. The curve type is changed to CURVE_TYPE_FREE. </td>
</tr>
</table>
<a class="anchor" name="z469_2" doxytag="GFC::Gtk::Curve::set_range" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void GFC::Gtk::Curve::set_range </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">float </td>
<td class="mdname" nowrap> <em>min_x</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>float </td>
<td class="mdname" nowrap> <em>max_x</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>float </td>
<td class="mdname" nowrap> <em>min_y</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>float </td>
<td class="mdname" nowrap> <em>max_y</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Sets the minimum and maximum x and y values of the curve.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>min_x</em> </td><td>The minimum x value. </td></tr>
<tr><td></td><td valign=top><em>max_x</em> </td><td>The maximum x value. </td></tr>
<tr><td></td><td valign=top><em>min_y</em> </td><td>The minimum y value. </td></tr>
<tr><td></td><td valign=top><em>max_y</em> </td><td>The maximum y value.</td></tr>
</table>
</dl>
<br>
The curve is also reset with a call to <a class="el" href="classGFC_1_1Gtk_1_1Curve.html#z469_0">reset()</a>. </td>
</tr>
</table>
<a class="anchor" name="z469_3" doxytag="GFC::Gtk::Curve::set_vector" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void GFC::Gtk::Curve::set_vector </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">int </td>
<td class="mdname" nowrap> <em>count</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>float </td>
<td class="mdname" nowrap> <em>data</em>[]</td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Sets the vector of points on the curve; the curve type is set to CURVE_TYPE_FREE.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>count</em> </td><td>The number of points. </td></tr>
<tr><td></td><td valign=top><em>data</em> </td><td>The points on the curve. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="z466_2" doxytag="GFC::Gtk::Curve::curve_type_changed_signal" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Signal.html">CurveTypeChangedSignalType</a> <a class="el" href="classGFC_1_1Gtk_1_1Curve.html#z466_2">GFC::Gtk::Curve::curve_type_changed_signal</a><code> [static, protected]</code> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<a class="el" href="classGFC_1_1Gtk_1_1Curve.html">Curve</a> type changed signal (see <a class="el" href="classGFC_1_1Gtk_1_1Curve.html#z470_0">sig_curve_type_changed()</a>).
<p>
Calls a slot with the signature: <div class="fragment"><pre> <span class="keywordtype">void</span> function();
</pre></div> </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="curve_8hh-source.html">curve.hh</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Tue Aug 24 00:34:38 2004 for GFC-UI by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border=0 ></a> 1.3.8 </small></address>
</body>
</html>
|