Toc Gallery Index Tree Gtk.Dialog

Screenshot

No screeshot

Hierarchy

Description

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.

Types

  • type Gtk_Dialog is access all Gtk_Dialog_Record'Class;
  • type Gtk_Dialog_Flags is mod 8;
  • type Gtk_Dialog_Record is new Gtk.Window.Gtk_Window_Record with private;
  • 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;

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

Subprograms

    Subprograms

  • 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.
  • 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).
  • procedure Initialize (Dialog : access Gtk_Dialog_Record'Class);
    Internal initialization function. See the section "Creating your own widgets" in the documentation.
  • 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.
  • function Get_Type return Gtk.Gtk_Type;
    Return the internal value associated with a Gtk_Dialog.
  • function Get_Action_Area (Dialog : access Gtk_Dialog_Record) return Gtk.Box.Gtk_Box;
    Return the action area box associated with a Dialog.
  • function Get_Vbox (Dialog : access Gtk_Dialog_Record) return Gtk.Box.Gtk_Box;
    Return the vertical box associated with a Dialog.
  • 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.
  • 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.
  • 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
  • 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.

  • 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

  • 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.
  • 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.
  • procedure Set_Has_Separator (Dialog : access Gtk_Dialog_Record; Setting : Boolean);
    function Get_Has_Separator (Dialog : access Gtk_Dialog_Record) return Boolean;
    Set whether the dialog has a separator above the buttons.
  • 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.
  • Signals

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

Signals

  • close
    procedure Handler (Dialog : access Gtk_Dialog_Record'Class);
    Emit this signal to force a closing of the dialog.
  • response
    procedure Handler (Dialog : access Gtk_Dialog_Record'Class; Response_Id : Gint);
    Emitted when an action widget is clicked, the dialog receives a delete event, or the application programmer calls Response. On delete event, the response ID is GTK_RESPONSE_NONE. Otherwise, it depends on which action widget was clicked.

Properties

  • Has_Separator_Property
    Boolean
    The dialog has a separator bar above its buttons

Style Properties

  • Action_Area_Border_Property
    Int
    Width of border around the button area at the bottom of the
  • Button_Spacing_Property
    Int
    Spacing between buttons
  • Content_Area_Border_Property
    Int
    Width of border around the main dialog area

Testgtk source code

This code is part of testgtk, a demo application packaged with GtkAda. Testgtk demonstrates the various widgets of GtkAda
----------------------------------------------------------------------- -- GtkAda - Ada95 binding for the Gimp Toolkit -- -- -- -- Copyright (C) 1998-1999 -- -- Emmanuel Briot, Joel Brobecker and Arnaud Charlet -- -- Copyright (C) 2003 ACT Europe -- -- -- -- This library is free software; you can redistribute it and/or -- -- modify it under the terms of the GNU General Public -- -- License as published by the Free Software Foundation; either -- -- version 2 of the License, or (at your option) any later version. -- -- -- -- This library is distributed in the hope that it will be useful, -- -- but WITHOUT ANY WARRANTY; without even the implied warranty of -- -- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -- -- General Public License for more details. -- -- -- -- You should have received a copy of the GNU General Public -- -- License along with this library; if not, write to the -- -- Free Software Foundation, Inc., 59 Temple Place - Suite 330, -- -- Boston, MA 02111-1307, USA. -- -- -- -- -- -- -- -- -- -- ----------------------------------------------------------------------- with Common; use Common; with Gtk.Box; use Gtk.Box; with Gtk.Button; use Gtk.Button; with Gtk.Dialog; use Gtk.Dialog; with Gtk.Handlers; use Gtk.Handlers; with Gtk.Label; use Gtk.Label; with Gtk.Widget; use Gtk.Widget; with Gtk; use Gtk; package body Create_Dialog is type Gtk_Label_Access is access all Gtk_Label; package Label_Destroy is new Handlers.User_Callback (Gtk_Label_Record, Gtk_Label_Access); procedure Destroyed (Lab : access Gtk_Label_Record'Class; Ptr : in Gtk_Label_Access); Dialog : aliased Gtk.Dialog.Gtk_Dialog; Global_Label : aliased Gtk_Label; function Help return String is begin return "A @bGtk_dialog@B is a separate window, usually used to print" & " a message for the user, or signal an error." & ASCII.LF & "A @bGtk_Dialog@B is split into two boxes, its @bVbox@B that will" & " contain the message, and an @bAction_Area@B that contains a" & " series of button, like OK, Cancel or Help."; end Help; procedure Destroyed (Lab : access Gtk_Label_Record'Class; Ptr : in Gtk_Label_Access) is pragma Warnings (Off, Lab); begin Ptr.all := null; end Destroyed; procedure Label_Toggle (Button : access Gtk_Widget_Record'Class) is pragma Warnings (Off, Button); begin if Global_Label = null then Gtk_New (Global_Label, "Dialog Test"); Label_Destroy.Connect (Global_Label, "destroy", Label_Destroy.To_Marshaller (Destroyed'Access), Global_Label'Access); Set_Padding (Global_Label, 10, 10); Pack_Start (Get_Vbox (Dialog), Global_Label, True, True, 0); Show (Global_Label); else Destroy (Global_Label); end if; end Label_Toggle; procedure Run (Frame : access Gtk.Frame.Gtk_Frame_Record'Class) is Button : Gtk_Button; begin Set_Label (Frame, "Dialog"); if Dialog = null then Gtk_New (Dialog); Destroy_Dialog_Handler.Connect (Dialog, "destroy", Destroy_Dialog_Handler.To_Marshaller (Destroy_Dialog'Access), Dialog'Access); Set_Title (Dialog, "Gtk_Dialog"); Set_Border_Width (Dialog, 0); Set_USize (Dialog, 200, 110); Gtk_New (Button, "OK"); Set_Flags (Button, Can_Default); Pack_Start (Get_Action_Area (Dialog), Button, True, True, 0); Grab_Default (Button); Show (Button); Gtk_New (Button, "Toggle"); Widget_Handler.Connect (Button, "clicked", Widget_Handler.To_Marshaller (Label_Toggle'Access)); Pack_Start (Get_Action_Area (Dialog), Button, True, True, 0); Show (Button); Show (Dialog); else Destroy (Dialog); end if; end Run; end Create_Dialog;

Alphabetical Index