diff options
Diffstat (limited to 'docs/reference/pygtk-gtkrange.xml')
| -rw-r--r-- | docs/reference/pygtk-gtkrange.xml | 790 |
1 files changed, 0 insertions, 790 deletions
diff --git a/docs/reference/pygtk-gtkrange.xml b/docs/reference/pygtk-gtkrange.xml deleted file mode 100644 index e2ce9918..00000000 --- a/docs/reference/pygtk-gtkrange.xml +++ /dev/null @@ -1,790 +0,0 @@ -<?xml version="1.0" standalone="no"?> -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" - "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"> - -<refentry id="class-gtkrange"> - <refnamediv> - <refname>gtk.Range</refname> - <refpurpose>a base class for widgets that allow a user to set a value in -a range.</refpurpose> - </refnamediv> - - <refsect1> - <title>Synopsis</title> - - <classsynopsis language="python"> - <ooclass><classname>gtk.Range</classname></ooclass> - <ooclass><classname><link -linkend="class-gtkwidget">gtk.Widget</link></classname></ooclass> - <methodsynopsis language="python"> - <methodname><link -linkend="method-gtkrange--set-update-policy">set_update_policy</link></methodname> - <methodparam><parameter - role="keyword">policy</parameter></methodparam> - </methodsynopsis> - <methodsynopsis language="python"> - <methodname><link -linkend="method-gtkrange--get-update-policy">get_update_policy</link></methodname> - <methodparam></methodparam> </methodsynopsis> - <methodsynopsis language="python"> - <methodname><link -linkend="method-gtkrange--set-adjustment">set_adjustment</link></methodname> - <methodparam><parameter - role="keyword">adjustment</parameter></methodparam> - </methodsynopsis> - <methodsynopsis language="python"> - <methodname><link -linkend="method-gtkrange--get-adjustment">get_adjustment</link></methodname> - <methodparam></methodparam> </methodsynopsis> - <methodsynopsis language="python"> - <methodname><link -linkend="method-gtkrange--set-inverted">set_inverted</link></methodname> - <methodparam><parameter - role="keyword">setting</parameter></methodparam> - </methodsynopsis> - <methodsynopsis language="python"> - <methodname><link -linkend="method-gtkrange--get-inverted">get_inverted</link></methodname> - <methodparam></methodparam> </methodsynopsis> - <methodsynopsis language="python"> - <methodname><link -linkend="method-gtkrange--set-increments">set_increments</link></methodname> - <methodparam><parameter - role="keyword">step</parameter></methodparam> - <methodparam><parameter - role="keyword">page</parameter></methodparam> - </methodsynopsis> - <methodsynopsis language="python"> - <methodname><link -linkend="method-gtkrange--set-range">set_range</link></methodname> - <methodparam><parameter role="keyword">min</parameter></methodparam> - <methodparam><parameter role="keyword">max</parameter></methodparam> - </methodsynopsis> - <methodsynopsis language="python"> - <methodname><link -linkend="method-gtkrange--set-value">set_value</link></methodname> - <methodparam><parameter - role="keyword">value</parameter></methodparam> - </methodsynopsis> - <methodsynopsis language="python"> - <methodname><link -linkend="method-gtkrange--get-value">get_value</link></methodname> - <methodparam></methodparam> </methodsynopsis> - </classsynopsis> - - </refsect1> - - <refsect1> - <title>Ancestry</title> - -<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link> - +-- <link linkend="class-gtkobject">gtk.Object</link> - +-- <link linkend="class-gtkwidget">gtk.Widget</link> - +-- <link linkend="class-gtkrange">gtk.Range</link> -</synopsis> - - </refsect1> - - <refsect1 id="properties-gtkrange"> - <title>gtk.Range Properties</title> - - <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para> - <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para> - - <blockquote role="properties"> - <informaltable pgwide="1" frame="none"> - <tgroup cols="3"> - <colspec column="1" colwidth="1in"/> - <colspec column="2" colwidth="1in"/> - <colspec column="3" colwidth="4in"/> - <tbody> - - <row valign="top"> - <entry>"adjustment"</entry> - <entry>Read-Write</entry> - <entry>The <link - linkend="class-gtkadjustment"><classname>gtk.Adjustment</classname></link> - that contains the current value of this range object</entry> - </row> - - <row valign="top"> - <entry>"inverted"</entry> - <entry>Read-Write</entry> - <entry>If <literal>True</literal>, the slider movement is - reversed e.g right-to-left instead of left-to-right</entry> - </row> - - <row valign="top"> - <entry>"lower-stepper-sensitivity"</entry> - <entry>Read-Write</entry> - <entry>The sensitivity policy for the stepper that points to the - adjustment's lower side</entry> - </row> - - <row valign="top"> - <entry>"update-policy"</entry> - <entry>Read-Write</entry> - <entry>How the range should be updated on the screen: - <literal>gtk.UPDATE_CONTINUOUS</literal>, - <literal>gtk.UPDATE_DISCONTINUOUS</literal>, - <literal>gtk.UPDATE_DELAYED</literal>.</entry> - </row> - - </tbody> - </tgroup> - </informaltable> - </blockquote> - - </refsect1> - - <refsect1 id="style-properties-gtkrange"> - <title>gtk.Range Style Properties</title> - - <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para> - - <blockquote role="properties"> - <informaltable pgwide="1" frame="none"> - <tgroup cols="3"> - <colspec column="1" colwidth="1in"/> - <colspec column="2" colwidth="1in"/> - <colspec column="3" colwidth="4in"/> - <tbody> - - <row valign="top"> - <entry>"activate-slider"</entry> - <entry>Read</entry> - <entry>With this option set to <literal>True</literal>, - sliders will be drawn <literal>ACTIVE</literal> and with - shadow <literal>IN</literal> while they are dragged</entry> - </row> - - <row valign="top"> - <entry>"arrow-displacement-x"</entry> - <entry>Read</entry> - <entry>The distance horizontally to move the arrow when the - button is depressed</entry> - </row> - - <row valign="top"> - <entry>"arrow-displacement-y"</entry> - <entry>Read</entry> - <entry>The distance vertically to move the arrow when the - button is depressed</entry> - </row> - - <row valign="top"> - <entry>"slider-width"</entry> - <entry>Read</entry> - <entry>The width of scrollbar or scale thumb</entry> - </row> - - <row valign="top"> - <entry>"stepper-size"</entry> - <entry>Read</entry> - <entry>The length of step buttons at ends</entry> - </row> - - <row valign="top"> - <entry>"stepper-spacing"</entry> - <entry>Read</entry> - <entry>The spacing between step buttons and thumb</entry> - </row> - - <row valign="top"> - <entry>"trough-border"</entry> - <entry>Read</entry> - <entry>The spacing between thumb or steppers and outer trough - bevel</entry> - </row> - - <row valign="top"> - <entry>"trough-side-details"</entry> - <entry>Read</entry> - <entry>This property is available in GTK+ 2.10 and above.</entry> - </row> - - <row valign="top"> - <entry>"trough-under-steppers"</entry> - <entry>Read</entry> - <entry>if <literal>True</literal> draw the trough across the - full length of the range or to exclude the steppers and their - spacing. Note that setting the "stepper-spacing" style - property to any value > 0 will automatically enable - "trough-under-steppers" too. This property is available in - GTK+ 2.10 and above.</entry> - </row> - - </tbody> - </tgroup> - </informaltable> - </blockquote> - - </refsect1> - - <refsect1 id="signal-prototypes-gtkrange"> - <title>gtk.Range Signal Prototypes</title> - - <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para> - <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para> - <para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para> - - <variablelist> - <varlistentry> - <term>"<link -linkend="signal-gtkrange--adjust-bounds">adjust-bounds</link>"</term> - <listitem> - <methodsynopsis - language="python"><methodname>callback</methodname> - <methodparam><parameter>range</parameter></methodparam> - <methodparam><parameter>value</parameter></methodparam> - <methodparam><parameter>user_param1</parameter></methodparam> - <methodparam><parameter>...</parameter></methodparam> - </methodsynopsis> - </listitem> - </varlistentry> - <varlistentry> - <term>"<link linkend="signal-gtkrange--change-value">change-value</link></term> - <listitem> - <methodsynopsis language="python"><methodname>callback</methodname> - <methodparam><parameter>range</parameter></methodparam> - <methodparam><parameter>scroll</parameter></methodparam> - <methodparam><parameter>value</parameter></methodparam> - <methodparam><parameter>arg1</parameter></methodparam> - <methodparam><parameter>arg2</parameter></methodparam> - <methodparam><parameter>user_param1</parameter></methodparam> - <methodparam><parameter>...</parameter></methodparam> - </methodsynopsis> - </listitem> - </varlistentry> - <varlistentry> - <term>"<link -linkend="signal-gtkrange--move-slider">move-slider</link>"</term> - <listitem> - <methodsynopsis - language="python"><methodname>callback</methodname> - <methodparam><parameter>range</parameter></methodparam> - <methodparam><parameter>scrolltype</parameter></methodparam> - <methodparam><parameter>user_param1</parameter></methodparam> - <methodparam><parameter>...</parameter></methodparam> - </methodsynopsis> - </listitem> - </varlistentry> - <varlistentry> - <term>"<link -linkend="signal-gtkrange--value-changed">value-changed</link>"</term> - <listitem> - <methodsynopsis - language="python"><methodname>callback</methodname> - <methodparam><parameter>range</parameter></methodparam> - <methodparam><parameter>user_param1</parameter></methodparam> - <methodparam><parameter>...</parameter></methodparam> - </methodsynopsis> - </listitem> - </varlistentry> - </variablelist> - - </refsect1> - - <refsect1> - <title>Description</title> - - <para>The <link -linkend="class-gtkrange"><classname>gtk.Range</classname></link> is the base -class for the <link -linkend="class-gtkscale"><classname>gtk.Scale</classname></link> and <link -linkend="class-gtkscrollbar"><classname>gtk.Scrollbar</classname></link> -widgets. The <link -linkend="class-gtkrange"><classname>gtk.Range</classname></link> provides -the common functionality for these widgets that allow a user to set a value -in a range of values. The <link -linkend="class-gtkscale"><classname>gtk.Scale</classname></link> works in -conjunction with a <link -linkend="class-gtkadjustment"><classname>gtk.Adjustment</classname></link> -which provides the range information.</para> - - </refsect1> - - <refsect1> - <title>Methods</title> - - <refsect2 id="method-gtkrange--set-update-policy"> - <title>gtk.Range.set_update_policy</title> - - <programlisting><methodsynopsis language="python"> - <methodname>set_update_policy</methodname> - <methodparam><parameter - role="keyword">policy</parameter></methodparam> - </methodsynopsis></programlisting> - <variablelist> - <varlistentry> - <term><parameter role="keyword">policy</parameter> :</term> - <listitem><simpara>the update policy: -<literal>gtk.UPDATE_CONTINUOUS</literal>, -<literal>gtk.UPDATE_DISCONTINUOUS</literal>, -<literal>gtk.UPDATE_DELAYED</literal></simpara></listitem> - </varlistentry> - </variablelist> - - <para>The <methodname>set_update_policy</methodname>() method sets the -"update-policy" property to the value specified by -<parameter>policy</parameter>. The update policy has the following values -and effects:</para> - - - <variablelist> - <varlistentry> - <term><literal>gtk.UPDATE_CONTINUOUS</literal></term> - <listitem> - <simpara>anytime the range slider is moved, the range value will -change and the "value_changed" signal will be emitted.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.UPDATE_DELAYED</literal></term> - <listitem> - <simpara>the value will be updated after a brief timeout where -no slider motion occurs, so value changes are delayed slightly rather than -continuously updated.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><literal>gtk.UPDATE_DISCONTINUOUS</literal></term> - <listitem> - <simpara>the value will only be updated when the user releases -the button and ends the slider drag operation.</simpara> - </listitem> - </varlistentry> - </variablelist> - - <para></para> - - </refsect2> - - <refsect2 id="method-gtkrange--get-update-policy"> - <title>gtk.Range.get_update_policy</title> - - <programlisting><methodsynopsis language="python"> - <methodname>get_update_policy</methodname> - <methodparam></methodparam> </methodsynopsis></programlisting> - <variablelist> - <varlistentry> - <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara>the current update policy</simpara></listitem> - </varlistentry> - </variablelist> - - <para>The <methodname>get_update_policy</methodname>() method gets the -value of the "update-policy" property. The update policy is one of: -<literal>gtk.UPDATE_CONTINUOUS</literal>, -<literal>gtk.UPDATE_DISCONTINUOUS</literal> or -<literal>gtk.UPDATE_DELAYED</literal>. See the <link -linkend="method-gtkrange--set-update-policy"><methodname>set_update_policy</methodname>()</link> -method for details.</para> - - </refsect2> - - <refsect2 id="method-gtkrange--set-adjustment"> - <title>gtk.Range.set_adjustment</title> - - <programlisting><methodsynopsis language="python"> - <methodname>set_adjustment</methodname> - <methodparam><parameter - role="keyword">adjustment</parameter></methodparam> - </methodsynopsis></programlisting> - <variablelist> - <varlistentry> - <term><parameter -role="keyword">adjustment</parameter> :</term> - <listitem><simpara>a <link -linkend="class-gtkadjustment"><classname>gtk.Adjustment</classname></link></simpara></listitem> - </varlistentry> - </variablelist> - - <para>The <methodname>set_adjustment</methodname>() method sets the -"adjustment" property to the value specified by -<parameter>adjustment</parameter>. The <link -linkend="class-gtkadjustment"><classname>gtk.Adjustment</classname></link> -is used as the "model" object for this range widget. -<parameter>adjustment</parameter> indicates the current range value, the -minimum and maximum range values, the step and page increments used for -keybindings and scrolling, and the page size. The page size is normally 0 -for <link linkend="class-gtkscale"><classname>gtk.Scale</classname></link> -and nonzero for <link -linkend="class-gtkscrollbar"><classname>gtk.Scrollbar</classname></link>, -and indicates the size of the visible area of the widget being scrolled. The -page size affects the size of the scrollbar slider.</para> - - </refsect2> - - <refsect2 id="method-gtkrange--get-adjustment"> - <title>gtk.Range.get_adjustment</title> - - <programlisting><methodsynopsis language="python"> - <methodname>get_adjustment</methodname> - <methodparam></methodparam> </methodsynopsis></programlisting> - <variablelist> - <varlistentry> - <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara>a <link -linkend="class-gtkadjustment"><classname>gtk.Adjustment</classname></link></simpara></listitem> - </varlistentry> - </variablelist> - - <para>The <methodname>get_adjustment</methodname>() method returns the -value of the "adjustment" property. See the <link -linkend="method-gtkrange--set-adjustment"><methodname>set_adjustment</methodname>()</link> -method for details.</para> - - </refsect2> - - <refsect2 id="method-gtkrange--set-inverted"> - <title>gtk.Range.set_inverted</title> - - <programlisting><methodsynopsis language="python"> - <methodname>set_inverted</methodname> - <methodparam><parameter - role="keyword">setting</parameter></methodparam> - </methodsynopsis></programlisting> - <variablelist> - <varlistentry> - <term><parameter role="keyword">setting</parameter> :</term> - <listitem><simpara>if <literal>True</literal> invert the -range</simpara></listitem> - </varlistentry> - </variablelist> - - <para>The <methodname>set_inverted</methodname>() method sets the -"inverted" property to the value specified by -<parameter>setting</parameter>. If <parameter>setting</parameter> is -<literal>True</literal> the normal motion of the range widget is reversed. -Ranges normally move from lower to higher values as the slider moves from -top to bottom or left to right. Inverted ranges have higher values at the -top or left rather than on the bottom or right.</para> - - </refsect2> - - <refsect2 id="method-gtkrange--get-inverted"> - <title>gtk.Range.get_inverted</title> - - <programlisting><methodsynopsis language="python"> - <methodname>get_inverted</methodname> - <methodparam></methodparam> </methodsynopsis></programlisting> - <variablelist> - <varlistentry> - <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara><literal>True</literal> if the range is -inverted</simpara></listitem> - </varlistentry> - </variablelist> - - <para>The <methodname>get_inverted</methodname>() method returns the -value of the "inverted" property that was set by the <link -linkend="method-gtkrange--set-inverted"><methodname>set_inverted</methodname>()</link> -method.</para> - - </refsect2> - - <refsect2 id="method-gtkrange--set-increments"> - <title>gtk.Range.set_increments</title> - - <programlisting><methodsynopsis language="python"> - <methodname>set_increments</methodname> - <methodparam><parameter - role="keyword">step</parameter></methodparam> - <methodparam><parameter - role="keyword">page</parameter></methodparam> - </methodsynopsis></programlisting> - <variablelist> - <varlistentry> - <term><parameter role="keyword">step</parameter> :</term> - <listitem><simpara>the step size</simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter role="keyword">page</parameter> :</term> - <listitem><simpara>the page size</simpara></listitem> - </varlistentry> - </variablelist> - - <para>The <methodname>set_increments</methodname>() method sets the -step and page sizes for the range to the values specified by -<parameter>step</parameter> and <parameter>page</parameter> respectively. -The step size is used when the user clicks the <link -linkend="class-gtkscrollbar"><classname>gtk.Scrollbar</classname></link> -arrows or moves <link -linkend="class-gtkscale"><classname>gtk.Scale</classname></link> via the -arrow keys. The page size is used for example when moving via <keycap>Page -Up</keycap> or <keycap>Page Down</keycap> keys.</para> - - </refsect2> - - <refsect2 id="method-gtkrange--set-range"> - <title>gtk.Range.set_range</title> - - <programlisting><methodsynopsis language="python"> - <methodname>set_range</methodname> - <methodparam><parameter - role="keyword">min</parameter></methodparam> - <methodparam><parameter - role="keyword">max</parameter></methodparam> - </methodsynopsis></programlisting> - <variablelist> - <varlistentry> - <term><parameter role="keyword">min</parameter> :</term> - <listitem><simpara>the minimum range value</simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter role="keyword">max</parameter> :</term> - <listitem><simpara>the maximum range value</simpara></listitem> - </varlistentry> - </variablelist> - - <para>The <methodname>set_range</methodname>() method sets the minimum -and maximum allowable values for the <link -linkend="class-gtkrange"><classname>gtk.Range</classname></link> to that -values specified by <parameter>min</parameter> and -<parameter>max</parameter> respectively. If the range has a non-zero page -size, it is also forced to be between <parameter>min</parameter> and -<parameter>max</parameter>.</para> - - </refsect2> - - <refsect2 id="method-gtkrange--set-value"> - <title>gtk.Range.set_value</title> - - <programlisting><methodsynopsis language="python"> - <methodname>set_value</methodname> - <methodparam><parameter - role="keyword">value</parameter></methodparam> - </methodsynopsis></programlisting> - <variablelist> - <varlistentry> - <term><parameter role="keyword">value</parameter> :</term> - <listitem><simpara>the new value of the range</simpara></listitem> - </varlistentry> - </variablelist> - - - <para>The <methodname>set_value</methodname>() method sets the current -value of the range to the value specified by <parameter>value</parameter>. -<parameter>value</parameter> will be forced inside the minimum or maximum -range values. The range emits the "value_changed" signal if the value -changes.</para> - - </refsect2> - - <refsect2 id="method-gtkrange--get-value"> - <title>gtk.Range.get_value</title> - - <programlisting><methodsynopsis language="python"> - <methodname>get_value</methodname> - <methodparam></methodparam> </methodsynopsis></programlisting> - <variablelist> - <varlistentry> - <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara>the current value of the -range.</simpara></listitem> - </varlistentry> - </variablelist> - - <para>The <methodname>get_value</methodname>() method gets the current -value of the range.</para> - - </refsect2> - - </refsect1> - - <refsect1> - <title>Signals</title> - - <refsect2 id="signal-gtkrange--adjust-bounds"> - <title>The "adjust-bounds" gtk.Range Signal</title> - - <programlisting><methodsynopsis language="python"> - <methodname>callback</methodname> - <methodparam><parameter>range</parameter></methodparam> - <methodparam><parameter>value</parameter></methodparam> - <methodparam><parameter>user_param1</parameter></methodparam> - <methodparam><parameter>...</parameter></methodparam> - </methodsynopsis></programlisting> - - <variablelist> - <varlistentry> - <term><parameter>range</parameter> :</term> - <listitem><simpara>the range that received the -signal</simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter>value</parameter> :</term> - <listitem><simpara>the value</simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter>user_param1</parameter> :</term> - <listitem><simpara>the first user parameter (if any) specified -with the <link -linkend="method-gobject--connect"><methodname>connect</methodname>()</link> -method</simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter>...</parameter> :</term> - <listitem><simpara>additional user parameters (if -any)</simpara></listitem> - </varlistentry> - </variablelist> - - <para>The "adjust-bounds" signal is emitted when the range is adjusted -by user action. Note the value can be more or less than the range since it -depends on the mouse position.</para> - - </refsect2> - - <refsect2 id="signal-gtkrange--change-value"> - <title>The "change-value" gtk.Range Signal</title> - - <programlisting><methodsynopsis language="python"><methodname>callback</methodname> - <methodparam><parameter>range</parameter></methodparam> - <methodparam><parameter>scroll</parameter></methodparam> - <methodparam><parameter>value</parameter></methodparam> - <methodparam><parameter>user_param1</parameter></methodparam> - <methodparam><parameter>...</parameter></methodparam> - </methodsynopsis></programlisting> - - <variablelist> - <varlistentry> - <term><parameter>range</parameter> :</term> - <listitem><simpara>the range that received the signal. the object - which received the signal.</simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter>scroll</parameter> :</term> - <listitem><simpara>the type of scroll action that was performed - - one of the <xref linkend="gtk-scroll-type-constants" - endterm="gtk-scroll-type-constants-title"></xref>..</simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter>value</parameter> :</term> - <listitem><simpara>the new value resulting from the scroll - action.</simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter>user_param1</parameter> :</term> - <listitem><simpara>the first user parameter (if any) specified - with the <link - linkend="method-gobject--connect"><methodname>connect</methodname>()</link> - method</simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter>...</parameter> :</term> - <listitem><simpara>additional user parameters (if any)</simpara></listitem> - </varlistentry> - <varlistentry> - <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara><literal>True</literal> to prevent other - handlers from being invoked for the signal or - <literal>False</literal> to propagate the signal - further.</simpara></listitem> - </varlistentry> - </variablelist> - - <note> - <para>This signal is available in GTK+ 2.6 and above.</para> - </note> - - <para>The "change-value" signal is emitted when a scroll action is - performed on a range. It allows an application to determine the type - of scroll event that occurred and the resultant new value. The - application can handle the event itself and return - <literal>True</literal> to prevent further processing. Or, by - returning <literal>False</literal>, it can pass the event to other - handlers until the default GTK+ handler is reached.</para> - - <para>The value parameter is unrounded. An application that overrides - the "change-value" signal is responsible for clamping the value to the - desired number of decimal digits.</para> - - <para>It is not possible to use delayed update policies in an - overridden "change-value" handler.</para> - - </refsect2> - - <refsect2 id="signal-gtkrange--move-slider"> - <title>The "move-slider" gtk.Range Signal</title> - - <programlisting><methodsynopsis language="python"> - <methodname>callback</methodname> - <methodparam><parameter>range</parameter></methodparam> - <methodparam><parameter>scrolltype</parameter></methodparam> - <methodparam><parameter>user_param1</parameter></methodparam> - <methodparam><parameter>...</parameter></methodparam> - </methodsynopsis></programlisting> - - <variablelist> - <varlistentry> - <term><parameter>range</parameter> :</term> - <listitem><simpara>the range that received the -signal</simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter>scrolltype</parameter> :</term> - <listitem><simpara>the scroll type issued because a key was - pressed by the user; one of the <xref - linkend="gtk-scroll-type-constants" - endterm="gtk-scroll-type-constants-title"></xref>.</simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter>user_param1</parameter> :</term> - <listitem><simpara>the first user parameter (if any) specified -with the <link -linkend="method-gobject--connect"><methodname>connect</methodname>()</link> -method</simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter>...</parameter> :</term> - <listitem><simpara>additional user parameters (if -any)</simpara></listitem> - </varlistentry> - </variablelist> - - <para>The "move-slider" signal is emitted when the user presses a key -(e.g. <keycap>Page Up</keycap>, <keycap>Home</keycap>, <keycap>Right -Arrow</keycap>) to move the slider.</para> - - </refsect2> - - <refsect2 id="signal-gtkrange--value-changed"> - <title>The "value-changed" gtk.Range Signal</title> - - <programlisting><methodsynopsis language="python"> - <methodname>callback</methodname> - <methodparam><parameter>range</parameter></methodparam> - <methodparam><parameter>user_param1</parameter></methodparam> - <methodparam><parameter>...</parameter></methodparam> - </methodsynopsis></programlisting> - - <variablelist> - <varlistentry> - <term><parameter>range</parameter> :</term> - <listitem><simpara>the range that received the -signal</simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter>user_param1</parameter> :</term> - <listitem><simpara>the first user parameter (if any) specified -with the <link -linkend="method-gobject--connect"><methodname>connect</methodname>()</link> -method</simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter>...</parameter> :</term> - <listitem><simpara>additional user parameters (if -any)</simpara></listitem> - </varlistentry> - </variablelist> - - <para>The "value-changed" signal is emitted when the range value is -changed either programmatically or by user action.</para> - - </refsect2> - - </refsect1> - -</refentry> |