~ubuntu-branches/ubuntu/quantal/gtkmm3.0/quantal

« back to all changes in this revision

Viewing changes to docs/reference/html/classGtk_1_1Scale.html

  • Committer: Package Import Robot
  • Author(s): Sebastien Bacher
  • Date: 2012-03-01 23:42:36 UTC
  • mfrom: (1.1.8)
  • Revision ID: package-import@ubuntu.com-20120301234236-12w6m0hkomhi7h53
Tags: 3.3.16-0ubuntu1
* New upstream version
* debian/control.in: updated the glib requirement

Show diffs side-by-side

added added

removed removed

Lines of Context:
14
14
 <tbody>
15
15
 <tr style="height: 56px;">
16
16
  <td style="padding-left: 0.5em;">
17
 
   <div id="projectname">gtkmm&#160;<span id="projectnumber">3.3.14</span></div>
 
17
   <div id="projectname">gtkmm&#160;<span id="projectnumber">3.3.16</span></div>
18
18
  </td>
19
19
 </tr>
20
20
 </tbody>
99
99
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Removes any marks that have been added with <a class="el" href="classGtk_1_1Scale.html#a283af7d7d0ddb8fb3077b8082786d8d0" title="Adds a mark at value.">add_mark()</a>. <a href="#a9e3e8d0d052a6b9851a89de31cc13003"></a><br/></td></tr>
100
100
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1SignalProxy1.html">Glib::SignalProxy1</a><br class="typebreak"/>
101
101
&lt; <a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1ustring.html">Glib::ustring</a>, double &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Scale.html#a9c6c9c22c77387c820ba07fe5e107ad1">signal_format_value</a> ()</td></tr>
102
 
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Determines how the value is formatted. <a href="#a9c6c9c22c77387c820ba07fe5e107ad1"></a><br/></td></tr>
103
102
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1PropertyProxy.html">Glib::PropertyProxy</a>&lt; int &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Scale.html#a7b52dddc7ec049bc7e5c231bcf0b48f5">property_digits</a> ()</td></tr>
104
103
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Number of displayed decimal digits. <a href="#a7b52dddc7ec049bc7e5c231bcf0b48f5"></a><br/></td></tr>
105
104
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1PropertyProxy__ReadOnly.html">Glib::PropertyProxy_ReadOnly</a>&lt; int &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Scale.html#a60ecf386434a3f4543316815ec43a2bc">property_digits</a> () const </td></tr>
117
116
<tr><td colspan="2"><h2><a name="pro-methods"></a>
118
117
Protected Member Functions</h2></td></tr>
119
118
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1ustring.html">Glib::ustring</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Scale.html#a4a3077296b964a1140af324b0747601e">on_format_value</a> (double <a class="elRef" doxygen="libstdc++.tag:http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a01618.html#ga1c9e781d8d15a3814a601f471797c825">value</a>)</td></tr>
 
119
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">This is a default handler for the signal <a class="el" href="classGtk_1_1Scale.html#a9c6c9c22c77387c820ba07fe5e107ad1">signal_format_value()</a>. <a href="#a4a3077296b964a1140af324b0747601e"></a><br/></td></tr>
120
120
<tr><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Scale.html#a1a8610694ad2ff3e2123951af8a7ad55">draw_value_vfunc</a> ()</td></tr>
121
121
<tr><td class="memItemLeft" align="right" valign="top">virtual int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Scale.html#a222499c514f33d1d4b83d09edfdebc9c">calc_digits_</a> (double step) const </td></tr>
122
122
<tr><td colspan="2"><h2><a name="related"></a>
177
177
      </table>
178
178
</div>
179
179
<div class="memdoc">
180
 
<dl class="since_3_2"><dt><b><a class="el" href="since_3_2.html#_since_3_2000012">Since gtkmm 3.2:</a></b></dt><dd></dd></dl>
 
180
<dl class="since_3_2"><dt><b><a class="el" href="since_3_2.html#_since_3_2000033">Since gtkmm 3.2:</a></b></dt><dd></dd></dl>
181
181
 
182
182
</div>
183
183
</div>
244
244
<p>A mark is indicated visually by drawing a tick mark next to the scale, and GTK+ makes it easy for the user to position the scale exactly at the marks value.</p>
245
245
<p>If <em>markup</em> is not <code>0</code>, text is shown next to the tick mark.</p>
246
246
<p>To remove marks from a scale, use <a class="el" href="classGtk_1_1Scale.html#a9e3e8d0d052a6b9851a89de31cc13003" title="Removes any marks that have been added with add_mark().">clear_marks()</a>.</p>
247
 
<dl class="since_2_16"><dt><b><a class="el" href="since_2_16.html#_since_2_16000087">Since gtkmm 2.16:</a></b></dt><dd></dd></dl>
 
247
<dl class="since_2_16"><dt><b><a class="el" href="since_2_16.html#_since_2_16000089">Since gtkmm 2.16:</a></b></dt><dd></dd></dl>
248
248
<dl><dt><b>Parameters:</b></dt><dd>
249
249
  <table class="params">
250
250
    <tr><td class="paramname">value</td><td>The value at which the mark is placed, must be between the lower and upper limits of the scales' adjustment. </td></tr>
288
288
<div class="memdoc">
289
289
 
290
290
<p>Removes any marks that have been added with <a class="el" href="classGtk_1_1Scale.html#a283af7d7d0ddb8fb3077b8082786d8d0" title="Adds a mark at value.">add_mark()</a>. </p>
291
 
<dl class="since_2_16"><dt><b><a class="el" href="since_2_16.html#_since_2_16000088">Since gtkmm 2.16:</a></b></dt><dd></dd></dl>
 
291
<dl class="since_2_16"><dt><b><a class="el" href="since_2_16.html#_since_2_16000090">Since gtkmm 2.16:</a></b></dt><dd></dd></dl>
292
292
 
293
293
</div>
294
294
</div>
360
360
 
361
361
<p>Gets the <a class="elRef" doxygen="pangomm-1.4.tag:http://library.gnome.org/devel/pangomm/unstable/" href="http://library.gnome.org/devel/pangomm/unstable/classPango_1_1Layout.html">Pango::Layout</a> used to display the scale. </p>
362
362
<p>The returned object is owned by the scale so does not need to be freed by the caller.</p>
363
 
<dl class="since_2_4"><dt><b><a class="el" href="since_2_4.html#_since_2_4000218">Since gtkmm 2.4:</a></b></dt><dd></dd></dl>
364
 
<dl class="return"><dt><b>Returns:</b></dt><dd>The <a class="elRef" doxygen="pangomm-1.4.tag:http://library.gnome.org/devel/pangomm/unstable/" href="http://library.gnome.org/devel/pangomm/unstable/classPango_1_1Layout.html">Pango::Layout</a> for this scale, or <code>0</code> if the <a class="el" href="classGtk_1_1Scale.html" title="A slider widget for selecting a value from a range.">Gtk::Scale</a>:draw-value property is <code>false</code>. </dd></dl>
 
363
<dl class="since_2_4"><dt><b><a class="el" href="since_2_4.html#_since_2_4000230">Since gtkmm 2.4:</a></b></dt><dd></dd></dl>
 
364
<dl class="return"><dt><b>Returns:</b></dt><dd>The <a class="elRef" doxygen="pangomm-1.4.tag:http://library.gnome.org/devel/pangomm/unstable/" href="http://library.gnome.org/devel/pangomm/unstable/classPango_1_1Layout.html">Pango::Layout</a> for this scale, or <code>0</code> if the <a class="el" href="classGtk_1_1Scale.html#a4a72080b7356e7d6e764f038a78edcc9" title="Whether to draw the value as a string next to slider.">Gtk::Scale::property_draw_value()</a> property is <code>false</code>. </dd></dl>
365
365
 
366
366
</div>
367
367
</div>
381
381
 
382
382
<p>Gets the <a class="elRef" doxygen="pangomm-1.4.tag:http://library.gnome.org/devel/pangomm/unstable/" href="http://library.gnome.org/devel/pangomm/unstable/classPango_1_1Layout.html">Pango::Layout</a> used to display the scale. </p>
383
383
<p>The returned object is owned by the scale so does not need to be freed by the caller.</p>
384
 
<dl class="since_2_4"><dt><b><a class="el" href="since_2_4.html#_since_2_4000217">Since gtkmm 2.4:</a></b></dt><dd></dd></dl>
385
 
<dl class="return"><dt><b>Returns:</b></dt><dd>The <a class="elRef" doxygen="pangomm-1.4.tag:http://library.gnome.org/devel/pangomm/unstable/" href="http://library.gnome.org/devel/pangomm/unstable/classPango_1_1Layout.html">Pango::Layout</a> for this scale, or <code>0</code> if the <a class="el" href="classGtk_1_1Scale.html" title="A slider widget for selecting a value from a range.">Gtk::Scale</a>:draw-value property is <code>false</code>. </dd></dl>
 
384
<dl class="since_2_4"><dt><b><a class="el" href="since_2_4.html#_since_2_4000229">Since gtkmm 2.4:</a></b></dt><dd></dd></dl>
 
385
<dl class="return"><dt><b>Returns:</b></dt><dd>The <a class="elRef" doxygen="pangomm-1.4.tag:http://library.gnome.org/devel/pangomm/unstable/" href="http://library.gnome.org/devel/pangomm/unstable/classPango_1_1Layout.html">Pango::Layout</a> for this scale, or <code>0</code> if the <a class="el" href="classGtk_1_1Scale.html#a4a72080b7356e7d6e764f038a78edcc9" title="Whether to draw the value as a string next to slider.">Gtk::Scale::property_draw_value()</a> property is <code>false</code>. </dd></dl>
386
386
 
387
387
</div>
388
388
</div>
413
413
 
414
414
<p>Obtains the coordinates where the scale will draw the <a class="elRef" doxygen="pangomm-1.4.tag:http://library.gnome.org/devel/pangomm/unstable/" href="http://library.gnome.org/devel/pangomm/unstable/classPango_1_1Layout.html">Pango::Layout</a> representing the text in the scale. </p>
415
415
<p>Remember when using the <a class="elRef" doxygen="pangomm-1.4.tag:http://library.gnome.org/devel/pangomm/unstable/" href="http://library.gnome.org/devel/pangomm/unstable/classPango_1_1Layout.html">Pango::Layout</a> function you need to convert to and from pixels using PANGO_PIXELS() or <a class="elRef" doxygen="pangomm-1.4.tag:http://library.gnome.org/devel/pangomm/unstable/" href="http://library.gnome.org/devel/pangomm/unstable/namespacePango.html#a20d9629a369a6a5ab40ed9c01f879730">Pango::SCALE</a>.</p>
416
 
<p>If the <a class="el" href="classGtk_1_1Scale.html" title="A slider widget for selecting a value from a range.">Gtk::Scale</a>:draw-value property is <code>false</code>, the return values are undefined.</p>
417
 
<dl class="since_2_4"><dt><b><a class="el" href="since_2_4.html#_since_2_4000219">Since gtkmm 2.4:</a></b></dt><dd></dd></dl>
 
416
<p>If the <a class="el" href="classGtk_1_1Scale.html#a4a72080b7356e7d6e764f038a78edcc9" title="Whether to draw the value as a string next to slider.">Gtk::Scale::property_draw_value()</a> property is <code>false</code>, the return values are undefined.</p>
 
417
<dl class="since_2_4"><dt><b><a class="el" href="since_2_4.html#_since_2_4000231">Since gtkmm 2.4:</a></b></dt><dd></dd></dl>
418
418
<dl><dt><b>Parameters:</b></dt><dd>
419
419
  <table class="params">
420
420
    <tr><td class="paramname">x</td><td>Location to store X offset of layout, or <code>0</code>. </td></tr>
502
502
</div>
503
503
<div class="memdoc">
504
504
 
 
505
<p>This is a default handler for the signal <a class="el" href="classGtk_1_1Scale.html#a9c6c9c22c77387c820ba07fe5e107ad1">signal_format_value()</a>. </p>
 
506
 
505
507
</div>
506
508
</div>
507
509
<a class="anchor" id="a60ecf386434a3f4543316815ec43a2bc"></a><!-- doxytag: member="Gtk::Scale::property_digits" ref="a60ecf386434a3f4543316815ec43a2bc" args="() const " -->
539
541
<div class="memdoc">
540
542
 
541
543
<p>Number of displayed decimal digits. </p>
542
 
<p>The number of decimal places that are displayed in the value.</p>
543
544
<p>You rarely need to use properties because there are get_ and set_ methods for almost all of them. </p>
544
545
<dl class="return"><dt><b>Returns:</b></dt><dd>A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes. </dd></dl>
545
546
 
560
561
<div class="memdoc">
561
562
 
562
563
<p>Whether to draw the value as a string next to slider. </p>
563
 
<p>Whether the current value is displayed as a string next to the slider.</p>
564
564
<p>You rarely need to use properties because there are get_ and set_ methods for almost all of them. </p>
565
565
<dl class="return"><dt><b>Returns:</b></dt><dd>A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes. </dd></dl>
566
566
 
601
601
<div class="memdoc">
602
602
 
603
603
<p>The position in which the value is displayed. </p>
604
 
<p>The position in which the current value is displayed.</p>
605
604
<p>You rarely need to use properties because there are get_ and set_ methods for almost all of them. </p>
606
605
<dl class="return"><dt><b>Returns:</b></dt><dd>A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes. </dd></dl>
607
606
 
698
697
      </table>
699
698
</div>
700
699
<div class="memdoc">
701
 
 
702
 
<p>Determines how the value is formatted. </p>
703
 
<p>This can be used to connect a custom function for determining how the value is formatted. The function (or function object) is given a the value as a double and should return the representation of it as a <a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1ustring.html">Glib::ustring</a>.</p>
704
 
<dl class="user"><dt><b>Prototype:</b></dt><dd><code><a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1ustring.html">Glib::ustring</a> on_my_format_value(double value)</code> </dd></dl>
 
700
<dl class="user"><dt><b>Slot Prototype:</b></dt><dd><code><a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1ustring.html">Glib::ustring</a> on_my_format_value(double value)</code></dd></dl>
 
701
<p>Signal which allows you to change how the scale value is displayed. Connect a signal handler which returns an allocated string representing <em>value</em>. That string will then be used to display the scale's value.</p>
 
702
<p>Here's an example signal handler which displays a value 1.0 as with "--&gt;1.0&lt;--".</p>
 
703
<p>[C example ellipted] </p>
 
704
<dl><dt><b>Parameters:</b></dt><dd>
 
705
  <table class="params">
 
706
    <tr><td class="paramname">value</td><td>The value to format. </td></tr>
 
707
  </table>
 
708
  </dd>
 
709
</dl>
 
710
<dl class="return"><dt><b>Returns:</b></dt><dd>Allocated string representing <em>value</em>. </dd></dl>
705
711
 
706
712
</div>
707
713
</div>
747
753
<li>gtkmm/scale.h</li>
748
754
</ul>
749
755
</div>
750
 
<hr class="footer"/><address class="footer"><small>Generated on Tue Feb 7 2012 10:44:09 for gtkmm by&#160;
 
756
<hr class="footer"/><address class="footer"><small>Generated on Tue Feb 28 2012 10:01:55 for gtkmm by&#160;
751
757
<a href="http://www.doxygen.org/index.html">
752
758
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address>
753
759
</body>