<?xml version='1.0' encoding='utf-8' />
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html><head>
<title>GtkAda: Gtk.Accel_Group</title>
<link rel='stylesheet' href='gtkada_rm.css' type='text/css'>
<script src='gtkada_rm.js' type='text/javascript'></script>
</head><body>
<div id='objectName'>
<span><a href='index.html'><img src='home.png' alt='Toc' title='Table of Contents'/></a> <a href='gallery.html'><img src='gallery.png' alt='Gallery' title='Widgets gallery'/></a>
<a href='entities.html'><img src='entities.png' alt='Index' title='Global Index'/></a>
<a href='tree.html'><img src='tree.png' alt='Tree' title='Widgets Inheritance Tree'/></a>
</span>
Gtk.Accel_Group
</div> <!-- objectName -->
<div id='leftSide'>
<div id='classHierarchy'>
<h2>Hierarchy</h2>
<ul class='top'>
<li><img src='childtree.png' alt='_' /><a class='tree' onclick='treetoggle(this)'><img src='treeopen.png' alt='[-]' /></a><a href='glib-object.html'>GObject_Record</a></li><ul>
<li><img src='childtree2.png' alt=' '/><img src='childtree.png' alt='_' />Gtk_Accel_Group_Record</li></ul>
</ul>
</div> <!-- classHierarchy -->
<div id='navigation'>
<h2>Navigation</h2>
<ul>
<li><a href='#Description' onclick='return switchPage("page1")'>Description</a></li>
<li><a href='#Types' onclick='return switchPage("page1")'>Types</a></li>
<li><a href='#Subprograms' onclick='return switchPage("page1")'>Subprograms</a>
<ul>
<li><a href='#Subprograms__General' onclick='return switchPage("page1")'>General</a></li>
<li><a href='#Subprograms__Groups' onclick='return switchPage("page1")'>Groups</a></li>
<li><a href='#Subprograms__Accelerators' onclick='return switchPage("page1")'>Accelerators</a></li>
</ul>
</li>
<li><a href='#Signals' onclick='return switchPage("page2")'>Signals</a></li>
</ul>
</div> <!-- navigation -->
</div> <!-- leftSide -->
<div id='documentation'>
<ul id='notebook'>
<li id='tab_page1' class='current'><a href='' onclick='return !switchPage("page1")'>Entities</a></li>
<li id='tab_page2'><a href='#Signals' onclick='return !switchPage("page2")'>Signals</a></li>
</ul> <!-- notebook -->
<div id='notebook_page1' class='notebookPage'>
<a name='Description'></a>
<div class='description'>
<h2>Description</h2>
An accel group represents a group of keyboard accelerators, generally
attached to a toplevel window.
Accelerators are different from mnemonics. Accelerators are shortcuts for
activating a menu item. They appear alongside the menu item they are a
shortcut for. Mnemonics are shortcuts for GUI elements, such as buttons.
They appear as underline characters. Menu items can have both.
</div> <!-- description -->
<a name='Types'></a>
<div id='types'>
<h2>Types</h2>
<ul>
<li><a name='Gtk_Accel_Flags_'></a>
<div class='profile'><b>type</b> Gtk_Accel_Flags <b>is</b> <b>new</b> Guint;</div>
<div class='comment'></div></li>
<li><a name='Gtk_Accel_Group_'></a>
<div class='profile'><b>type</b> Gtk_Accel_Group <b>is</b> <b>access</b> <b>all</b> Gtk_Accel_Group_Record'Class;</div>
<div class='comment'></div></li>
<li><a name='Gtk_Accel_Group_Activate_'></a>
<div class='profile'><b>type</b> Gtk_Accel_Group_Activate <b>is</b> <b>access</b> <b>function</b>
(Accel_Group : <b>access</b> Gtk_Accel_Group_Record'Class;
Acceleratable : <a href='glib-object.html'>Glib.Object.GObject</a>;
Keyval : Gdk.Types.Gdk_Key_Type;
Modifier : Gdk.Types.Gdk_Modifier_Type) <b>return</b> Boolean;</div>
<div class='comment'></div></li>
<li><a name='Gtk_Accel_Group_Entry_'></a>
<div class='profile'><b>type</b> Gtk_Accel_Group_Entry <b>is</b> <b>new</b> <a href='gdk.html'>Gdk.C_Proxy</a>;</div>
<div class='comment'></div></li>
<li><a name='Gtk_Accel_Group_Record_'></a>
<div class='profile'><b>type</b> Gtk_Accel_Group_Record <b>is</b> <b>new</b> <a href='glib-object.html'>Glib.Object.GObject_Record</a> <b>with</b> <b>private</b>;</div>
<div class='comment'></div></li>
<li><a name='Gtk_Accel_Key_'></a>
<div class='profile'><b>type</b> Gtk_Accel_Key <b>is</b> <b>record</b>
Accel_Key : Gdk.Types.Gdk_Key_Type;</div>
<div class='comment'></div></li>
</ul>
</div> <!-- types -->
<a name='Subprograms'> </a>
<a name='Subprograms__General'> </a>
<div id='subprograms'>
<h2>Subprograms</h2>
<ul>
<li><a name='Gtk_New_1_'></a>
<div class='profile'><b>procedure</b> <span class='name'>Gtk_New</span> (Accel_Group : <b>out</b> Gtk_Accel_Group);</div>
<a name='Initialize_2_'></a>
<div class='profile'><b>procedure</b> <span class='name'>Initialize</span> (Accel_Group : <b>access</b> Gtk_Accel_Group_Record'Class);</div>
<div class='comment'>Remember to call <a href='gtk-window.html#Add_Accel_Group_93_'>Gtk.Window.Add_Accel_Group</a> to active the group.
</div></li>
<li><a name='Get_Type_3_'></a>
<div class='profile'><b>function</b> <span class='name'>Get_Type</span> <b>return</b> <a href='glib.html'>Glib.GType</a>;</div>
<div class='comment'>Return the internal value associated with a <a href='gtk-accel_group.html'>Gtk_Accel_Group</a>.
</div></li>
<li><a name='Lock_4_'></a>
<div class='profile'><b>procedure</b> <span class='name'>Lock</span> (Accel_Group : <b>access</b> Gtk_Accel_Group_Record);</div>
<a name='Unlock_5_'></a>
<div class='profile'><b>procedure</b> <span class='name'>Unlock</span> (Accel_Group : <b>access</b> Gtk_Accel_Group_Record);</div>
<a name='Get_Is_Locked_6_'></a>
<div class='profile'><b>function</b> <span class='name'>Get_Is_Locked</span>
(Accel_Group : <b>access</b> Gtk_Accel_Group_Record) <b>return</b> Boolean;</div>
<div class='comment'>Locks or unlocks the group. When a group is locked, the accelerators
contained in it cannot be changed at runtime by the user. See
Gtk_Accel_Map.Change_Entry about runtime accelerator changes.
<a href='gtk-accel_group.html#Unlock_5_'>Unlock</a> must be called the same number of time that <a href='gtk-accel_group.html#Lock_4_'>Lock</a> was called.
</div></li>
<a name='Subprograms__Groups'></a>
<h3>Groups</h3>
<div class='description'></div>
<li><a name='Accel_Groups_Activate_7_'></a>
<div class='profile'><b>function</b> <span class='name'>Accel_Groups_Activate</span>
(Object : <b>access</b> <a href='gtk-object.html'>Gtk.Object.Gtk_Object_Record</a>'Class;
Accel_Key : Gdk.Types.Gdk_Key_Type;
Accel_Mods : Gdk.Types.Gdk_Modifier_Type) <b>return</b> Boolean;</div>
<div class='comment'>Find the first accelerator in any group, attached to <tt>Object</tt> that matches
the given key and modifier, and activate that accelerator.
Returns True if an accelerator was activated.
</div></li>
<li><a name='From_Object_8_'></a>
<div class='profile'><b>function</b> <span class='name'>From_Object</span>
(Object : <b>access</b> <a href='gtk-object.html'>Gtk.Object.Gtk_Object_Record</a>'Class)
<b>return</b> Object_List.GSlist;</div>
<div class='comment'>Gets a list of all accel groups which are attached to <tt>Object</tt>.
</div></li>
<a name='Subprograms__Accelerators'></a>
<h3>Accelerators</h3>
<div class='description'></div>
<li><a name='Accelerator_Valid_9_'></a>
<div class='profile'><b>function</b> <span class='name'>Accelerator_Valid</span>
(Keyval : Gdk.Types.Gdk_Key_Type;
Modifiers : Gdk.Types.Gdk_Modifier_Type) <b>return</b> Boolean;</div>
<div class='comment'>Determines whether a given keyval and modifier constitute a valid
accelerator. For instance, GDK_Control_L is not a valid accelerator,
whereas Gdk_L associated with Control_Mask is valid.
</div></li>
<li><a name='Accelerator_Parse_10_'></a>
<div class='profile'><b>procedure</b> <span class='name'>Accelerator_Parse</span>
(Accelerator : String;
Accelerator_Key : <b>out</b> Gdk.Types.Gdk_Key_Type;
Accelerator_Mods : <b>out</b> Gdk.Types.Gdk_Modifier_Type);</div>
<div class='comment'>Parse a string representing an accelerator. The format looks like
"<Control>a", "<Shift><Alt>a" or "<Release>z" (the last one applies to
a key release. Abbreviations such as "Ctrl" are allowed.
</div></li>
<li><a name='Accelerator_Name_11_'></a>
<div class='profile'><b>function</b> <span class='name'>Accelerator_Name</span>
(Accelerator_Key : Gdk.Types.Gdk_Key_Type;
Accelerator_Mods : Gdk.Types.Gdk_Modifier_Type) <b>return</b> String;</div>
<div class='comment'>Converts an accelerator keyval and modifier mask into a string parseable
by <a href='gtk-accel_group.html#Accelerator_Parse_10_'>Accelerator_Parse</a>. For example, if you pass in GDK_q and
GDK_CONTROL_MASK, this function returns "<Control>q".
If you need to display accelerators in the user interface, see
<a href='gtk-accel_group.html#Accelerator_Get_Label_12_'>Accelerator_Get_Label</a>.
</div></li>
<li><a name='Accelerator_Get_Label_12_'></a>
<div class='profile'><b>function</b> <span class='name'>Accelerator_Get_Label</span>
(Accelerator_Key : Gdk.Types.Gdk_Key_Type;
Accelerator_Mods : Gdk.Types.Gdk_Modifier_Type) <b>return</b> String;</div>
<div class='comment'>Converts an accelerator keyval and modifier mask into a string
which can be used to represent the accelerator to the user.
</div></li>
<li><a name='Set_Default_Mod_Mask_13_'></a>
<div class='profile'><b>procedure</b> <span class='name'>Set_Default_Mod_Mask</span>
(Default_Mod_Mask : Gdk.Types.Gdk_Modifier_Type);</div>
<a name='Get_Default_Mod_Mask_14_'></a>
<div class='profile'><b>function</b> <span class='name'>Get_Default_Mod_Mask</span> <b>return</b> Gdk.Types.Gdk_Modifier_Type;</div>
<div class='comment'>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, that is, Control, Shift, and Alt. Other modifiers will
by default be ignored by GtkAccelGroup. You must include at least the
three default modifiers in any value you pass to this function.
<p>
The default mod mask should be changed on application startup, before
using any accelerator groups.
</div></li>
<li><a name='Get_Modifier_Mask_15_'></a>
<div class='profile'><b>function</b> <span class='name'>Get_Modifier_Mask</span>
(Accel_Group : <b>access</b> Gtk_Accel_Group_Record)
<b>return</b> Gdk.Types.Gdk_Modifier_Type;</div>
<div class='comment'>Gets a modifier type representing the mask for this
<tt>Accel_Group</tt>. For example, GDK_CONTROL_MASK, GDK_SHIFT_MASK, etc.
</div></li>
</ul>
</div> <!-- subprograms -->
</div> <!-- notebook_page1 -->
<div id='notebook_page2' class='notebookPage'>
<a name='Signals'></a>
<div id='signals'>
<h2>Signals</h2>
<ul>
<li><div class='name'>accel_activate</div>
<div class='profile'><b>procedure</b> <span class='name'>Handler</span>
(Group : <b>access</b> Gtk_Accel_Group_Record'Class;
Acceleratable : <b>access</b> GObject_Record'Class;
Keyval : Gdk_Key_Type;
Modifier : Gdk_Modifier_Type);</div>
<div class='comment'> This is an implementation detail, not meant to be used by applications
<div></li>
<li><div class='name'>accel_changed</div>
<div class='profile'><b>procedure</b> <span class='name'>Handler</span>
(Group : <b>access</b> Gtk_Accel_Group_Record'Class;
Keyval : Gdk_Key_Type;
Modifier : Gdk_Modifier_Type;
Closure : GClosure);</div>
<div class='comment'> Emitted when a <a href='gtk-accel_group.html'>Gtk_Accel_Group_Entry</a> is added to or removed from the
accel group.
Widgets like Gtk_Accel_Label which display an associated accelerator
should connect to this signal, and rebuild their visual representation
if the accel_closure is theirs.
<div></li>
</ul>
</div> <!-- signals -->
</div> <!-- notebook_page2 -->
<div id='notebook_page3' class='notebookPage'>
</div> <!-- notebook_page3 -->
</div> <!-- documentation -->
<div id='rightSide'>
<div id='Index'>
<h2>Alphabetical Index</h2>
<ul>
<li><a href='#Accel_Groups_Activate_7_' onclick='return switchPage("page1")'>Accel_Groups_Activate</a></li>
<li><a href='#Accelerator_Get_Label_12_' onclick='return switchPage("page1")'>Accelerator_Get_Label</a></li>
<li><a href='#Accelerator_Name_11_' onclick='return switchPage("page1")'>Accelerator_Name</a></li>
<li><a href='#Accelerator_Parse_10_' onclick='return switchPage("page1")'>Accelerator_Parse</a></li>
<li><a href='#Accelerator_Valid_9_' onclick='return switchPage("page1")'>Accelerator_Valid</a></li>
<li><a href='#From_Object_8_' onclick='return switchPage("page1")'>From_Object</a></li>
<li><a href='#Get_Default_Mod_Mask_14_' onclick='return switchPage("page1")'>Get_Default_Mod_Mask</a></li>
<li><a href='#Get_Is_Locked_6_' onclick='return switchPage("page1")'>Get_Is_Locked</a></li>
<li><a href='#Get_Modifier_Mask_15_' onclick='return switchPage("page1")'>Get_Modifier_Mask</a></li>
<li><a href='#Get_Type_3_' onclick='return switchPage("page1")'>Get_Type</a></li>
<li><a href='#Gtk_New_1_' onclick='return switchPage("page1")'>Gtk_New</a></li>
<li><a href='#Initialize_2_' onclick='return switchPage("page1")'>Initialize</a></li>
<li><a href='#Lock_4_' onclick='return switchPage("page1")'>Lock</a></li>
<li><a href='#Set_Default_Mod_Mask_13_' onclick='return switchPage("page1")'>Set_Default_Mod_Mask</a></li>
<li><a href='#Unlock_5_' onclick='return switchPage("page1")'>Unlock</a></li>
</ul>
</div> <!-- Index -->
</div> <!-- rightSide -->
<script language='javascript'>switchPage('page1');
adjust_height()</script>
</body>
</html>
