← Back to branch summary

~canonical-dx-team/ubuntu/maverick/gtk+2.0/menuproxy

« back to all changes in this revision

Viewing changes to docs/reference/gtk/html/GtkScrolledWindow.html

  • Committer: Bazaar Package Importer
  • Author(s): Sebastian Dröge
  • Date: 2010-06-11 12:19:30 UTC
  • mfrom: (1.11.6 upstream)
  • mto: This revision was merged to the branch mainline in revision 175.
  • Revision ID: james.westby@ubuntu.com-20100611121930-n4pklvkoqdsg12vm
Tags: 2.21.2-1
* New upstream development release:
  + debian/rules,
    debian/libgtk2.0-0.symbols:
    - Update for new API symbols.
  + debian/patches/070_mandatory-relibtoolize.patch:
    - Regenerated for the new version.
  + debian/control.in:
    - Update GLib (build-) dependency to >= 2.25.8.

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/gtk/html/GtkScrolledWindow.html
82
82
<div class="refsect1" title="Object Hierarchy">
83
83
<a name="GtkScrolledWindow.object-hierarchy"></a><h2>Object Hierarchy</h2>
84
84
<pre class="synopsis">
85
 
  <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>
86
 
   +----<a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
 
85
  <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
 
86
   +----<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
87
87
         +----<a class="link" href="GtkObject.html" title="GtkObject">GtkObject</a>
88
88
               +----<a class="link" href="GtkWidget.html" title="GtkWidget">GtkWidget</a>
89
89
                     +----<a class="link" href="GtkContainer.html" title="GtkContainer">GtkContainer</a>
106
106
  "<a class="link" href="GtkScrolledWindow.html#GtkScrolledWindow--vadjustment" title='The "vadjustment" property'>vadjustment</a>"              <a class="link" href="GtkAdjustment.html" title="GtkAdjustment"><span class="type">GtkAdjustment</span></a>*        : Read / Write / Construct
107
107
  "<a class="link" href="GtkScrolledWindow.html#GtkScrolledWindow--vscrollbar-policy" title='The "vscrollbar-policy" property'>vscrollbar-policy</a>"        <a class="link" href="gtk-Standard-Enumerations.html#GtkPolicyType" title="enum GtkPolicyType"><span class="type">GtkPolicyType</span></a>         : Read / Write
108
108
  "<a class="link" href="GtkScrolledWindow.html#GtkScrolledWindow--window-placement" title='The "window-placement" property'>window-placement</a>"         <a class="link" href="gtk-Standard-Enumerations.html#GtkCornerType" title="enum GtkCornerType"><span class="type">GtkCornerType</span></a>         : Read / Write
109
 
  "<a class="link" href="GtkScrolledWindow.html#GtkScrolledWindow--window-placement-set" title='The "window-placement-set" property'>window-placement-set</a>"     <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
 
109
  "<a class="link" href="GtkScrolledWindow.html#GtkScrolledWindow--window-placement-set" title='The "window-placement-set" property'>window-placement-set</a>"     <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
110
110
</pre>
111
111
</div>
112
112
<div class="refsect1" title="Style Properties">
113
113
<a name="GtkScrolledWindow.style-properties"></a><h2>Style Properties</h2>
114
114
<pre class="synopsis">
115
 
  "<a class="link" href="GtkScrolledWindow.html#GtkScrolledWindow--s-scrollbar-spacing" title='The "scrollbar-spacing" style property'>scrollbar-spacing</a>"        <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read
116
 
  "<a class="link" href="GtkScrolledWindow.html#GtkScrolledWindow--s-scrollbars-within-bevel" title='The "scrollbars-within-bevel" style property'>scrollbars-within-bevel</a>"  <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read
 
115
  "<a class="link" href="GtkScrolledWindow.html#GtkScrolledWindow--s-scrollbar-spacing" title='The "scrollbar-spacing" style property'>scrollbar-spacing</a>"        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read
 
116
  "<a class="link" href="GtkScrolledWindow.html#GtkScrolledWindow--s-scrollbars-within-bevel" title='The "scrollbars-within-bevel" style property'>scrollbars-within-bevel</a>"  <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read
117
117
</pre>
118
118
</div>
119
119
<div class="refsect1" title="Signals">
135
135
The scrolled window can work in two ways. Some widgets have native
136
136
scrolling support; these widgets have "slots" for <a class="link" href="GtkAdjustment.html" title="GtkAdjustment"><span class="type">GtkAdjustment</span></a>
137
137
objects.
138
 
<sup>[<a name="id1184447" href="#ftn.id1184447" class="footnote">5</a>]</sup>
 
138
<sup>[<a name="id1063211" href="#ftn.id1063211" class="footnote">5</a>]</sup>
139
139
Widgets with native scroll support include <a class="link" href="GtkTreeView.html" title="GtkTreeView"><span class="type">GtkTreeView</span></a>, <a class="link" href="GtkTextView.html" title="GtkTextView"><span class="type">GtkTextView</span></a>,
140
140
and <a class="link" href="GtkLayout.html" title="GtkLayout"><span class="type">GtkLayout</span></a>.
141
141
</p>
195
195
<p>
196
196
The two arguments are the scrolled window's adjustments; these will be
197
197
shared with the scrollbars and the child widget to keep the bars in sync 
198
 
with the child. Usually you want to pass <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> for the adjustments, which 
 
198
with the child. Usually you want to pass <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> for the adjustments, which 
199
199
will cause the scrolled window to create them for you.
200
200
</p>
201
201
<div class="variablelist"><table border="0">
287
287
<tr>
288
288
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
289
289
<td> the horizontal scrollbar of the scrolled window, or 
290
 
 <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if it does not have one.
 
290
 <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if it does not have one.
291
291
 
292
292
</td>
293
293
</tr>
313
313
<tr>
314
314
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
315
315
<td> the vertical scrollbar of the scrolled window, or
316
 
 <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if it does not have one.
 
316
 <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if it does not have one.
317
317
 
318
318
</td>
319
319
</tr>
373
373
<a class="link" href="GtkContainer.html#gtk-container-add" title="gtk_container_add ()"><code class="function">gtk_container_add()</code></a> instead of this function.
374
374
</p>
375
375
<p>
376
 
The viewport scrolls the child by moving its <a href="/usr/share/gtk-doc/html/gdk/gdk-Windows.html#GdkWindow"><span class="type">GdkWindow</span></a>, and takes
377
 
the size of the child to be the size of its toplevel <a href="/usr/share/gtk-doc/html/gdk/gdk-Windows.html#GdkWindow"><span class="type">GdkWindow</span></a>. 
 
376
The viewport scrolls the child by moving its <a href="http://library.gnome.org/devel/gdk/unstable/gdk-Windows.html#GdkWindow"><span class="type">GdkWindow</span></a>, and takes
 
377
the size of the child to be the size of its toplevel <a href="http://library.gnome.org/devel/gdk/unstable/gdk-Windows.html#GdkWindow"><span class="type">GdkWindow</span></a>. 
378
378
This will be very wrong for most widgets that support native scrolling;
379
379
for example, if you add a widget such as <a class="link" href="GtkTreeView.html" title="GtkTreeView"><span class="type">GtkTreeView</span></a> with a viewport,
380
380
the whole widget will scroll, including the column headings. Thus, 
581
581
<tr>
582
582
<td><p><span class="term"><em class="parameter"><code>hscrollbar_policy</code></em> :</span></p></td>
583
583
<td>location to store the policy for the horizontal 
584
 
    scrollbar, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.
 
584
    scrollbar, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.
585
585
</td>
586
586
</tr>
587
587
<tr>
588
588
<td><p><span class="term"><em class="parameter"><code>vscrollbar_policy</code></em> :</span></p></td>
589
589
<td>location to store the policy for the vertical
590
 
    scrollbar, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.
 
590
    scrollbar, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.
591
591
</td>
592
592
</tr>
593
593
</tbody>
662
662
<hr>
663
663
<div class="refsect2" title='The "window-placement-set" property'>
664
664
<a name="GtkScrolledWindow--window-placement-set"></a><h3>The <code class="literal">"window-placement-set"</code> property</h3>
665
 
<pre class="programlisting">  "window-placement-set"     <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
 
665
<pre class="programlisting">  "window-placement-set"     <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
666
666
<p>
667
667
Whether "window-placement" should be used to determine the location
668
668
of the contents with respect to the scrollbars. Otherwise, the 
676
676
<a name="GtkScrolledWindow.style-property-details"></a><h2>Style Property Details</h2>
677
677
<div class="refsect2" title='The "scrollbar-spacing" style property'>
678
678
<a name="GtkScrolledWindow--s-scrollbar-spacing"></a><h3>The <code class="literal">"scrollbar-spacing"</code> style property</h3>
679
 
<pre class="programlisting">  "scrollbar-spacing"        <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read</pre>
 
679
<pre class="programlisting">  "scrollbar-spacing"        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read</pre>
680
680
<p>Number of pixels between the scrollbars and the scrolled window.</p>
681
681
<p>Allowed values: &gt;= 0</p>
682
682
<p>Default value: 3</p>
684
684
<hr>
685
685
<div class="refsect2" title='The "scrollbars-within-bevel" style property'>
686
686
<a name="GtkScrolledWindow--s-scrollbars-within-bevel"></a><h3>The <code class="literal">"scrollbars-within-bevel"</code> style property</h3>
687
 
<pre class="programlisting">  "scrollbars-within-bevel"  <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read</pre>
 
687
<pre class="programlisting">  "scrollbars-within-bevel"  <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read</pre>
688
688
<p>
689
689
Whether to place scrollbars within the scrolled window's bevel.
690
690
</p>
698
698
<a name="GtkScrolledWindow-move-focus-out"></a><h3>The <code class="literal">"move-focus-out"</code> signal</h3>
699
699
<pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="GtkScrolledWindow.html" title="GtkScrolledWindow"><span class="type">GtkScrolledWindow</span></a> *scrolledwindow,
700
700
                                                        <a class="link" href="gtk-Standard-Enumerations.html#GtkDirectionType" title="enum GtkDirectionType"><span class="type">GtkDirectionType</span></a>   arg1,
701
 
                                                        <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>           user_data)           : Run Last / Action</pre>
 
701
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>           user_data)           : Run Last / Action</pre>
702
702
<p>
703
703
</p>
704
704
<div class="variablelist"><table border="0">
724
724
<hr>
725
725
<div class="refsect2" title='The "scroll-child" signal'>
726
726
<a name="GtkScrolledWindow-scroll-child"></a><h3>The <code class="literal">"scroll-child"</code> signal</h3>
727
 
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            user_function                      (<a class="link" href="GtkScrolledWindow.html" title="GtkScrolledWindow"><span class="type">GtkScrolledWindow</span></a> *scrolledwindow,
 
727
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            user_function                      (<a class="link" href="GtkScrolledWindow.html" title="GtkScrolledWindow"><span class="type">GtkScrolledWindow</span></a> *scrolledwindow,
728
728
                                                        <a class="link" href="gtk-Standard-Enumerations.html#GtkScrollType" title="enum GtkScrollType"><span class="type">GtkScrollType</span></a>      arg1,
729
 
                                                        <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>           arg2,
730
 
                                                        <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>           user_data)           : Run Last / Action</pre>
 
729
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>           arg2,
 
730
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>           user_data)           : Run Last / Action</pre>
731
731
<p>
732
732
</p>
733
733
<div class="variablelist"><table border="0">
769
769
</div>
770
770
<div class="footnotes">
771
771
<br><hr width="100" align="left">
772
 
<div class="footnote"><p><sup>[<a name="ftn.id1184447" href="#id1184447" class="para">5</a>] </sup>The scrolled window installs <a class="link" href="GtkAdjustment.html" title="GtkAdjustment"><span class="type">GtkAdjustment</span></a> objects in
 
772
<div class="footnote"><p><sup>[<a name="ftn.id1063211" href="#id1063211" class="para">5</a>] </sup>The scrolled window installs <a class="link" href="GtkAdjustment.html" title="GtkAdjustment"><span class="type">GtkAdjustment</span></a> objects in
773
773
the child window's slots using the set_scroll_adjustments_signal,
774
774
found in <a class="link" href="GtkWidget.html#GtkWidgetClass" title="GtkWidgetClass"><span class="type">GtkWidgetClass</span></a>. (Conceptually, these widgets implement a
775
775
"Scrollable" interface; because GTK+ 1.2 lacked interface support in