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
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
|
/*
Copyright (c) 2002 Carlos Moro <[email protected]>
Copyright (c) 2002-2003 Hans Petter Bieker <[email protected]>
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Library General Public
License as published by the Free Software Foundation; either
version 2 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Library General Public License for more details.
You should have received a copy of the GNU Library General Public License
along with this library; see the file COPYING.LIB. If not, write to
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.
*/
#ifndef KCALENDARSYSTEM_H
#define KCALENDARSYSTEM_H
#include <tqdatetime.h>
#include <tqstring.h>
#include "kdelibs_export.h"
class KLocale;
class KCalendarSystemPrivate;
/**
* CalendarSystem abstract class, default derived kde gregorian class and
* factory class. Provides support for different calendar types for kde
* calendar widget and related stuff.
*
* Derived classes must be created through KCalendarFactory class
*
* @author Carlos Moro <[email protected]>
* @since 3.2
*/
class TDECORE_EXPORT KCalendarSystem
{
public:
/**
* Constructor of abstract calendar class. This will be called by the derived classes.
*
* @param locale It will use this locale for translations, 0 means global.
*/
KCalendarSystem(const KLocale * locale = 0);
/**
* Descructor.
*/
virtual ~KCalendarSystem();
/**
* Gets specific calendar type year for a given gregorian date
*
* @param date gregorian date
* @return year
*/
virtual int year (const TQDate & date) const = 0;
/**
* Converts a date into a year literal
*
* @param pDate The date to convert
* @param bShort If the short version of should be used
* @return The year literal of the date
*/
virtual TQString yearString(const TQDate & pDate, bool bShort) const;
/**
* Converts a year literal of a part of a string into a integer starting at the beginning of the string
*
* @param sNum The string to parse
* @param iLength The number of QChars used, and 0 if no valid symbols was found in the string
* @return An integer corresponding to the year
*/
virtual int yearStringToInteger(const TQString & sNum, int & iLength) const;
/**
* Gets specific calendar type month for a given gregorian date
*
* @param date gregorian date
* @return month number
*/
virtual int month (const TQDate & date) const = 0;
/**
* Converts a date into a month literal
*
* @param pDate The date to convert
* @param bShort If the short version of should be used
* @return The month literal of the date
*/
virtual TQString monthString(const TQDate & pDate, bool bShort) const;
/**
* Converts a month literal of a part of a string into a integer starting at the beginning of the string
*
* @param sNum The string to parse
* @param iLength The number of QChars used, and 0 if no valid symbols was found in the string
* @return An integer corresponding to the month
*/
virtual int monthStringToInteger(const TQString & sNum, int & iLength) const;
/**
* Gets specific calendar type day number of month for a given date
*
* @param date gregorian date equivalent to the specific one
* @return day of the month
*/
virtual int day (const TQDate & date) const = 0;
/**
* Converts a date into a day literal
*
* @param pDate The date to convert
* @param bShort If the short version of should be used
* @return The day literal of the date
*/
virtual TQString dayString(const TQDate & pDate, bool bShort) const;
/**
* Converts a day literal of a part of a string into a integer starting at the beginning of the string
*
* @param sNum The string to parse
* @param iLength The number of QChars used, and 0 if no valid symbols was found in the string
* @return An integer corresponding to the day
*/
virtual int dayStringToInteger(const TQString & sNum, int & iLength) const;
/**
* Gets specific calendar type number of day of week number for a given
* date
*
* @param date gregorian date
* @return day of week
*/
virtual int dayOfWeek (const TQDate & date) const = 0;
/**
* Gets specific calendar type day number of year for a given date
*
* @param date gregorian date equivalent to the specific one
* @return day number
*/
virtual int dayOfYear (const TQDate & date) const = 0;
/**
* Changes the date's year, month and day. The range of the year, month
* and day depends on which calendar is being used.
*
* @param date Date to change
* @param y Year
* @param m Month number
* @param d Day of month
* @return true if the date is valid; otherwise returns false.
*/
virtual bool setYMD(TQDate & date, int y, int m, int d) const = 0;
/**
* Returns a TQDate object containing a date nyears later.
*
* @param date The old date
* @param nyears The number of years to add
* @return The new date
*/
virtual TQDate addYears(const TQDate & date, int nyears) const = 0;
/**
* Returns a TQDate object containing a date nmonths later.
*
* @param date The old date
* @param nmonths The number of months to add
* @return The new date
*/
virtual TQDate addMonths(const TQDate & date, int nmonths) const = 0;
/**
* Returns a TQDate object containing a date ndays later.
*
* @param date The old date
* @param ndays The number of days to add
* @return The new date
*/
virtual TQDate addDays(const TQDate & date, int ndays) const = 0;
/**
* Gets specific calendar type number of month for a given year
*
* @param date The date whose year to use
* @return The number of months in that year
*/
virtual int monthsInYear (const TQDate & date) const = 0;
/**
* Gets the number of days in date whose years specified.
*
* @param date Gregorian date equivalent to the specific one
* @return The number of days in year
*/
virtual int daysInYear (const TQDate & date) const = 0;
/**
* Gets specific calendar type number of days in month for a given date
*
* @param date gregorian date
* @return number of days for month in date
*/
virtual int daysInMonth (const TQDate & date) const = 0;
/**
* Gets the number of weeks in a specified year
*
* @param year the year
* @return number of weeks in year
*/
virtual int weeksInYear(int year) const = 0;
/**
* Gets specific calendar type week number for a given date
*
* @param date gregorian date
* @param yearNum The year the date belongs to
* @return week number
*/
virtual int weekNumber(const TQDate& date, int * yearNum = 0) const = 0;
/**
* Gets specific calendar type month name for a given month number
* If an invalid month is specified, TQString::null is returned.
*
* @param month The month number
* @param year The year the month belongs to
* @param shortName Specifies if the short month name should be used
* @return The name of the month
*/
virtual TQString monthName (int month, int year, bool shortName = false) const = 0;
/**
* Gets specific calendar type month name for a given gregorian date
*
* @param date Gregorian date
* @param shortName Specifies if the short month name should be used
* @return The name of the month
*/
virtual TQString monthName (const TQDate & date, bool shortName = false ) const = 0;
/**
* Returns a string containing the possessive form of the month name.
* ("of January", "of February", etc.)
* It's needed in long format dates in some languages.
* If an invalid month is specified, TQString::null is returned.
*
* @param month The month number
* @param year The year the month belongs to
* @param shortName Specifies if the short month name should be used
*
* @return The possessive form of the name of the month
*/
virtual TQString monthNamePossessive(int month, int year, bool shortName = false) const = 0;
/**
* Returns a string containing the possessive form of the month name.
* ("of January", "of February", etc.)
* It's needed in long format dates in some languages.
*
* @param date Gregorian date
* @param shortName Specifies if the short month name should be used
*
* @return The possessive form of the name of the month
*/
virtual TQString monthNamePossessive(const TQDate & date, bool shortName = false) const = 0;
/**
* Gets specific calendar type week day name
* If an invalid week day is specified, TQString::null is returned.
*
* @param weekDay number of day in week (1 -> Monday)
* @param shortName short or complete day name
* @return day name
*/
virtual TQString weekDayName (int weekDay, bool shortName = false) const = 0;
/**
* Gets specific calendar type week day name
*
* @param date the date
* @param shortName short or complete day name
* @return day name
*/
virtual TQString weekDayName (const TQDate & date, bool shortName = false) const = 0;
/**
* Gets the first year value supported by specific calendar type
* algorithms.
*
* @return first year supported
*/
virtual int minValidYear () const = 0;
/**
* Gets the maximum year value supported by specific calendar type
* algorithms (TQDate, 8000)
*
* @return maximum year supported
*/
virtual int maxValidYear () const = 0;
/**
* Gets the day of the week traditionaly associated with pray
*
* @return day number
*/
virtual int weekDayOfPray () const = 0;
/**
* Gets the string representing the calendar
*/
virtual TQString calendarName() const = 0;
/**
* Gets if the calendar is lunar based
*
* @return if the calendar is lunar based
*/
virtual bool isLunar() const = 0;
/**
* Gets if the calendar is lunisolar based
*
* @return if the calendar is lunisolar based
*/
virtual bool isLunisolar() const = 0;
/**
* Gets if the calendar is solar based
*
* @return if the calendar is solar based
*/
virtual bool isSolar() const = 0;
protected:
/**
* Gets the locale the calendar uses for translations. Set in
* the constructor.
*/
const KLocale * locale() const;
private:
KCalendarSystemPrivate * d;
};
#endif
|