File: gtk-toggle_button.ads

-----------------------------------------------------------------------

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

--                                                                   --

--   Copyright (C) 1998-2000 E. Briot, J. Brobecker and A. Charlet   --

--                Copyright (C) 2000-2007 AdaCore                    --

--                                                                   --

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

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

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

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

--                                                                   --

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

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

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

-- General Public License for more details.                          --

--                                                                   --

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

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

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

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

--                                                                   --

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

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

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

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

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

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

-----------------------------------------------------------------------

```
 
```
```
--  <description> 
```

--  A Gtk_Toggle_Button is like a regular button, but can be in one of

--  two states, "active" or "inactive". Its visual aspect is modified

```
--  when the state is changed. 
```
```
-- 
```

--  You should consider using a Gtk_Check_Button instead, since it looks

--  nicer and provides more visual clues that the button can be

```
--  toggled. 
```
```
--  </description> 
```
```
--  <c_version>2.8.17</c_version> 
```

--  <screenshot>gtk-toggle_button</screenshot>

```
--  <group>Buttons and Toggles</group> 
```

--  <testgtk>create_toggle_buttons.adb</testgtk>

```
 
```

with Glib.PropertiesTo API doc
To spec
To body;

with Gtk.ButtonTo API doc
To spec
To body;

```
 
```

package Gtk.Toggle_ButtonTo API doc
To spec
To body is

```
 
```

   type Gtk_Toggle_Button_RecordTo API doc
To body is new Gtk.Button.Gtk_Button_RecordTo API doc
To spec
To body

```
     with private; 
```

   type Gtk_Toggle_Button is access all Gtk_Toggle_Button_RecordTo API doc
To spec
To body'Class;

```
 
```
```
   procedure Gtk_NewTo API doc
To body 
```

     (Toggle_Button : out Gtk_Toggle_ButtonTo API doc
To spec;

      Label         : UTF8_StringTo API doc
To spec := "");

```
   --  Initialize a button. 
```

   --  If Label is "", then no label is created inside the button and

   --  you will have to provide your own child through a call to

   --  Gtk.Container.Add. This is the recommended way to put a pixmap

```
   --  inside a toggle button. 
```
```
 
```

   procedure Gtk_New_With_MnemonicTo API doc
To body

     (Toggle_Button : out Gtk_Toggle_ButtonTo API doc
To spec;

      Label         : UTF8_StringTo API doc
To spec);

   --  Create a Gtk_Toggle_Button containing Label. The Label will be created

   --  using Gtk.Label.Gtk_New_With_Mnemonic, so underscores in Label indicate

```
   --  the mnemonic for the button. 
```
```
 
```

   procedure InitializeTo API doc
To body

     (Toggle_Button : access Gtk_Toggle_Button_RecordTo API doc
To spec
To body'Class;

      Label         : UTF8_StringTo API doc
To spec := "");

   --  Internal initialization function.

   --  See the section "Creating your own widgets" in the documentation.

```
 
```

   procedure Initialize_With_MnemonicTo API doc
To body

     (Toggle_Button : access Gtk_Toggle_Button_RecordTo API doc
To spec
To body'Class;

      Label         : UTF8_StringTo API doc
To spec);

   --  Internal initialization function.

```
 
```

   function Get_TypeTo API doc
To body return Glib.GTypeTo API doc
To spec;

   --  Return the internal value associated with a Gtk_Toggle_Button.

```
 
```
```
   procedure Set_ModeTo API doc
To body 
```

     (Toggle_Button  : access Gtk_Toggle_Button_RecordTo API doc
To spec
To body;

```
      Draw_Indicator : Boolean); 
```
```
   function Get_ModeTo API doc
To body 
```

     (Toggle_Button : access Gtk_Toggle_Button_RecordTo API doc
To spec
To body) return Boolean;

```
   --  Change the mode of the button. 
```

   --  If Draw_Indicator is False, then the button is hidden.

```
 
```

   procedure Set_ActiveTo API doc
To body

     (Toggle_Button : access Gtk_Toggle_Button_RecordTo API doc
To spec
To body;

```
      Is_Active     : Boolean); 
```

   function Get_ActiveTo API doc
To body

     (Toggle_Button : access Gtk_Toggle_Button_RecordTo API doc
To spec
To body) return Boolean;

```
   --  Change the state of the button. 
```

   --  When Is_Active is True, the button is drawn as a pressed button.

```
 
```

   procedure Set_InconsistentTo API doc
To body

     (Toggle_Button : access Gtk_Toggle_Button_RecordTo API doc
To spec
To body;

      Setting       : Boolean := True);

   function Get_InconsistentTo API doc
To body

     (Toggle_Button : access Gtk_Toggle_Button_RecordTo API doc
To spec
To body) return Boolean;

   --  If the user has selected a range of elements (such as some text or

   --  spreadsheet cells) that are affected by a toggle button, and the

   --  current values in that range are inconsistent, you may want to

   --  display the toggle in an "in between" state. This function turns on

   --  "in between" display.  Normally you would turn off the inconsistent

   --  state again if the user toggles the toggle button. This has to be

   --  done manually, Set_Inconsistent only affects visual appearance, it

   --  doesn't affect the semantics of the button.

```
 
```
```
   ---------------------- 
```
```
   -- Signals emission -- 
```
```
   ---------------------- 
```
```
 
```

   procedure ToggledTo API doc
To body (Toggle_Button : access Gtk_Toggle_Button_RecordTo API doc
To spec
To body);

   --  Emit the toggled signal on this widget.

   --  Note that the state of the button is not changed, only the callbacks

```
   --  are called. 
```
```
 
```
```
   ---------------- 
```
```
   -- Properties -- 
```
```
   ---------------- 
```
```
 
```
```
   --  <properties> 
```

   --  The following properties are defined for this widget. See

   --  Glib.Properties for more information on properties.

```
   -- 
```
```
   --  Name:  Active_Property 
```
```
   --  Type:  Boolean 
```

   --  Descr: If the toggle button should be pressed in or not

```
   -- 
```
```
   --  Name:  Draw_Indicator_Property 
```
```
   --  Type:  Boolean 
```

   --  Descr: If the toggle part of the button is displayed

```
   -- 
```
```
   --  Name:  Inconsistent_Property 
```
```
   --  Type:  Boolean 
```

   --  Descr: If the toggle button is in an \

```
   -- 
```
```
   --  </properties> 
```
```
 
```

   Active_Property         : constant Glib.Properties.Property_BooleanTo API doc
To spec;

   Draw_Indicator_Property : constant Glib.Properties.Property_BooleanTo API doc
To spec;

   Inconsistent_Property   : constant Glib.Properties.Property_BooleanTo API doc
To spec;

```
 
```
```
   ------------- 
```
```
   -- Signals -- 
```
```
   ------------- 
```
```
 
```
```
   --  <signals> 
```

   --  The following new signals are defined for this widget:

```
   -- 
```
```
   --  - "toggled" 
```

   --    procedure Handler (Toggle : access Gtk_Toggle_Button_Record'Class);

```
   -- 
```

   --    This signal is emitted every time the state of the button is

```
   --    modified. 
```
```
   --  </signals> 
```
```
 
```

   Signal_Toggled : constant Glib.Signal_NameTo API doc
To spec := "toggled";

```
 
```
```
private 
```

   type Gtk_Toggle_Button_RecordTo API doc
To spec is new Gtk.Button.Gtk_Button_RecordTo API doc
To spec
To body

```
      with null record; 
```
```
 
```

   Active_PropertyTo API doc
To spec         : constant Glib.Properties.Property_BooleanTo API doc
To spec :=

     Glib.Properties.BuildTo API doc
To spec
To body ("active");

   Draw_Indicator_PropertyTo API doc
To spec : constant Glib.Properties.Property_BooleanTo API doc
To spec :=

     Glib.Properties.BuildTo API doc
To spec
To body ("draw-indicator");

   Inconsistent_PropertyTo API doc
To spec   : constant Glib.Properties.Property_BooleanTo API doc
To spec :=

     Glib.Properties.BuildTo API doc
To spec
To body ("inconsistent");

```
 
```

   pragma Import (C, Get_TypeTo API doc
To spec, "gtk_toggle_button_get_type");

end Gtk.Toggle_ButtonTo API doc
To spec
To body;

```
 
```
```
--  <example> 
```

--  <include>../examples/documentation/toggle.adb</include>

```
--  </example> 
```

Documentation