summaryrefslogtreecommitdiff
path: root/docs/reference/pygtk-gtkhscale.xml
blob: 950040800143d1cbbab4cb1f6eb80fb36ccf26b1 (plain)
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
<?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-gtkhscale">
  <refnamediv>
    <refname>gtk.HScale</refname>
    <refpurpose>a horizontal slider widget for selecting a value from a
range.</refpurpose>
  </refnamediv>

  <refsect1>
    <title>Synopsis</title>

    <classsynopsis language="python">
      <ooclass><classname>gtk.HScale</classname></ooclass>
      <ooclass><classname><link
linkend="class-gtkscale">gtk.Scale</link></classname></ooclass>
      <constructorsynopsis language="python">
	<methodname><link
linkend="constructor-gtkhscale">gtk.HScale</link></methodname>
	<methodparam><parameter
		       role="keyword">adjustment</parameter><initializer>None</initializer></methodparam>
      </constructorsynopsis>
    </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>
        +-- <link linkend="class-gtkscale">gtk.Scale</link>
          +-- <link linkend="class-gtkhscale">gtk.HScale</link>
</synopsis>

  </refsect1>
  
  <refsect1>
		<title>Implemented Interfaces</title>
		<para>
			<link linkend="class-gtkhscale"><classname>gtk.HScale</classname></link>
			implements 
			<link linkend="class-gtkbuildable"><classname>gtk.Buildable</classname></link>
		</para>
	</refsect1>

  <refsect1 id="properties-gtkhscale">
    <title>gtk.HScale Properties</title>

    <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
    <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
    <para><link linkend="properties-gtkrange">gtk.Range Properties</link></para>
    <para><link linkend="properties-gtkscale">gtk.Scale Properties</link></para>

  </refsect1>

  <refsect1 id="style-properties-gtkhscale">
    <title>gtk.HScale Style Properties</title>

    <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
    <para><link linkend="style-properties-gtkrange">gtk.Range Style Properties</link></para>
    <para><link linkend="style-properties-gtkscale">gtk.Scale Style Properties</link></para>

  </refsect1>

  <refsect1 id="signal-prototypes-gtkhscale">
    <title>gtk.HScale 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>
    <para><link linkend="signal-prototypes-gtkrange">gtk.Range Signal Prototypes</link></para>
    <para><link linkend="signal-prototypes-gtkscale">gtk.Scale Signal Prototypes</link></para>
  </refsect1>

  <refsect1>
    <title>Description</title>

    <para>The <link
linkend="class-gtkhscale"><classname>gtk.HScale</classname></link> is
subclassed from <link
linkend="class-gtkscale"><classname>gtk.Scale</classname></link> to provide
a widget that allows a user to select a value using a horizontal slider. See
the <link linkend="class-gtkscale"><classname>gtk.Scale</classname></link>
description for more information on the methods available to manage a <link
linkend="class-gtkhscale"><classname>gtk.HScale</classname></link>.</para>

  </refsect1>

  <refsect1 id="constructor-gtkhscale">
    <title>Constructor</title>

    <programlisting><constructorsynopsis language="python">
	<methodname>gtk.HScale</methodname>
	<methodparam><parameter
		       role="keyword">adjustment</parameter><initializer>None</initializer></methodparam>
      </constructorsynopsis></programlisting>
    <variablelist>
      <varlistentry>
	<term><parameter role="keyword">adjustment</parameter>&nbsp;:</term>
	<listitem><simpara>a <link
linkend="class-gtkadjustment"><classname>gtk.Adjustment</classname></link>
object</simpara></listitem>
      </varlistentry>
      <varlistentry>
	<term><emphasis>Returns</emphasis>&nbsp;:</term>
	<listitem><simpara>a new hscale widget</simpara></listitem>
      </varlistentry>
    </variablelist>

    <para>Creates a new <link
linkend="class-gtkhscale"><classname>gtk.HScale</classname></link> widget
and associates a <link
linkend="class-gtkadjustment"><classname>gtk.Adjustment</classname></link>
specified by <parameter>adjustment</parameter>. The default value of
<parameter>adjustment</parameter> is <literal>None</literal> which creates
the hscale with no <link
linkend="class-gtkadjustment"><classname>gtk.Adjustment</classname></link>.</para>

  </refsect1>

</refentry>