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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
|
<refentry id="lunar-LunarCalendar">
<refmeta>
<refentrytitle role="top_of_page" id="lunar-LunarCalendar.top_of_page">LunarCalendar</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LUNAR Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>LunarCalendar</refname>
<refpurpose>a gtk widget that can displays a chinese lunar calendar</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv id="lunar-LunarCalendar.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
#include <lunar/lunar.h>
<link linkend="LunarCalendar">LunarCalendar</link>;
enum <link linkend="LunarCalendarDisplayOptions">LunarCalendarDisplayOptions</link>;
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="lunar-calendar-new">lunar_calendar_new</link> (void);
<link linkend="gboolean">gboolean</link> <link linkend="lunar-calendar-select-month">lunar_calendar_select_month</link> (<link linkend="LunarCalendar">LunarCalendar</link> *calendar,
<link linkend="guint">guint</link> month,
<link linkend="guint">guint</link> year);
<link linkend="void">void</link> <link linkend="lunar-calendar-select-day">lunar_calendar_select_day</link> (<link linkend="LunarCalendar">LunarCalendar</link> *calendar,
<link linkend="guint">guint</link> day);
<link linkend="gboolean">gboolean</link> <link linkend="lunar-calendar-mark-day">lunar_calendar_mark_day</link> (<link linkend="LunarCalendar">LunarCalendar</link> *calendar,
<link linkend="guint">guint</link> day);
<link linkend="gboolean">gboolean</link> <link linkend="lunar-calendar-unmark-day">lunar_calendar_unmark_day</link> (<link linkend="LunarCalendar">LunarCalendar</link> *calendar,
<link linkend="guint">guint</link> day);
<link linkend="void">void</link> <link linkend="lunar-calendar-clear-marks">lunar_calendar_clear_marks</link> (<link linkend="LunarCalendar">LunarCalendar</link> *calendar);
<link linkend="LunarCalendarDisplayOptions">LunarCalendarDisplayOptions</link> <link linkend="lunar-calendar-get-display-options">lunar_calendar_get_display_options</link>
(<link linkend="LunarCalendar">LunarCalendar</link> *calendar);
<link linkend="void">void</link> <link linkend="lunar-calendar-set-display-options">lunar_calendar_set_display_options</link> (<link linkend="LunarCalendar">LunarCalendar</link> *calendar,
<link linkend="LunarCalendarDisplayOptions">LunarCalendarDisplayOptions</link> flags);
<link linkend="void">void</link> <link linkend="lunar-calendar-display-options">lunar_calendar_display_options</link> (<link linkend="LunarCalendar">LunarCalendar</link> *calendar,
<link linkend="LunarCalendarDisplayOptions">LunarCalendarDisplayOptions</link> flags);
<link linkend="void">void</link> <link linkend="lunar-calendar-get-date">lunar_calendar_get_date</link> (<link linkend="LunarCalendar">LunarCalendar</link> *calendar,
<link linkend="guint">guint</link> *year,
<link linkend="guint">guint</link> *month,
<link linkend="guint">guint</link> *day);
<link linkend="void">void</link> <link linkend="lunar-calendar-freeze">lunar_calendar_freeze</link> (<link linkend="LunarCalendar">LunarCalendar</link> *calendar);
<link linkend="void">void</link> <link linkend="lunar-calendar-thaw">lunar_calendar_thaw</link> (<link linkend="LunarCalendar">LunarCalendar</link> *calendar);
</synopsis>
</refsynopsisdiv>
<refsect1 id="lunar-LunarCalendar.description" role="desc">
<title role="desc.title">Description</title>
<para>
</para>
</refsect1>
<refsect1 id="lunar-LunarCalendar.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="LunarCalendar" role="struct">
<title>LunarCalendar</title>
<indexterm zone="LunarCalendar"><primary>LunarCalendar</primary></indexterm><programlisting>typedef struct {
GtkWidget widget;
GtkStyle *header_style;
GtkStyle *label_style;
gint month;
gint year;
gint selected_day;
gint day_month[6][7];
gint day[6][7];
gint num_marked_dates;
gint marked_date[31];
LunarCalendarDisplayOptions display_flags;
GdkColor marked_date_color[31];
GdkGC *gc; /* unused */
GdkGC *xor_gc; /* unused */
gint focus_row;
gint focus_col;
gint highlight_row;
gint highlight_col;
LunarCalendarPrivate *priv;
gchar grow_space [32];
/* Padding for future expansion */
void (*_gtk_reserved1) (void);
void (*_gtk_reserved2) (void);
void (*_gtk_reserved3) (void);
void (*_gtk_reserved4) (void);
} LunarCalendar;
</programlisting>
<para>
</para></refsect2>
<refsect2 id="LunarCalendarDisplayOptions" role="enum">
<title>enum LunarCalendarDisplayOptions</title>
<indexterm zone="LunarCalendarDisplayOptions"><primary>LunarCalendarDisplayOptions</primary></indexterm><programlisting>typedef enum
{
LUNAR_CALENDAR_SHOW_HEADING = 1 << 0,
LUNAR_CALENDAR_SHOW_DAY_NAMES = 1 << 1,
LUNAR_CALENDAR_NO_MONTH_CHANGE = 1 << 2,
LUNAR_CALENDAR_SHOW_WEEK_NUMBERS = 1 << 3,
LUNAR_CALENDAR_WEEK_START_MONDAY = 1 << 4,
LUNAR_CALENDAR_SHOW_LUNAR = 1 << 5
} LunarCalendarDisplayOptions;
</programlisting>
<para>
</para></refsect2>
<refsect2 id="lunar-calendar-new" role="function">
<title>lunar_calendar_new ()</title>
<indexterm zone="lunar-calendar-new"><primary>lunar_calendar_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* lunar_calendar_new (void);</programlisting>
<para>
Creates a new calendar, with the current date being selected.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a newly <link linkend="LunarCalendar"><type>LunarCalendar</type></link> widget
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="lunar-calendar-select-month" role="function">
<title>lunar_calendar_select_month ()</title>
<indexterm zone="lunar-calendar-select-month"><primary>lunar_calendar_select_month</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> lunar_calendar_select_month (<link linkend="LunarCalendar">LunarCalendar</link> *calendar,
<link linkend="guint">guint</link> month,
<link linkend="guint">guint</link> year);</programlisting>
<para>
Shifts the calendar to a different month.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>calendar</parameter> :</term>
<listitem><simpara> a <link linkend="LunarCalendar"><type>LunarCalendar</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>month</parameter> :</term>
<listitem><simpara> a month number between 0 and 11.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>year</parameter> :</term>
<listitem><simpara> the year the month is in.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link>, always
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="lunar-calendar-select-day" role="function">
<title>lunar_calendar_select_day ()</title>
<indexterm zone="lunar-calendar-select-day"><primary>lunar_calendar_select_day</primary></indexterm><programlisting><link linkend="void">void</link> lunar_calendar_select_day (<link linkend="LunarCalendar">LunarCalendar</link> *calendar,
<link linkend="guint">guint</link> day);</programlisting>
<para>
Selects a day from the current month.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>calendar</parameter> :</term>
<listitem><simpara> a <link linkend="LunarCalendar"><type>LunarCalendar</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>day</parameter> :</term>
<listitem><simpara> the day number between 1 and 31, or 0 to unselect
the currently selected day.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="lunar-calendar-mark-day" role="function">
<title>lunar_calendar_mark_day ()</title>
<indexterm zone="lunar-calendar-mark-day"><primary>lunar_calendar_mark_day</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> lunar_calendar_mark_day (<link linkend="LunarCalendar">LunarCalendar</link> *calendar,
<link linkend="guint">guint</link> day);</programlisting>
<para>
Places a visual marker on a particular day.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>calendar</parameter> :</term>
<listitem><simpara> a <link linkend="LunarCalendar"><type>LunarCalendar</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>day</parameter> :</term>
<listitem><simpara> the day number to mark between 1 and 31.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link>, always
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="lunar-calendar-unmark-day" role="function">
<title>lunar_calendar_unmark_day ()</title>
<indexterm zone="lunar-calendar-unmark-day"><primary>lunar_calendar_unmark_day</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> lunar_calendar_unmark_day (<link linkend="LunarCalendar">LunarCalendar</link> *calendar,
<link linkend="guint">guint</link> day);</programlisting>
<para>
Removes the visual marker from a particular day.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>calendar</parameter> :</term>
<listitem><simpara> a <link linkend="LunarCalendar"><type>LunarCalendar</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>day</parameter> :</term>
<listitem><simpara> the day number to unmark between 1 and 31.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link>, always
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="lunar-calendar-clear-marks" role="function">
<title>lunar_calendar_clear_marks ()</title>
<indexterm zone="lunar-calendar-clear-marks"><primary>lunar_calendar_clear_marks</primary></indexterm><programlisting><link linkend="void">void</link> lunar_calendar_clear_marks (<link linkend="LunarCalendar">LunarCalendar</link> *calendar);</programlisting>
<para>
Remove all visual markers.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>calendar</parameter> :</term>
<listitem><simpara> a <link linkend="LunarCalendar"><type>LunarCalendar</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="lunar-calendar-get-display-options" role="function" condition="since:2.4">
<title>lunar_calendar_get_display_options ()</title>
<indexterm zone="lunar-calendar-get-display-options" role="2.4"><primary>lunar_calendar_get_display_options</primary></indexterm><programlisting><link linkend="LunarCalendarDisplayOptions">LunarCalendarDisplayOptions</link> lunar_calendar_get_display_options
(<link linkend="LunarCalendar">LunarCalendar</link> *calendar);</programlisting>
<para>
Returns the current display options of <parameter>calendar</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>calendar</parameter> :</term>
<listitem><simpara> a <link linkend="LunarCalendar"><type>LunarCalendar</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the display options.
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.4
</para></refsect2>
<refsect2 id="lunar-calendar-set-display-options" role="function" condition="since:2.4">
<title>lunar_calendar_set_display_options ()</title>
<indexterm zone="lunar-calendar-set-display-options" role="2.4"><primary>lunar_calendar_set_display_options</primary></indexterm><programlisting><link linkend="void">void</link> lunar_calendar_set_display_options (<link linkend="LunarCalendar">LunarCalendar</link> *calendar,
<link linkend="LunarCalendarDisplayOptions">LunarCalendarDisplayOptions</link> flags);</programlisting>
<para>
Sets display options (whether to display the heading and the month
headings).</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>calendar</parameter> :</term>
<listitem><simpara> a <link linkend="LunarCalendar"><type>LunarCalendar</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>flags</parameter> :</term>
<listitem><simpara> the display options to set
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.4
</para></refsect2>
<refsect2 id="lunar-calendar-display-options" role="function" condition="deprecated:2.4: Use lunar_calendar_set_display_options() instead">
<title>lunar_calendar_display_options ()</title>
<indexterm zone="lunar-calendar-display-options" role="deprecated"><primary>lunar_calendar_display_options</primary></indexterm><programlisting><link linkend="void">void</link> lunar_calendar_display_options (<link linkend="LunarCalendar">LunarCalendar</link> *calendar,
<link linkend="LunarCalendarDisplayOptions">LunarCalendarDisplayOptions</link> flags);</programlisting>
<warning><para><literal>lunar_calendar_display_options</literal> has been deprecated since version 2.4 and should not be used in newly-written code. Use <link linkend="lunar-calendar-set-display-options"><function>lunar_calendar_set_display_options()</function></link> instead</para></warning>
<para>
Sets display options (whether to display the heading and the month headings).</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>calendar</parameter> :</term>
<listitem><simpara> a <link linkend="LunarCalendar"><type>LunarCalendar</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>flags</parameter> :</term>
<listitem><simpara> the display options to set.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="lunar-calendar-get-date" role="function">
<title>lunar_calendar_get_date ()</title>
<indexterm zone="lunar-calendar-get-date"><primary>lunar_calendar_get_date</primary></indexterm><programlisting><link linkend="void">void</link> lunar_calendar_get_date (<link linkend="LunarCalendar">LunarCalendar</link> *calendar,
<link linkend="guint">guint</link> *year,
<link linkend="guint">guint</link> *month,
<link linkend="guint">guint</link> *day);</programlisting>
<para>
Obtains the selected date from a <link linkend="LunarCalendar"><type>LunarCalendar</type></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>calendar</parameter> :</term>
<listitem><simpara> a <link linkend="LunarCalendar"><type>LunarCalendar</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>year</parameter> :</term>
<listitem><simpara> location to store the year number, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>month</parameter> :</term>
<listitem><simpara> location to store the month number (between 0 and 11), or <link linkend="NULL:CAPS"><literal>NULL</literal></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>day</parameter> :</term>
<listitem><simpara> location to store the day number (between 1 and 31), or <link linkend="NULL:CAPS"><literal>NULL</literal></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="lunar-calendar-freeze" role="function" condition="deprecated:2.8:">
<title>lunar_calendar_freeze ()</title>
<indexterm zone="lunar-calendar-freeze" role="deprecated"><primary>lunar_calendar_freeze</primary></indexterm><programlisting><link linkend="void">void</link> lunar_calendar_freeze (<link linkend="LunarCalendar">LunarCalendar</link> *calendar);</programlisting>
<warning><para><literal>lunar_calendar_freeze</literal> has been deprecated since version 2.8 and should not be used in newly-written code. </para></warning>
<para>
Does nothing. Previously locked the display of the calendar until
it was thawed with <link linkend="lunar-calendar-thaw"><function>lunar_calendar_thaw()</function></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>calendar</parameter> :</term>
<listitem><simpara> a <link linkend="LunarCalendar"><type>LunarCalendar</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="lunar-calendar-thaw" role="function" condition="deprecated:2.8:">
<title>lunar_calendar_thaw ()</title>
<indexterm zone="lunar-calendar-thaw" role="deprecated"><primary>lunar_calendar_thaw</primary></indexterm><programlisting><link linkend="void">void</link> lunar_calendar_thaw (<link linkend="LunarCalendar">LunarCalendar</link> *calendar);</programlisting>
<warning><para><literal>lunar_calendar_thaw</literal> has been deprecated since version 2.8 and should not be used in newly-written code. </para></warning>
<para>
Does nothing. Previously defrosted a calendar; all the changes made
since the last <link linkend="lunar-calendar-freeze"><function>lunar_calendar_freeze()</function></link> were displayed.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>calendar</parameter> :</term>
<listitem><simpara> a <link linkend="LunarCalendar"><type>LunarCalendar</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>
|
