Index

Package: Accel_Label

Description

package Gtk.Accel_Label is

The Gtk_Accel_Label widget is a child of Gtk_Label that also displays an accelerator key on the right of the label text, e.g. 'Ctl+S'. It is commonly used in menus to show the keyboard short-cuts for commands.

The accelerator key to display is not set explicitly. Instead, the Gtk_Accel_Label displays the accelerators which have been added to a particular widget. This widget is set by calling Set_Accel_Widget.

For example, a Gtk_Menu_Item widget may have an accelerator added to emit the "activate" signal when the 'Ctl+S' key combination is pressed.

A Gtk_Accel_Label is created and added to the Gtk_Menu_Item, and Set_Accel_Widget is called with the Gtk_Menu_Item as the second argument.

The Gtk_Accel_Label will now display 'Ctl+S' after its label.

Note that creating a Gtk_Menu_Item with Gtk_New and a non null "label" parameter (ditto for Gtk_Check_Menu_Item and Gtk_Radio_Menu_Item) automatically adds a Gtk_Accel_Label to the Gtk_Menu_Item and calls Set_Accel_Widget to set it up for you.

A Gtk_Accel_Label will only display accelerators which have the Accel_Visible (see Gtk.Accel_Group) flag set. A Gtk_Accel_Label can display multiple accelerators and even signal names, though it is almost always used to display just one accelerator key.

Binding from C File version 2.8.17

Screenshot

gtk-accel_label.png

Classes

Gtk_Accel_Label_Record

type Gtk_Accel_Label_Record is new Gtk.Label.Gtk_Label_Record with private;

Ancestors:

Primitive operations:

Get_Accel_Widget
Get_Accel_Width
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.Label.Get_Angle (Inherited)
Gtk.Label.Get_Attributes (Inherited)
Gtk.Label.Get_Current_Uri (Inherited)
Gtk.Label.Get_Ellipsize (Inherited)
Gtk.Label.Get_Justify (Inherited)
Gtk.Label.Get_Label (Inherited)
Gtk.Label.Get_Layout (Inherited)
Gtk.Label.Get_Layout_Offsets (Inherited)
Gtk.Label.Get_Line_Wrap (Inherited)
Gtk.Label.Get_Line_Wrap_Mode (Inherited)
Gtk.Label.Get_Max_Width_Chars (Inherited)
Gtk.Label.Get_Mnemonic_Keyval (Inherited)
Gtk.Label.Get_Mnemonic_Widget (Inherited)
Gtk.Label.Get_Selectable (Inherited)
Gtk.Label.Get_Selection_Bounds (Inherited)
Gtk.Label.Get_Single_Line_Mode (Inherited)
Gtk.Label.Get_Text (Inherited)
Gtk.Label.Get_Track_Visited_Links (Inherited)
Gtk.Label.Get_Use_Markup (Inherited)
Gtk.Label.Get_Use_Underline (Inherited)
Gtk.Label.Get_Width_Chars (Inherited)
Gtk.Label.Parse_Uline (Inherited)
Gtk.Label.Select_Region (Inherited)
Gtk.Label.Set_Angle (Inherited)
Gtk.Label.Set_Attributes (Inherited)
Gtk.Label.Set_Ellipsize (Inherited)
Gtk.Label.Set_Justify (Inherited)
Gtk.Label.Set_Label (Inherited)
Gtk.Label.Set_Line_Wrap (Inherited)
Gtk.Label.Set_Line_Wrap_Mode (Inherited)
Gtk.Label.Set_Markup (Inherited)
Gtk.Label.Set_Markup_With_Mnemonic (Inherited)
Gtk.Label.Set_Max_Width_Chars (Inherited)
Gtk.Label.Set_Mnemonic_Widget (Inherited)
Gtk.Label.Set_Pattern (Inherited)
Gtk.Label.Set_Selectable (Inherited)
Gtk.Label.Set_Single_Line_Mode (Inherited)
Gtk.Label.Set_Text (Inherited)
Gtk.Label.Set_Text_With_Mnemonic (Inherited)
Gtk.Label.Set_Track_Visited_Links (Inherited)
Gtk.Label.Set_Use_Markup (Inherited)
Gtk.Label.Set_Use_Underline (Inherited)
Gtk.Label.Set_Width_Chars (Inherited)
Gtk.Misc.Get_Alignment (Inherited)
Gtk.Misc.Get_Padding (Inherited)
Gtk.Misc.Set_Alignment (Inherited)
Gtk.Misc.Set_Padding (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_Accel_Widget

Types

Gtk_Accel_Label

type Gtk_Accel_Label is access all Gtk_Accel_Label_Record;

Constants & Global variables

Accel_Widget_Property (Glib.Properties.Property_Object)

Accel_Widget_Property  : constant Glib.Properties.Property_Object;
Accel_Closure_Property : constant Glib.Properties.Property_Boxed;

Subprograms & Entries

Gtk_New

procedure Gtk_New 
(Accel_Label: out Gtk_Accel_Label;
Str: UTF8_String);
Create a new Gtk_Accel_Label. Str is the label string.

Initialize

procedure Initialize 
(Accel_Label: access Gtk_Accel_Label_Record'Class;
Str: UTF8_String);
Internal initialization function. See the section "Creating your own widgets" in the documentation.

Get_Type

function Get_Type return Gtk.Gtk_Type;
Return the internal value associated with a Gtk_Accel_Label.

Set_Accel_Widget

procedure Set_Accel_Widget 
(Accel_Label: access Gtk_Accel_Label_Record;
Accel_Widget: access Gtk.Widget.Gtk_Widget_Record'Class);
Add an accelerator to a particular widget.

Get_Accel_Widget

function Get_Accel_Widget 
(Accel_Label: access Gtk_Accel_Label_Record) return Gtk.Widget.Gtk_Widget;
Return the widget monitored by Accel_Label.

Get_Accel_Width

function Get_Accel_Width 
(Accel_Label: access Gtk_Accel_Label_Record) return Guint;
Return the width needed to display the accelerator key(s). This is used by menus to align all of the Gtk_Menu_Item widgets, and shouldn't be needed by applications.

Refetch

function Refetch 
(Accel_Label: access Gtk_Accel_Label_Record) return Boolean;
Recreate the string representing the accelerator keys. This should not be needed since the string is automatically updated whenever accelerators are added or removed from the associated widget. Always return False.