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
|
/*************************************************************************
*
* $RCSfile: XCalendar.idl,v $
*
* $Revision: 1.5 $
*
* last change: $Author: mi $ $Date: 2000-12-19 16:03:33 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
*
* - GNU Lesser General Public License Version 2.1
* - Sun Industry Standards Source License Version 1.1
*
* Sun Microsystems Inc., October, 2000
*
* GNU Lesser General Public License Version 2.1
* =============================================
* Copyright 2000 by Sun Microsystems, Inc.
* 901 San Antonio Road, Palo Alto, CA 94303, USA
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License version 2.1, as published by the Free Software Foundation.
*
* 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston,
* MA 02111-1307 USA
*
*
* Sun Industry Standards Source License Version 1.1
* =================================================
* The contents of this file are subject to the Sun Industry Standards
* Source License Version 1.1 (the "License"); You may not use this file
* except in compliance with the License. You may obtain a copy of the
* License at http://www.openoffice.org/license.html.
*
* Software provided under this License is provided on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
* WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
* MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
* See the License for the specific provisions governing your rights and
* obligations concerning the Software.
*
* The Initial Developer of the Original Code is: Sun Microsystems, Inc.
*
* Copyright: 2000 by Sun Microsystems, Inc.
*
* All Rights Reserved.
*
* Contributor(s): _______________________________________
*
*
************************************************************************/
#ifndef __com_sun_star_i18n_XCalendar_idl__
#define __com_sun_star_i18n_XCalendar_idl__
#include <com/sun/star/lang/Locale.idl>
#include <com/sun/star/i18n/Calendar.idl>
#include <com/sun/star/i18n/CalendarItem.idl>
//=============================================================================
module com { module sun { module star { module i18n {
//=============================================================================
/**
This interface provides access to locale specific calendar systems.
*/
[ uik(721dcc9d-0503-4357-a56ecdae-ea36e29f), ident( "XCalendar", 1.0 ) ]
interface XCalendar : com::sun::star::uno::XInterface
{
/// load the default calendar for the given locale
void loadDefaultCalendar( [in] ::com::sun::star::lang::Locale rLocale );
/// load a specific calendar for the given locale
void loadCalendar( [in] string uniqueID, [in] ::com::sun::star::lang::Locale rLocale );
/// get the current loaded <type>Calendar</type>
Calendar getLoadedCalendar();
/// returns all available calendars for the given locale
sequence< string > getAllCalendars( [in] ::com::sun::star::lang::Locale rLocale );
/// returns the ID string of the loaded calendar, e.g. <bold>gregorian</bold>
string getUniqueID();
/**
Set the date/time as an offset to the start of the calendar at 1Jan1970 00:00
The integer part represents the number of days passed since start date.
The fractional part represents fractions of a day, thus 0.5 means 12 hours.
*/
void setDateTime( [in] double nTimeInDays );
/**
Get the date/time as an offset to the start of the calendar at 1Jan1970 00:00
The integer part represents the number of days passed since start date.
The fractional part represents fractions of a day, thus 0.5 means 12 hours.
*/
double getDateTime();
/**
Set the value of a field.
@param nCalendarFieldIndex
one of <type>CalendarFieldIndex</type> values
@param nValue
a value of the allowed range for the field index
*/
void setValue( [in] short nCalendarFieldIndex, [in] short nValue );
/**
Get the value of a field.
@param nCalendarFieldIndex
one of <type>CalendarFieldIndex</type> values
*/
short getValue( [in] short nCalendarFieldIndex );
/**
Add an amount to a field.
@param nCalendarFieldIndex
one of <type>CalendarFieldIndex</type> values
@param nAmount
the amount to add
*/
void addValue( [in] short nCalendarFieldIndex, [in] long nAmount );
/// returns the first day of a week, one of <type>Weekdays</type> values
short getFirstDayOfWeek();
/// set the first day of a week, one of <type>Weekdays</type> values
void setFirstDayOfWeek( [in] short nDay );
/// set how many days of a week must reside in the first week of a year
void setMinimumNumberOfDaysForFirstWeek( [in] short nDays );
/// returns how many days of a week must reside in the first week of a year
short getMinimumNumberOfDaysForFirstWeek();
/// returns the number of months in a year, e.g. <bold>12</bold>
short getNumberOfMonthsInYear();
/// returns the number of days in a week, e.g. <bold>7</bold>
short getNumberOfDaysInWeek();
/// returns a sequence of <type>CalendarItem</type> describing the month names
sequence< CalendarItem > getMonths();
/// returns a sequence of <type>CalendarItem</type> describing the day names
sequence< CalendarItem > getDays();
/**
Returns a string (name to display) matching the given parameters.
@param nCalendarDisplayIndex
one of <type>CalendarDisplayIndex</type> values
@param nIdx
A value matching the <type>CalendarDisplayIndex</type> type:
<emp>AM_PM</emp> => one of <type>AmPmValue</type>
<emp>DAY</emp> => one of <type>Weekdays</type>
<emp>MONTH</emp> => one of <type>Months</type>
<emp>YEAR</emp> => <bold>not used, empty string returned</bold>
<emp>ERA</emp> => one of ???
The value should be obtained by a previous call to
<member>XCalendar::getValue()</member> with an appropriate
<type>CalendarFieldIndex</type> argument.
@param nNameType
0 => abbreviated name, e.g. <bold>Jan</bold>
1 => full name, e.g. <bold>January</bold>
This parameter is not used if the <emp>nCalendarDisplayIndex<emp>
argument equals <type>CalendarDisplayIndex::AM_PM</type>
*/
string getDisplayName( [in] short nCalendarDisplayIndex, [in] short nIdx, [in] short nNameType );
};
//=============================================================================
}; }; }; };
//=============================================================================
#endif
|
