LibreOffice
LibreOffice 5.3 SDK API Reference
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Public Member Functions | List of all members
XCalendar Interface Referencepublished

Access to locale specific calendar systems. More...

import "XCalendar.idl";

Inheritance diagram for XCalendar:
XInterface XExtendedCalendar XCalendar3 LocaleCalendar XCalendar4 LocaleCalendar2

Public Member Functions

void loadDefaultCalendar ([in]::com::sun::star::lang::Locale rLocale)
 Load the default calendar for the given locale. More...
 
void loadCalendar ([in] string uniqueID, [in]::com::sun::star::lang::Locale rLocale)
 Load a specific calendar for the given locale. More...
 
Calendar getLoadedCalendar ()
 Get the currently loaded Calendar. More...
 
sequence< string > getAllCalendars ([in]::com::sun::star::lang::Locale rLocale)
 Returns all available calendars for the given locale. More...
 
string getUniqueID ()
 Returns the ID string of the loaded calendar, for example, "Gregorian" More...
 
void setDateTime ([in] double nTimeInDays)
 Set the UTC date/time as an offset to the start of the calendar at 1-Jan-1970 00:00. More...
 
double getDateTime ()
 Get the UTC date/time as an offset to the start of the calendar at 1-Jan-1970 00:00. More...
 
void setValue ([in] short nCalendarFieldIndex, [in] short nValue)
 Set the value of a field. More...
 
short getValue ([in] short nCalendarFieldIndex)
 Get the value of a field. More...
 
boolean isValid ()
 Verify if the date fields set by a combination of XCalendar::setValue() calls is valid. More...
 
void addValue ([in] short nCalendarFieldIndex, [in] long nAmount)
 Add an amount to a field. More...
 
short getFirstDayOfWeek ()
 returns the first day of a week, one of Weekdays values. More...
 
void setFirstDayOfWeek ([in] short nDay)
 Set the first day of a week, one of Weekdays values. More...
 
void setMinimumNumberOfDaysForFirstWeek ([in] short nDays)
 Set how many days of a week must reside in the first week of a year. More...
 
short getMinimumNumberOfDaysForFirstWeek ()
 returns how many days of a week must reside in the first week of a year. More...
 
short getNumberOfMonthsInYear ()
 returns the number of months in a year, e.g. 12 More...
 
short getNumberOfDaysInWeek ()
 returns the number of days in a week, e.g. 7 More...
 
sequence< CalendarItemgetMonths ()
 returns a sequence of CalendarItem describing the month names. More...
 
sequence< CalendarItemgetDays ()
 returns a sequence of CalendarItem describing the day names. More...
 
string getDisplayName ([in] short nCalendarDisplayIndex, [in] short nIdx, [in] short nNameType)
 Returns a string (name to display) matching the given parameters. More...
 
- Public Member Functions inherited from XInterface
any queryInterface ([in] type aType)
 queries for a new interface to an existing UNO object. More...
 
void acquire ()
 increases the reference counter by one. More...
 
void release ()
 decreases the reference counter by one. More...
 

Detailed Description

Access to locale specific calendar systems.

Developers Guide
OfficeDev - Implementing a New Locale - XCalendar
OfficeDev - Overview and Using the API - XCalendar

Member Function Documentation

void addValue ( [in] short  nCalendarFieldIndex,
[in] long  nAmount 
)

Add an amount to a field.

Parameters
nCalendarFieldIndexOne of CalendarFieldIndex values.
nAmountThe amount to add.
sequence< string > getAllCalendars ( [in] ::com::sun::star::lang::Locale  rLocale)

Returns all available calendars for the given locale.

double getDateTime ( )

Get the UTC date/time as an offset to the start of the calendar at 1-Jan-1970 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.

sequence< CalendarItem > getDays ( )

returns a sequence of CalendarItem describing the day names.

string getDisplayName ( [in] short  nCalendarDisplayIndex,
[in] short  nIdx,
[in] short  nNameType 
)

Returns a string (name to display) matching the given parameters.

Parameters
nCalendarDisplayIndexOne of CalendarDisplayIndex values
nIdxA value matching the nCalendarDisplayIndex type:
CalendarDisplayIndex::AM_PM
one of AmPmValue
CalendarDisplayIndex::DAY
one of Weekdays or a number used as an offset into the corresponding Calendar::Days sequence
CalendarDisplayIndex::MONTH
one of Months or a number used as an offset into the corresponding Calendar::Months sequence
CalendarDisplayIndex::YEAR
not used, empty string returned
CalendarDisplayIndex::ERA
a number used as an offset into the corresponding Calendar:Eras sequence
CalendarDisplayIndex::GENITIVE_MONTH
a number used as an offset into the corresponding Calendar2:GenitiveMonth sequence

The value should be obtained by a previous call to XCalendar::getValue() with an appropriate CalendarFieldIndex argument.

Parameters
nNameTypeA value indicating whether to return the abbreviated or the full name, or the narrow name for some CalendarDisplayIndex values.
0
abbreviated name, e.g. "Jan"
1
full name, e.g. "January"
2
narrow name, e.g. "J"
Valid only for CalendarDisplayIndex::DAY, CalendarDisplayIndex::MONTH and CalendarDisplayIndex::GENITIVE_MONTH
Since
LibreOffice 3.5

This parameter is not used if the nCalendarDisplayIndex argument equals CalendarDisplayIndex::AM_PM

short getFirstDayOfWeek ( )

returns the first day of a week, one of Weekdays values.

Calendar getLoadedCalendar ( )

Get the currently loaded Calendar.

short getMinimumNumberOfDaysForFirstWeek ( )

returns how many days of a week must reside in the first week of a year.

sequence< CalendarItem > getMonths ( )

returns a sequence of CalendarItem describing the month names.

short getNumberOfDaysInWeek ( )

returns the number of days in a week, e.g. 7

short getNumberOfMonthsInYear ( )

returns the number of months in a year, e.g. 12

string getUniqueID ( )

Returns the ID string of the loaded calendar, for example, "Gregorian"

short getValue ( [in] short  nCalendarFieldIndex)

Get the value of a field.

Parameters
nCalendarFieldIndexOne of CalendarFieldIndex values.
boolean isValid ( )

Verify if the date fields set by a combination of XCalendar::setValue() calls is valid.

It has a side-effect because it will internally calculate the final value for the date fields

void loadCalendar ( [in] string  uniqueID,
[in] ::com::sun::star::lang::Locale  rLocale 
)

Load a specific calendar for the given locale.

void loadDefaultCalendar ( [in] ::com::sun::star::lang::Locale  rLocale)

Load the default calendar for the given locale.

void setDateTime ( [in] double  nTimeInDays)

Set the UTC date/time as an offset to the start of the calendar at 1-Jan-1970 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 setFirstDayOfWeek ( [in] short  nDay)

Set the first day of a week, one of Weekdays values.

void setMinimumNumberOfDaysForFirstWeek ( [in] short  nDays)

Set how many days of a week must reside in the first week of a year.

void setValue ( [in] short  nCalendarFieldIndex,
[in] short  nValue 
)

Set the value of a field.

Parameters
nCalendarFieldIndexOne of CalendarFieldIndex values.
nValueA value of the allowed range for the field index.

The documentation for this interface was generated from the following file: