Index

Package: About_Dialog

Description

package Gtk.About_Dialog is

The Gtk_About_Dialog offers a simple way to display information about a program like its logo, name, copyright, website and license. It is also possible to give credits to the authors, documenters, translators and artists who have worked on the program. An about dialog is typically opened when the user selects the About option from the Help menu. All parts of the dialog are optional.

About dialog often contain links and email addresses. Gtk_About_Dialog supports this by offering global hooks, which are called when the user clicks on a link or email address, see Set_Email_Hook and Set_Url_Hook.

Email addresses in the authors, documenters and artists properties are recognized by looking for <user@host>, URLs are recognized by looking for http://url, with url extending to the next space, tab or line break.

To make constructing a Gtk_About_Dialog as convenient as possible, you can use the function gtk_show_about_dialog which constructs and shows a dialog and keeps it around so that it can be shown again.

<testgtk>create_about.adb</testgtk>

Packages

Implements_Buildable (new Glib.Types.Implements)

Classes

Gtk_About_Dialog_Record

type Gtk_About_Dialog_Record is new Gtk_Dialog_Record with null record;

Ancestors:

Primitive operations:

Get_Comments
Get_Copyright
Get_Documenters
Get_Logo_Icon_Name
Get_Program_Name
Get_Translator_Credits
Get_Website_Label
Get_Wrap_License
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.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.Dialog.Add_Action_Widget (Inherited)
Gtk.Dialog.Add_Button (Inherited)
Gtk.Dialog.Get_Action_Area (Inherited)
Gtk.Dialog.Get_Content_Area (Inherited)
Gtk.Dialog.Get_Has_Separator (Inherited)
Gtk.Dialog.Get_Response_For_Widget (Inherited)
Gtk.Dialog.Get_Vbox (Inherited)
Gtk.Dialog.Get_Widget_For_Response (Inherited)
Gtk.Dialog.Response (Inherited)
Gtk.Dialog.Run (Inherited)
Gtk.Dialog.Set_Alternative_Button_Order_From_Array (Inherited)
Gtk.Dialog.Set_Default_Response (Inherited)
Gtk.Dialog.Set_Has_Separator (Inherited)
Gtk.Dialog.Set_Response_Sensitive (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_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_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)
Gtk.Window.Activate_Default (Inherited)
Gtk.Window.Activate_Focus (Inherited)
Gtk.Window.Activate_Key (Inherited)
Gtk.Window.Add_Accel_Group (Inherited)
Gtk.Window.Add_Mnemonic (Inherited)
Gtk.Window.Begin_Move_Drag (Inherited)
Gtk.Window.Begin_Resize_Drag (Inherited)
Gtk.Window.Deiconify (Inherited)
Gtk.Window.Fullscreen (Inherited)
Gtk.Window.Get_Accept_Focus (Inherited)
Gtk.Window.Get_Decorated (Inherited)
Gtk.Window.Get_Default_Size (Inherited)
Gtk.Window.Get_Default_Widget (Inherited)
Gtk.Window.Get_Deletable (Inherited)
Gtk.Window.Get_Destroy_With_Parent (Inherited)
Gtk.Window.Get_Focus (Inherited)
Gtk.Window.Get_Focus_On_Map (Inherited)
Gtk.Window.Get_Frame_Dimensions (Inherited)
Gtk.Window.Get_Gravity (Inherited)
Gtk.Window.Get_Group (Inherited)
Gtk.Window.Get_Has_Frame (Inherited)
Gtk.Window.Get_Icon (Inherited)
Gtk.Window.Get_Icon_List (Inherited)
Gtk.Window.Get_Icon_Name (Inherited)
Gtk.Window.Get_Mnemonic_Modifier (Inherited)
Gtk.Window.Get_Modal (Inherited)
Gtk.Window.Get_Opacity (Inherited)
Gtk.Window.Get_Position (Inherited)
Gtk.Window.Get_Resizable (Inherited)
Gtk.Window.Get_Role (Inherited)
Gtk.Window.Get_Size (Inherited)
Gtk.Window.Get_Skip_Pager_Hint (Inherited)
Gtk.Window.Get_Skip_Taskbar_Hint (Inherited)
Gtk.Window.Get_Title (Inherited)
Gtk.Window.Get_Transient_For (Inherited)
Gtk.Window.Get_Type_Hint (Inherited)
Gtk.Window.Get_Urgency_Hint (Inherited)
Gtk.Window.Has_Toplevel_Focus (Inherited)
Gtk.Window.Iconify (Inherited)
Gtk.Window.Is_Active (Inherited)
Gtk.Window.Maximize (Inherited)
Gtk.Window.Mnemonic_Activate (Inherited)
Gtk.Window.Move (Inherited)
Gtk.Window.Parse_Geometry (Inherited)
Gtk.Window.Present (Inherited)
Gtk.Window.Present_With_Time (Inherited)
Gtk.Window.Propagate_Key_Event (Inherited)
Gtk.Window.Remove_Accel_Group (Inherited)
Gtk.Window.Remove_Mnemonic (Inherited)
Gtk.Window.Reshow_With_Initial_Size (Inherited)
Gtk.Window.Resize (Inherited)
Gtk.Window.Set_Accept_Focus (Inherited)
Gtk.Window.Set_Decorated (Inherited)
Gtk.Window.Set_Default (Inherited)
Gtk.Window.Set_Default_Size (Inherited)
Gtk.Window.Set_Deletable (Inherited)
Gtk.Window.Set_Destroy_With_Parent (Inherited)
Gtk.Window.Set_Focus (Inherited)
Gtk.Window.Set_Focus_On_Map (Inherited)
Gtk.Window.Set_Frame_Dimensions (Inherited)
Gtk.Window.Set_Geometry_Hints (Inherited)
Gtk.Window.Set_Gravity (Inherited)
Gtk.Window.Set_Has_Frame (Inherited)
Gtk.Window.Set_Icon (Inherited)
Gtk.Window.Set_Icon_From_File (Inherited)
Gtk.Window.Set_Icon_List (Inherited)
Gtk.Window.Set_Icon_Name (Inherited)
Gtk.Window.Set_Keep_Above (Inherited)
Gtk.Window.Set_Keep_Below (Inherited)
Gtk.Window.Set_Mnemonic_Modifier (Inherited)
Gtk.Window.Set_Modal (Inherited)
Gtk.Window.Set_Opacity (Inherited)
Gtk.Window.Set_Policy (Inherited)
Gtk.Window.Set_Position (Inherited)
Gtk.Window.Set_Resizable (Inherited)
Gtk.Window.Set_Role (Inherited)
Gtk.Window.Set_Skip_Pager_Hint (Inherited)
Gtk.Window.Set_Skip_Taskbar_Hint (Inherited)
Gtk.Window.Set_Startup_Id (Inherited)
Gtk.Window.Set_Title (Inherited)
Gtk.Window.Set_Transient_For (Inherited)
Gtk.Window.Set_Type_Hint (Inherited)
Gtk.Window.Set_Urgency_Hint (Inherited)
Gtk.Window.Set_Wmclass (Inherited)
Gtk.Window.Stick (Inherited)
Gtk.Window.Unfullscreen (Inherited)
Gtk.Window.Unmaximize (Inherited)
Gtk.Window.Unstick (Inherited)
Set_Comments
Set_Copyright
Set_Documenters
Set_Logo_Icon_Name
Set_Program_Name
Set_Translator_Credits
Set_Website_Label
Set_Wrap_License

Types

Gtk_About_Dialog

type Gtk_About_Dialog is access all Gtk_About_Dialog_Record'Class;

Activate_Link_Func

type Activate_Link_Func is access procedure
     (About : System.Address;
      Link  : Interfaces.C.Strings.chars_ptr;
      Data  : System.Address);

Constants & Global variables

Logo_Icon_Name_Property (Glib.Properties.Property_String)

Logo_Icon_Name_Property : constant Glib.Properties.Property_String;

Program_Name_Property (Glib.Properties.Property_String)

Program_Name_Property : constant Glib.Properties.Property_String;

Translator_Credits_Property (Glib.Properties.Property_String)

Translator_Credits_Property : constant Glib.Properties.Property_String;

Website_Label_Property (Glib.Properties.Property_String)

Website_Label_Property : constant Glib.Properties.Property_String;

Wrap_License_Property (Glib.Properties.Property_Boolean)

Wrap_License_Property : constant Glib.Properties.Property_Boolean;

Signal_Activate_Link (Glib.Signal_Name)

Signal_Activate_Link : constant Glib.Signal_Name := "activate-link";

Subprograms & Entries

Gtk_New

procedure Gtk_New 
(About: out Gtk_About_Dialog);

Initialize

procedure Initialize 
(About: access Gtk_About_Dialog_Record'Class);
Creates a new Gtk.About_Dialog.Gtk_About_Dialog. Since: gtk+ 2.6

Get_Type

function Get_Type return Glib.GType;

Get_Artists

function Get_Artists 
(About: access Gtk_About_Dialog_Record) return GNAT.Strings.String_List;

Set_Artists

procedure Set_Artists 
(About: access Gtk_About_Dialog_Record;
Artists: GNAT.Strings.String_List);
Sets the strings which are displayed in the artists tab of the secondary credits dialog. Since: gtk+ 2.6 "artists": a null-terminated array of strings

Get_Authors

function Get_Authors 
(About: access Gtk_About_Dialog_Record) return GNAT.Strings.String_List;

Set_Authors

procedure Set_Authors 
(About: access Gtk_About_Dialog_Record;
Authors: GNAT.Strings.String_List);
Sets the strings which are displayed in the authors tab of the secondary credits dialog. Since: gtk+ 2.6 "authors": a null-terminated array of strings

Get_Comments

function Get_Comments 
(About: access Gtk_About_Dialog_Record) return UTF8_String;

Set_Comments

procedure Set_Comments 
(About: access Gtk_About_Dialog_Record;
Comments: UTF8_String);
Sets the comments string to display in the about dialog. This should be a short string of one or two lines. Since: gtk+ 2.6 "comments": a comments string

Get_Copyright

function Get_Copyright 
(About: access Gtk_About_Dialog_Record) return UTF8_String;

Set_Copyright

procedure Set_Copyright 
(About: access Gtk_About_Dialog_Record;
Copyright: UTF8_String);
Sets the copyright string to display in the about dialog. This should be a short string of one or two lines. Since: gtk+ 2.6 "copyright": (allow-none) the copyright string

Get_Documenters

function Get_Documenters 
(About: access Gtk_About_Dialog_Record) return GNAT.Strings.String_List;

Set_Documenters

procedure Set_Documenters 
(About: access Gtk_About_Dialog_Record;
Documenters: GNAT.Strings.String_List);
Sets the strings which are displayed in the documenters tab of the secondary credits dialog. Since: gtk+ 2.6 "documenters": a null-terminated array of strings

Get_License

function Get_License 
(About: access Gtk_About_Dialog_Record) return UTF8_String;

Set_License

procedure Set_License 
(About: access Gtk_About_Dialog_Record;
License: UTF8_String);
Sets the license information to be displayed in the secondary license dialog. If License is null, the license button is hidden. Since: gtk+ 2.6 "license": the license information or null

Get_Logo

function Get_Logo 
(About: access Gtk_About_Dialog_Record) return Gdk.Pixbuf.Gdk_Pixbuf;

Set_Logo

procedure Set_Logo 
(About: access Gtk_About_Dialog_Record;
Logo: access Gdk.Pixbuf.Gdk_Pixbuf_Record'Class);
Sets the pixbuf to be displayed as logo in the about dialog. If it is null, the default window icon set with Gtk.Window.Set_Default_Icon will be used. Since: gtk+ 2.6 "logo": a Gdk.Pixbuf.Gdk_Pixbuf, or null

Get_Logo_Icon_Name

function Get_Logo_Icon_Name 
(About: access Gtk_About_Dialog_Record) return UTF8_String;

Set_Logo_Icon_Name

procedure Set_Logo_Icon_Name 
(About: access Gtk_About_Dialog_Record;
Icon_Name: UTF8_String);
Sets the pixbuf to be displayed as logo in the about dialog. If it is null, the default window icon set with Gtk.Window.Set_Default_Icon will be used. Since: gtk+ 2.6 "icon_name": an icon name, or null

Get_Name

function Get_Name 
(About: access Gtk_About_Dialog_Record) return UTF8_String;

Set_Name

procedure Set_Name 
(About: access Gtk_About_Dialog_Record;
Name: UTF8_String);

Get_Program_Name

function Get_Program_Name 
(About: access Gtk_About_Dialog_Record) return UTF8_String;

Set_Program_Name

procedure Set_Program_Name 
(About: access Gtk_About_Dialog_Record;
Name: UTF8_String);
Sets the name to display in the about dialog. If this is not set, it defaults to g_get_application_name. Since: gtk+ 2.12 "name": the program name

Get_Translator_Credits

function Get_Translator_Credits 
(About: access Gtk_About_Dialog_Record) return UTF8_String;

Set_Translator_Credits

procedure Set_Translator_Credits 
(About: access Gtk_About_Dialog_Record;
Translator_Credits: UTF8_String);
Sets the translator credits string which is displayed in the translators tab of the secondary credits dialog. The intended use for this string is to display the translator of the language which is currently used in the user interface. Using gettext, a simple way to achieve that is to mark the string for translation: |[ gtk_about_dialog_set_translator_credits (about, _("translator-credits")); ]| It is a good idea to use the customary msgid "translator-credits" for this purpose, since translators will already know the purpose of that msgid, and since Gtk.About_Dialog.Gtk_About_Dialog will detect if "translator-credits" is untranslated and hide the tab. Since: gtk+ 2.6 "translator_credits": the translator credits

Get_Version

function Get_Version 
(About: access Gtk_About_Dialog_Record) return UTF8_String;

Set_Version

procedure Set_Version 
(About: access Gtk_About_Dialog_Record;
Version: UTF8_String);
Sets the version string to display in the about dialog. Since: gtk+ 2.6 "version": the version string

Get_Website

function Get_Website 
(About: access Gtk_About_Dialog_Record) return UTF8_String;

Set_Website

procedure Set_Website 
(About: access Gtk_About_Dialog_Record;
Website: UTF8_String);
Sets the URL to use for the website link. Note that that the hook functions need to be set up before calling this function. Since: gtk+ 2.6 "website": a URL string starting with "http://"

Get_Website_Label

function Get_Website_Label 
(About: access Gtk_About_Dialog_Record) return UTF8_String;

Set_Website_Label

procedure Set_Website_Label 
(About: access Gtk_About_Dialog_Record;
Website_Label: UTF8_String);
Sets the label to be used for the website link. It defaults to the website URL. Since: gtk+ 2.6 "website_label": the label used for the website link

Get_Wrap_License

function Get_Wrap_License 
(About: access Gtk_About_Dialog_Record) return Boolean;

Set_Wrap_License

procedure Set_Wrap_License 
(About: access Gtk_About_Dialog_Record;
Wrap_License: Boolean);
Sets whether the license text in About is automatically wrapped. Since: gtk+ 2.8 "wrap_license": whether to wrap the license

Set_Email_Hook

function Set_Email_Hook 
(Func: Activate_Link_Func;
Data: System.Address;
Destroy: Glib.G_Destroy_Notify_Address) return Activate_Link_Func;

Set_Url_Hook

function Set_Url_Hook 
(Func: Activate_Link_Func;
Data: System.Address;
Destroy: Glib.G_Destroy_Notify_Address) return Activate_Link_Func;