1. ----------------------------------------------------------------------- 
  2. --               GtkAda - Ada95 binding for Gtk+/Gnome               -- 
  3. --                                                                   -- 
  4. --                    Copyright (C) 2010, 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 Gtk_Assistant is a widget used to represent a generally complex 
  25. --  operation split into several steps, guiding the user through its 
  26. --  pages and controlling the page flow to collect the necessary data. 
  27. --  </description> 
  28. --  <c_version>2.16.6</c_version> 
  29. --  <group>Windows</group> 
  30. --  <testgtk>create_assistant.adb</testgtk> 
  31.  
  32. with Glib; 
  33. with Glib.Properties; 
  34. with Gdk.Pixbuf;      use Gdk.Pixbuf; 
  35. with Gtk.Widget;      use Gtk.Widget; 
  36. with Gtk.Window; 
  37.  
  38. package Gtk.Assistant is 
  39.  
  40.    type Gtk_Assistant_Record is new Gtk.Window.Gtk_Window_Record with private; 
  41.    type Gtk_Assistant is access all Gtk_Assistant_Record'Class; 
  42.  
  43.    procedure Gtk_New (Widget : out Gtk_Assistant); 
  44.    procedure Initialize (Widget : access Gtk_Assistant_Record'Class); 
  45.    --  Creates a new Gtk_Assistant. 
  46.  
  47.    type Gtk_Assistant_Page_Type is 
  48.      (Gtk_Assistant_Page_Content, 
  49.       Gtk_Assistant_Page_Intro, 
  50.       Gtk_Assistant_Page_Confirm, 
  51.       Gtk_Assistant_Page_Summary, 
  52.       Gtk_Assistant_Page_Progress); 
  53.    --  Definition of various page types.  See Get_Page_Type/Set_Page_Type 
  54.    --  for more info. 
  55.  
  56.    procedure Add_Action_Widget 
  57.      (Assistant : access Gtk_Assistant_Record; 
  58.       Child     : access Gtk_Widget_Record'Class); 
  59.    --  Adds a widget to the action area of a Gtk_Assistant. 
  60.  
  61.    function Append_Page 
  62.      (Assistant : access Gtk_Assistant_Record; 
  63.       Page      : access Gtk_Widget_Record'Class) 
  64.       return Gint; 
  65.    --  Appends a page to the Assistant. 
  66.    -- 
  67.    --  Return value: the index (starting at 0) of the inserted page 
  68.  
  69.    function Get_Current_Page (Assistant : access Gtk_Assistant_Record) 
  70.       return Gint; 
  71.    --  Returns the index (starting from 0) of the current page in the 
  72.    --  Assistant.  If the Assistant has no pages, -1 will be returned 
  73.  
  74.    function Get_N_Pages (Assistant : access Gtk_Assistant_Record) return Gint; 
  75.    --  Returns the number of pages in the Assistant 
  76.  
  77.    function Get_Nth_Page 
  78.      (Assistant : access Gtk_Assistant_Record; 
  79.       Page_Num  : Gint) 
  80.       return Gtk_Widget; 
  81.    --  Assistant: a Gtk_Assistant 
  82.    --  Page_Num: The index of a page in the Assistant, or -1 to get the 
  83.    --  last page 
  84.    -- 
  85.    --  Returns the child widget contained in page number Page_Num, or null 
  86.    --  if Page_Num is out of bounds. 
  87.  
  88.    function Get_Page_Complete 
  89.      (Assistant : access Gtk_Assistant_Record; 
  90.       Page      : access Gtk_Widget_Record'Class) 
  91.       return Boolean; 
  92.    --  Returns whether Page is complete. 
  93.  
  94.    function Get_Page_Header_Image 
  95.      (Assistant : access Gtk_Assistant_Record; 
  96.       Page      : access Gtk_Widget_Record'Class) 
  97.       return Gdk_Pixbuf; 
  98.    --  Gets the header image for Page.  Returns null if there's no header 
  99.    --  image for the page. 
  100.  
  101.    function Get_Page_Side_Image 
  102.      (Assistant : access Gtk_Assistant_Record; 
  103.       Page      : access Gtk_Widget_Record'Class) 
  104.       return Gdk_Pixbuf; 
  105.    --  Gets the side image for Page.  Returns null if there's no side 
  106.    --  image for the page. 
  107.  
  108.    function Get_Page_Title 
  109.      (Assistant : access Gtk_Assistant_Record; 
  110.       Page      : access Gtk_Widget_Record'Class) 
  111.       return String; 
  112.    --  Gets the title for Page. 
  113.  
  114.    function Get_Page_Type 
  115.      (Assistant : access Gtk_Assistant_Record; 
  116.       Page      : access Gtk_Widget_Record'Class) 
  117.       return Gtk_Assistant_Page_Type; 
  118.    --  Gets the page type of Page. 
  119.  
  120.    function Get_Type return GType; 
  121.    --  Return the internal value associated with a Gtk_Assistant. 
  122.  
  123.    function Insert_Page 
  124.      (Assistant : access Gtk_Assistant_Record; 
  125.       Page      : access Gtk_Widget_Record'Class; 
  126.       Position  : Gint) 
  127.       return Gint; 
  128.    --  Assistant: a Gtk_Assistant 
  129.    --  Page: a Gtk_Widget 
  130.    --  Position: the index (starting at 0) at which to insert the page, 
  131.    --  or -1 to append the page to the Assistant 
  132.    -- 
  133.    --  Inserts a page in the Assistant at a given position. 
  134.    -- 
  135.    --  Return value: the index (starting from 0) of the inserted page 
  136.  
  137.    function Prepend_Page 
  138.      (Assistant : access Gtk_Assistant_Record; 
  139.       Page      : access Gtk_Widget_Record'Class) 
  140.       return Gint; 
  141.    --  Prepends a page to the Assistant. 
  142.    -- 
  143.    --  Return value: the index (starting at 0) of the inserted page 
  144.  
  145.    procedure Remove_Action_Widget 
  146.      (Assistant : access Gtk_Assistant_Record; 
  147.       Child     : access Gtk_Widget_Record'Class); 
  148.    --  Removes a widget from the action area of a Gtk_Assistant. 
  149.  
  150.    procedure Set_Current_Page 
  151.      (Assistant : access Gtk_Assistant_Record; 
  152.       Page_Num  : Gint); 
  153.    --  Assistant: a Gtk_Assistant 
  154.    --  Page_Num: index of the page to switch to, starting from 0. 
  155.    --  If negative, the last page will be used. If greater 
  156.    --  than the number of pages in the Assistant, nothing 
  157.    --  will be done. 
  158.    -- 
  159.    --  Switches the page to Page_Num. Note that this will only be necessary 
  160.    --  in custom buttons, as the Assistant flow can be set with 
  161.    --  Set_Forward_Page_Func. 
  162.  
  163.    generic 
  164.       type Data_Type (<>) is private; 
  165.    package Generic_Assistant_Functions is 
  166.       type Page_Func is access function 
  167.         (Current_Page : Gint; 
  168.          User_Data    : Data_Type) 
  169.          return Gint; 
  170.       --  Spec for page forwarding function. 
  171.  
  172.       type Destroy_Notify is access procedure (User_Data : in out Data_Type); 
  173.       --  Destroy_Notify is called just prior to the destruction of 
  174.       --  User_Data. 
  175.  
  176.       procedure Set_Forward_Page_Func 
  177.         (Assistant : Gtk_Assistant; 
  178.          Func      : Page_Func; 
  179.          User_Data : Data_Type; 
  180.          Destroy   : Destroy_Notify := null); 
  181.       --  Sets the Assistant's page forwarding function to be Func.  This 
  182.       --  function will be used to determine what will be the next page when 
  183.       --  the user presses the forward button. Setting Func to null will make 
  184.       --  the assistant use the default forward function, which just goes 
  185.       --  to the next visible page. 
  186.    end Generic_Assistant_Functions; 
  187.  
  188.    procedure Set_Page_Complete 
  189.      (Assistant : access Gtk_Assistant_Record; 
  190.       Page      : access Gtk_Widget_Record'Class; 
  191.       Complete  : Boolean); 
  192.    --  Sets whether Page contents are complete. This will make 
  193.    --  Assistant update the buttons' state to be able to continue the task. 
  194.  
  195.    procedure Set_Page_Header_Image 
  196.      (Assistant : access Gtk_Assistant_Record; 
  197.       Page      : access Gtk_Widget_Record'Class; 
  198.       Pixbuf    : Gdk_Pixbuf); 
  199.    --  Sets a header image for Page. This image is displayed in the header 
  200.    --  area of the assistant when Page is the current page. 
  201.  
  202.    procedure Set_Page_Side_Image 
  203.      (Assistant : access Gtk_Assistant_Record; 
  204.       Page      : access Gtk_Widget_Record'Class; 
  205.       Pixbuf    : Gdk_Pixbuf); 
  206.    --  Sets a side image for Page. This image is displayed in the side 
  207.    --  area of the assistant when Page is the current page. 
  208.  
  209.    procedure Set_Page_Title 
  210.      (Assistant : access Gtk_Assistant_Record; 
  211.       Page      : access Gtk_Widget_Record'Class; 
  212.       Title     : String); 
  213.    --  Sets a title for Page. The title is displayed in the header 
  214.    --  area of the assistant when Page is the current page. 
  215.  
  216.    procedure Set_Page_Type 
  217.      (Assistant : access Gtk_Assistant_Record; 
  218.       Page      : access Gtk_Widget_Record'Class; 
  219.       Page_Type : Gtk_Assistant_Page_Type); 
  220.    --  Sets the page type for Page. The page type determines the page 
  221.    --  behavior in the Assistant. 
  222.  
  223.    procedure Update_Buttons_State (Assistant : access Gtk_Assistant_Record); 
  224.    --  Forces Assistant to recompute the state of the buttons. 
  225.    -- 
  226.    --  GTK+ automatically takes care of this in most situations, 
  227.    --  e.g. when the user goes to a different page, or when the 
  228.    --  visibility or completeness of a page changes. 
  229.    -- 
  230.    --  One situation where it can be necessary to call this 
  231.    --  function is when changing a value on the current page 
  232.    --  affects the future page flow of the assistant. 
  233.  
  234.    ---------------------- 
  235.    -- Child Properties -- 
  236.    ---------------------- 
  237.    --  The following properties can be set on children of this widget. See 
  238.    --  in particular Gtk.Containers.Child_Set_Property. 
  239.  
  240.    --  <child_properties> 
  241.    --  Name:  Complete_Property 
  242.    --  Type:  Boolean 
  243.    --  Descr: Whether all required fields on the page have been filled out 
  244.    -- 
  245.    --  Name:  Header_Image_Property 
  246.    --  Type:  Object 
  247.    --  Descr: Header image for the assistant page 
  248.    -- 
  249.    --  Name:  Page_Type_Property 
  250.    --  Type:  Enum 
  251.    --  Descr: The type of the assistant page 
  252.    -- 
  253.    --  Name:  Sidebar_Image_Property 
  254.    --  Type:  Object 
  255.    --  Descr: Sidebar image for the assistant page 
  256.    -- 
  257.    --  Name:  Title_Property 
  258.    --  Type:  String 
  259.    --  Descr: The title of the assistant page 
  260.    --  </child_properties> 
  261.  
  262.    Complete_Property      : constant Glib.Properties.Property_Boolean; 
  263.    Header_Image_Property  : constant Glib.Properties.Property_Object; 
  264.    Page_Type_Property     : constant Glib.Properties.Property_Enum; 
  265.    Sidebar_Image_Property : constant Glib.Properties.Property_Object; 
  266.    Title_Property         : constant Glib.Properties.Property_String; 
  267.  
  268.    ---------------------- 
  269.    -- Style Properties -- 
  270.    ---------------------- 
  271.    --  The following properties can be changed through the gtk theme and 
  272.    --  configuration files, and retrieved through Gtk.Widget.Style_Get_Property 
  273.  
  274.    --  <style_properties> 
  275.    --  Name:  Content_Padding_Property 
  276.    --  Type:  Int 
  277.    --  Descr: Number of pixels around the content pages. 
  278.    -- 
  279.    --  Name:  Header_Padding_Property 
  280.    --  Type:  Int 
  281.    --  Descr: Number of pixels around the header. 
  282.    --  </style_properties> 
  283.  
  284.    Content_Padding_Property : constant Glib.Properties.Property_Int; 
  285.    Header_Padding_Property  : constant Glib.Properties.Property_Int; 
  286.  
  287. private 
  288.  
  289.    type Gtk_Assistant_Record is 
  290.      new Gtk.Window.Gtk_Window_Record with null record; 
  291.  
  292.    pragma Import (C, Get_Type, "gtk_assistant_get_type"); 
  293.  
  294.    Complete_Property : constant Glib.Properties.Property_Boolean := 
  295.      Glib.Properties.Build ("complete"); 
  296.    Header_Image_Property : constant Glib.Properties.Property_Object := 
  297.      Glib.Properties.Build ("header-image"); 
  298.    Page_Type_Property : constant Glib.Properties.Property_Enum := 
  299.      Glib.Properties.Build ("page-type"); 
  300.    Sidebar_Image_Property : constant Glib.Properties.Property_Object := 
  301.      Glib.Properties.Build ("sidebar-image"); 
  302.    Title_Property : constant Glib.Properties.Property_String := 
  303.      Glib.Properties.Build ("title"); 
  304.  
  305.    Content_Padding_Property : constant Glib.Properties.Property_Int := 
  306.      Glib.Properties.Build ("content-padding"); 
  307.    Header_Padding_Property : constant Glib.Properties.Property_Int := 
  308.      Glib.Properties.Build ("header-padding"); 
  309.  
  310. end Gtk.Assistant;