Sophie

Sophie

distrib > Mandriva > 9.1 > ppc > media > main > by-pkgid > ca81b57b553ae75608ba0fc5e7925e4e > files > 276

libgtkmm1.2-devel-1.2.10-1mdk.ppc.rpm

<html>
<head><title>Gtk-- Reference: Gtk::Adjustment</title></head>

<body bgcolor="#F0F0F0" text="#000000" link="#0000FF"
vlink="#000077" alink="#FF0000">
<table align=center border=0 cellspacing=10> <tr>
<td><a href="class_index.html">Class Index</a></td>
<td><a href="cross_index.html">Cross Index</a></td>
<td><a href="name_index.html">Namespace Index</a></td>
</table>
<h1 align=center>Class Gtk::Adjustment</h1><p>
<b>  A GtkObject representing an adjustable bounded value.</b><br>
Contained in: <a href="Gtk.html">Gtk</a><br>
Derived from:
<a href="Gtk%3A%3AData.html">Gtk::Data</a>
<br>
Derived by:
<i>none</i>
<p>
#include &lt;gtk--/adjustment.h&gt;
<p>
<hr noshade>
<table border=0>
<tr><td colspan=3><h3>public function member index:</h3></td>
<tr valign=top><td align=right><tt></tt> </td><td align=right><a href="Gtk%3A%3AAdjustment.html#69"><tt><font color=blue><b>Adjustment</b></font></tt></a></td><td><tt>(<tt><font color=purple>gfloat</font></tt> <tt><font color=blue>value</font></tt>, <tt><font color=purple>gfloat</font></tt> <tt><font color=blue>lower</font></tt>, <tt><font color=purple>gfloat</font></tt> <tt><font color=blue>upper</font></tt>, <tt><font color=purple>gfloat</font></tt> <tt><font color=blue>step_increment</font></tt>=1, <tt><font color=purple>gfloat</font></tt> <tt><font color=blue>page_increment</font></tt>=10, <tt><font color=purple>gfloat</font></tt> <tt><font color=blue>page_size</font></tt>=0)</tt>;</td>
<tr valign=top><td align=right><tt><tt>emitable</tt> <tt>signal</tt> <tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="Gtk%3A%3AAdjustment.html#70"><tt><font color=blue><b>changed</b></font></tt></a></td><td><tt>()</tt>;</td>
<tr valign=top><td align=right><tt><tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="Gtk%3A%3AAdjustment.html#72"><tt><font color=blue><b>clamp_page</b></font></tt></a></td><td><tt>(<tt><font color=purple>gfloat</font></tt> <tt><font color=blue>lower</font></tt>, <tt><font color=purple>gfloat</font></tt> <tt><font color=blue>upper</font></tt>)</tt>;</td>
<tr valign=top><td align=right><tt><tt><font color=purple>gfloat</font></tt></tt> </td><td align=right><a href="Gtk%3A%3AAdjustment.html#75"><tt><font color=blue><b>get_lower</b></font></tt></a></td><td><tt>() <tt>const</tt></tt>;</td>
<tr valign=top><td align=right><tt><tt><font color=purple>gfloat</font></tt></tt> </td><td align=right><a href="Gtk%3A%3AAdjustment.html#78"><tt><font color=blue><b>get_page_increment</b></font></tt></a></td><td><tt>() <tt>const</tt></tt>;</td>
<tr valign=top><td align=right><tt><tt><font color=purple>gfloat</font></tt></tt> </td><td align=right><a href="Gtk%3A%3AAdjustment.html#79"><tt><font color=blue><b>get_page_size</b></font></tt></a></td><td><tt>() <tt>const</tt></tt>;</td>
<tr valign=top><td align=right><tt><tt><font color=purple>gfloat</font></tt></tt> </td><td align=right><a href="Gtk%3A%3AAdjustment.html#77"><tt><font color=blue><b>get_step_increment</b></font></tt></a></td><td><tt>() <tt>const</tt></tt>;</td>
<tr valign=top><td align=right><tt><tt><font color=purple>gfloat</font></tt></tt> </td><td align=right><a href="Gtk%3A%3AAdjustment.html#76"><tt><font color=blue><b>get_upper</b></font></tt></a></td><td><tt>() <tt>const</tt></tt>;</td>
<tr valign=top><td align=right><tt><tt><font color=purple>gfloat</font></tt></tt> </td><td align=right><a href="Gtk%3A%3AAdjustment.html#74"><tt><font color=blue><b>get_value</b></font></tt></a></td><td><tt>() <tt>const</tt></tt>;</td>
<tr valign=top><td align=right><tt><tt><font color=navy>GtkAdjustment</font></tt>*</tt> </td><td align=right><a href="Gtk%3A%3AAdjustment.html#62"><tt><font color=blue><b>gtkobj</b></font></tt></a></td><td><tt>()</tt>;</td>
<tr valign=top><td align=right><tt><tt>const</tt> <tt><font color=navy>GtkAdjustment</font></tt>*</tt> </td><td align=right><a href="Gtk%3A%3AAdjustment.html#63"><tt><font color=blue><b>gtkobj</b></font></tt></a></td><td><tt>() <tt>const</tt></tt>;</td>
<tr valign=top><td align=right><tt><tt>static</tt> <tt><font color=purple>bool</font></tt></tt> </td><td align=right><a href="Gtk%3A%3AAdjustment.html#64"><tt><font color=blue><b>isA</b></font></tt></a></td><td><tt>(<a href="Gtk%3A%3AObject.html"><tt><font color=navy><b>Object</b></font></tt></a>* <tt><font color=blue>object</font></tt>)</tt>;</td>
<tr valign=top><td align=right><tt><tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="Gtk%3A%3AAdjustment.html#80"><tt><font color=blue><b>set_lower</b></font></tt></a></td><td><tt>(<tt><font color=purple>gfloat</font></tt> <tt><font color=blue>lower</font></tt>)</tt>;</td>
<tr valign=top><td align=right><tt><tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="Gtk%3A%3AAdjustment.html#83"><tt><font color=blue><b>set_page_increment</b></font></tt></a></td><td><tt>(<tt><font color=purple>gfloat</font></tt> <tt><font color=blue>incr</font></tt>)</tt>;</td>
<tr valign=top><td align=right><tt><tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="Gtk%3A%3AAdjustment.html#84"><tt><font color=blue><b>set_page_size</b></font></tt></a></td><td><tt>(<tt><font color=purple>gfloat</font></tt> <tt><font color=blue>size</font></tt>)</tt>;</td>
<tr valign=top><td align=right><tt><tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="Gtk%3A%3AAdjustment.html#82"><tt><font color=blue><b>set_step_increment</b></font></tt></a></td><td><tt>(<tt><font color=purple>gfloat</font></tt> <tt><font color=blue>incr</font></tt>)</tt>;</td>
<tr valign=top><td align=right><tt><tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="Gtk%3A%3AAdjustment.html#81"><tt><font color=blue><b>set_upper</b></font></tt></a></td><td><tt>(<tt><font color=purple>gfloat</font></tt> <tt><font color=blue>upper</font></tt>)</tt>;</td>
<tr valign=top><td align=right><tt><tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="Gtk%3A%3AAdjustment.html#73"><tt><font color=blue><b>set_value</b></font></tt></a></td><td><tt>(<tt><font color=purple>gfloat</font></tt> <tt><font color=blue>value</font></tt>)</tt>;</td>
<tr valign=top><td align=right><tt><tt>emitable</tt> <tt>signal</tt> <tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="Gtk%3A%3AAdjustment.html#71"><tt><font color=blue><b>value_changed</b></font></tt></a></td><td><tt>()</tt>;</td>
<tr valign=top><td align=right><tt><tt>virtual</tt> </tt> </td><td align=right><a href="Gtk%3A%3AAdjustment.html#65"><tt><font color=blue><b>~Adjustment</b></font></tt></a></td><td><tt>()</tt>;</td>
<tr><td>&nbsp;</td><tr><td colspan=3><h3>protected function member index:</h3></td>
<tr valign=top><td align=right><tt><tt>virtual</tt> <tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="Gtk%3A%3AAdjustment.html#85"><tt><font color=blue><b>changed_impl</b></font></tt></a></td><td><tt>()</tt>;</td>
<tr valign=top><td align=right><tt><tt>virtual</tt> <tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="Gtk%3A%3AAdjustment.html#86"><tt><font color=blue><b>value_changed_impl</b></font></tt></a></td><td><tt>()</tt>;</td>
<tr><td>&nbsp;</td></table>
<hr noshade>
<h2>Description:</h2>
  The adjustment is used for holding numerical values and controlling the range
  of values a widget can take on. It can be used with the <tt><font color=navy><b>Gtk::SpinButton::</b></font></tt>,
  <tt><font color=navy><b>Gtk::ScrollBar::</b></font></tt>, and <tt><font color=navy><b>Gtk::Scale::</b></font></tt> widgets.<br>
<p>
<hr noshade>
<h2>Function Member Descriptions:</h2>
<a name="69"><font size=+1><b>Gtk::Adjustment::Adjustment</b></font></a> -   Constructor.<br>
<hr size="1" width="70%" align="left" noshade="noshade"><tt></tt> <a href="Gtk%3A%3AAdjustment.html#69"><tt><font color=blue><b>Adjustment</b></font></tt></a><tt>(<tt><font color=purple>gfloat</font></tt> <tt><font color=blue>value</font></tt>, <tt><font color=purple>gfloat</font></tt> <tt><font color=blue>lower</font></tt>, <tt><font color=purple>gfloat</font></tt> <tt><font color=blue>upper</font></tt>, <tt><font color=purple>gfloat</font></tt> <tt><font color=blue>step_increment</font></tt>=1, <tt><font color=purple>gfloat</font></tt> <tt><font color=blue>page_increment</font></tt>=10, <tt><font color=purple>gfloat</font></tt> <tt><font color=blue>page_size</font></tt>=0)</tt>;<br><blockquote>  value: The initial value of the adjustment, and consequently, the widget that uses this adjustment.
         This value must be between lower and upper.
<P>
  lower: The lowest value this adjustment can take.
<P>
  upper: An upper value for the adjustment, but see below to determine what this value should be set to.
<P>
  step_increment: The amount the adjustment changes when incremented by one. For example, clicking on
                  a scrollbar's left or right arrows will change the value by this amount.
<P>
  page_increment: The amount an adjustment changes when "paged". Clicking in the trough of a scrollbar
                  or using the page up and page down keys will change the value by this amount.
<P>
  page_size: The relative size of a scrollbar's (or another widget's equivalent) handle. For example, if
             upper-lower equals 100, and page_size equals 25, then the bar will fill 1/4th of the
             width or height of the widget, leaving 3/4ths left as trough.
<P>
  The upper value is not the maximum value that the adjustment can achieve. To calculate the upper value,
  determine what you want the maximum value for the adjustment to be, and add the page_size amount to that.</blockquote>
<br><br>
<a name="70"><font size=+1><b>Gtk::Adjustment::changed</b></font></a> - <P><br>
<hr size="1" width="70%" align="left" noshade="noshade"><tt><tt>emitable</tt> <tt>signal</tt> <tt><font color=purple>void</font></tt></tt> <a href="Gtk%3A%3AAdjustment.html#70"><tt><font color=blue><b>changed</b></font></tt></a><tt>()</tt>;<br><tt><tt>virtual</tt> <tt><font color=purple>void</font></tt></tt> <a href="Gtk%3A%3AAdjustment.html#85"><tt><font color=blue><b>changed_impl</b></font></tt></a><tt>()</tt>;<br><br>
<a name="72"><font size=+1><b>Gtk::Adjustment::clamp_page</b></font></a> - <P><br>
<hr size="1" width="70%" align="left" noshade="noshade"><tt><tt><font color=purple>void</font></tt></tt> <a href="Gtk%3A%3AAdjustment.html#72"><tt><font color=blue><b>clamp_page</b></font></tt></a><tt>(<tt><font color=purple>gfloat</font></tt> <tt><font color=blue>lower</font></tt>, <tt><font color=purple>gfloat</font></tt> <tt><font color=blue>upper</font></tt>)</tt>;<br><br>
<a name="75"><font size=+1><b>Gtk::Adjustment::get_lower</b></font></a> -   Returns the current lower value.<br>
<hr size="1" width="70%" align="left" noshade="noshade"><tt><tt><font color=purple>gfloat</font></tt></tt> <a href="Gtk%3A%3AAdjustment.html#75"><tt><font color=blue><b>get_lower</b></font></tt></a><tt>() <tt>const</tt></tt>;<br><br>
<a name="78"><font size=+1><b>Gtk::Adjustment::get_page_increment</b></font></a> -   Returns the current page_increment value.<br>
<hr size="1" width="70%" align="left" noshade="noshade"><tt><tt><font color=purple>gfloat</font></tt></tt> <a href="Gtk%3A%3AAdjustment.html#78"><tt><font color=blue><b>get_page_increment</b></font></tt></a><tt>() <tt>const</tt></tt>;<br><br>
<a name="79"><font size=+1><b>Gtk::Adjustment::get_page_size</b></font></a> -   Returns the current page_size value.<br>
<hr size="1" width="70%" align="left" noshade="noshade"><tt><tt><font color=purple>gfloat</font></tt></tt> <a href="Gtk%3A%3AAdjustment.html#79"><tt><font color=blue><b>get_page_size</b></font></tt></a><tt>() <tt>const</tt></tt>;<br><br>
<a name="77"><font size=+1><b>Gtk::Adjustment::get_step_increment</b></font></a> -   Returns the current step_increment value.<br>
<hr size="1" width="70%" align="left" noshade="noshade"><tt><tt><font color=purple>gfloat</font></tt></tt> <a href="Gtk%3A%3AAdjustment.html#77"><tt><font color=blue><b>get_step_increment</b></font></tt></a><tt>() <tt>const</tt></tt>;<br><br>
<a name="76"><font size=+1><b>Gtk::Adjustment::get_upper</b></font></a> -   Returns the current upper value.<br>
<hr size="1" width="70%" align="left" noshade="noshade"><tt><tt><font color=purple>gfloat</font></tt></tt> <a href="Gtk%3A%3AAdjustment.html#76"><tt><font color=blue><b>get_upper</b></font></tt></a><tt>() <tt>const</tt></tt>;<br><br>
<a name="74"><font size=+1><b>Gtk::Adjustment::get_value</b></font></a> -   Returns the current value.<br>
<hr size="1" width="70%" align="left" noshade="noshade"><tt><tt><font color=purple>gfloat</font></tt></tt> <a href="Gtk%3A%3AAdjustment.html#74"><tt><font color=blue><b>get_value</b></font></tt></a><tt>() <tt>const</tt></tt>;<br><br>
<a name="62"><font size=+1><b>Gtk::Adjustment::gtkobj</b></font></a> -   Returns the underlaying gtk+ object.<br>
<hr size="1" width="70%" align="left" noshade="noshade"><tt><tt><font color=navy>GtkAdjustment</font></tt>*</tt> <a href="Gtk%3A%3AAdjustment.html#62"><tt><font color=blue><b>gtkobj</b></font></tt></a><tt>()</tt>;<br><br>
<a name="64"><font size=+1><b>Gtk::Adjustment::isA</b></font></a> -   Returns true if object is this type.<br>
<hr size="1" width="70%" align="left" noshade="noshade"><tt><tt>static</tt> <tt><font color=purple>bool</font></tt></tt> <a href="Gtk%3A%3AAdjustment.html#64"><tt><font color=blue><b>isA</b></font></tt></a><tt>(<a href="Gtk%3A%3AObject.html"><tt><font color=navy><b>Object</b></font></tt></a>* <tt><font color=blue>object</font></tt>)</tt>;<br><br>
<a name="80"><font size=+1><b>Gtk::Adjustment::set_lower</b></font></a> -   Sets the lower value.<br>
<hr size="1" width="70%" align="left" noshade="noshade"><tt><tt><font color=purple>void</font></tt></tt> <a href="Gtk%3A%3AAdjustment.html#80"><tt><font color=blue><b>set_lower</b></font></tt></a><tt>(<tt><font color=purple>gfloat</font></tt> <tt><font color=blue>lower</font></tt>)</tt>;<br><br>
<a name="83"><font size=+1><b>Gtk::Adjustment::set_page_increment</b></font></a> -   Sets the page_increment value.<br>
<hr size="1" width="70%" align="left" noshade="noshade"><tt><tt><font color=purple>void</font></tt></tt> <a href="Gtk%3A%3AAdjustment.html#83"><tt><font color=blue><b>set_page_increment</b></font></tt></a><tt>(<tt><font color=purple>gfloat</font></tt> <tt><font color=blue>incr</font></tt>)</tt>;<br><br>
<a name="84"><font size=+1><b>Gtk::Adjustment::set_page_size</b></font></a> -   Sets the page_size value.<br>
<hr size="1" width="70%" align="left" noshade="noshade"><tt><tt><font color=purple>void</font></tt></tt> <a href="Gtk%3A%3AAdjustment.html#84"><tt><font color=blue><b>set_page_size</b></font></tt></a><tt>(<tt><font color=purple>gfloat</font></tt> <tt><font color=blue>size</font></tt>)</tt>;<br><br>
<a name="82"><font size=+1><b>Gtk::Adjustment::set_step_increment</b></font></a> -   Sets the step_increment value.<br>
<hr size="1" width="70%" align="left" noshade="noshade"><tt><tt><font color=purple>void</font></tt></tt> <a href="Gtk%3A%3AAdjustment.html#82"><tt><font color=blue><b>set_step_increment</b></font></tt></a><tt>(<tt><font color=purple>gfloat</font></tt> <tt><font color=blue>incr</font></tt>)</tt>;<br><br>
<a name="81"><font size=+1><b>Gtk::Adjustment::set_upper</b></font></a> -   Sets the upper value.<br>
<hr size="1" width="70%" align="left" noshade="noshade"><tt><tt><font color=purple>void</font></tt></tt> <a href="Gtk%3A%3AAdjustment.html#81"><tt><font color=blue><b>set_upper</b></font></tt></a><tt>(<tt><font color=purple>gfloat</font></tt> <tt><font color=blue>upper</font></tt>)</tt>;<br><br>
<a name="73"><font size=+1><b>Gtk::Adjustment::set_value</b></font></a> -   Set the adjustment to a specific value. Will by default emit the value_changed signal.<br>
<hr size="1" width="70%" align="left" noshade="noshade"><tt><tt><font color=purple>void</font></tt></tt> <a href="Gtk%3A%3AAdjustment.html#73"><tt><font color=blue><b>set_value</b></font></tt></a><tt>(<tt><font color=purple>gfloat</font></tt> <tt><font color=blue>value</font></tt>)</tt>;<br><br>
<a name="71"><font size=+1><b>Gtk::Adjustment::value_changed</b></font></a> -   This signal is emmited when the adjustment's value has changed.<br>
<hr size="1" width="70%" align="left" noshade="noshade"><tt><tt>emitable</tt> <tt>signal</tt> <tt><font color=purple>void</font></tt></tt> <a href="Gtk%3A%3AAdjustment.html#71"><tt><font color=blue><b>value_changed</b></font></tt></a><tt>()</tt>;<br><tt><tt>virtual</tt> <tt><font color=purple>void</font></tt></tt> <a href="Gtk%3A%3AAdjustment.html#86"><tt><font color=blue><b>value_changed_impl</b></font></tt></a><tt>()</tt>;<br><br>
<hr noshade>
</html>