/usr/share/gtk-doc/html/pygtk/class-gtkcalendar.html is in python-gtk2-doc 2.24.0-5.1ubuntu2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 | <html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><title>gtk.Calendar</title><link rel="stylesheet" href="style.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.75.2"><link rel="home" href="index.html" title="PyGTK 2.0 Reference Manual"><link rel="up" href="gtk-class-reference.html" title="The gtk Class Reference"><link rel="prev" href="class-gtkbuttonbox.html" title="gtk.ButtonBox"><link rel="next" href="class-gtkcelleditable.html" title="gtk.CellEditable"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">gtk.Calendar</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="class-gtkbuttonbox.html">Prev</a> </td><th width="60%" align="center">The gtk Class Reference</th><td width="20%" align="right"> <a accesskey="n" href="class-gtkcelleditable.html">Next</a></td></tr></table><hr></div><div class="refentry" title="gtk.Calendar"><a name="class-gtkcalendar"></a><div class="titlepage"></div><div class="refnamediv"><h2>gtk.Calendar</h2><p>gtk.Calendar — a widget that displays a calendar and allows the user to
select a date.</p></div><div class="refsect1" title="Synopsis"><a name="id3622581"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">gtk.Calendar</span></span>(<span class="ooclass"><span class="classname"><a class="link" href="class-gtkwidget.html" title="gtk.Widget">gtk.Widget</a></span></span>):
<code class="constructorsynopsis"> <span class="methodname"><a class="link" href="class-gtkcalendar.html#constructor-gtkcalendar" title="Constructor">gtk.Calendar</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkcalendar.html#method-gtkcalendar--select-month" title="gtk.Calendar.select_month">select_month</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>month</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>year</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkcalendar.html#method-gtkcalendar--select-day" title="gtk.Calendar.select_day">select_day</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>day</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkcalendar.html#method-gtkcalendar--mark-day" title="gtk.Calendar.mark_day">mark_day</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>day</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkcalendar.html#method-gtkcalendar--unmark-day" title="gtk.Calendar.unmark_day">unmark_day</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>day</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkcalendar.html#method-gtkcalendar--clear-marks" title="gtk.Calendar.clear_marks">clear_marks</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkcalendar.html#method-gtkcalendar--get-display-options" title="gtk.Calendar.get_display_options">get_display_options</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkcalendar.html#method-gtkcalendar--set-display-options" title="gtk.Calendar.set_display_options">set_display_options</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>flags</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkcalendar.html#method-gtkcalendar--get-detail-height-rows" title="gtk.Calendar.get_detail_height_rows">get_detail_height_rows</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkcalendar.html#method-gtkcalendar--set-detail-height-rows" title="gtk.Calendar.set_detail_height_rows">set_detail_height_rows</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>rows</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkcalendar.html#method-gtkcalendar--get-detail-width-chars" title="gtk.Calendar.get_detail_width_chars">get_detail_width_chars</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkcalendar.html#method-gtkcalendar--set-detail-width-chars" title="gtk.Calendar.set_detail_width_chars">set_detail_width_chars</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>chars</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkcalendar.html#method-gtkcalendar--display-options" title="gtk.Calendar.display_options">display_options</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>flags</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkcalendar.html#method-gtkcalendar--get-date" title="gtk.Calendar.get_date">get_date</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkcalendar.html#method-gtkcalendar--freeze" title="gtk.Calendar.freeze">freeze</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkcalendar.html#method-gtkcalendar--thaw" title="gtk.Calendar.thaw">thaw</a></span>(<span class="methodparam"></span>)</code><br></pre></td></tr></table></div><div class="refsect1" title="Ancestry"><a name="id3622949"></a><h2>Ancestry</h2><pre class="synopsis">+-- <PYGTKDOCLINK HREF="class-gobject">gobject.GObject</PYGTKDOCLINK>
+-- <a class="link" href="class-gtkobject.html" title="gtk.Object">gtk.Object</a>
+-- <a class="link" href="class-gtkwidget.html" title="gtk.Widget">gtk.Widget</a>
+-- <a class="link" href="class-gtkcalendar.html" title="gtk.Calendar">gtk.Calendar</a>
</pre></div><div class="refsect1" title="Implemented Interfaces"><a name="id3622981"></a><h2>Implemented Interfaces</h2><p>
<a class="link" href="class-gtkcalendar.html" title="gtk.Calendar"><code class="classname">gtk.Calendar</code></a>
implements
<a class="link" href="class-gtkbuildable.html" title="gtk.Buildable"><code class="classname">gtk.Buildable</code></a>
</p></div><div class="refsect1" title="gtk.Calendar Properties"><a name="properties-gtkcalendar"></a><h2>gtk.Calendar Properties</h2><p><a class="link" href="class-gtkobject.html#properties-gtkobject" title="gtk.Object Properties">gtk.Object Properties</a></p><p><a class="link" href="class-gtkwidget.html#properties-gtkwidget" title="gtk.Widget Properties">gtk.Widget Properties</a></p><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>These properties are available in GTK+ 2.4 and above.</p></div><div class="blockquote"><table width="100%" border="0" bgcolor="#E0E0E0"><tr><td valign="top"><div class="informaltable"><table width="100%" border="0"><colgroup><col width="1in"><col width="1in"><col width="4in"></colgroup><tbody><tr valign="top"><td valign="top">"day"</td><td valign="top">Read-Write</td><td valign="top">The selected day (as a number between 1 and 31, or 0 to
unselect the currently selected day).</td></tr><tr valign="top"><td valign="top">"detail-height-rows"</td><td valign="top">Read-Write</td><td valign="top">Height of a detail cell, in rows. A value of 0 allows any width.
See gtk_calendar_set_detail_func(). Allowed values: [0,127].
Default value: 0 .This property is available in GTK+ 2.14 and above.</td></tr><tr valign="top"><td valign="top">"detail-width-chars"</td><td valign="top">Read-Write</td><td valign="top">Width of a detail cell, in characters. A value of 0 allows any width.
See gtk_calendar_set_detail_func(). Allowed values: [0,127] Default value: 0.
This property is available in GTK+ 2.14 and above.</td></tr><tr valign="top"><td valign="top">"month"</td><td valign="top">Read-Write</td><td valign="top">The selected month (as a number between 0 and 11).</td></tr><tr valign="top"><td valign="top">"no-month-change"</td><td valign="top">Read-Write</td><td valign="top">If <code class="literal">True</code> the selected month cannot be
changed.</td></tr><tr valign="top"><td valign="top">"show-day-names"</td><td valign="top">Read-Write</td><td valign="top">If <code class="literal">True</code>, day names are
displayed.</td></tr><tr valign="top"><td valign="top">"show-details"</td><td valign="top">Read-Write</td><td valign="top">Determines whether details are shown directly in the widget,
or if they are available only as tooltip. When this property is set days
with details are marked. Default value: <code class="literal">True</code>.
This property is available in GTK+ 2.14 and above.</td></tr><tr valign="top"><td valign="top">"show-heading"</td><td valign="top">Read-Write</td><td valign="top">If <code class="literal">True</code>, a heading is
displayed.</td></tr><tr valign="top"><td valign="top">"show-week-numbers"</td><td valign="top">Read-Write</td><td valign="top">If <code class="literal">True</code>, week numbers are
displayed.</td></tr><tr valign="top"><td valign="top">"year"</td><td valign="top">Read-Write</td><td valign="top">The selected year.</td></tr></tbody></table></div></td></tr></table></div></div><div class="refsect1" title="gtk.Calendar Style Properties"><a name="style-properties-gtkcalendar"></a><h2>gtk.Calendar Style Properties</h2><p><a class="link" href="class-gtkwidget.html#style-properties-gtkwidget" title="gtk.Widget Style Properties">gtk.Widget Style Properties</a></p><div class="blockquote"><table width="100%" border="0" bgcolor="#E0E0E0"><tr><td valign="top"><div class="informaltable"><table width="100%" border="0"><colgroup><col width="1in"><col width="1in"><col width="3.5in"></colgroup><tbody><tr valign="top"><td valign="top">"horizontal-separation"</td><td valign="top">Read</td><td valign="top">Separation between week headers and main area. Allowed values: >=0. Default value: 4.</td></tr><tr valign="top"><td valign="top">"inner-border"</td><td valign="top">Read</td><td valign="top">The spacing around the day/week headers and main area. Allowed values: >=0. Default value: 2.</td></tr><tr valign="top"><td valign="top">"vertical-separation"</td><td valign="top">Read</td><td valign="top">Space between day headers and main area. Allowed values: >=0. Default value: 2.</td></tr></tbody></table></div></td></tr></table></div></div><div class="refsect1" title="gtk.Calendar Signal Prototypes"><a name="signal-prototypes-gtkcalendar"></a><h2>gtk.Calendar Signal Prototypes</h2><p><PYGTKDOCLINK HREF="signal-prototypes-gobject">gobject.GObject Signal Prototypes</PYGTKDOCLINK></p><p><a class="link" href="class-gtkobject.html#signal-prototypes-gtkobject" title="gtk.Object Signal Prototypes">gtk.Object Signal Prototypes</a></p><p><a class="link" href="class-gtkwidget.html#signal-prototypes-gtkwidget" title="gtk.Widget Signal Prototypes">gtk.Widget Signal Prototypes</a></p><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term">"<a class="link" href="class-gtkcalendar.html#signal-gtkcalendar--day-selected" title='The "day-selected" gtk.Calendar Signal'>day-selected</a>"</span></p></td><td><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>calendar</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></td></tr><tr><td><p><span class="term">"<a class="link" href="class-gtkcalendar.html#signal-gtkcalendar--day-selected-double-click" title='The "day-selected-double-click" gtk.Calendar Signal'>day-selected-double-click</a>"</span></p></td><td><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>calendar</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></td></tr><tr><td><p><span class="term">"<a class="link" href="class-gtkcalendar.html#signal-gtkcalendar--month-changed" title='The "month-changed" gtk.Calendar Signal'>month-changed</a>"</span></p></td><td><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>calendar</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></td></tr><tr><td><p><span class="term">"<a class="link" href="class-gtkcalendar.html#signal-gtkcalendar--next-month" title='The "next-month" gtk.Calendar Signal'>next-month</a>"</span></p></td><td><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>calendar</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></td></tr><tr><td><p><span class="term">"<a class="link" href="class-gtkcalendar.html#signal-gtkcalendar--next-year" title='The "next-year" gtk.Calendar Signal'>next-year</a>"</span></p></td><td><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>calendar</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></td></tr><tr><td><p><span class="term">"<a class="link" href="class-gtkcalendar.html#signal-gtkcalendar--prev-month" title='The "prev-month" gtk.Calendar Signal'>prev-month</a>"</span></p></td><td><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>calendar</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></td></tr><tr><td><p><span class="term">"<a class="link" href="class-gtkcalendar.html#signal-gtkcalendar--prev-year" title='The "prev-year" gtk.Calendar Signal'>prev-year</a>"</span></p></td><td><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>calendar</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></td></tr></tbody></table></div><div class="refsect1" title="Description"><a name="id3623787"></a><h2>Description</h2><p>The <a class="link" href="class-gtkcalendar.html" title="gtk.Calendar"><code class="classname">gtk.Calendar</code></a> is a
widget that displays a simple calendar, one month at a time. In addition,
the calendar can display the days of the week and navigation controls that
allow a user to change the month and year displayed by calling the <a class="link" href="class-gtkcalendar.html#method-gtkcalendar--display-options" title="gtk.Calendar.display_options"><code class="methodname">display_options</code>()</a>
(<a class="link" href="class-gtkcalendar.html#method-gtkcalendar--set-display-options" title="gtk.Calendar.set_display_options"><code class="methodname">set_display_options</code>()</a>
in PyGTK 2.4 and above) method. The possible display options are:</p><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><code class="literal">gtk.CALENDAR_SHOW_HEADING</code></span></p></td><td>Specifies that the month and year should be
displayed.</td></tr><tr><td><p><span class="term"><code class="literal">gtk.CALENDAR_SHOW_DAY_NAMES</code></span></p></td><td>Specifies that three letter day descriptions should be
present.</td></tr><tr><td><p><span class="term"><code class="literal">gtk.CALENDAR_NO_MONTH_CHANGE</code></span></p></td><td>Prevents the user from switching months with the
calendar.</td></tr><tr><td><p><span class="term"><code class="literal">gtk.CALENDAR_SHOW_WEEK_NUMBERS</code></span></p></td><td>Displays each week numbers of the current year, down the
left side of the calendar.</td></tr><tr><td><p><span class="term"><code class="literal">gtk.CALENDAR_WEEK_START_MONDAY</code></span></p></td><td>Starts the calendar week on Monday, instead of the
default Sunday.</td></tr></tbody></table><p>The month and year currently displayed are programatically
changed by calling the <a class="link" href="class-gtkcalendar.html#method-gtkcalendar--select-month" title="gtk.Calendar.select_month"><code class="methodname">select_month</code>()</a>
method. The exact day is selected from the displayed month using the <a class="link" href="class-gtkcalendar.html#method-gtkcalendar--select-day" title="gtk.Calendar.select_day"><code class="methodname">select_day</code>()</a>
method.</p><p>To place a visual marker on a particular day, use the <a class="link" href="class-gtkcalendar.html#method-gtkcalendar--mark-day" title="gtk.Calendar.mark_day"><code class="methodname">mark_day</code>()</a>
method and to remove the marker, the <a class="link" href="class-gtkcalendar.html#method-gtkcalendar--unmark-day" title="gtk.Calendar.unmark_day"><code class="methodname">unmark_day</code>()</a>
method. All marks are cleared by calling the <a class="link" href="class-gtkcalendar.html#method-gtkcalendar--clear-marks" title="gtk.Calendar.clear_marks"><code class="methodname">clear_marks</code>()</a>
method.</p><p>The selected date can be retrieved from a <a class="link" href="class-gtkcalendar.html" title="gtk.Calendar"><code class="classname">gtk.Calendar</code></a> using
the <a class="link" href="class-gtkcalendar.html#method-gtkcalendar--get-date" title="gtk.Calendar.get_date"><code class="methodname">get_date</code>()</a>
method. If performing many 'mark' operations, the calendar can be frozen to
prevent flicker, using the <a class="link" href="class-gtkcalendar.html#method-gtkcalendar--freeze" title="gtk.Calendar.freeze"><code class="methodname">freeze</code>()</a>
method, and 'thawed' again using the <a class="link" href="class-gtkcalendar.html#method-gtkcalendar--freeze" title="gtk.Calendar.freeze"><code class="methodname">thaw</code>()</a>
method.</p><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>Note that month is zero-based (i.e it allowed values are 0-11) while selected_day
is one-based (i.e. allowed values are 1-31).</p></div></div><div class="refsect1" title="Constructor"><a name="constructor-gtkcalendar"></a><h2>Constructor</h2><pre class="programlisting"><code class="constructorsynopsis"> <span class="methodname">gtk.Calendar</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>a calendar object</td></tr></tbody></table><p>Creates a calendar object that displays the current month and year
with the current day selected. The default calendar display style is:
gtk.CALENDAR_SHOW_HEADING | gtk.CALENDAR_SHOW_DAY_NAMES that shows the days
of the week and the month and year heading with navigation controls.</p></div><div class="refsect1" title="Methods"><a name="id3624051"></a><h2>Methods</h2><div class="refsect2" title="gtk.Calendar.select_month"><a name="method-gtkcalendar--select-month"></a><h3>gtk.Calendar.select_month</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">select_month</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>month</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>year</code></em></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>month</code></strong> :</span></p></td><td>the new month number between 0 and
11</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>year</code></strong> :</span></p></td><td>the new year number</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>True if the month is set</td></tr></tbody></table><p>The <code class="methodname">select_month</code>() method changes the
calendar display to the specified <em class="parameter"><code>month</code></em> and
<em class="parameter"><code>year</code></em>.</p></div><div class="refsect2" title="gtk.Calendar.select_day"><a name="method-gtkcalendar--select-day"></a><h3>gtk.Calendar.select_day</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">select_day</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>day</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>day</code></strong> :</span></p></td><td>the new day number between 1 and 31 - 0 removes
the current selection</td></tr></tbody></table><p>The <code class="methodname">select_day</code>() method selects the
specified <em class="parameter"><code>day</code></em> on the calendar when
<em class="parameter"><code>day</code></em> has a value between 1 and 31. If
<em class="parameter"><code>day</code></em> is 0 then the current day selection is
removed.</p></div><div class="refsect2" title="gtk.Calendar.mark_day"><a name="method-gtkcalendar--mark-day"></a><h3>gtk.Calendar.mark_day</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">mark_day</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>day</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>day</code></strong> :</span></p></td><td>the number of the day to be
marked</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>True</td></tr></tbody></table><p>The <code class="methodname">mark_day</code>() method marks the
specified month <em class="parameter"><code>day</code></em> with a visual marker (typically
by making the number bold). If the calendar month and year are changed the
marked days remain marked.</p></div><div class="refsect2" title="gtk.Calendar.unmark_day"><a name="method-gtkcalendar--unmark-day"></a><h3>gtk.Calendar.unmark_day</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">unmark_day</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>day</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>day</code></strong> :</span></p></td><td>the number of the day to be
unmarked</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>True</td></tr></tbody></table><p>The <code class="methodname">unmark_day</code>() method unmarks the
specified month <em class="parameter"><code>day</code></em>.</p></div><div class="refsect2" title="gtk.Calendar.clear_marks"><a name="method-gtkcalendar--clear-marks"></a><h3>gtk.Calendar.clear_marks</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">clear_marks</span>(<span class="methodparam"></span>)</code></pre><p>The <code class="methodname">clear_marks</code>() method clears all
marked days.</p></div><div class="refsect2" title="gtk.Calendar.get_display_options"><a name="method-gtkcalendar--get-display-options"></a><h3>gtk.Calendar.get_display_options</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_display_options</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>the calendar display options</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.4 and above.</p></div><p>The <code class="methodname">get_display_options</code>() method
returns the current calendar display options. See the <a class="link" href="class-gtkcalendar.html#method-gtkcalendar--set-display-options" title="gtk.Calendar.set_display_options"><code class="methodname">set_display_options</code>()</a>
method for more information.</p></div><div class="refsect2" title="gtk.Calendar.set_display_options"><a name="method-gtkcalendar--set-display-options"></a><h3>gtk.Calendar.set_display_options</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_display_options</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>flags</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>flags</code></strong> :</span></p></td><td>the new calendar display
options</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.4 and above.</p></div><p>The <code class="methodname">set_display_options</code>() method sets the
calendar display options to the value specified by
<em class="parameter"><code>flags</code></em>. The possible display options are a combination
of:</p><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><code class="literal">gtk.CALENDAR_SHOW_HEADING</code></span></p></td><td>Specifies that the month and year should be
displayed.</td></tr><tr><td><p><span class="term"><code class="literal">gtk.CALENDAR_SHOW_DAY_NAMES</code></span></p></td><td>Specifies that three letter day descriptions should be
present.</td></tr><tr><td><p><span class="term"><code class="literal">gtk.CALENDAR_NO_MONTH_CHANGE</code></span></p></td><td>Prevents the user from switching months with the
calendar.</td></tr><tr><td><p><span class="term"><code class="literal">gtk.CALENDAR_SHOW_WEEK_NUMBERS</code></span></p></td><td>Displays each week numbers of the current year, down
the left side of the calendar.</td></tr><tr><td><p><span class="term"><code class="literal">gtk.CALENDAR_WEEK_START_MONDAY</code></span></p></td><td>Starts the calendar week on Monday, instead of the
default Sunday.</td></tr></tbody></table><p>The display options can be removed by passing 0 as the value of
<em class="parameter"><code>flags</code></em>.</p></div><div class="refsect2" title="gtk.Calendar.get_detail_height_rows"><a name="method-gtkcalendar--get-detail-height-rows"></a><h3>gtk.Calendar.get_detail_height_rows</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_detail_height_rows</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>The height of detail cells, in rows.</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.14 and above.</p></div><p>
The <code class="methodname">get_detail_height_rows</code>() method
queries the height of detail cells, in rows. See the "detail-width-chars" property.
</p></div><div class="refsect2" title="gtk.Calendar.set_detail_height_rows"><a name="method-gtkcalendar--set-detail-height-rows"></a><h3>gtk.Calendar.set_detail_height_rows</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_detail_height_rows</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>rows</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>rows</code></strong> :</span></p></td><td>detail height in rows.</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.14 and above.</p></div><p>
The <code class="methodname">set_detail_height_rows</code>() method
updates the height of detail cells. See the "detail-height-rows" property.
</p></div><div class="refsect2" title="gtk.Calendar.get_detail_width_chars"><a name="method-gtkcalendar--get-detail-width-chars"></a><h3>gtk.Calendar.get_detail_width_chars</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_detail_width_chars</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>The width of detail cells, in characters.</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.14 and above.</p></div><p>
The <code class="methodname">get_detail_width_chars</code>() method
queries the width of detail cells, in characters. See the "detail-width-chars" property.
</p></div><div class="refsect2" title="gtk.Calendar.set_detail_width_chars"><a name="method-gtkcalendar--set-detail-width-chars"></a><h3>gtk.Calendar.set_detail_width_chars</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_detail_width_chars</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>chars</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>chars</code></strong> :</span></p></td><td>detail width in characters.</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.14 and above.</p></div><p>
The <code class="methodname">set_detail_width_chars</code>() method
updates the width of detail cells. See the "detail-width-chars" property.
</p></div><div class="refsect2" title="gtk.Calendar.display_options"><a name="method-gtkcalendar--display-options"></a><h3>gtk.Calendar.display_options</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">display_options</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>flags</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>flags</code></strong> :</span></p></td><td>the new calendar display
options</td></tr></tbody></table><div class="warning" title="Warning" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Warning</h3><p>This method is deprecated in PyGTK 2.4 and should be replaced
by the <a class="link" href="class-gtkcalendar.html#method-gtkcalendar--set-display-options" title="gtk.Calendar.set_display_options"><code class="methodname">set_display_options</code>()</a>
method.</p></div><p>The <code class="methodname">display_options</code>() method sets the
calendar display options to the value specified by
<em class="parameter"><code>flags</code></em>. The possible display options are a combination
of:</p><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><code class="literal">gtk.CALENDAR_SHOW_HEADING</code></span></p></td><td>Specifies that the month and year should be
displayed.</td></tr><tr><td><p><span class="term"><code class="literal">gtk.CALENDAR_SHOW_DAY_NAMES</code></span></p></td><td>Specifies that three letter day descriptions should be
present.</td></tr><tr><td><p><span class="term"><code class="literal">gtk.CALENDAR_NO_MONTH_CHANGE</code></span></p></td><td>Prevents the user from switching months with the
calendar.</td></tr><tr><td><p><span class="term"><code class="literal">gtk.CALENDAR_SHOW_WEEK_NUMBERS</code></span></p></td><td>Displays each week numbers of the current year, down
the left side of the calendar.</td></tr><tr><td><p><span class="term"><code class="literal">gtk.CALENDAR_WEEK_START_MONDAY</code></span></p></td><td>Starts the calendar week on Monday, instead of the
default Sunday.</td></tr></tbody></table><p>The display options can be removed by passing 0 as the value of
<em class="parameter"><code>flags</code></em>.</p></div><div class="refsect2" title="gtk.Calendar.get_date"><a name="method-gtkcalendar--get-date"></a><h3>gtk.Calendar.get_date</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_date</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>a tuple containing the year, month and
day</td></tr></tbody></table><p>The <code class="methodname">get_date</code>() method retrieves the
calendar's current year, month and selected day numbers as a tuple (year,
month, day).</p><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>Note that month is zero-based (i.e it allowed values are 0-11) while selected_day
is one-based (i.e. allowed values are 1-31).</p></div></div><div class="refsect2" title="gtk.Calendar.freeze"><a name="method-gtkcalendar--freeze"></a><h3>gtk.Calendar.freeze</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">freeze</span>(<span class="methodparam"></span>)</code></pre><div class="warning" title="Warning" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Warning</h3><p>This method is deprecated since PyGTK 2.8 and should not be used in newly-written code.</p></div><p>The <code class="methodname">freeze</code>() method stops the update of
the calendar display until the <a class="link" href="class-gtkcalendar.html#method-gtkcalendar--thaw" title="gtk.Calendar.thaw"><code class="methodname">thaw</code>()</a>
method is called. This method is used to reduce calendar flicker when doing
a large number of updates to the calendar.</p></div><div class="refsect2" title="gtk.Calendar.thaw"><a name="method-gtkcalendar--thaw"></a><h3>gtk.Calendar.thaw</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">thaw</span>(<span class="methodparam"></span>)</code></pre><div class="warning" title="Warning" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Warning</h3><p>This method is deprecated since PyGTK 2.8 and should not be used in newly-written code.</p></div><p>The <code class="methodname">thaw</code>() method reenables the update
of the calendar after a <a class="link" href="class-gtkcalendar.html#method-gtkcalendar--freeze" title="gtk.Calendar.freeze"><code class="methodname">freeze</code>()</a>
method is called. All changes made since the last <a class="link" href="class-gtkcalendar.html#method-gtkcalendar--freeze" title="gtk.Calendar.freeze"><code class="methodname">freeze</code>()</a>
are displayed</p></div></div><div class="refsect1" title="Signals"><a name="id3625267"></a><h2>Signals</h2><div class="refsect2" title='The "day-selected" gtk.Calendar Signal'><a name="signal-gtkcalendar--day-selected"></a><h3>The "day-selected" gtk.Calendar Signal</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>calendar</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><em class="parameter"><code>calendar</code></em> :</span></p></td><td>the calendar that received the
signal</td></tr><tr><td><p><span class="term"><em class="parameter"><code>user_param1</code></em> :</span></p></td><td>the first user parameter (if any) specified
with the <PYGTKDOCLINK HREF="method-gobject--connect"><code class="methodname">connect</code>()</PYGTKDOCLINK>
method</td></tr><tr><td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td><td>additional user parameters (if
any)</td></tr></tbody></table><p>The "day-selected" signal is emitted when a day is selected
either by the user or programatically.</p></div><div class="refsect2" title='The "day-selected-double-click" gtk.Calendar Signal'><a name="signal-gtkcalendar--day-selected-double-click"></a><h3>The "day-selected-double-click" gtk.Calendar Signal</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>calendar</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><em class="parameter"><code>calendar</code></em> :</span></p></td><td>the calendar that received the
signal</td></tr><tr><td><p><span class="term"><em class="parameter"><code>user_param1</code></em> :</span></p></td><td>the first user parameter (if any) specified
with the <PYGTKDOCLINK HREF="method-gobject--connect"><code class="methodname">connect</code>()</PYGTKDOCLINK>
method</td></tr><tr><td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td><td>additional user parameters (if
any)</td></tr></tbody></table><p>The "day-selected-double-click" signal is emitted when a
calendar day is doubled-clicked by the user.</p></div><div class="refsect2" title='The "month-changed" gtk.Calendar Signal'><a name="signal-gtkcalendar--month-changed"></a><h3>The "month-changed" gtk.Calendar Signal</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>calendar</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><em class="parameter"><code>calendar</code></em> :</span></p></td><td>the calendar that received the
signal</td></tr><tr><td><p><span class="term"><em class="parameter"><code>user_param1</code></em> :</span></p></td><td>the first user parameter (if any) specified
with the <PYGTKDOCLINK HREF="method-gobject--connect"><code class="methodname">connect</code>()</PYGTKDOCLINK>
method</td></tr><tr><td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td><td>additional user parameters (if
any)</td></tr></tbody></table><p>The "month-changed" signal is emitted when the calendar month is
changed programatically or by the user.</p></div><div class="refsect2" title='The "next-month" gtk.Calendar Signal'><a name="signal-gtkcalendar--next-month"></a><h3>The "next-month" gtk.Calendar Signal</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>calendar</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><em class="parameter"><code>calendar</code></em> :</span></p></td><td>the calendar that received the
signal</td></tr><tr><td><p><span class="term"><em class="parameter"><code>user_param1</code></em> :</span></p></td><td>the first user parameter (if any) specified
with the <PYGTKDOCLINK HREF="method-gobject--connect"><code class="methodname">connect</code>()</PYGTKDOCLINK>
method</td></tr><tr><td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td><td>additional user parameters (if
any)</td></tr></tbody></table><p>The "next-month" signal is emitted when the user clicks the
"next-month" navigation control in the calendar header.</p></div><div class="refsect2" title='The "next-year" gtk.Calendar Signal'><a name="signal-gtkcalendar--next-year"></a><h3>The "next-year" gtk.Calendar Signal</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>calendar</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><em class="parameter"><code>calendar</code></em> :</span></p></td><td>the calendar that received the
signal</td></tr><tr><td><p><span class="term"><em class="parameter"><code>user_param1</code></em> :</span></p></td><td>the first user parameter (if any) specified
with the <PYGTKDOCLINK HREF="method-gobject--connect"><code class="methodname">connect</code>()</PYGTKDOCLINK>
method</td></tr><tr><td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td><td>additional user parameters (if
any)</td></tr></tbody></table><p>The "next-year" signal is emitted when the user clicks the
"next-year" navigation control in the calendar header.</p></div><div class="refsect2" title='The "prev-month" gtk.Calendar Signal'><a name="signal-gtkcalendar--prev-month"></a><h3>The "prev-month" gtk.Calendar Signal</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>calendar</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><em class="parameter"><code>calendar</code></em> :</span></p></td><td>the calendar that received the
signal</td></tr><tr><td><p><span class="term"><em class="parameter"><code>user_param1</code></em> :</span></p></td><td>the first user parameter (if any) specified
with the <PYGTKDOCLINK HREF="method-gobject--connect"><code class="methodname">connect</code>()</PYGTKDOCLINK>
method</td></tr><tr><td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td><td>additional user parameters (if
any)</td></tr></tbody></table><p>The "prev-month" signal is emitted when the user clicks the
"prev-month" navigation control in the calendar header.</p></div><div class="refsect2" title='The "prev-year" gtk.Calendar Signal'><a name="signal-gtkcalendar--prev-year"></a><h3>The "prev-year" gtk.Calendar Signal</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>calendar</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><em class="parameter"><code>calendar</code></em> :</span></p></td><td>the calendar that received the
signal</td></tr><tr><td><p><span class="term"><em class="parameter"><code>user_param1</code></em> :</span></p></td><td>the first user parameter (if any) specified
with the <PYGTKDOCLINK HREF="method-gobject--connect"><code class="methodname">connect</code>()</PYGTKDOCLINK>
method</td></tr><tr><td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td><td>additional user parameters (if
any)</td></tr></tbody></table><p>The "prev-year" signal is emitted when the user clicks the
"prev-year" navigation control in the calendar header.</p></div></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="class-gtkbuttonbox.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="gtk-class-reference.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="class-gtkcelleditable.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">gtk.ButtonBox </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> gtk.CellEditable</td></tr></table></div></body></html>
|