Reference Manual
Inti Logo
Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Namespace Members | Compound Members | File Members

Inti::Gtk::Calendar Class Reference

A GtkCalendar C++ wrapper class. More...

#include <inti/gtk/calendar.h>

Inheritance diagram for Inti::Gtk::Calendar:

Inti::Gtk::Widget Inti::Gtk::Object Inti::Atk::Implementor Inti::G::Object Inti::G::TypeInterface Inti::G::TypeInstance Inti::MemoryHandler Inti::G::TypeInstance Inti::ReferencedBase Inti::ReferencedBase List of all members.

Public Member Functions

Constructors
Accessors
Methods
Signal Proxies

Protected Member Functions

Constructors
Signal Handlers

Detailed Description

A GtkCalendar C++ wrapper class.

Calendar is a widget that displays a calendar, one month at a time. The month and year currently displayed can be altered with select_month(). The exact day can be selected from the displayed month using select_day(). To place a visual marker on a particular day, use mark_day() and to remove the marker, unmark_day(). Alternative, all marks can be cleared with clear_marks(). The way in which the calendar itself is displayed can be altered using display_options(). The selected date can be retrieved from a Calendar using get_date(). If performing many 'mark' operations, the calendar can be frozen to prevent flicker, with freeze(), and 'thawed' again using thaw().


Constructor & Destructor Documentation

Inti::Gtk::Calendar::Calendar GtkCalendar *  calendar,
bool  reference = false
[explicit, protected]
 

Construct a new Calendar from an existing GtkCalendar.

Parameters:
calendar A pointer to a GtkCalendar.
reference Set false if the initial reference count is floating, set true if it's not.

The calendar can be a newly created GtkCalendar or an existing GtkCalendar. (see G::Object::Object).

Inti::Gtk::Calendar::Calendar CalendarDisplayOptionsField  flags  )  [explicit]
 

Construct a new calendar, with the specified display options and current date selected.

Parameters:
flags One or more values from the CalendarDisplayOptions enum OR'd together.

This is a convenience constructor that lets you specifiy the display options.


Member Function Documentation

void Inti::Gtk::Calendar::display_options CalendarDisplayOptionsField  flags  ) 
 

Sets the display options (whether to display the year and month headings).

Parameters:
flags One or more values from the CalendarDisplayOptions enum OR'd together.

void Inti::Gtk::Calendar::get_date int *  year,
int *  month,
int *  day
const
 

Obtains the selected date from a Calendar.

Parameters:
year Location to store the year number.
month Location to store the month number.
day Location to store the day number.

bool Inti::Gtk::Calendar::mark_day int  day  ) 
 

Places a visual marker on a particular day.

Parameters:
day The day number to mark between 1 and 31.
Returns:
Always true.

void Inti::Gtk::Calendar::select_day int  day  ) 
 

Selects a day from the current month.

Parameters:
day The day number between 1 and 31, or 0 to unselect the currently selected day.

bool Inti::Gtk::Calendar::select_month int  month,
int  year
 

Shifts the calendar to a different month.

Parameters:
month A month number between 0 and 11.
year The year the month is in.
Returns:
Always true.

bool Inti::Gtk::Calendar::unmark_day int  day  ) 
 

Removes the visual marker from a particular day.

Parameters:
day The day number to unmark between 1 and 31.
Returns:
true.


The documentation for this class was generated from the following file: Main Page - Footer


Generated on Sun Sep 14 20:08:13 2003 for Inti by doxygen 1.3.2 written by Dimitri van Heesch, © 1997-2002