-----------------------------------------------------------------------
-- GtkAda - Ada95 binding for Gtk+/Gnome --
-- --
-- Copyright (C) 1998-2000 E. Briot, J. Brobecker and A. Charlet --
-- Copyright (C) 2000-2006 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. --
-----------------------------------------------------------------------
--
-- 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.
--
-- 2.8.17
-- gtk-toggle_button
-- Buttons and Toggles
-- create_toggle_buttons.adb
with Glib.Properties;
with Gtk.Button;
package Gtk.Toggle_Button is
type Gtk_Toggle_Button_Record is new Gtk.Button.Gtk_Button_Record
with private;
type Gtk_Toggle_Button is access all Gtk_Toggle_Button_Record'Class;
procedure Gtk_New
(Toggle_Button : out Gtk_Toggle_Button;
Label : UTF8_String := "");
-- 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_Mnemonic
(Toggle_Button : out Gtk_Toggle_Button;
Label : UTF8_String);
-- 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 Initialize
(Toggle_Button : access Gtk_Toggle_Button_Record'Class;
Label : UTF8_String := "");
-- Internal initialization function.
-- See the section "Creating your own widgets" in the documentation.
procedure Initialize_With_Mnemonic
(Toggle_Button : access Gtk_Toggle_Button_Record'Class;
Label : UTF8_String);
-- Internal initialization function.
function Get_Type return Glib.GType;
-- Return the internal value associated with a Gtk_Toggle_Button.
procedure Set_Mode
(Toggle_Button : access Gtk_Toggle_Button_Record;
Draw_Indicator : Boolean);
function Get_Mode
(Toggle_Button : access Gtk_Toggle_Button_Record) return Boolean;
-- Change the mode of the button.
-- If Draw_Indicator is False, then the button is hidden.
procedure Set_Active
(Toggle_Button : access Gtk_Toggle_Button_Record;
Is_Active : Boolean);
function Get_Active
(Toggle_Button : access Gtk_Toggle_Button_Record) return Boolean;
-- Change the state of the button.
-- When Is_Active is True, the button is drawn as a pressed button.
procedure Set_Inconsistent
(Toggle_Button : access Gtk_Toggle_Button_Record;
Setting : Boolean := True);
function Get_Inconsistent
(Toggle_Button : access Gtk_Toggle_Button_Record) 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 Toggled (Toggle_Button : access Gtk_Toggle_Button_Record);
-- Emit the toggled signal on this widget.
-- Note that the state of the button is not changed, only the callbacks
-- are called.
----------------
-- 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 \
--
--
Active_Property : constant Glib.Properties.Property_Boolean;
Draw_Indicator_Property : constant Glib.Properties.Property_Boolean;
Inconsistent_Property : constant Glib.Properties.Property_Boolean;
-------------
-- 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.
--
Signal_Toggled : constant String := "toggled";
private
type Gtk_Toggle_Button_Record is new Gtk.Button.Gtk_Button_Record
with null record;
Active_Property : constant Glib.Properties.Property_Boolean :=
Glib.Properties.Build ("active");
Draw_Indicator_Property : constant Glib.Properties.Property_Boolean :=
Glib.Properties.Build ("draw-indicator");
Inconsistent_Property : constant Glib.Properties.Property_Boolean :=
Glib.Properties.Build ("inconsistent");
pragma Import (C, Get_Type, "gtk_toggle_button_get_type");
end Gtk.Toggle_Button;
--
-- ../examples/documentation/toggle.adb
--