## Documentation

Table of Contents
Class Inheritance Tree
Widget Screenshots
Package groups

1.     -----------------------------------------------------------------------

2.     --               GtkAda - Ada95 binding for Gtk+/Gnome               --

3.     --                                                                   --

4.     --                    Copyright (C) 2010, AdaCore                    --

5.     --                                                                   --

6.     -- This library is free software; you can redistribute it and/or     --

7.     -- modify it under the terms of the GNU General Public               --

8.     -- License as published by the Free Software Foundation; either      --

9.     -- version 2 of the License, or (at your option) any later version.  --

10.     --                                                                   --

11.     -- This library is distributed in the hope that it will be useful,   --

12.     -- but WITHOUT ANY WARRANTY; without even the implied warranty of    --

13.     -- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU --

14.     -- General Public License for more details.                          --

15.     --                                                                   --

16.     -- You should have received a copy of the GNU General Public         --

17.     -- License along with this library; if not, write to the             --

18.     -- Free Software Foundation, Inc., 59 Temple Place - Suite 330,      --

19.     -- Boston, MA 02111-1307, USA.                                       --

20.     --                                                                   --

21.     -- As a special exception, if other files instantiate generics from  --

22.     -- this unit, or you link this unit with other files to produce an   --

23.     -- executable, this  unit  does not  by itself cause  the resulting  --

24.     -- executable to be covered by the GNU General Public License. This  --

25.     -- exception does not however invalidate any other reasons why the   --

26.     -- executable file  might be covered by the  GNU Public License.     --

27.     -----------------------------------------------------------------------

29.     --  <description>

30.     --  Gtk_Scale_Button provides a button which pops up a scale widget. This kind

31.     --  of widget is commonly used for volume controls in multimedia applications,

32.     --  and GTK+ provides a Gtk_Volume_Button subclass that is tailored for this

33.     --  use case.

34.     --  </description>

35.     --  <c_version>2.16.6</c_version>

36.     --  <group>Numeric/Text Data Entry</group>

38.     with Glib.PropertiesTo API docTo specTo body;

39.     with Gtk.AdjustmentTo API docTo specTo body;

40.     with Gtk.ButtonTo API docTo specTo body;

41.     with Gtk.EnumsTo API docTo specTo body;

42.     with Gtk.WidgetTo API docTo specTo body;

43.     with Gtkada.TypesTo API docTo specTo body;

45.     package Gtk.Scale_ButtonTo API docTo specTo body is

47.        type Gtk_Scale_Button_RecordTo API docTo body is

48.          new Gtk.Button.Gtk_Button_RecordTo API docTo spec with private;

49.        type Gtk_Scale_Button is access all Gtk_Scale_Button_RecordTo API docTo specTo body'Class;

51.        function Gtk_NewTo API docTo body

52.          (Size  : Gtk.Enums.Gtk_Icon_SizeTo API docTo spec;

53.           Min   : GdoubleTo API docTo spec;

54.           Max   : GdoubleTo API docTo spec;

55.           Step  : GdoubleTo API docTo spec;

56.           Icons : Gtkada.Types.Chars_Ptr_ArrayTo API docTo spec)

57.           return Gtk_Scale_ButtonTo API docTo spec;

58.        --  Creates a Gtk_Scale_Button, with a range between Min and Max (usually

59.        --  0 .. 100), with a stepping of Step (usually 2).  Invoke with a list of

60.        --  icon names, or Null_Array if you want to set the list later with

61.        --  Set_Icons.

63.        function Get_TypeTo API docTo body return GTypeTo API docTo spec;

65.        function Get_AdjustmentTo API docTo body

66.          (Button : access Gtk_Scale_Button_RecordTo API docTo specTo body)

67.           return Gtk.Adjustment.Gtk_AdjustmentTo API docTo spec;

68.        --  Gets the Gtk_Adjustment associated with the Gtk_Scale_Button's scale.

69.        --  See Gtk.Range.Get_Adjustment for details.

71.        function Get_Minus_ButtonTo API docTo body

72.          (Button : access Gtk_Scale_Button_RecordTo API docTo specTo body) return Gtk.Widget.Gtk_WidgetTo API docTo spec;

73.        function Get_Plus_ButtonTo API docTo body

74.          (Button : access Gtk_Scale_Button_RecordTo API docTo specTo body) return Gtk.Widget.Gtk_WidgetTo API docTo spec;

75.        --  Retrieves the minus/plus button of the Gtk_Scale_Button.

77.        function Get_PopupTo API docTo body

78.          (Button : access Gtk_Scale_Button_RecordTo API docTo specTo body) return Gtk.Widget.Gtk_WidgetTo API docTo spec;

79.        --  Retrieves the popup of the Gtk_Scale_Button.

81.        function Get_ValueTo API docTo body (Button : access Gtk_Scale_Button_RecordTo API docTo specTo body) return GdoubleTo API docTo spec;

82.        procedure Set_ValueTo API docTo body

83.          (Button : access Gtk_Scale_Button_RecordTo API docTo specTo body;

84.           Value  : GdoubleTo API docTo spec);

85.        --  Gets/Sets the current value of the scale; if the value is outside

86.        --  the minimum or maximum range values, it will be clamped to fit

87.        --  inside them. The scale button emits the GtkScaleButton::value-changed

88.        --  signal if the value changes.

90.        procedure Set_AdjustmentTo API docTo body

91.          (Button     : access Gtk_Scale_Button_RecordTo API docTo specTo body;

92.           Adjustment : access Gtk.Adjustment.Gtk_Adjustment_RecordTo API docTo spec'Class);

93.        --  Sets the Gtk_Adjustment to be used as a model for the Gtk_Scale_Button's

94.        --  scale.  See Gtk.Range.Set_Adjustment for details.

96.        procedure Set_IconsTo API docTo body

97.          (Button : access Gtk_Scale_Button_RecordTo API docTo specTo body;

98.           Icons  : Gtkada.Types.Chars_Ptr_ArrayTo API docTo spec);

99.        --  Sets the icons to be used by the scale button.

100.        --  For details, see the icons property.

102.        -----------------

103.        -- Obsolescent --

104.        -----------------

106.        function Get_OrientationTo API docTo body

107.          (Button : access Gtk_Scale_Button_RecordTo API docTo specTo body)

108.           return Gtk.Enums.Gtk_OrientationTo API docTo spec;

109.        pragma Obsolescent; --  Get_Orientation

110.        procedure Set_OrientationTo API docTo body

111.          (Button      : access Gtk_Scale_Button_RecordTo API docTo specTo body;

112.           OrientationTo API docTo body : Gtk.Enums.Gtk_OrientationTo API docTo spec);

113.        pragma Obsolescent; --  Set_Orientation

114.        --  Gets/Sets the orientation of the Gtk_Scale_Button's popup window.

115.        --

116.        --  Deprecated: 2.16: Use Gtk.Orientable.Get_Orientation and

117.        --  Gtk.Orientable.Set_Orientation instead.

119.        ----------------

120.        -- Properties --

121.        ----------------

123.        --  <properties>

124.        --  Name:  Adjustment_Property

125.        --  Type:  Object

126.        --  Descr: The Gtk_Adjustment that contains the current value of this scale

127.        --         button object

128.        --

129.        --  Name:  Icons_Property

130.        --  Type:  Boxed

131.        --  Descr: List of icon names

132.        --

133.        --  Name:  Size_Property

134.        --  Type:  Enum

135.        --  Descr: The icon size

136.        --

137.        --  Name:  Value_Property

138.        --  Type:  Double

139.        --  Descr: The value of the scale

140.        --

141.        --  </properties>

143.        Adjustment_Property : constant Glib.Properties.Property_ObjectTo API docTo spec;

144.        Icons_Property      : constant Glib.Properties.Property_BoxedTo API docTo spec;

145.        Size_Property       : constant Glib.Properties.Property_EnumTo API docTo spec;

146.        Value_Property      : constant Glib.Properties.Property_DoubleTo API docTo spec;

148.     private

150.        type Gtk_Scale_Button_RecordTo API docTo spec is

151.          new Gtk.Button.Gtk_Button_RecordTo API docTo spec with null record;

153.        Adjustment_PropertyTo API docTo spec : constant Glib.Properties.Property_ObjectTo API docTo spec :=

154.          Glib.Properties.BuildTo API docTo specTo body ("adjustment");

155.        Icons_PropertyTo API docTo spec : constant Glib.Properties.Property_BoxedTo API docTo spec :=

156.          Glib.Properties.BuildTo API docTo specTo body ("icons");

157.        Size_PropertyTo API docTo spec : constant Glib.Properties.Property_EnumTo API docTo spec :=

158.          Glib.Properties.BuildTo API docTo specTo body ("size");

159.        Value_PropertyTo API docTo spec : constant Glib.Properties.Property_DoubleTo API docTo spec :=

160.          Glib.Properties.BuildTo API docTo specTo body ("value");

162.        pragma Import (C, Get_TypeTo API docTo spec, "gtk_scale_button_get_type");

164.     end Gtk.Scale_ButtonTo API docTo specTo body;