Index

Package: Toggle_Button

Description

package Gtk.Toggle_Button is

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.

Screenshot

gtk-toggle_button.png
<testgtk>create_toggle_buttons.adb</testgtk>

Packages

Implements_Activatable (new Glib.Types.Implements)

Implements_Buildable (new Glib.Types.Implements)

Classes

Gtk_Toggle_Button_Record

type Gtk_Toggle_Button_Record is new Gtk_Button_Record with null record;

Ancestors:

Immediate Children:

Primitive operations:

Do_Set_Related_Action (overriding Gtk.Button.Do_Set_Related_Action)
Get_Inconsistent
Get_Related_Action (overriding Gtk.Button.Get_Related_Action)
Get_Use_Action_Appearance (overriding Gtk.Button.Get_Use_Action_Appearance)
Glib.Object.Deallocate (Inherited)
Glib.Object.Get_Type (Inherited)
Glib.Object.Notify (Inherited)
Glib.Object.Ref (Inherited)
Glib.Object.Ref_Sink (Inherited)
Glib.Object.Unref (Inherited)
Gtk.Bin.Get_Child (Inherited)
Gtk.Button.Clicked (Inherited)
Gtk.Button.Enter (Inherited)
Gtk.Button.Get_Alignment (Inherited)
Gtk.Button.Get_Event_Window (Inherited)
Gtk.Button.Get_Focus_On_Click (Inherited)
Gtk.Button.Get_Image (Inherited)
Gtk.Button.Get_Image_Position (Inherited)
Gtk.Button.Get_Label (Inherited)
Gtk.Button.Get_Relief (Inherited)
Gtk.Button.Get_Use_Stock (Inherited)
Gtk.Button.Get_Use_Underline (Inherited)
Gtk.Button.Leave (Inherited)
Gtk.Button.Pressed (Inherited)
Gtk.Button.Released (Inherited)
Gtk.Button.Set_Alignment (Inherited)
Gtk.Button.Set_Focus_On_Click (Inherited)
Gtk.Button.Set_Image (Inherited)
Gtk.Button.Set_Image_Position (Inherited)
Gtk.Button.Set_Label (Inherited)
Gtk.Button.Set_Relief (Inherited)
Gtk.Button.Set_Use_Stock (Inherited)
Gtk.Button.Set_Use_Underline (Inherited)
Gtk.Container.Add (Inherited)
Gtk.Container.Check_Resize (Inherited)
Gtk.Container.Child_Get_Property (Inherited)
Gtk.Container.Child_Set_Property (Inherited)
Gtk.Container.Child_Type (Inherited)
Gtk.Container.Forall (Inherited)
Gtk.Container.Foreach (Inherited)
Gtk.Container.Get_Border_Width (Inherited)
Gtk.Container.Get_Children (Inherited)
Gtk.Container.Get_Focus_Chain (Inherited)
Gtk.Container.Get_Focus_Child (Inherited)
Gtk.Container.Get_Focus_Hadjustment (Inherited)
Gtk.Container.Get_Focus_Vadjustment (Inherited)
Gtk.Container.Get_Resize_Mode (Inherited)
Gtk.Container.Propagate_Expose (Inherited)
Gtk.Container.Remove (Inherited)
Gtk.Container.Resize_Children (Inherited)
Gtk.Container.Set_Border_Width (Inherited)
Gtk.Container.Set_Focus_Chain (Inherited)
Gtk.Container.Set_Focus_Child (Inherited)
Gtk.Container.Set_Focus_Hadjustment (Inherited)
Gtk.Container.Set_Focus_Vadjustment (Inherited)
Gtk.Container.Set_Reallocate_Redraws (Inherited)
Gtk.Container.Set_Resize_Mode (Inherited)
Gtk.Container.Unset_Focus_Chain (Inherited)
Gtk.Widget.Activate (Inherited)
Gtk.Widget.Add_Accelerator (Inherited)
Gtk.Widget.Add_Events (Inherited)
Gtk.Widget.Add_Mnemonic_Label (Inherited)
Gtk.Widget.Can_Activate_Accel (Inherited)
Gtk.Widget.Child_Notify (Inherited)
Gtk.Widget.Class_Path (Inherited)
Gtk.Widget.Class_Path_Reversed (Inherited)
Gtk.Widget.Create_Pango_Context (Inherited)
Gtk.Widget.Create_Pango_Layout (Inherited)
Gtk.Widget.Destroy (Inherited)
Gtk.Widget.Draw (Inherited)
Gtk.Widget.Ensure_Style (Inherited)
Gtk.Widget.Error_Bell (Inherited)
Gtk.Widget.Flag_Is_Set (Inherited)
Gtk.Widget.Flags (Inherited)
Gtk.Widget.Freeze_Child_Notify (Inherited)
Gtk.Widget.Get_Allocation_Height (Inherited)
Gtk.Widget.Get_Allocation_Width (Inherited)
Gtk.Widget.Get_Allocation_X (Inherited)
Gtk.Widget.Get_Allocation_Y (Inherited)
Gtk.Widget.Get_Ancestor (Inherited)
Gtk.Widget.Get_Child_Requisition (Inherited)
Gtk.Widget.Get_Child_Visible (Inherited)
Gtk.Widget.Get_Colormap (Inherited)
Gtk.Widget.Get_Composite_Name (Inherited)
Gtk.Widget.Get_Direction (Inherited)
Gtk.Widget.Get_Events (Inherited)
Gtk.Widget.Get_Extension_Events (Inherited)
Gtk.Widget.Get_Has_Tooltip (Inherited)
Gtk.Widget.Get_Name (Inherited)
Gtk.Widget.Get_No_Show_All (Inherited)
Gtk.Widget.Get_Pango_Context (Inherited)
Gtk.Widget.Get_Parent (Inherited)
Gtk.Widget.Get_Parent_Window (Inherited)
Gtk.Widget.Get_Pointer (Inherited)
Gtk.Widget.Get_Root_Window (Inherited)
Gtk.Widget.Get_Size_Request (Inherited)
Gtk.Widget.Get_Snapshot (Inherited)
Gtk.Widget.Get_State (Inherited)
Gtk.Widget.Get_Style (Inherited)
Gtk.Widget.Get_Tooltip_Markup (Inherited)
Gtk.Widget.Get_Tooltip_Text (Inherited)
Gtk.Widget.Get_Tooltip_Window (Inherited)
Gtk.Widget.Get_Toplevel (Inherited)
Gtk.Widget.Get_Visual (Inherited)
Gtk.Widget.Get_Window (Inherited)
Gtk.Widget.Grab_Default (Inherited)
Gtk.Widget.Grab_Focus (Inherited)
Gtk.Widget.Has_Screen (Inherited)
Gtk.Widget.Hide (Inherited)
Gtk.Widget.Hide_All (Inherited)
Gtk.Widget.Input_Shape_Combine_Mask (Inherited)
Gtk.Widget.Intersect (Inherited)
Gtk.Widget.Is_Ancestor (Inherited)
Gtk.Widget.Is_Composited (Inherited)
Gtk.Widget.Is_Focus (Inherited)
Gtk.Widget.Keynav_Failed (Inherited)
Gtk.Widget.List_Mnemonic_Labels (Inherited)
Gtk.Widget.Map (Inherited)
Gtk.Widget.Mnemonic_Activate (Inherited)
Gtk.Widget.Modify_Base (Inherited)
Gtk.Widget.Modify_Bg (Inherited)
Gtk.Widget.Modify_Cursor (Inherited)
Gtk.Widget.Modify_Fg (Inherited)
Gtk.Widget.Modify_Font (Inherited)
Gtk.Widget.Modify_Text (Inherited)
Gtk.Widget.Path (Inherited)
Gtk.Widget.Path_Reversed (Inherited)
Gtk.Widget.Queue_Clear (Inherited)
Gtk.Widget.Queue_Clear_Area (Inherited)
Gtk.Widget.Queue_Draw (Inherited)
Gtk.Widget.Queue_Draw_Area (Inherited)
Gtk.Widget.Queue_Resize (Inherited)
Gtk.Widget.Queue_Resize_No_Redraw (Inherited)
Gtk.Widget.Realize (Inherited)
Gtk.Widget.Region_Intersect (Inherited)
Gtk.Widget.Remove_Accelerator (Inherited)
Gtk.Widget.Remove_Mnemonic_Label (Inherited)
Gtk.Widget.Render_Icon (Inherited)
Gtk.Widget.Reparent (Inherited)
Gtk.Widget.Reset_Rc_Styles (Inherited)
Gtk.Widget.Reset_Shapes (Inherited)
Gtk.Widget.Restore_Default_Style (Inherited)
Gtk.Widget.Send_Expose (Inherited)
Gtk.Widget.Set_Accel_Path (Inherited)
Gtk.Widget.Set_App_Paintable (Inherited)
Gtk.Widget.Set_Child_Visible (Inherited)
Gtk.Widget.Set_Colormap (Inherited)
Gtk.Widget.Set_Composite_Name (Inherited)
Gtk.Widget.Set_Direction (Inherited)
Gtk.Widget.Set_Double_Buffered (Inherited)
Gtk.Widget.Set_Events (Inherited)
Gtk.Widget.Set_Extension_Events (Inherited)
Gtk.Widget.Set_Flags (Inherited)
Gtk.Widget.Set_Has_Tooltip (Inherited)
Gtk.Widget.Set_Name (Inherited)
Gtk.Widget.Set_No_Show_All (Inherited)
Gtk.Widget.Set_Parent (Inherited)
Gtk.Widget.Set_Parent_Window (Inherited)
Gtk.Widget.Set_Redraw_On_Allocate (Inherited)
Gtk.Widget.Set_Scroll_Adjustments (Inherited)
Gtk.Widget.Set_Sensitive (Inherited)
Gtk.Widget.Set_Size_Request (Inherited)
Gtk.Widget.Set_State (Inherited)
Gtk.Widget.Set_Style (Inherited)
Gtk.Widget.Set_Tooltip_Markup (Inherited)
Gtk.Widget.Set_Tooltip_Text (Inherited)
Gtk.Widget.Set_Tooltip_Window (Inherited)
Gtk.Widget.Set_UPosition (Inherited)
Gtk.Widget.Set_USize (Inherited)
Gtk.Widget.Set_Window (Inherited)
Gtk.Widget.Shape_Combine_Mask (Inherited)
Gtk.Widget.Show (Inherited)
Gtk.Widget.Show_All (Inherited)
Gtk.Widget.Show_Now (Inherited)
Gtk.Widget.Size_Allocate (Inherited)
Gtk.Widget.Size_Request (Inherited)
Gtk.Widget.Style_Get_Property (Inherited)
Gtk.Widget.Thaw_Child_Notify (Inherited)
Gtk.Widget.Trigger_Tooltip_Query (Inherited)
Gtk.Widget.Unmap (Inherited)
Gtk.Widget.Unrealize (Inherited)
Gtk.Widget.Unset_Flags (Inherited)
Set_Inconsistent
Set_Related_Action (overriding Gtk.Button.Set_Related_Action)
Set_Use_Action_Appearance (overriding Gtk.Button.Set_Use_Action_Appearance)
Sync_Action_Properties (overriding Gtk.Button.Sync_Action_Properties)

Types

Gtk_Toggle_Button

type Gtk_Toggle_Button is access all Gtk_Toggle_Button_Record'Class;

Constants & Global variables

Draw_Indicator_Property (Glib.Properties.Property_Boolean)

Draw_Indicator_Property : constant Glib.Properties.Property_Boolean;

Inconsistent_Property (Glib.Properties.Property_Boolean)

Inconsistent_Property : constant Glib.Properties.Property_Boolean;

Signal_Toggled (Glib.Signal_Name)

Signal_Toggled : constant Glib.Signal_Name := "toggled";

Subprograms & Entries

Gtk_New

procedure Gtk_New 
(Toggle_Button: out Gtk_Toggle_Button;
Label: UTF8_String := "");

Initialize

procedure Initialize 
(Toggle_Button: access Gtk_Toggle_Button_Record'Class;
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.

Gtk_New_With_Mnemonic

procedure Gtk_New_With_Mnemonic 
(Toggle_Button: out Gtk_Toggle_Button;
Label: UTF8_String);

Initialize_With_Mnemonic

procedure Initialize_With_Mnemonic 
(Toggle_Button: access Gtk_Toggle_Button_Record'Class;
Label: UTF8_String);
Creates a new Gtk.Toggle_Button.Gtk_Toggle_Button containing a label. The label will be created using Gtk.Label.Gtk_New_With_Mnemonic, so underscores in Label indicate the mnemonic for the button. "label": the text of the button, with an underscore in front of the mnemonic character

Get_Type

function Get_Type return Glib.GType;

Get_Active

function Get_Active 
(Toggle_Button: access Gtk_Toggle_Button_Record) return Boolean;

Set_Active

procedure Set_Active 
(Toggle_Button: access Gtk_Toggle_Button_Record;
Is_Active: Boolean);
Change the state of the button. When Is_Active is True, the button is drawn as a pressed button

Get_Inconsistent

function Get_Inconsistent 
(Toggle_Button: access Gtk_Toggle_Button_Record) return Boolean;

Set_Inconsistent

procedure Set_Inconsistent 
(Toggle_Button: access Gtk_Toggle_Button_Record;
Setting: Boolean := True);
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, Gtk.Toggle_Button.Set_Inconsistent only affects visual appearance, it doesn't affect the semantics of the button. "setting": True if state is inconsistent

Get_Mode

function Get_Mode 
(Toggle_Button: access Gtk_Toggle_Button_Record) return Boolean;

Set_Mode

procedure Set_Mode 
(Toggle_Button: access Gtk_Toggle_Button_Record;
Draw_Indicator: Boolean);
Sets whether the button is displayed as a separate indicator and label. You can call this function on a checkbutton or a radiobutton with This function only affects instances of classes like Gtk.Check_Button.Gtk_Check_Button and Gtk.Radio_Button.Gtk_Radio_Button that derive from Gtk.Toggle_Button.Gtk_Toggle_Button, not instances of Gtk.Toggle_Button.Gtk_Toggle_Button itself. "draw_indicator": if True, draw the button as a separate indicator and label; if False, draw the button like a normal button

Toggled

procedure Toggled 
(Toggle_Button: access Gtk_Toggle_Button_Record);

Do_Set_Related_Action

procedure Do_Set_Related_Action 
(Self: access Gtk_Toggle_Button_Record;
Action: access Gtk.Action.Gtk_Action_Record'Class);

Get_Related_Action

function Get_Related_Action 
(Self: access Gtk_Toggle_Button_Record) return Gtk.Action.Gtk_Action;

Set_Related_Action

procedure Set_Related_Action 
(Self: access Gtk_Toggle_Button_Record;
Action: access Gtk.Action.Gtk_Action_Record'Class);

Get_Use_Action_Appearance

function Get_Use_Action_Appearance 
(Self: access Gtk_Toggle_Button_Record) return Boolean;

Set_Use_Action_Appearance

procedure Set_Use_Action_Appearance 
(Self: access Gtk_Toggle_Button_Record;
Use_Appearance: Boolean);

Sync_Action_Properties

procedure Sync_Action_Properties 
(Self: access Gtk_Toggle_Button_Record;
Action: access Gtk.Action.Gtk_Action_Record'Class);