[ruby-gnome2-doc-cvs] [Hiki] update - Gtk::Calendar

Back to archive index

ruby-****@lists***** ruby-****@lists*****
2003年 4月 1日 (火) 11:36:40 JST


-------------------------
REMOTE_ADDR = 61.204.181.66
REMOTE_HOST = 
-------------------------
= class Gtk::Calendar
Gtk::Calendar is a widget that displays a calendar, one month at a time. It can be created with Gtk::Calendar.new. 

The month and year currently displayed can be altered with Gtk::Calendar#select_month. The exact day can be selected from the displayed month using Gtk::Calendar#select_day. 

To place a visual marker on a particular day, use Gtk::Calendar#mark_day and to remove the marker, Gtk::Calendar#unmark_day. Alternative, all marks can be cleared with Gtk::Calendar#clear_marks. 

The way in which the calendar itself is displayed can be altered using Gtk::Calendar#display_options. 

The selected date can be retrieved from a Gtk::Calendar using Gtk::Calendar#date. 

If performing many 'mark' operations, the calendar can be frozen to prevent flicker, using Gtk::Calendar#freeze, and 'thawed' again using Gtk::Calendar#thaw. 

== super class
* Gtk::Widget

== class methods
--- Gtk::Calendar.new
    Creates a new calendar, with the current date being selected. 
    * Returns: a Gtk::Calendar.  

== public instance methods
--- select_month(month, year)
    Shifts the calendar to a different month. 
    * month: a month number between 1 and 12.  
    * year: the year the month is in.  
    * Returns: self

--- select_day(day)
    Selects a day from the current month. 
    * day: the day number between 1 and 31, or 0 to unselect the currently selected day.  
    * Returns: self

--- mark_day(day)
    Places a visual marker on a particular day. 
    * day: the day number to mark between 1 and 31.  
    * Returns: self

--- unmark_day(day)
    Removes the visual marker from a particular day. 
    * day: the day number to unmark between 1 and 31.  
    * Returns: self

--- clear_marks
    Remove all visual markers. 
    * Returns: self

--- display_options(flags)
    Sets display options (whether to display the heading and the month headings). 
    * flags: the display options(((<GtkCalendarDisplayOptions|Gtk::Calendar#GtkCalendarDisplayOptions>))) to set.  

--- date
    Obtains the selected date from a GtkCalendar. 
    * Returns: [year, month, day]

--- freeze
    Locks the display of the calendar until it is thawed with Gtk::Calendar#thaw. 
    * Returns: self

--- thaw
    Defrosts a calendar; all the changes made since the last Gtk::Calendar#freeze are displayed. 

== constants
=== GtkCalendarDisplayOptions
--- NO_MONTH_CHANGE
    Prevents the user from switching months with the calendar.
--- SHOW_DAY_NAMES
    Specifies that three letter day descriptions should be present.
--- SHOW_HEADING
    Specifies that the month and year should be displayed.
--- SHOW_WEEK_NUMBERS
    Displays each week numbers of the current year, down the left side of the calendar.
--- WEEK_START_MONDAY
    Starts the calendar week on Monday, instead of the default Sunday.

== signals
--- day-selected: self
     * self: Gtk::Calendar

--- day-selected-double-click: self
     * self: Gtk::Calendar

--- month-changed: self
     * self: Gtk::Calendar

--- next-month: self
     * self: Gtk::Calendar

--- next-year: self
     * self: Gtk::Calendar

--- prev-month: self
     * self: Gtk::Calendar

--- prev-year: self
     * self: Gtk::Calendar

- ((<Masao>))

-------------------------
= class Gtk::Calendar
Gtk::Calendar is a widget that displays a calendar, one month at a time. It can be created with Gtk::Calendar.new. 

The month and year currently displayed can be altered with Gtk::Calendar#select_month. The exact day can be selected from the displayed month using Gtk::Calendar#select_day. 

To place a visual marker on a particular day, use Gtk::Calendar#mark_day and to remove the marker, Gtk::Calendar#unmark_day. Alternative, all marks can be cleared with Gtk::Calendar#clear_marks. 

The way in which the calendar itself is displayed can be altered using Gtk::Calendar#display_options. 

The selected date can be retrieved from a Gtk::Calendar using Gtk::Calendar#date. 

If performing many 'mark' operations, the calendar can be frozen to prevent flicker, using Gtk::Calendar#freeze, and 'thawed' again using Gtk::Calendar#thaw. 

== super class
* Gtk::Widget

== class methods
--- Gtk::Calendar.new
    Creates a new calendar, with the current date being selected. 
    * Returns: a Gtk::Calendar.  

== public instance methods
--- select_month(month, year)
    Shifts the calendar to a different month. 
    * month: a month number between 1 and 12.  
    * year: the year the month is in.  
    * Returns: self

--- select_day(day)
    Selects a day from the current month. 
    * day: the day number between 1 and 31, or 0 to unselect the currently selected day.  
    * Returns: self

--- mark_day(day)
    Places a visual marker on a particular day. 
    * day: the day number to mark between 1 and 31.  
    * Returns: self

--- unmark_day(day)
    Removes the visual marker from a particular day. 
    * day: the day number to unmark between 1 and 31.  
    * Returns: self

--- clear_marks
    Remove all visual markers. 
    * Returns: self

--- display_options(flags)
    Sets display options (whether to display the heading and the month headings). 
    * flags: the display options(((<GtkCalendarDisplayOptions|Gtk::Calendar#GtkCalendarDisplayOptions>))) to set.  

--- date
    Obtains the selected date from a Gtk::Calendar. 
    * Returns: [year, month, day]

--- freeze
    Locks the display of the calendar until it is thawed with Gtk::Calendar#thaw. 
    * Returns: self

--- thaw
    Defrosts a calendar; all the changes made since the last Gtk::Calendar#freeze are displayed. 

== constants
=== GtkCalendarDisplayOptions
--- NO_MONTH_CHANGE
    Prevents the user from switching months with the calendar.
--- SHOW_DAY_NAMES
    Specifies that three letter day descriptions should be present.
--- SHOW_HEADING
    Specifies that the month and year should be displayed.
--- SHOW_WEEK_NUMBERS
    Displays each week numbers of the current year, down the left side of the calendar.
--- WEEK_START_MONDAY
    Starts the calendar week on Monday, instead of the default Sunday.

== signals
--- day-selected: self
     * self: Gtk::Calendar

--- day-selected-double-click: self
     * self: Gtk::Calendar

--- month-changed: self
     * self: Gtk::Calendar

--- next-month: self
     * self: Gtk::Calendar

--- next-year: self
     * self: Gtk::Calendar

--- prev-month: self
     * self: Gtk::Calendar

--- prev-year: self
     * self: Gtk::Calendar

- ((<Masao>))




ruby-gnome2-cvs メーリングリストの案内
Back to archive index