1. ----------------------------------------------------------------------- 
  2. --              GtkAda - Ada95 binding for Gtk+/Gnome                -- 
  3. --                                                                   -- 
  4. --                Copyright (C) 2006-2007 AdaCore                    -- 
  5. --                                                                   -- 
  6. -- This library is free software; you can redistribute it and/or     -- 
  7. -- modify it under the terms of the GNU General Public               -- 
  8. -- License as published by the Free Software Foundation; either      -- 
  9. -- version 2 of the License, or (at your option) any later version.  -- 
  10. --                                                                   -- 
  11. -- This library is distributed in the hope that it will be useful,   -- 
  12. -- but WITHOUT ANY WARRANTY; without even the implied warranty of    -- 
  13. -- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU -- 
  14. -- General Public License for more details.                          -- 
  15. --                                                                   -- 
  16. -- You should have received a copy of the GNU General Public         -- 
  17. -- License along with this library; if not, write to the             -- 
  18. -- Free Software Foundation, Inc., 59 Temple Place - Suite 330,      -- 
  19. -- Boston, MA 02111-1307, USA.                                       -- 
  20. --                                                                   --
    21. -- -- -- -- -- -- -- -- -- -- -- -- 
  21. ----------------------------------------------------------------------- 
  22.  
  23. --  <description> 
  24. --  A container which can hide its child. 
  25. --  </description> 
  26. --  <c_version>2.8.17</c_version> 
  27. --  <group>Layout containers</group> 
  28. --  <screenshot>gtk-expander</screenshot> 
  29.  
  30. with Glib.Properties; 
  31. with Gtk.Bin; 
  32. with Gtk.Widget; 
  33.  
  34. package Gtk.Expander is 
  35.  
  36.    type Gtk_Expander_Record is new Gtk.Bin.Gtk_Bin_Record with null record; 
  37.    type Gtk_Expander is access all Gtk_Expander_Record'Class; 
  38.  
  39.    procedure Gtk_New (Expander : out Gtk_Expander; Label : String); 
  40.    procedure Initialize 
  41.      (Expander : access Gtk_Expander_Record'Class; Label  : String); 
  42.    --  Creates or initializes a new expander, using Label as the text of the 
  43.    --  label. 
  44.  
  45.    procedure Gtk_New_With_Mnemonic 
  46.      (Expander : out Gtk_Expander; Label : String); 
  47.    procedure Initialize_With_Mnemonic 
  48.      (Expander : access Gtk_Expander_Record'Class; Label  : String); 
  49.    --  Creates or initializes a new expander, using Label as the text of the 
  50.    --  label. 
  51.    --  If characters in Label are preceded by an underscore, they are 
  52.    --  underlined. If you need a literal underscore character in a label, use 
  53.    --  '__' (two underscores). The first underlined character represents a 
  54.    --  keyboard accelerator called a mnemonic. 
  55.    --  Pressing Alt and that key activates the button. 
  56.  
  57.    function Get_Type return Glib.GType; 
  58.    --  Returns the internal value used for an expander 
  59.  
  60.    procedure Set_Expanded 
  61.      (Expander : access Gtk_Expander_Record; Expanded : Boolean); 
  62.    function Get_Expanded 
  63.      (Expander : access Gtk_Expander_Record) return Boolean; 
  64.    --  Sets the state of the expander. Set to True, if you want 
  65.    --  the child widget to be revealed, and False if you want the 
  66.    --  child widget to be hidden. 
  67.  
  68.    procedure Set_Label 
  69.      (Expander : access Gtk_Expander_Record; Label : String); 
  70.    function Get_Label 
  71.      (Expander : access Gtk_Expander_Record) return String; 
  72.    --  Sets the text of the label of the expander to Label. 
  73.  
  74.    procedure Set_Label_Widget 
  75.      (Expander     : access Gtk_Expander_Record; 
  76.       Label_Widget : access Gtk.Widget.Gtk_Widget_Record'Class); 
  77.    function Get_Label_Widget 
  78.      (Expander : access Gtk_Expander_Record) return Gtk.Widget.Gtk_Widget; 
  79.    --  Set the label widget for the expander. This is the widget 
  80.    --  that will appear embedded alongside the expander arrow. 
  81.  
  82.    procedure Set_Spacing 
  83.      (Expander : access Gtk_Expander_Record; Spacing  : Gint); 
  84.    function Get_Spacing 
  85.      (Expander : access Gtk_Expander_Record) return Gint; 
  86.    --  Sets the spacing field of Expander, which is the number of pixels to 
  87.    --  place between expander and the child. 
  88.  
  89.    procedure Set_Use_Markup 
  90.      (Expander : access Gtk_Expander_Record; Use_Markup : Boolean); 
  91.    function Get_Use_Markup 
  92.      (Expander : access Gtk_Expander_Record) return Boolean; 
  93.    --  Sets whether the text of the label contains markup in Pango's text 
  94.    --  markup language. See Gtk.Label.Set_Markup. 
  95.  
  96.    procedure Set_Use_Underline 
  97.      (Expander : access Gtk_Expander_Record; Use_Underline : Boolean); 
  98.    function Get_Use_Underline 
  99.      (Expander : access Gtk_Expander_Record) return Boolean; 
  100.    --  If true, an underline in the text of the expander label indicates 
  101.    --  the next character should be used for the mnemonic accelerator key. 
  102.  
  103.    ---------------- 
  104.    -- Properties -- 
  105.    ---------------- 
  106.    --  The following properties are defined for this widget. See 
  107.    --  Glib.Properties for more information on properties. 
  108.  
  109.    --  <properties> 
  110.    --  Name:  Expanded_Property 
  111.    --  Type:  Boolean 
  112.    --  Descr: Whether the expander has been opened to reveal the child widget 
  113.    -- 
  114.    --  Name:  Label_Property 
  115.    --  Type:  String 
  116.    --  Descr: Text of the expander's label 
  117.    -- 
  118.    --  Name:  Label_Widget_Property 
  119.    --  Type:  Object 
  120.    --  Descr: A widget to display in place of the usual expander label 
  121.    -- 
  122.    --  Name:  Spacing_Property 
  123.    --  Type:  Int 
  124.    --  Descr: Space to put between the label and the child 
  125.    -- 
  126.    --  Name:  Use_Markup_Property 
  127.    --  Type:  Boolean 
  128.    --  Descr: The text of the label includes XML markup. See pango_parse_markup 
  129.    -- 
  130.    --  Name:  Use_Underline_Property 
  131.    --  Type:  Boolean 
  132.    --  Descr: If set, an underline in the text indicates the next character 
  133.    --         should be used for the mnemonic accelerator key 
  134.    --  </properties> 
  135.  
  136.    Expanded_Property      : constant Glib.Properties.Property_Boolean; 
  137.    Label_Property         : constant Glib.Properties.Property_String; 
  138.    Label_Widget_Property  : constant Glib.Properties.Property_Object; 
  139.    Spacing_Property       : constant Glib.Properties.Property_Int; 
  140.    Use_Markup_Property    : constant Glib.Properties.Property_Boolean; 
  141.    Use_Underline_Property : constant Glib.Properties.Property_Boolean; 
  142.  
  143.    ---------------------- 
  144.    -- Style Properties -- 
  145.    ---------------------- 
  146.    --  The following properties can be changed through the gtk theme and 
  147.    --  configuration files, and retrieved through Gtk.Widget.Style_Get_Property 
  148.  
  149.    --  <style_properties> 
  150.    --  Name:  Expander_Size_Property 
  151.    --  Type:  Int 
  152.    --  Descr: Size of the expander arrow 
  153.    -- 
  154.    --  Name:  Expander_Spacing_Property 
  155.    --  Type:  Int 
  156.    --  Descr: Spacing around expander arrow 
  157.    --  </style_properties> 
  158.  
  159.    Expander_Size_Property    : constant Glib.Properties.Property_Int; 
  160.    Expander_Spacing_Property : constant Glib.Properties.Property_Int; 
  161.  
  162.    ------------- 
  163.    -- Signals -- 
  164.    ------------- 
  165.  
  166.    --  <signals> 
  167.    --  The following new signals are defined for this widget: 
  168.    -- 
  169.    --  - "activate" 
  170.    --    procedure Handler (Expander : access Gtk_Expander_Record'Class); 
  171.    --    Send this signal if you want to toggle the state of the expander, as 
  172.    --    if the user had clicked on it. This is mostly useful when associated 
  173.    --    with a keybinding 
  174.    -- 
  175.    --  - "notify::expanded" 
  176.    --    This is the general "notify" signal, but will only call the handler 
  177.    --    when the "expanded property changes. This can be used to monitor state 
  178.    --    changes for the expander 
  179.    -- 
  180.    --  </signals> 
  181.  
  182.    Signal_Activate : constant Glib.Signal_Name := "activate"; 
  183.  
  184. private 
  185.    pragma Import (C, Get_Type, "gtk_expander_get_type"); 
  186.  
  187.    Expanded_Property : constant Glib.Properties.Property_Boolean := 
  188.      Glib.Properties.Build ("expanded"); 
  189.    Label_Property : constant Glib.Properties.Property_String := 
  190.      Glib.Properties.Build ("label"); 
  191.    Label_Widget_Property : constant Glib.Properties.Property_Object := 
  192.      Glib.Properties.Build ("label-widget"); 
  193.    Spacing_Property : constant Glib.Properties.Property_Int := 
  194.      Glib.Properties.Build ("spacing"); 
  195.    Use_Markup_Property : constant Glib.Properties.Property_Boolean := 
  196.      Glib.Properties.Build ("use-markup"); 
  197.    Use_Underline_Property : constant Glib.Properties.Property_Boolean := 
  198.      Glib.Properties.Build ("use-underline"); 
  199.  
  200.    Expander_Size_Property : constant Glib.Properties.Property_Int := 
  201.      Glib.Properties.Build ("expander-size"); 
  202.    Expander_Spacing_Property : constant Glib.Properties.Property_Int := 
  203.      Glib.Properties.Build ("expander-spacing"); 
  204.  
  205. end Gtk.Expander;