GtkCalendar              package:RGtk2              R Documentation

_G_t_k_C_a_l_e_n_d_a_r

_D_e_s_c_r_i_p_t_i_o_n:

     Displays a calendar and allows the user to select a date

_M_e_t_h_o_d_s _a_n_d _F_u_n_c_t_i_o_n_s:

     'gtkCalendarNew(show = TRUE)'
      'gtkCalendarSelectMonth(object, month, year)'
      'gtkCalendarSelectDay(object, day)'
      'gtkCalendarMarkDay(object, day)'
      'gtkCalendarUnmarkDay(object, day)'
      'gtkCalendarClearMarks(object)'
      'gtkCalendarGetDisplayOptions(object)'
      'gtkCalendarSetDisplayOptions(object, flags)'
      'gtkCalendarDisplayOptions(object, flags)'
      'gtkCalendarGetDate(object)'
      'gtkCalendarFreeze(object)'
      'gtkCalendarThaw(object)'
      'gtkCalendar(show = TRUE)'

_H_i_e_r_a_r_c_h_y:

     GObject
        +----GInitiallyUnowned
              +----GtkObject
                    +----GtkWidget
                          +----GtkCalendar 

_I_n_t_e_r_f_a_c_e_s:

     GtkCalendar implements AtkImplementorIface and  'GtkBuildable'.

_D_e_t_a_i_l_e_d _D_e_s_c_r_i_p_t_i_o_n:

     'GtkCalendar' is a widget that displays a calendar, one month at a
     time.  It can be created with 'gtkCalendarNew'.

     The month and year currently displayed can be altered with 
     'gtkCalendarSelectMonth'. The exact day can be selected from the
     displayed  month using 'gtkCalendarSelectDay'.

     To place a visual marker on a particular day, use
     'gtkCalendarMarkDay'  and to remove the marker,
     'gtkCalendarUnmarkDay'. Alternative, all marks can be cleared with
     'gtkCalendarClearMarks'.

     The way in which the calendar itself is displayed can be altered
     using 'gtkCalendarSetDisplayOptions'.

     The selected date can be retrieved from a 'GtkCalendar' using
     'gtkCalendarGetDate'.

_S_t_r_u_c_t_u_r_e_s:


     '_G_t_k_C_a_l_e_n_d_a_r' 'num_marked_dates' is an integer containing the
          number of days that have a mark over them. 'marked_date' is a
          list containing the day numbers that currently have a mark
          over them. 'month', 'year', and  'selected_day' contain the
          currently visible month, year, and selected day respectively.

          All of these fields should be considered read only, and
          everything in this struct should only be modified using the
          functions provided below.


_C_o_n_v_e_n_i_e_n_t _C_o_n_s_t_r_u_c_t_i_o_n:

     'gtkCalendar' is the equivalent of 'gtkCalendarNew'.

_E_n_u_m_s _a_n_d _F_l_a_g_s:


     '_G_t_k_C_a_l_e_n_d_a_r_D_i_s_p_l_a_y_O_p_t_i_o_n_s' These options can be used to influence
          the display and behaviour of a 'GtkCalendar'.

          '_s_h_o_w-_h_e_a_d_i_n_g' Specifies that the month and year should be
               displayed.

          '_s_h_o_w-_d_a_y-_n_a_m_e_s' Specifies that three letter day descriptions
               should be present.

          '_n_o-_m_o_n_t_h-_c_h_a_n_g_e' Prevents the user from switching months
               with the calendar.

          '_s_h_o_w-_w_e_e_k-_n_u_m_b_e_r_s' Displays each week numbers of the current
               year, down the left side  of the calendar.

          '_w_e_e_k-_s_t_a_r_t-_m_o_n_d_a_y' Since GTK+ 2.4, this option is deprecated
               and ignored by GTK+.  The information on which day the
               calendar week starts is derived from the locale.


_S_i_g_n_a_l_s:


     '_d_a_y-_s_e_l_e_c_t_e_d(_c_a_l_e_n_d_a_r, _u_s_e_r._d_a_t_a)' Emitted when the user selects
          a day.

          '_c_a_l_e_n_d_a_r' ['GtkCalendar'] the object which received the
               signal.

          '_u_s_e_r._d_a_t_a' [R object] user data set when the signal handler
               was connected.


     '_d_a_y-_s_e_l_e_c_t_e_d-_d_o_u_b_l_e-_c_l_i_c_k(_c_a_l_e_n_d_a_r, _u_s_e_r._d_a_t_a)' _undocumented _

          '_c_a_l_e_n_d_a_r' ['GtkCalendar'] the object which received the
               signal.

          '_u_s_e_r._d_a_t_a' [R object] user data set when the signal handler
               was connected.


     '_m_o_n_t_h-_c_h_a_n_g_e_d(_c_a_l_e_n_d_a_r, _u_s_e_r._d_a_t_a)' Emitted when the user clicks
          a button to change the selected month on a calendar.

          '_c_a_l_e_n_d_a_r' ['GtkCalendar'] the object which received the
               signal.

          '_u_s_e_r._d_a_t_a' [R object] user data set when the signal handler
               was connected.


     '_n_e_x_t-_m_o_n_t_h(_c_a_l_e_n_d_a_r, _u_s_e_r._d_a_t_a)' _undocumented _

          '_c_a_l_e_n_d_a_r' ['GtkCalendar'] the object which received the
               signal.

          '_u_s_e_r._d_a_t_a' [R object] user data set when the signal handler
               was connected.


     '_n_e_x_t-_y_e_a_r(_c_a_l_e_n_d_a_r, _u_s_e_r._d_a_t_a)' _undocumented _

          '_c_a_l_e_n_d_a_r' ['GtkCalendar'] the object which received the
               signal.

          '_u_s_e_r._d_a_t_a' [R object] user data set when the signal handler
               was connected.


     '_p_r_e_v-_m_o_n_t_h(_c_a_l_e_n_d_a_r, _u_s_e_r._d_a_t_a)' _undocumented _

          '_c_a_l_e_n_d_a_r' ['GtkCalendar'] the object which received the
               signal.

          '_u_s_e_r._d_a_t_a' [R object] user data set when the signal handler
               was connected.


     '_p_r_e_v-_y_e_a_r(_c_a_l_e_n_d_a_r, _u_s_e_r._d_a_t_a)' _undocumented _

          '_c_a_l_e_n_d_a_r' ['GtkCalendar'] the object which received the
               signal.

          '_u_s_e_r._d_a_t_a' [R object] user data set when the signal handler
               was connected.


_P_r_o_p_e_r_t_i_e_s:


     '_d_a_y' [_i_n_t_e_g_e_r : _R_e_a_d / _W_r_i_t_e] The selected day (as a number
          between 1 and 31, or 0 to unselect the currently selected
          day).  Allowed values: [0,31]  Default value: 0


     '_m_o_n_t_h' [_i_n_t_e_g_e_r : _R_e_a_d / _W_r_i_t_e] The selected month (as a number
          between 0 and 11).  Allowed values: [0,11]  Default value: 0


     '_n_o-_m_o_n_t_h-_c_h_a_n_g_e' [_l_o_g_i_c_a_l : _R_e_a_d / _W_r_i_t_e] Determines whether the
          selected month can be changed.  

          Default value: FALSE  Since  2.4


     '_s_h_o_w-_d_a_y-_n_a_m_e_s' [_l_o_g_i_c_a_l : _R_e_a_d / _W_r_i_t_e] Determines whether day
          names are displayed.  

          Default value: TRUE  Since  2.4


     '_s_h_o_w-_h_e_a_d_i_n_g' [_l_o_g_i_c_a_l : _R_e_a_d / _W_r_i_t_e] Determines whether a
          heading is displayed.  

          Default value: TRUE  Since  2.4


     '_s_h_o_w-_w_e_e_k-_n_u_m_b_e_r_s' [_l_o_g_i_c_a_l : _R_e_a_d / _W_r_i_t_e] Determines whether
          week numbers are displayed.  

          Default value: FALSE  Since  2.4


     '_y_e_a_r' [_i_n_t_e_g_e_r : _R_e_a_d / _W_r_i_t_e] The selected year.  Allowed
          values: >= 0  Default value: 0


_A_u_t_h_o_r(_s):

     Derived by RGtkGen from GTK+ documentation

_R_e_f_e_r_e_n_c_e_s:

     <URL: http://developer.gnome.org/doc/API/2.0/gtk/GtkCalendar.html>

