1. ----------------------------------------------------------------------- 
  2. --               GtkAda - Ada95 binding for Gtk+/Gnome               -- 
  3. --                                                                   -- 
  4. --   Copyright (C) 1998-2000 E. Briot, J. Brobecker and A. Charlet   -- 
  5. --                Copyright (C) 2000-2009, AdaCore                   -- 
  6. --                                                                   -- 
  7. -- This library is free software; you can redistribute it and/or     -- 
  8. -- modify it under the terms of the GNU General Public               -- 
  9. -- License as published by the Free Software Foundation; either      -- 
  10. -- version 2 of the License, or (at your option) any later version.  -- 
  11. --                                                                   -- 
  12. -- This library is distributed in the hope that it will be useful,   -- 
  13. -- but WITHOUT ANY WARRANTY; without even the implied warranty of    -- 
  14. -- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU -- 
  15. -- General Public License for more details.                          -- 
  16. --                                                                   -- 
  17. -- You should have received a copy of the GNU General Public         -- 
  18. -- License along with this library; if not, write to the             -- 
  19. -- Free Software Foundation, Inc., 59 Temple Place - Suite 330,      -- 
  20. -- Boston, MA 02111-1307, USA.                                       -- 
  21. --                                                                   --
    22. -- -- -- -- -- -- -- -- -- -- -- -- 
  22. ----------------------------------------------------------------------- 
  23.  
  24. --  <description> 
  25. --  Gtk_Calendar is a widget that displays a calendar, one month at a time. 
  26. --  It can be created with Gtk_New. 
  27. -- 
  28. --  The month and year currently displayed can be altered with Select_Month. 
  29. --  The exact day can be selected from the displayed month using Select_Day. 
  30. -- 
  31. --  The way in which the calendar itself is displayed can be altered using 
  32. --  Display_Options. 
  33. -- 
  34. --  The selected date can be retrieved from a Gtk_Calendar using Get_Date. 
  35. -- 
  36. --  If performing many 'mark' operations, the calendar can be frozen to prevent 
  37. --  flicker, using Freeze, and 'thawed' again using Thaw. 
  38. --  </description> 
  39. --  <c_version>2.14</c_version> 
  40. --  <group>Selectors</group> 
  41. --  <testgtk>create_calendar.adb</testgtk> 
  42. --  <screenshot>gtk-calendar</screenshot> 
  43.  
  44. with Glib.Properties; 
  45. with Gtk.Widget; 
  46.  
  47. package Gtk.Calendar is 
  48.  
  49.    type Gtk_Calendar_Display_Options is mod 2 ** 8; 
  50.  
  51.    Show_Heading : constant Gtk_Calendar_Display_Options; 
  52.    --  Specify that the month and year should be displayed. 
  53.  
  54.    Show_Day_Names : constant Gtk_Calendar_Display_Options; 
  55.    --  Specify that three letter day descriptions should be present. 
  56.  
  57.    No_Month_Change : constant Gtk_Calendar_Display_Options; 
  58.    --  Prevent the user from switching months with the calendar. 
  59.  
  60.    Show_Week_Numbers : constant Gtk_Calendar_Display_Options; 
  61.    --  Display each week numbers of the current year, down the left side of 
  62.    --  the calendar. 
  63.  
  64.    Week_Start_Monday : constant Gtk_Calendar_Display_Options; 
  65.    --  Start the calendar week on Monday, instead of the default Sunday. 
  66.  
  67.    type Gtk_Calendar_Record is new Gtk.Widget.Gtk_Widget_Record with private; 
  68.    type Gtk_Calendar is access all Gtk_Calendar_Record'Class; 
  69.  
  70.    procedure Gtk_New (Widget : out Gtk_Calendar); 
  71.    --  Create a new Calendar that points to the current date. 
  72.  
  73.    procedure Initialize (Widget : access Gtk_Calendar_Record'Class); 
  74.    --  Internal initialization function. 
  75.    --  See the section "Creating your own widgets" in the documentation. 
  76.  
  77.    function Get_Type return Gtk.Gtk_Type; 
  78.    --  Return the internal value associated with a Gtk_Calendar. 
  79.  
  80.    function Select_Month 
  81.      (Calendar : access Gtk_Calendar_Record; 
  82.       Month    : Guint; 
  83.       Year     : Guint) return Boolean; 
  84.    --  Shift the calendar to a different month/year. 
  85.    --  Return True if sucessful. 
  86.  
  87.    procedure Select_Day 
  88.      (Calendar : access Gtk_Calendar_Record; 
  89.       Day      : Guint); 
  90.    --  Select a day from the current month. 
  91.    --  Only one day can be selected at a time. 
  92.  
  93.    function Mark_Day 
  94.      (Calendar : access Gtk_Calendar_Record; 
  95.       Day      : Guint) return Boolean; 
  96.    --  Set a specified Day as marked in the Calendar. 
  97.    --  This is shown visually as a painted box around the Day. 
  98.    --  Note that several days can be marked. 
  99.    --  Return True if successful. 
  100.  
  101.    function Unmark_Day 
  102.      (Calendar : access Gtk_Calendar_Record; 
  103.       Day      : Guint) return Boolean; 
  104.    --  Undo the marking of Day. 
  105.    --  Return True if sucessful. 
  106.  
  107.    procedure Clear_Marks (Calendar : access Gtk_Calendar_Record); 
  108.    --  Clear all the marks set by Mark_Day. 
  109.  
  110.    procedure Get_Date 
  111.      (Calendar : access Gtk_Calendar_Record; 
  112.       Year     : out Guint; 
  113.       Month    : out Guint; 
  114.       Day      : out Guint); 
  115.    --  Return the date currently selected. 
  116.  
  117.    procedure Set_Display_Options 
  118.      (Calendar : access Gtk_Calendar_Record; 
  119.       Flags    : Gtk_Calendar_Display_Options); 
  120.    function Get_Display_Options 
  121.      (Calendar : access Gtk_Calendar_Record) 
  122.       return Gtk_Calendar_Display_Options; 
  123.    --  Sets display options (whether to display the heading and the month 
  124.    --  headings). 
  125.  
  126.    function Get_Detail_Height_Rows 
  127.      (Calendar : access Gtk_Calendar_Record) 
  128.       return Gint; 
  129.    procedure Set_Detail_Height_Rows 
  130.      (Calendar : access Gtk_Calendar_Record; 
  131.       Rows     : Gint); 
  132.    --  Queries the height of detail cells, in rows. 
  133.    --  Since: 2.14 
  134.  
  135.    function Get_Detail_Width_Chars 
  136.      (Calendar : access Gtk_Calendar_Record) 
  137.       return Gint; 
  138.    procedure Set_Detail_Width_Chars 
  139.      (Calendar : access Gtk_Calendar_Record; 
  140.       Chars    : Gint); 
  141.    --  Queries the width of detail cells, in characters. 
  142.    --  Since: 2.14 
  143.  
  144.    ------------- 
  145.    -- Details -- 
  146.    ------------- 
  147.  
  148.    type Gtk_Calendar_Detail_Func is access function 
  149.       (Calendar  : access Gtk_Calendar_Record'Class; 
  150.        Year      : Guint; 
  151.        Month     : Guint; 
  152.        Day       : Guint; 
  153.        User_Data : System.Address) return String; 
  154.    --  Return the details for the given day, or the empty string when there 
  155.    --  are no details. 
  156.  
  157.    procedure Set_Detail_Func 
  158.      (Calendar : access Gtk_Calendar_Record; 
  159.       Func     : Gtk_Calendar_Detail_Func; 
  160.       Data     : System.Address; 
  161.       Destroy  : G_Destroy_Notify_Address); 
  162.    --  Installs a function which provides Pango markup with detail information 
  163.    --  for each day. Examples for such details are holidays or appointments. 
  164.    --  That information is shown below each day when the property 
  165.    --  "show-details" is set. 
  166.    --  A tooltip containing with full detail information is provided, if the 
  167.    --  entire text should not fit into the details area, or if show-details 
  168.    --  is not set. 
  169.    -- 
  170.    --  The size of the details area can be restricted by setting the 
  171.    --  "detail-width-chars" and "detail-height-rows" properties. 
  172.    -- 
  173.    --  Since: 2.14 
  174.  
  175.    ----------------- 
  176.    -- Obsolescent -- 
  177.    ----------------- 
  178.    --  All subprograms below are now obsolescent in gtk+. They might be removed 
  179.    --  from future versions of gtk+ (and therefore GtkAda). 
  180.    --  To find out whether your code uses any of these, we recommend compiling 
  181.    --  with the -gnatwj switch 
  182.    --  <doc_ignore> 
  183.  
  184.    procedure Display_Options 
  185.      (Calendar : access Gtk_Calendar_Record; 
  186.       Flags    : Gtk_Calendar_Display_Options); 
  187.    pragma Obsolescent;  --  Display_Options 
  188.    --  Change the display options. 
  189.    --  See individual Display_Option flags for more details. 
  190.  
  191.    procedure Freeze (Calendar : access Gtk_Calendar_Record); 
  192.    pragma Obsolescent;  --  Freeze 
  193.    --  Lock the display of the calendar until it is thawed. 
  194.  
  195.    procedure Thaw (Calendar : access Gtk_Calendar_Record); 
  196.    pragma Obsolescent;  --  Thaw 
  197.    --  Defrost a calendar. 
  198.    --  All the changes made since the last Freeze are displayed. 
  199.  
  200.    --  </doc_ignore> 
  201.  
  202.    ---------------- 
  203.    -- Properties -- 
  204.    ---------------- 
  205.  
  206.    --  <properties> 
  207.    --  The following properties are defined for this widget. See 
  208.    --  Glib.Properties for more information on properties. 
  209.    -- 
  210.    --  Name:  Day_Property 
  211.    --  Type:  Int 
  212.    --  Descr: The selected day (as a number between 1 and 31, or 0 to unselect 
  213.    --         the currently selected day) 
  214.    -- 
  215.    --  Name:  Detail_Height_Rows_Property 
  216.    --  Type:  Int 
  217.    --  Descr: Details height in rows 
  218.    -- 
  219.    --  Name:  Detail_Width_Chars_Property 
  220.    --  Type:  Int 
  221.    --  Descr: Details width in characters 
  222.    -- 
  223.    --  Name:  Month_Property 
  224.    --  Type:  Int 
  225.    --  Descr: The selected month (as a number between 0 and 11) 
  226.    -- 
  227.    --  Name:  No_Month_Change_Property 
  228.    --  Type:  Boolean 
  229.    --  Descr: If TRUE, the selected month cannot be changed 
  230.    -- 
  231.    --  Name:  Show_Day_Names_Property 
  232.    --  Type:  Boolean 
  233.    --  Descr: If TRUE, day names are displayed 
  234.    -- 
  235.    --  Name:  Show_Details_Property 
  236.    --  Type:  Boolean 
  237.    --  Descr: If TRUE, details are shown 
  238.    -- 
  239.    --  Name:  Show_Heading_Property 
  240.    --  Type:  Boolean 
  241.    --  Descr: If TRUE, a heading is displayed 
  242.    -- 
  243.    --  Name:  Show_Week_Numbers_Property 
  244.    --  Type:  Boolean 
  245.    --  Descr: If TRUE, week numbers are displayed 
  246.    -- 
  247.    --  Name:  Year_Property 
  248.    --  Type:  Int 
  249.    --  Descr: The selected year 
  250.    -- 
  251.    --  </properties> 
  252.  
  253.    Day_Property               : constant Glib.Properties.Property_Int; 
  254.    Detail_Height_Rows_Property : constant Glib.Properties.Property_Int; 
  255.    Detail_Width_Chars_Property : constant Glib.Properties.Property_Int; 
  256.    Month_Property             : constant Glib.Properties.Property_Int; 
  257.    No_Month_Change_Property   : constant Glib.Properties.Property_Boolean; 
  258.    Show_Day_Names_Property    : constant Glib.Properties.Property_Boolean; 
  259.    Show_Details_Property      : constant Glib.Properties.Property_Boolean; 
  260.    Show_Heading_Property      : constant Glib.Properties.Property_Boolean; 
  261.    Show_Week_Numbers_Property : constant Glib.Properties.Property_Boolean; 
  262.    Year_Property              : constant Glib.Properties.Property_Int; 
  263.  
  264.    ------------- 
  265.    -- Signals -- 
  266.    ------------- 
  267.  
  268.    --  <signals> 
  269.    --  The following new signals are defined for this widget: 
  270.    --  - "month_changed" 
  271.    --    procedure Handler (Calendar : access Gtk_Calendar_Record'Class); 
  272.    --    Emitted when the user clicks a button to change the selected month on 
  273.    --    calendar. 
  274.    -- 
  275.    --  - "day_selected" 
  276.    --    procedure Handler (Calendar : access Gtk_Calendar_Record'Class); 
  277.    --    Emitted when the user selects a day on a calendar. 
  278.    -- 
  279.    --  - "day_selected_double_click" 
  280.    --    procedure Handler (Calendar : access Gtk_Calendar_Record'Class); 
  281.    --    Emitted when the user double clicks a day on a calendar. 
  282.    -- 
  283.    --  - "prev_month" 
  284.    --    procedure Handler (Calendar : access Gtk_Calendar_Record'Class); 
  285.    --    Emitted when the user selects the previous month on a calendar. 
  286.    -- 
  287.    --  - "next_month" 
  288.    --    procedure Handler (Calendar : access Gtk_Calendar_Record'Class); 
  289.    --    Emitted when the user selects the next month on a calendar. 
  290.    -- 
  291.    --  - "prev_year" 
  292.    --    procedure Handler (Calendar : access Gtk_Calendar_Record'Class); 
  293.    --    Emitted when the user selects the previous year on a calendar. 
  294.    -- 
  295.    --  - "next_year" 
  296.    --    procedure Handler (Calendar : access Gtk_Calendar_Record'Class); 
  297.    --    Emitted when the user selects the next year on a calendar. 
  298.    -- 
  299.    --  </signals> 
  300.  
  301.    Signal_Day_Selected              : constant Glib.Signal_Name := 
  302.                                         "day_selected"; 
  303.    Signal_Day_Selected_Double_Click : constant Glib.Signal_Name := 
  304.                                         "day_selected_double_click"; 
  305.    Signal_Month_Changed             : constant Glib.Signal_Name := 
  306.                                         "month_changed"; 
  307.    Signal_Next_Month                : constant Glib.Signal_Name := 
  308.                                         "next_month"; 
  309.    Signal_Next_Year                 : constant Glib.Signal_Name := 
  310.                                         "next_year"; 
  311.    Signal_Prev_Month                : constant Glib.Signal_Name := 
  312.                                         "prev_month"; 
  313.    Signal_Prev_Year                 : constant Glib.Signal_Name := 
  314.                                         "prev_year"; 
  315.  
  316. private 
  317.    type Gtk_Calendar_Record is new Gtk.Widget.Gtk_Widget_Record 
  318.       with null record; 
  319.  
  320.    Day_Property : constant Glib.Properties.Property_Int := 
  321.      Glib.Properties.Build ("day"); 
  322.    Detail_Height_Rows_Property : constant Glib.Properties.Property_Int := 
  323.      Glib.Properties.Build ("detail-height-rows"); 
  324.    Detail_Width_Chars_Property : constant Glib.Properties.Property_Int := 
  325.      Glib.Properties.Build ("detail-width-chars"); 
  326.    Month_Property : constant Glib.Properties.Property_Int := 
  327.      Glib.Properties.Build ("month"); 
  328.    No_Month_Change_Property : constant Glib.Properties.Property_Boolean := 
  329.      Glib.Properties.Build ("no-month-change"); 
  330.    Show_Day_Names_Property : constant Glib.Properties.Property_Boolean := 
  331.      Glib.Properties.Build ("show-day-names"); 
  332.    Show_Details_Property : constant Glib.Properties.Property_Boolean := 
  333.      Glib.Properties.Build ("show-details"); 
  334.    Show_Heading_Property : constant Glib.Properties.Property_Boolean := 
  335.      Glib.Properties.Build ("show-heading"); 
  336.    Show_Week_Numbers_Property : constant Glib.Properties.Property_Boolean := 
  337.      Glib.Properties.Build ("show-week-numbers"); 
  338.    Year_Property : constant Glib.Properties.Property_Int := 
  339.      Glib.Properties.Build ("year"); 
  340.  
  341.    pragma Import (C, Get_Type, "gtk_calendar_get_type"); 
  342.  
  343.    Show_Heading      : constant Gtk_Calendar_Display_Options := 2 ** 0; 
  344.    Show_Day_Names    : constant Gtk_Calendar_Display_Options := 2 ** 1; 
  345.    No_Month_Change   : constant Gtk_Calendar_Display_Options := 2 ** 2; 
  346.    Show_Week_Numbers : constant Gtk_Calendar_Display_Options := 2 ** 3; 
  347.    Week_Start_Monday : constant Gtk_Calendar_Display_Options := 2 ** 4; 
  348.  
  349. end Gtk.Calendar;