Index

Package: Dialog

Description

package Gtk.Dialog is

Dialog boxes are a convenient way to prompt the user for a small amount of input, eg. to display a message, ask a question, or anything else that does not require extensive effort on the user's part.

Gtkada treats a dialog as a window split horizontally. The top section is a Gtk_Vbox, and is where widgets such as a Gtk_Label or a Gtk_Entry should be packed. The second area is known as the action_area. This is generally used for packing buttons into the dialog which may perform functions such as cancel, ok, or apply. The two areas are separated by a Gtk_Hseparator.

If 'dialog' is a newly created dialog, the two primary areas of the window can be accessed using Get_Vbox and Get_Action_Area as can be seen from the example, below.

A 'modal' dialog (that is, one which freezes the rest of the application from user input), can be created by calling Set_Modal on the dialog.

See Gtkada.Dialogs for a higher level dialog interface.

Binding from C File version 2.16.6

<testgtk>create_dialog.adb</testgtk>

Screenshot

gtk-dialog.png

Classes

Gtk_Dialog_Record

type Gtk_Dialog_Record is new Gtk.Window.Gtk_Window_Record with private;

Ancestors:

Immediate Children:

Primitive operations:

Add_Action_Widget
Get_Action_Area
Get_Content_Area
Get_Has_Separator
Get_Response_For_Widget
Glib.Object.Deallocate (Inherited)
Glib.Object.Notify (Inherited)
Glib.Object.Ref (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.Object.Destroy (Inherited)
Gtk.Object.Flag_Is_Set (Inherited)
Gtk.Object.Flags (Inherited)
Gtk.Object.Get_Type (Inherited)
Gtk.Object.Set_Flags (Inherited)
Gtk.Object.Sink (Inherited)
Gtk.Object.Unset_Flags (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.Draw (Inherited)
Gtk.Widget.Ensure_Style (Inherited)
Gtk.Widget.Error_Bell (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_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.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_Alternative_Button_Order_From_Array
Set_Default_Response
Set_Has_Separator
Set_Response_Sensitive

Types

Gtk_Dialog

type Gtk_Dialog is access all Gtk_Dialog_Record'Class;

Gtk_Dialog_Flags

type Gtk_Dialog_Flags is mod 8;

Gtk_Response_Type

type Gtk_Response_Type is new Gint;
Type used for Response_Id's. Positive values are totally user-interpreted. GtkAda will sometimes return Gtk_Response_None if no Response_Id is available. Typical usage is: if Gtk.Dialog.Run (Dialog) = Gtk_Response_Accept then blah; end if;

Response_Type_Array

type Response_Type_Array is array (Natural range <>) of Gtk_Response_Type;

Constants & Global variables

Modal (Gtk_Dialog_Flags)

Modal               : constant Gtk_Dialog_Flags := 2 ** 0;

Destroy_With_Parent (Gtk_Dialog_Flags)

Destroy_With_Parent : constant Gtk_Dialog_Flags := 2 ** 1;

No_Separator (Gtk_Dialog_Flags)

No_Separator        : constant Gtk_Dialog_Flags := 2 ** 2;
Various flags that can be set for the dialog, with the following implications: - Modal : the dialog is modal, see Gtk.Window.Set_Modal - Destroy_With_Parent: The dialog is destroyed if its parent is destroyed. See Gtk.Window.Set_Destroy_With_Parent - No_Separator: No separator bar above the buttons.

Gtk_Response_None (Gtk_Response_Type)

Gtk_Response_None : constant Gtk_Response_Type := -1;
GtkAda returns this if a response widget has no Response_Id, or if the dialog gets programmatically hidden or destroyed.

Gtk_Response_Reject (Gtk_Response_Type)

Gtk_Response_Reject : constant Gtk_Response_Type := -2;

Gtk_Response_Accept (Gtk_Response_Type)

Gtk_Response_Accept : constant Gtk_Response_Type := -3;
GtkAda won't return these unless you pass them in as the response for an action widget. They are for your convenience.

Gtk_Response_Delete_Event (Gtk_Response_Type)

Gtk_Response_Delete_Event : constant Gtk_Response_Type := -4;
If the dialog is deleted through the button in the titlebar

Gtk_Response_OK (Gtk_Response_Type)

Gtk_Response_OK     : constant Gtk_Response_Type := -5;

Gtk_Response_Cancel (Gtk_Response_Type)

Gtk_Response_Cancel : constant Gtk_Response_Type := -6;

Gtk_Response_Close (Gtk_Response_Type)

Gtk_Response_Close  : constant Gtk_Response_Type := -7;

Gtk_Response_Yes (Gtk_Response_Type)

Gtk_Response_Yes    : constant Gtk_Response_Type := -8;

Gtk_Response_No (Gtk_Response_Type)

Gtk_Response_No     : constant Gtk_Response_Type := -9;

Gtk_Response_Apply (Gtk_Response_Type)

Gtk_Response_Apply  : constant Gtk_Response_Type := -10;

Gtk_Response_Help (Gtk_Response_Type)

Gtk_Response_Help   : constant Gtk_Response_Type := -11;
These are returned from dialogs, and you can also use them yourself if you like.

Has_Separator_Property (Glib.Properties.Property_Boolean)

Has_Separator_Property : constant Glib.Properties.Property_Boolean;

Action_Area_Border_Property (Glib.Properties.Property_Int)

Action_Area_Border_Property  : constant Glib.Properties.Property_Int;

Button_Spacing_Property (Glib.Properties.Property_Int)

Button_Spacing_Property      : constant Glib.Properties.Property_Int;

Content_Area_Border_Property (Glib.Properties.Property_Int)

Content_Area_Border_Property : constant Glib.Properties.Property_Int;

Content_Area_Spacing_Property (Glib.Properties.Property_Int)

Content_Area_Spacing_Property : constant Glib.Properties.Property_Int;

Signal_Close (Glib.Signal_Name)

Signal_Close    : constant Glib.Signal_Name := "close";

Signal_Response (Glib.Signal_Name)

Signal_Response : constant Glib.Signal_Name := "response";

Subprograms & Entries

Gtk_New

procedure Gtk_New 
(Dialog: out Gtk_Dialog);
Create a new dialog. Widgets should not be packed into this widget directly, but into the vbox and action_area, as described above.

Gtk_New

procedure Gtk_New 
(Dialog: out Gtk_Dialog;
Title: UTF8_String;
Parent: Gtk.Window.Gtk_Window;
Flags: Gtk_Dialog_Flags);
Create a new dialog with a specific title, and specific attributes. Parent is the transient parent for the dialog (ie the one that is used for reference for the flag Destroy_With_Parent, or to compute the initial position of the dialog).

Initialize

procedure Initialize 
(Dialog: access Gtk_Dialog_Record'Class);
Internal initialization function. See the section "Creating your own widgets" in the documentation.

Initialize

procedure Initialize 
(Dialog: access Gtk_Dialog_Record'Class;
Title: UTF8_String;
Parent: Gtk.Window.Gtk_Window;
Flags: Gtk_Dialog_Flags);
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_Dialog.

Get_Action_Area

function Get_Action_Area 
(Dialog: access Gtk_Dialog_Record) return Gtk.Box.Gtk_Box;
Return the action area box associated with a Dialog.

Get_Content_Area

function Get_Content_Area 
(Dialog: access Gtk_Dialog_Record) return Gtk.Box.Gtk_Box;
Return the content area of the Dialog.

Get_Vbox

function Get_Vbox 
(Dialog: access Gtk_Dialog_Record) return Gtk.Box.Gtk_Box;
Return the vertical box associated with a Dialog.

Add_Action_Widget

procedure Add_Action_Widget 
(Dialog: access Gtk_Dialog_Record;
Child: access Gtk.Widget.Gtk_Widget_Record'Class;
Response_Id: Gtk_Response_Type);
Add an activatable widget to the action area of Dialog. When the widget is activated (ie emits the "activate" signal), Dialog will emit the "response" signal with Response_Id.

Add_Button

function Add_Button 
(Dialog: access Gtk_Dialog_Record;
Text: UTF8_String;
Response_Id: Gtk_Response_Type) return Gtk.Widget.Gtk_Widget;
Add a button with the given text to the dialog. Note that you can also pass one of the constants defined in Gtk.Stock for the predefined buttons. When the button is clicked, Dialog will emit the "response" signal. The button widget is returned.

Get_Response_For_Widget

function Get_Response_For_Widget 
(Dialog: access Gtk_Dialog_Record;
Widget: access Gtk.Widget.Gtk_Widget_Record'Class) return Gint;
Gets the response id of a widget in the action area of a dialog, or Gtk_Response_None if Widget doesn't have a response Id set

Set_Alternative_Button_Order_From_Array

procedure Set_Alternative_Button_Order_From_Array 
(Dialog: access Gtk_Dialog_Record;
New_Order: Response_Type_Array);
Sets an alternative button order. If the gtk-alternative-button-order setting is set to %TRUE, the dialog buttons are reordered according to the order of the response ids passed to this function. By default, GTK+ dialogs use the button order advocated by the Gnome Human Interface Guidelines with the affirmative button at the far right, and the cancel button left of it. But the builtin GTK+ dialogs and message dialogs' do provide an alternative button order, which is more suitable on some platforms, e.g. Windows. Use this function after adding all the buttons to your dialog.

Gtk_Alternative_Dialog_Button_Order

function Gtk_Alternative_Dialog_Button_Order 
(Screen: Gdk.Gdk_Screen := null) return Boolean;
Returns True if dialogs are expected to use an alternative button order on the given screen (or current screen if null) . See Set_Alternative_Button_Order_From_Array for more details about alternative button order. If you need to use this function, you should probably connect to the ::notify:gtk-alternative-button-order signal on the Gtk_Settings object associated to Screen, in order to be notified if the button order setting changes. Returns: Whether the alternative button order should be used

Set_Response_Sensitive

procedure Set_Response_Sensitive 
(Dialog: access Gtk_Dialog_Record;
Response_Id: Gtk_Response_Type;
Setting: Boolean);
Call Gtk.Widget.Set_Sensitive for all the buttons in the dialog associated with Response_Id.

Set_Default_Response

procedure Set_Default_Response 
(Dialog: access Gtk_Dialog_Record;
Response_Id: Gtk_Response_Type);
Set the last widget in the dialog's action area with the given Response_Id as the default widget for Dialog. Pressing Enter will activate this default widget.

Set_Has_Separator

procedure Set_Has_Separator 
(Dialog: access Gtk_Dialog_Record;
Setting: Boolean);

Get_Has_Separator

function Get_Has_Separator 
(Dialog: access Gtk_Dialog_Record) return Boolean;
Set whether the dialog has a separator above the buttons.

Run

function Run 
(Dialog: access Gtk_Dialog_Record) return Gtk_Response_Type;
Block in a recursive main loop until Dialog emits the "response" signal, or is destroyed. If the dialog is destroyed, Gtk_Response_None is returned. Otherwise, the response_id from the "response" signal is returned. Run will call Show on the dialog automatically. However, it is your responsability to call Show for any child you have inserted in the dialog. The dialog is automatically set to modal when this function is called. You can exit at any time from this function by emitting the "response" signal directly. When Run returns, you are responsible for hiding or destroying the dialog if necessary.

Response

procedure Response 
(Dialog: access Gtk_Dialog_Record;
Response_Id: Gtk_Response_Type);
Emit the "response" signal