Index

Package: Accel_Group

Description

package Gtk.Accel_Group is

A Gtk.Accel_Group.Gtk_Accel_Group represents a group of keyboard accelerators, typically attached to a toplevel Gtk.Window.Gtk_Window (with Gtk.Window.Add_Accel_Group). Usually you won't need to create a Gtk.Accel_Group.Gtk_Accel_Group directly; instead, when using Gtk.UI_Manager.Gtk_UI_Manager, GTK+ automatically sets up the accelerators for your menus in the ui manager's Gtk.Accel_Group.Gtk_Accel_Group.

Note that 'accelerators' are different from 'mnemonics'. Accelerators are shortcuts for activating a menu item; they appear alongside the menu item they're a shortcut for. For example "Ctrl+Q" might appear alongside the "Quit" menu item. Mnemonics are shortcuts for GUI elements such as text entries or buttons; they appear as underlined characters. See Gtk.Label.Gtk_New_With_Mnemonic. Menu items can have both accelerators and mnemonics, of course.

Packages

Gtk_Accel_Flags_Properties (new Glib.Generic_Properties.Generic_Internal_Discrete_Property) 

package Gtk_Accel_Flags_Properties is
      new Generic_Internal_Discrete_Property (Gtk_Accel_Flags);

Find_User_Data (generic)

Full description

Classes

Gtk_Accel_Group_Record 

type Gtk_Accel_Group_Record is new GObject_Record with null record;

Ancestors:

Primitive operations:

Connect_By_Path
Disconnect_Key
Get_Is_Locked
Get_Modifier_Mask
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)
On_Accel_Activate
On_Accel_Activate
On_Accel_Changed
On_Accel_Changed

Types

Gtk_Accel_Group 

type Gtk_Accel_Group is access all Gtk_Accel_Group_Record'Class;

Gtk_Accel_Flags 

type Gtk_Accel_Flags is mod 2 ** Integer'Size;

Gtk_Accel_Key 

type Gtk_Accel_Key is record
      Accel_Key : Gdk.Types.Gdk_Key_Type;
      Accel_Mods : Gdk.Types.Gdk_Modifier_Type;
      Accel_Flags : Gtk_Accel_Flags;
   end record;

Gtk_Accel_Group_Activate 

type Gtk_Accel_Group_Activate is access function
     (Accel_Group   : access Gtk_Accel_Group_Record'Class;
      Acceleratable : Glib.Object.GObject;
      Keyval        : Gdk.Types.Gdk_Key_Type;
      Modifier      : Gdk.Types.Gdk_Modifier_Type) return Boolean;

C_Gtk_Accel_Group_Activate 

type C_Gtk_Accel_Group_Activate is access function
     (Accel_Group   : System.Address;
      Acceleratable : System.Address;
      Keyval        : Gdk.Types.Gdk_Key_Type;
      Modifier      : Gdk.Types.Gdk_Modifier_Type) return Boolean;

Gtk_Accel_Group_Find_Func 

type Gtk_Accel_Group_Find_Func is access function
     (Key     : Gtk_Accel_Key;
      Closure : System.Address) return Boolean;
Since: gtk+ 2.2

Property_Gtk_Accel_Flags 

type Property_Gtk_Accel_Flags is new Gtk_Accel_Flags_Properties.Property;

Cb_Gtk_Accel_Group_GObject_Guint_Gdk_Modifier_Type_Boolean 

type Cb_Gtk_Accel_Group_GObject_Guint_Gdk_Modifier_Type_Boolean is not null access function
     (Self          : access Gtk_Accel_Group_Record'Class;
      Acceleratable : not null access Glib.Object.GObject_Record'Class;
      Keyval        : Guint;
      Modifier      : Gdk.Types.Gdk_Modifier_Type) return Boolean;

Cb_GObject_GObject_Guint_Gdk_Modifier_Type_Boolean 

type Cb_GObject_GObject_Guint_Gdk_Modifier_Type_Boolean is not null access function
     (Self          : access Glib.Object.GObject_Record'Class;
      Acceleratable : not null access Glib.Object.GObject_Record'Class;
      Keyval        : Guint;
      Modifier      : Gdk.Types.Gdk_Modifier_Type) return Boolean;

Cb_Gtk_Accel_Group_Guint_Gdk_Modifier_Type_Address_Void 

type Cb_Gtk_Accel_Group_Guint_Gdk_Modifier_Type_Address_Void is not null access procedure
     (Self          : access Gtk_Accel_Group_Record'Class;
      Keyval        : Guint;
      Modifier      : Gdk.Types.Gdk_Modifier_Type;
      Accel_Closure : System.Address);

Cb_GObject_Guint_Gdk_Modifier_Type_Address_Void 

type Cb_GObject_Guint_Gdk_Modifier_Type_Address_Void is not null access procedure
     (Self          : access Glib.Object.GObject_Record'Class;
      Keyval        : Guint;
      Modifier      : Gdk.Types.Gdk_Modifier_Type;
      Accel_Closure : System.Address);

Constants & Global variables

Accel_Visible (Gtk_Accel_Flags) 

Accel_Visible : constant Gtk_Accel_Flags := 1;

Accel_Locked (Gtk_Accel_Flags) 

Accel_Locked : constant Gtk_Accel_Flags := 2;

Accel_Mask (Gtk_Accel_Flags) 

Accel_Mask : constant Gtk_Accel_Flags := 7;

Is_Locked_Property (Glib.Properties.Property_Boolean) 

Is_Locked_Property : constant Glib.Properties.Property_Boolean;

Modifier_Mask_Property (Glib.Properties.Property_Boxed) 

Modifier_Mask_Property : constant Glib.Properties.Property_Boxed;
Type: Gdk.Types.Gdk_Modifier_Type

Signal_Accel_Activate (Glib.Signal_Name) 

Signal_Accel_Activate : constant Glib.Signal_Name := "accel-activate";

Signal_Accel_Changed (Glib.Signal_Name) 

Signal_Accel_Changed : constant Glib.Signal_Name := "accel-changed";

Subprograms & Entries

From_Object_Free 

function From_Object_Free 
(B: access Gtk_Accel_Key) return Gtk_Accel_Key;

Gtk_New 

procedure Gtk_New 
(Accel_Group: out Gtk_Accel_Group);

Initialize 

procedure Initialize 
(Accel_Group: not null access Gtk_Accel_Group_Record'Class);
Creates a new Gtk.Accel_Group.Gtk_Accel_Group. Remember to call Gtk.Window.Add_Accel_Group to active the group.

Gtk_Accel_Group_New 

function Gtk_Accel_Group_New return Gtk_Accel_Group;
Creates a new Gtk.Accel_Group.Gtk_Accel_Group. Remember to call Gtk.Window.Add_Accel_Group to active the group.

Get_Type 

function Get_Type return Glib.GType;

Activate 

function Activate 
(Accel_Group: not null access Gtk_Accel_Group_Record;
Accel_Quark: Glib.GQuark;
Acceleratable: not null access Glib.Object.GObject_Record'Class;
Accel_Key: Guint;
Accel_Mods: Gdk.Types.Gdk_Modifier_Type) return Boolean;
Finds the first accelerator in Accel_Group that matches Accel_Key and Accel_Mods, and activates it. "accel_quark": the quark for the accelerator name "acceleratable": the Glib.Object.GObject, usually a Gtk.Window.Gtk_Window, on which to activate the accelerator "accel_key": accelerator keyval from a key event "accel_mods": keyboard state mask from a key event

Connect 

procedure Connect 
(Accel_Group: not null access Gtk_Accel_Group_Record;
Accel_Key: Guint;
Accel_Mods: Gdk.Types.Gdk_Modifier_Type;
Accel_Flags: Gtk_Accel_Flags;
Closure: C_Gtk_Accel_Group_Activate);
Installs an accelerator in this group. When Accel_Group is being activated in response to a call to Gtk.Accel_Group.Accel_Groups_Activate, Closure will be invoked if the Accel_Key and Accel_Mods from Gtk.Accel_Group.Accel_Groups_Activate match those of this connection. The signature used for the Closure is that of Gtk_Accel_Group_Activate. Note that, due to implementation details, a single closure can only be connected to one accelerator group. "accel_key": key value of the accelerator "accel_mods": modifier combination of the accelerator "accel_flags": a flag mask to configure this accelerator "closure": closure to be executed upon accelerator activation

Connect_By_Path 

procedure Connect_By_Path 
(Accel_Group: not null access Gtk_Accel_Group_Record;
Accel_Path: UTF8_String;
Closure: C_Gtk_Accel_Group_Activate);
Installs an accelerator in this group, using an accelerator path to look up the appropriate key and modifiers (see Gtk.Accel_Map.Add_Entry). When Accel_Group is being activated in response to a call to Gtk.Accel_Group.Accel_Groups_Activate, Closure will be invoked if the Accel_Key and Accel_Mods from Gtk.Accel_Group.Accel_Groups_Activate match the key and modifiers for the path. The signature used for the Closure is that of Gtk_Accel_Group_Activate. Note that Accel_Path string will be stored in a Glib.GQuark. Therefore, if you pass a static string, you can save some memory by interning it first with g_intern_static_string. "accel_path": path used for determining key and modifiers "closure": closure to be executed upon accelerator activation

Disconnect 

function Disconnect 
(Accel_Group: not null access Gtk_Accel_Group_Record;
Closure: C_Gtk_Accel_Group_Activate) return Boolean;
Removes an accelerator previously installed through Gtk.Accel_Group.Connect. Since 2.20 Closure can be null. "closure": the closure to remove from this accelerator group, or null to remove all closures

Disconnect_Key 

function Disconnect_Key 
(Accel_Group: not null access Gtk_Accel_Group_Record;
Accel_Key: Guint;
Accel_Mods: Gdk.Types.Gdk_Modifier_Type) return Boolean;
Removes an accelerator previously installed through Gtk.Accel_Group.Connect. "accel_key": key value of the accelerator "accel_mods": modifier combination of the accelerator

Find 

function Find 
(Accel_Group: not null access Gtk_Accel_Group_Record;
Find_Func: Gtk_Accel_Group_Find_Func) return Gtk_Accel_Key;
Finds the first entry in an accelerator group for which Find_Func returns True and returns its Gtk.Accel_Group.Gtk_Accel_Key. "find_func": a function to filter the entries of Accel_Group with

Get_Is_Locked 

function Get_Is_Locked 
(Accel_Group: not null access Gtk_Accel_Group_Record) return Boolean;
Locks are added and removed using Gtk.Accel_Group.Lock and Gtk.Accel_Group.Unlock. Since: gtk+ 2.14

Get_Modifier_Mask 

function Get_Modifier_Mask 
(Accel_Group: not null access Gtk_Accel_Group_Record) return Gdk.Types.Gdk_Modifier_Type;
Gets a Gdk.Types.Gdk_Modifier_Type representing the mask for this Accel_Group. For example, GDK_CONTROL_MASK, GDK_SHIFT_MASK, etc. Since: gtk+ 2.14

Lock 

procedure Lock 
(Accel_Group: not null access Gtk_Accel_Group_Record);
Locks the given accelerator group. Locking an acelerator group prevents the accelerators contained within it to be changed during runtime. Refer to Gtk.Accel_Map.Change_Entry about runtime accelerator changes. If called more than once, Accel_Group remains locked until Gtk.Accel_Group.Unlock has been called an equivalent number of times.

Unlock 

procedure Unlock 
(Accel_Group: not null access Gtk_Accel_Group_Record);
Undoes the last call to Gtk.Accel_Group.Lock on this Accel_Group.

From_Accel_Closure 

function From_Accel_Closure 
(Closure: C_Gtk_Accel_Group_Activate) return Gtk_Accel_Group;
Finds the Gtk.Accel_Group.Gtk_Accel_Group to which Closure is connected; see Gtk.Accel_Group.Connect. "closure": a GClosure

Accel_Groups_Activate 

function Accel_Groups_Activate 
(Object: not null access Glib.Object.GObject_Record'Class;
Accel_Key: Gdk.Types.Gdk_Key_Type;
Accel_Mods: Gdk.Types.Gdk_Modifier_Type) return Boolean;
Finds the first accelerator in any Gtk.Accel_Group.Gtk_Accel_Group attached to Object that matches Accel_Key and Accel_Mods, and activates that accelerator. "object": the Glib.Object.GObject, usually a Gtk.Window.Gtk_Window, on which to activate the accelerator "accel_key": accelerator keyval from a key event "accel_mods": keyboard state mask from a key event

From_Object 

function From_Object 
(Object: not null access Glib.Object.GObject_Record'Class) return Glib.Object.Object_List.GSlist;
Gets a list of all accel groups which are attached to Object. "object": a Glib.Object.GObject, usually a Gtk.Window.Gtk_Window

Accelerator_Valid 

function Accelerator_Valid 
(Keyval: Gdk.Types.Gdk_Key_Type;
Modifiers: Gdk.Types.Gdk_Modifier_Type) return Boolean;
Determines whether a given keyval and modifier mask constitute a valid keyboard accelerator. For example, the GDK_KEY_a keyval plus GDK_CONTROL_MASK is valid - this is a "Ctrl+a" accelerator. But, you can't, for instance, use the GDK_KEY_Control_L keyval as an accelerator. "keyval": a GDK keyval "modifiers": modifier mask

Accelerator_Parse 

procedure Accelerator_Parse 
(Accelerator: UTF8_String;
Accelerator_Key: out Gdk.Types.Gdk_Key_Type;
Accelerator_Mods: out Gdk.Types.Gdk_Modifier_Type);
Parses a string representing an accelerator. The format looks like "<Control>a" or "<Shift><Alt>F1" or "<Release>z" (the last one is for key release). The parser is fairly liberal and allows lower or upper case, and also abbreviations such as "<Ctl>" and "<Ctrl>". Key names are parsed using gdk_keyval_from_name. For character keys the name is not the symbol, but the lowercase name, e.g. one would use "<Ctrl>minus" instead of "<Ctrl>-". If the parse fails, Accelerator_Key and Accelerator_Mods will be set to 0 (zero). "accelerator": string representing an accelerator "accelerator_key": return location for accelerator keyval, or null "accelerator_mods": return location for accelerator modifier mask, null

Accelerator_Name 

function Accelerator_Name 
(Accelerator_Key: Gdk.Types.Gdk_Key_Type;
Accelerator_Mods: Gdk.Types.Gdk_Modifier_Type) return UTF8_String;
Converts an accelerator keyval and modifier mask into a string parseable by Gtk.Accel_Group.Accelerator_Parse. For example, if you pass in GDK_KEY_q and GDK_CONTROL_MASK, this function returns "<Control>q". If you need to display accelerators in the user interface, see Gtk.Accel_Group.Accelerator_Get_Label. "accelerator_key": accelerator keyval "accelerator_mods": accelerator modifier mask

Accelerator_Get_Label 

function Accelerator_Get_Label 
(Accelerator_Key: Gdk.Types.Gdk_Key_Type;
Accelerator_Mods: Gdk.Types.Gdk_Modifier_Type) return UTF8_String;
Converts an accelerator keyval and modifier mask into a string which can be used to represent the accelerator to the user. Since: gtk+ 2.6 "accelerator_key": accelerator keyval "accelerator_mods": accelerator modifier mask

Set_Default_Mod_Mask 

procedure Set_Default_Mod_Mask 
(Default_Mod_Mask: Gdk.Types.Gdk_Modifier_Type);
Sets the modifiers that will be considered significant for keyboard accelerators. The default mod mask is GDK_CONTROL_MASK | GDK_SHIFT_MASK | GDK_MOD1_MASK | GDK_SUPER_MASK | GDK_HYPER_MASK | GDK_META_MASK, that is, Control, Shift, Alt, Super, Hyper and Meta. Other modifiers will by default be ignored by Gtk.Accel_Group.Gtk_Accel_Group. You must include at least the three modifiers Control, Shift and Alt in any value you pass to this function. The default mod mask should be changed on application startup, before using any accelerator groups. "default_mod_mask": accelerator modifier mask

Get_Default_Mod_Mask 

function Get_Default_Mod_Mask return Gdk.Types.Gdk_Modifier_Type;
Gets the value set by Gtk.Accel_Group.Set_Default_Mod_Mask.

On_Accel_Activate 

procedure On_Accel_Activate 
(Self: not null access Gtk_Accel_Group_Record;
Call: Cb_Gtk_Accel_Group_GObject_Guint_Gdk_Modifier_Type_Boolean;
After: Boolean := False);

On_Accel_Activate 

procedure On_Accel_Activate 
(Self: not null access Gtk_Accel_Group_Record;
Call: Cb_GObject_GObject_Guint_Gdk_Modifier_Type_Boolean;
Slot: not null access Glib.Object.GObject_Record'Class;
After: Boolean := False);
The accel-activate signal is an implementation detail of Gtk.Accel_Group.Gtk_Accel_Group and not meant to be used by applications. Callback parameters: -- "acceleratable": the object on which the accelerator was activated -- "keyval": the accelerator keyval -- "modifier": the modifier combination of the accelerator -- Returns True if the accelerator was activated

On_Accel_Changed 

procedure On_Accel_Changed 
(Self: not null access Gtk_Accel_Group_Record;
Call: Cb_Gtk_Accel_Group_Guint_Gdk_Modifier_Type_Address_Void;
After: Boolean := False);

On_Accel_Changed 

procedure On_Accel_Changed 
(Self: not null access Gtk_Accel_Group_Record;
Call: Cb_GObject_Guint_Gdk_Modifier_Type_Address_Void;
Slot: not null access Glib.Object.GObject_Record'Class;
After: Boolean := False);
The accel-changed signal is emitted when an entry is added to or removed from the accel group. Widgets like Gtk.Accel_Label.Gtk_Accel_Label which display an associated accelerator should connect to this signal, and rebuild their visual representation if the Accel_Closure is theirs. Callback parameters: -- "keyval": the accelerator keyval -- "modifier": the modifier combination of the accelerator -- "accel_closure": the GClosure of the accelerator