|
Server : Apache/2.2.17 (Unix) mod_ssl/2.2.17 OpenSSL/0.9.8e-fips-rhel5 DAV/2 PHP/5.2.17 System : Linux localhost 2.6.18-419.el5 #1 SMP Fri Feb 24 22:47:42 UTC 2017 x86_64 User : nobody ( 99) PHP Version : 5.2.17 Disable Function : NONE Directory : /usr/share/gtk-doc/html/gtk/ |
Upload File : |
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>GtkCalendar</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
<link rel="start" href="index.html" title="GTK+ Reference Manual">
<link rel="up" href="MiscObjects.html" title="Miscellaneous">
<link rel="prev" href="GtkArrow.html" title="GtkArrow">
<link rel="next" href="GtkDrawingArea.html" title="GtkDrawingArea">
<meta name="generator" content="GTK-Doc V1.6 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="part" href="gtk.html" title="Part I. GTK+ Overview">
<link rel="part" href="gtkbase.html" title="Part II. GTK+ Core Reference">
<link rel="part" href="gtkobjects.html" title="Part III. GTK+ Widgets and Objects">
<link rel="chapter" href="ch01.html" title="Object Hierarchy">
<link rel="chapter" href="ch02.html" title="Widget Gallery">
<link rel="chapter" href="WindowWidgets.html" title="Windows">
<link rel="chapter" href="DisplayWidgets.html" title="Display Widgets">
<link rel="chapter" href="ButtonWidgets.html" title="Buttons and Toggles">
<link rel="chapter" href="NumericEntry.html" title="Numeric/Text Data Entry">
<link rel="chapter" href="TextWidgetObjects.html" title="Multiline Text Editor">
<link rel="chapter" href="TreeWidgetObjects.html" title="Tree, List and Icon Grid Widgets">
<link rel="chapter" href="MenusAndCombos.html" title="Menus, Combo Box, Toolbar">
<link rel="chapter" href="Actions.html" title="Action-based menus and toolbars">
<link rel="chapter" href="SelectorWidgets.html" title="Selectors (File/Font/Color/Input Devices)">
<link rel="chapter" href="LayoutContainers.html" title="Layout Containers">
<link rel="chapter" href="Ornaments.html" title="Ornaments">
<link rel="chapter" href="ScrollingWidgets.html" title="Scrolling">
<link rel="chapter" href="Printing.html" title="Printing">
<link rel="chapter" href="MiscObjects.html" title="Miscellaneous">
<link rel="chapter" href="AbstractObjects.html" title="Abstract Base Classes">
<link rel="chapter" href="PlugSocket.html" title="Cross-process Embedding">
<link rel="chapter" href="SpecialObjects.html" title="Special-purpose features">
<link rel="chapter" href="RecentDocuments.html" title="Recently Used Documents">
<link rel="chapter" href="DeprecatedObjects.html" title="Deprecated">
<link rel="part" href="migrating.html" title="Part IV. Migrating from Previous Versions of GTK+">
<link rel="chapter" href="gtk-migrating-checklist.html" title="Migration Checklist">
<link rel="chapter" href="gtk-migrating-GtkFileChooser.html" title="Migrating from GtkFileSelection to GtkFileChooser">
<link rel="chapter" href="gtk-migrating-GtkAction.html" title="Migrating from old menu and toolbar systems to GtkAction">
<link rel="chapter" href="gtk-migrating-GtkComboBox.html" title="Migrating from GtkOptionMenu and GtkCombo to GtkComboBox and
GtkComboBoxEntry">
<link rel="chapter" href="gtk-migrating-GtkIconView.html" title="Migrating from GnomeIconList to GtkIconView">
<link rel="chapter" href="gtk-migrating-GtkAboutDialog.html" title="Migrating from GnomeAbout to GtkAboutDialog">
<link rel="chapter" href="gtk-migrating-GtkColorButton.html" title="Migrating from GnomeColorPicker to GtkColorButton">
<link rel="chapter" href="gtk-migrating-GtkAssistant.html" title="Migrating from GnomeDruid to GtkAssistant">
<link rel="chapter" href="gtk-migrating-GtkRecentChooser.html" title="Migrating from EggRecent to GtkRecentChooser">
<link rel="chapter" href="gtk-migrating-GtkLinkButton.html" title="Migrating from GnomeHRef to GtkLinkButton">
<link rel="part" href="pt05.html" title="Part V. GTK+ Tools">
<link rel="glossary" href="glossary.html" title="Glossary">
<link rel="index" href="ix01.html" title="Index">
<link rel="index" href="ix02.html" title="Index of deprecated symbols">
<link rel="index" href="ix03.html" title="Index of new symbols in 2.2">
<link rel="index" href="ix04.html" title="Index of new symbols in 2.4">
<link rel="index" href="ix05.html" title="Index of new symbols in 2.6">
<link rel="index" href="ix06.html" title="Index of new symbols in 2.8">
<link rel="index" href="ix07.html" title="Index of new symbols in 2.10">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="GtkArrow.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="MiscObjects.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GTK+ Reference Manual</th>
<td><a accesskey="n" href="GtkDrawingArea.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id3596241" class="shortcut">Top</a>
 | 
<a href="#id3597069" class="shortcut">Description</a>
 | 
<a href="#id3596619" class="shortcut">Object Hierarchy</a>
 | 
<a href="#id3596666" class="shortcut">Implemented Interfaces</a>
 | 
<a href="#id3596688" class="shortcut">Properties</a>
 | 
<a href="#id3596825" class="shortcut">Signals</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="GtkCalendar"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id3596241"></a><span class="refentrytitle">GtkCalendar</span>
</h2>
<p>GtkCalendar — Displays a calendar and allows the user to select a date</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<pre class="synopsis">
#include <gtk/gtk.h>
<a href="GtkCalendar.html#GtkCalendar-struct">GtkCalendar</a>;
enum <a href="GtkCalendar.html#GtkCalendarDisplayOptions">GtkCalendarDisplayOptions</a>;
<a href="GtkWidget.html" title="GtkWidget">GtkWidget</a>* <a href="GtkCalendar.html#gtk-calendar-new">gtk_calendar_new</a> (void);
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a href="GtkCalendar.html#gtk-calendar-select-month">gtk_calendar_select_month</a> (<a href="GtkCalendar.html" title="GtkCalendar">GtkCalendar</a> *calendar,
<a
href="../glib/glib-Basic-Types.html#guint"
>guint</a> month,
<a
href="../glib/glib-Basic-Types.html#guint"
>guint</a> year);
void <a href="GtkCalendar.html#gtk-calendar-select-day">gtk_calendar_select_day</a> (<a href="GtkCalendar.html" title="GtkCalendar">GtkCalendar</a> *calendar,
<a
href="../glib/glib-Basic-Types.html#guint"
>guint</a> day);
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a href="GtkCalendar.html#gtk-calendar-mark-day">gtk_calendar_mark_day</a> (<a href="GtkCalendar.html" title="GtkCalendar">GtkCalendar</a> *calendar,
<a
href="../glib/glib-Basic-Types.html#guint"
>guint</a> day);
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a href="GtkCalendar.html#gtk-calendar-unmark-day">gtk_calendar_unmark_day</a> (<a href="GtkCalendar.html" title="GtkCalendar">GtkCalendar</a> *calendar,
<a
href="../glib/glib-Basic-Types.html#guint"
>guint</a> day);
void <a href="GtkCalendar.html#gtk-calendar-clear-marks">gtk_calendar_clear_marks</a> (<a href="GtkCalendar.html" title="GtkCalendar">GtkCalendar</a> *calendar);
<a href="GtkCalendar.html#GtkCalendarDisplayOptions">GtkCalendarDisplayOptions</a> <a href="GtkCalendar.html#gtk-calendar-get-display-options">gtk_calendar_get_display_options</a>
(<a href="GtkCalendar.html" title="GtkCalendar">GtkCalendar</a> *calendar);
void <a href="GtkCalendar.html#gtk-calendar-set-display-options">gtk_calendar_set_display_options</a>
(<a href="GtkCalendar.html" title="GtkCalendar">GtkCalendar</a> *calendar,
<a href="GtkCalendar.html#GtkCalendarDisplayOptions">GtkCalendarDisplayOptions</a> flags);
void <a href="GtkCalendar.html#gtk-calendar-display-options">gtk_calendar_display_options</a> (<a href="GtkCalendar.html" title="GtkCalendar">GtkCalendar</a> *calendar,
<a href="GtkCalendar.html#GtkCalendarDisplayOptions">GtkCalendarDisplayOptions</a> flags);
void <a href="GtkCalendar.html#gtk-calendar-get-date">gtk_calendar_get_date</a> (<a href="GtkCalendar.html" title="GtkCalendar">GtkCalendar</a> *calendar,
<a
href="../glib/glib-Basic-Types.html#guint"
>guint</a> *year,
<a
href="../glib/glib-Basic-Types.html#guint"
>guint</a> *month,
<a
href="../glib/glib-Basic-Types.html#guint"
>guint</a> *day);
void <a href="GtkCalendar.html#gtk-calendar-freeze">gtk_calendar_freeze</a> (<a href="GtkCalendar.html" title="GtkCalendar">GtkCalendar</a> *calendar);
void <a href="GtkCalendar.html#gtk-calendar-thaw">gtk_calendar_thaw</a> (<a href="GtkCalendar.html" title="GtkCalendar">GtkCalendar</a> *calendar);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id3596619"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
<a
href="../gobject/gobject-The-Base-Object-Type.html#GObject"
>GObject</a>
+----<a
href="../gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned"
>GInitiallyUnowned</a>
+----<a href="GtkObject.html" title="GtkObject">GtkObject</a>
+----<a href="GtkWidget.html" title="GtkWidget">GtkWidget</a>
+----GtkCalendar
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id3596666"></a><h2>Implemented Interfaces</h2>
<p>
GtkCalendar implements
AtkImplementorIface.</p>
</div>
<div class="refsect1" lang="en">
<a name="id3596688"></a><h2>Properties</h2>
<pre class="synopsis">
"<a href="GtkCalendar.html#GtkCalendar--day">day</a>" <a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> : Read / Write
"<a href="GtkCalendar.html#GtkCalendar--month">month</a>" <a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> : Read / Write
"<a href="GtkCalendar.html#GtkCalendar--no-month-change">no-month-change</a>" <a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> : Read / Write
"<a href="GtkCalendar.html#GtkCalendar--show-day-names">show-day-names</a>" <a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> : Read / Write
"<a href="GtkCalendar.html#GtkCalendar--show-heading">show-heading</a>" <a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> : Read / Write
"<a href="GtkCalendar.html#GtkCalendar--show-week-numbers">show-week-numbers</a>" <a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> : Read / Write
"<a href="GtkCalendar.html#GtkCalendar--year">year</a>" <a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> : Read / Write
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id3596825"></a><h2>Signals</h2>
<pre class="synopsis">
"<a href="GtkCalendar.html#GtkCalendar-day-selected">day-selected</a>"
void user_function (<a href="GtkCalendar.html" title="GtkCalendar">GtkCalendar</a> *calendar,
<a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data) : Run first
"<a href="GtkCalendar.html#GtkCalendar-day-selected-double-click">day-selected-double-click</a>"
void user_function (<a href="GtkCalendar.html" title="GtkCalendar">GtkCalendar</a> *calendar,
<a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data) : Run first
"<a href="GtkCalendar.html#GtkCalendar-month-changed">month-changed</a>"
void user_function (<a href="GtkCalendar.html" title="GtkCalendar">GtkCalendar</a> *calendar,
<a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data) : Run first
"<a href="GtkCalendar.html#GtkCalendar-next-month">next-month</a>"
void user_function (<a href="GtkCalendar.html" title="GtkCalendar">GtkCalendar</a> *calendar,
<a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data) : Run first
"<a href="GtkCalendar.html#GtkCalendar-next-year">next-year</a>" void user_function (<a href="GtkCalendar.html" title="GtkCalendar">GtkCalendar</a> *calendar,
<a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data) : Run first
"<a href="GtkCalendar.html#GtkCalendar-prev-month">prev-month</a>"
void user_function (<a href="GtkCalendar.html" title="GtkCalendar">GtkCalendar</a> *calendar,
<a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data) : Run first
"<a href="GtkCalendar.html#GtkCalendar-prev-year">prev-year</a>" void user_function (<a href="GtkCalendar.html" title="GtkCalendar">GtkCalendar</a> *calendar,
<a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data) : Run first
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id3597069"></a><h2>Description</h2>
<p>
<a href="GtkCalendar.html" title="GtkCalendar"><span class="type">GtkCalendar</span></a> is a widget that displays a calendar, one month at a time.
It can be created with <a href="GtkCalendar.html#gtk-calendar-new"><code class="function">gtk_calendar_new()</code></a>.
</p>
<p>
The month and year currently displayed can be altered with
<a href="GtkCalendar.html#gtk-calendar-select-month"><code class="function">gtk_calendar_select_month()</code></a>. The exact day can be selected from the displayed
month using <a href="GtkCalendar.html#gtk-calendar-select-day"><code class="function">gtk_calendar_select_day()</code></a>.
</p>
<p>
To place a visual marker on a particular day, use <a href="GtkCalendar.html#gtk-calendar-mark-day"><code class="function">gtk_calendar_mark_day()</code></a>
and to remove the marker, <a href="GtkCalendar.html#gtk-calendar-unmark-day"><code class="function">gtk_calendar_unmark_day()</code></a>.
Alternative, all marks can be cleared with <a href="GtkCalendar.html#gtk-calendar-clear-marks"><code class="function">gtk_calendar_clear_marks()</code></a>.
</p>
<p>
The way in which the calendar itself is displayed can be altered using
<a href="GtkCalendar.html#gtk-calendar-set-display-options"><code class="function">gtk_calendar_set_display_options()</code></a>.
</p>
<p>
The selected date can be retrieved from a <a href="GtkCalendar.html" title="GtkCalendar"><span class="type">GtkCalendar</span></a> using
<a href="GtkCalendar.html#gtk-calendar-get-date"><code class="function">gtk_calendar_get_date()</code></a>.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id3597206"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id3597216"></a><h3>
<a name="GtkCalendar-struct"></a>GtkCalendar</h3>
<a class="indexterm" name="id3597229"></a><pre class="programlisting">typedef struct _GtkCalendar GtkCalendar;</pre>
<p>
<em class="structfield"><code>num_marked_dates</code></em> is an integer containing the
number of days that have a mark over them.
</p>
<p>
<em class="structfield"><code>marked_date</code></em> is an array containing the day numbers
that currently have a mark over them.
</p>
<p>
<em class="structfield"><code>month</code></em>, <em class="structfield"><code>year</code></em>, and
<em class="structfield"><code>selected_day</code></em> contain the currently visible month,
year, and selected day respectively.
</p>
<p>
All of these fields should be considered read only, and everything in this
struct should only be modified using the functions provided below.
</p>
<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Note</h3>
<p>
Note that <em class="structfield"><code>month</code></em> is zero-based (i.e it allowed values
are 0-11) while <em class="structfield"><code>selected_day</code></em> is one-based
(i.e. allowed values are 1-31).
</p>
</div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3597294"></a><h3>
<a name="GtkCalendarDisplayOptions"></a>enum GtkCalendarDisplayOptions</h3>
<a class="indexterm" name="id3597308"></a><pre class="programlisting">typedef enum
{
GTK_CALENDAR_SHOW_HEADING = 1 << 0,
GTK_CALENDAR_SHOW_DAY_NAMES = 1 << 1,
GTK_CALENDAR_NO_MONTH_CHANGE = 1 << 2,
GTK_CALENDAR_SHOW_WEEK_NUMBERS = 1 << 3,
GTK_CALENDAR_WEEK_START_MONDAY = 1 << 4
} GtkCalendarDisplayOptions;
</pre>
<p>
These options can be used to influence the display and behaviour of a <a href="GtkCalendar.html" title="GtkCalendar"><span class="type">GtkCalendar</span></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><a name="GTK-CALENDAR-SHOW-HEADING:CAPS"></a><code class="literal">GTK_CALENDAR_SHOW_HEADING</code></span></td>
<td>Specifies that the month and year should be displayed.
</td>
</tr>
<tr>
<td>
<span class="term"><a name="GTK-CALENDAR-SHOW-DAY-NAMES:CAPS"></a><code class="literal">GTK_CALENDAR_SHOW_DAY_NAMES</code></span></td>
<td>Specifies that three letter day descriptions should be present.
</td>
</tr>
<tr>
<td>
<span class="term"><a name="GTK-CALENDAR-NO-MONTH-CHANGE:CAPS"></a><code class="literal">GTK_CALENDAR_NO_MONTH_CHANGE</code></span></td>
<td>Prevents the user from switching months with the calendar.
</td>
</tr>
<tr>
<td>
<span class="term"><a name="GTK-CALENDAR-SHOW-WEEK-NUMBERS:CAPS"></a><code class="literal">GTK_CALENDAR_SHOW_WEEK_NUMBERS</code></span></td>
<td>Displays each week numbers of the current year, down the left side
of the calendar.
</td>
</tr>
<tr>
<td>
<span class="term"><a name="GTK-CALENDAR-WEEK-START-MONDAY:CAPS"></a><code class="literal">GTK_CALENDAR_WEEK_START_MONDAY</code></span></td>
<td>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.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3597462"></a><h3>
<a name="gtk-calendar-new"></a>gtk_calendar_new ()</h3>
<a class="indexterm" name="id3597474"></a><pre class="programlisting"><a href="GtkWidget.html" title="GtkWidget">GtkWidget</a>* gtk_calendar_new (void);</pre>
<p>
Creates a new calendar, with the current date being selected.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> a newly <a href="GtkCalendar.html" title="GtkCalendar"><span class="type">GtkCalendar</span></a> widget
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3597522"></a><h3>
<a name="gtk-calendar-select-month"></a>gtk_calendar_select_month ()</h3>
<a class="indexterm" name="id3597536"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> gtk_calendar_select_month (<a href="GtkCalendar.html" title="GtkCalendar">GtkCalendar</a> *calendar,
<a
href="../glib/glib-Basic-Types.html#guint"
>guint</a> month,
<a
href="../glib/glib-Basic-Types.html#guint"
>guint</a> year);</pre>
<p>
Shifts the calendar to a different month.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>calendar</code></em> :</span></td>
<td> a <a href="GtkCalendar.html" title="GtkCalendar"><span class="type">GtkCalendar</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>month</code></em> :</span></td>
<td> a month number between 0 and 11.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>year</code></em> :</span></td>
<td> the year the month is in.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> <a
href="../glib/glib-Standard-Macros.html#TRUE:CAPS"
><code class="literal">TRUE</code></a>, always
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3597657"></a><h3>
<a name="gtk-calendar-select-day"></a>gtk_calendar_select_day ()</h3>
<a class="indexterm" name="id3597671"></a><pre class="programlisting">void gtk_calendar_select_day (<a href="GtkCalendar.html" title="GtkCalendar">GtkCalendar</a> *calendar,
<a
href="../glib/glib-Basic-Types.html#guint"
>guint</a> day);</pre>
<p>
Selects a day from the current month.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>calendar</code></em> :</span></td>
<td> a <a href="GtkCalendar.html" title="GtkCalendar"><span class="type">GtkCalendar</span></a>.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>day</code></em> :</span></td>
<td> the day number between 1 and 31, or 0 to unselect
the currently selected day.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3597751"></a><h3>
<a name="gtk-calendar-mark-day"></a>gtk_calendar_mark_day ()</h3>
<a class="indexterm" name="id3597764"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> gtk_calendar_mark_day (<a href="GtkCalendar.html" title="GtkCalendar">GtkCalendar</a> *calendar,
<a
href="../glib/glib-Basic-Types.html#guint"
>guint</a> day);</pre>
<p>
Places a visual marker on a particular day.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>calendar</code></em> :</span></td>
<td> a <a href="GtkCalendar.html" title="GtkCalendar"><span class="type">GtkCalendar</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>day</code></em> :</span></td>
<td> the day number to mark between 1 and 31.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> <a
href="../glib/glib-Standard-Macros.html#TRUE:CAPS"
><code class="literal">TRUE</code></a>, always
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3597864"></a><h3>
<a name="gtk-calendar-unmark-day"></a>gtk_calendar_unmark_day ()</h3>
<a class="indexterm" name="id3597878"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> gtk_calendar_unmark_day (<a href="GtkCalendar.html" title="GtkCalendar">GtkCalendar</a> *calendar,
<a
href="../glib/glib-Basic-Types.html#guint"
>guint</a> day);</pre>
<p>
Removes the visual marker from a particular day.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>calendar</code></em> :</span></td>
<td> a <a href="GtkCalendar.html" title="GtkCalendar"><span class="type">GtkCalendar</span></a>.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>day</code></em> :</span></td>
<td> the day number to unmark between 1 and 31.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> <a
href="../glib/glib-Standard-Macros.html#TRUE:CAPS"
><code class="literal">TRUE</code></a>, always
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3597978"></a><h3>
<a name="gtk-calendar-clear-marks"></a>gtk_calendar_clear_marks ()</h3>
<a class="indexterm" name="id3597991"></a><pre class="programlisting">void gtk_calendar_clear_marks (<a href="GtkCalendar.html" title="GtkCalendar">GtkCalendar</a> *calendar);</pre>
<p>
Remove all visual markers.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td>
<span class="term"><em class="parameter"><code>calendar</code></em> :</span></td>
<td> a <a href="GtkCalendar.html" title="GtkCalendar"><span class="type">GtkCalendar</span></a>
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3598049"></a><h3>
<a name="gtk-calendar-get-display-options"></a>gtk_calendar_get_display_options ()</h3>
<a class="indexterm" name="id3598065"></a><pre class="programlisting"><a href="GtkCalendar.html#GtkCalendarDisplayOptions">GtkCalendarDisplayOptions</a> gtk_calendar_get_display_options
(<a href="GtkCalendar.html" title="GtkCalendar">GtkCalendar</a> *calendar);</pre>
<p>
Returns the current display options of <em class="parameter"><code>calendar</code></em>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>calendar</code></em> :</span></td>
<td> a <a href="GtkCalendar.html" title="GtkCalendar"><span class="type">GtkCalendar</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> the display options.
</td>
</tr>
</tbody>
</table></div>
<p>Since 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3598145"></a><h3>
<a name="gtk-calendar-set-display-options"></a>gtk_calendar_set_display_options ()</h3>
<a class="indexterm" name="id3598161"></a><pre class="programlisting">void gtk_calendar_set_display_options
(<a href="GtkCalendar.html" title="GtkCalendar">GtkCalendar</a> *calendar,
<a href="GtkCalendar.html#GtkCalendarDisplayOptions">GtkCalendarDisplayOptions</a> flags);</pre>
<p>
Sets display options (whether to display the heading and the month
headings).</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>calendar</code></em> :</span></td>
<td> a <a href="GtkCalendar.html" title="GtkCalendar"><span class="type">GtkCalendar</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>flags</code></em> :</span></td>
<td> the display options to set
</td>
</tr>
</tbody>
</table></div>
<p>Since 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3598247"></a><h3>
<a name="gtk-calendar-display-options"></a>gtk_calendar_display_options ()</h3>
<a class="indexterm" name="id3598263"></a><pre class="programlisting">void gtk_calendar_display_options (<a href="GtkCalendar.html" title="GtkCalendar">GtkCalendar</a> *calendar,
<a href="GtkCalendar.html#GtkCalendarDisplayOptions">GtkCalendarDisplayOptions</a> flags);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gtk_calendar_display_options</code> is deprecated and should not be used in newly-written code. </p>
</div>
<p>
Sets display options (whether to display the heading and the month headings).</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>calendar</code></em> :</span></td>
<td> a <a href="GtkCalendar.html" title="GtkCalendar"><span class="type">GtkCalendar</span></a>.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>flags</code></em> :</span></td>
<td> the display options to set.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3598357"></a><h3>
<a name="gtk-calendar-get-date"></a>gtk_calendar_get_date ()</h3>
<a class="indexterm" name="id3598371"></a><pre class="programlisting">void gtk_calendar_get_date (<a href="GtkCalendar.html" title="GtkCalendar">GtkCalendar</a> *calendar,
<a
href="../glib/glib-Basic-Types.html#guint"
>guint</a> *year,
<a
href="../glib/glib-Basic-Types.html#guint"
>guint</a> *month,
<a
href="../glib/glib-Basic-Types.html#guint"
>guint</a> *day);</pre>
<p>
Obtains the selected date from a <a href="GtkCalendar.html" title="GtkCalendar"><span class="type">GtkCalendar</span></a>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>calendar</code></em> :</span></td>
<td> a <a href="GtkCalendar.html" title="GtkCalendar"><span class="type">GtkCalendar</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>year</code></em> :</span></td>
<td> location to store the year number, or <a
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>month</code></em> :</span></td>
<td> location to store the month number (between 0 and 11), or <a
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>day</code></em> :</span></td>
<td> location to store the day number (between 1 and 31), or <a
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3598532"></a><h3>
<a name="gtk-calendar-freeze"></a>gtk_calendar_freeze ()</h3>
<a class="indexterm" name="id3598548"></a><pre class="programlisting">void gtk_calendar_freeze (<a href="GtkCalendar.html" title="GtkCalendar">GtkCalendar</a> *calendar);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gtk_calendar_freeze</code> has been deprecated since version 2.8 and should not be used in newly-written code. </p>
</div>
<p>
Does nothing. Previously locked the display of the calendar until
it was thawed with <a href="GtkCalendar.html#gtk-calendar-thaw"><code class="function">gtk_calendar_thaw()</code></a>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td>
<span class="term"><em class="parameter"><code>calendar</code></em> :</span></td>
<td> a <a href="GtkCalendar.html" title="GtkCalendar"><span class="type">GtkCalendar</span></a>
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3598630"></a><h3>
<a name="gtk-calendar-thaw"></a>gtk_calendar_thaw ()</h3>
<a class="indexterm" name="id3598645"></a><pre class="programlisting">void gtk_calendar_thaw (<a href="GtkCalendar.html" title="GtkCalendar">GtkCalendar</a> *calendar);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gtk_calendar_thaw</code> has been deprecated since version 2.8 and should not be used in newly-written code. </p>
</div>
<p>
Does nothing. Previously defrosted a calendar; all the changes made
since the last <a href="GtkCalendar.html#gtk-calendar-freeze"><code class="function">gtk_calendar_freeze()</code></a> were displayed.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td>
<span class="term"><em class="parameter"><code>calendar</code></em> :</span></td>
<td> a <a href="GtkCalendar.html" title="GtkCalendar"><span class="type">GtkCalendar</span></a>
</td>
</tr></tbody>
</table></div>
</div>
</div>
<div class="refsect1" lang="en">
<a name="id3598728"></a><h2>Property Details</h2>
<div class="refsect2" lang="en">
<a name="id3598739"></a><h3>
<a name="GtkCalendar--day"></a>The "<code class="literal">day</code>" property</h3>
<a class="indexterm" name="id3598755"></a><pre class="programlisting"> "day" <a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> : Read / Write</pre>
<p>The selected day (as a number between 1 and 31, or 0 to unselect the currently selected day).</p>
<p>Allowed values: [0,31]</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3598787"></a><h3>
<a name="GtkCalendar--month"></a>The "<code class="literal">month</code>" property</h3>
<a class="indexterm" name="id3598803"></a><pre class="programlisting"> "month" <a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> : Read / Write</pre>
<p>The selected month (as a number between 0 and 11).</p>
<p>Allowed values: [0,11]</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3598833"></a><h3>
<a name="GtkCalendar--no-month-change"></a>The "<code class="literal">no-month-change</code>" property</h3>
<a class="indexterm" name="id3598850"></a><pre class="programlisting"> "no-month-change" <a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> : Read / Write</pre>
<p>
Determines whether the selected month can be changed.</p>
<p>
</p>
<p>Default value: FALSE</p>
<p>Since 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3598886"></a><h3>
<a name="GtkCalendar--show-day-names"></a>The "<code class="literal">show-day-names</code>" property</h3>
<a class="indexterm" name="id3598903"></a><pre class="programlisting"> "show-day-names" <a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> : Read / Write</pre>
<p>
Determines whether day names are displayed.</p>
<p>
</p>
<p>Default value: TRUE</p>
<p>Since 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3598938"></a><h3>
<a name="GtkCalendar--show-heading"></a>The "<code class="literal">show-heading</code>" property</h3>
<a class="indexterm" name="id3598955"></a><pre class="programlisting"> "show-heading" <a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> : Read / Write</pre>
<p>
Determines whether a heading is displayed.</p>
<p>
</p>
<p>Default value: TRUE</p>
<p>Since 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3598990"></a><h3>
<a name="GtkCalendar--show-week-numbers"></a>The "<code class="literal">show-week-numbers</code>" property</h3>
<a class="indexterm" name="id3599008"></a><pre class="programlisting"> "show-week-numbers" <a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> : Read / Write</pre>
<p>
Determines whether week numbers are displayed.</p>
<p>
</p>
<p>Default value: FALSE</p>
<p>Since 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3599043"></a><h3>
<a name="GtkCalendar--year"></a>The "<code class="literal">year</code>" property</h3>
<a class="indexterm" name="id3599060"></a><pre class="programlisting"> "year" <a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> : Read / Write</pre>
<p>The selected year.</p>
<p>Allowed values: >= 0</p>
<p>Default value: 0</p>
</div>
</div>
<div class="refsect1" lang="en">
<a name="id3599091"></a><h2>Signal Details</h2>
<div class="refsect2" lang="en">
<a name="id3599102"></a><h3>
<a name="GtkCalendar-day-selected"></a>The "day-selected" signal</h3>
<a class="indexterm" name="id3599112"></a><pre class="programlisting">void user_function (<a href="GtkCalendar.html" title="GtkCalendar">GtkCalendar</a> *calendar,
<a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data) : Run first</pre>
<p>
Emitted when the user selects a day.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>calendar</code></em> :</span></td>
<td>the object which received the signal.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>user_data</code></em> :</span></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3599181"></a><h3>
<a name="GtkCalendar-day-selected-double-click"></a>The "day-selected-double-click" signal</h3>
<a class="indexterm" name="id3599193"></a><pre class="programlisting">void user_function (<a href="GtkCalendar.html" title="GtkCalendar">GtkCalendar</a> *calendar,
<a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data) : Run first</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>calendar</code></em> :</span></td>
<td>the object which received the signal.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>user_data</code></em> :</span></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3599261"></a><h3>
<a name="GtkCalendar-month-changed"></a>The "month-changed" signal</h3>
<a class="indexterm" name="id3599272"></a><pre class="programlisting">void user_function (<a href="GtkCalendar.html" title="GtkCalendar">GtkCalendar</a> *calendar,
<a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data) : Run first</pre>
<p>
Emitted when the user clicks a button to change the selected month on a
calendar.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>calendar</code></em> :</span></td>
<td>the object which received the signal.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>user_data</code></em> :</span></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3599341"></a><h3>
<a name="GtkCalendar-next-month"></a>The "next-month" signal</h3>
<a class="indexterm" name="id3599352"></a><pre class="programlisting">void user_function (<a href="GtkCalendar.html" title="GtkCalendar">GtkCalendar</a> *calendar,
<a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data) : Run first</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>calendar</code></em> :</span></td>
<td>the object which received the signal.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>user_data</code></em> :</span></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3599420"></a><h3>
<a name="GtkCalendar-next-year"></a>The "next-year" signal</h3>
<a class="indexterm" name="id3599431"></a><pre class="programlisting">void user_function (<a href="GtkCalendar.html" title="GtkCalendar">GtkCalendar</a> *calendar,
<a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data) : Run first</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>calendar</code></em> :</span></td>
<td>the object which received the signal.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>user_data</code></em> :</span></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3599498"></a><h3>
<a name="GtkCalendar-prev-month"></a>The "prev-month" signal</h3>
<a class="indexterm" name="id3599509"></a><pre class="programlisting">void user_function (<a href="GtkCalendar.html" title="GtkCalendar">GtkCalendar</a> *calendar,
<a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data) : Run first</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>calendar</code></em> :</span></td>
<td>the object which received the signal.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>user_data</code></em> :</span></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3599577"></a><h3>
<a name="GtkCalendar-prev-year"></a>The "prev-year" signal</h3>
<a class="indexterm" name="id3599588"></a><pre class="programlisting">void user_function (<a href="GtkCalendar.html" title="GtkCalendar">GtkCalendar</a> *calendar,
<a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data) : Run first</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>calendar</code></em> :</span></td>
<td>the object which received the signal.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>user_data</code></em> :</span></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
</body>
</html>