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
XExtendedCalendar Interface Referencepublished

This interface provides access to locale specific calendar systems. More...

import "XExtendedCalendar.idl";

Inheritance diagram for XExtendedCalendar:
XCalendar XInterface XCalendar3 LocaleCalendar XCalendar4 LocaleCalendar2

Public Member Functions

string getDisplayString ([in] long nCalendarDisplayCode, [in] short nNativeNumberMode)
 Returns a string (number or name to display) matching the given code constant. More...
 
- Public Member Functions inherited from XCalendar
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

This interface provides access to locale specific calendar systems.

It is derived from com::sun::star::i18n::XCalendar and provides additional functionality to display parts of the date currently set at the calendar.

Since
OOo 1.1.2
Developers Guide
OfficeDev - Overview and Using the API - XExtendedCalendar

Member Function Documentation

string getDisplayString ( [in] long  nCalendarDisplayCode,
[in] short  nNativeNumberMode 
)

Returns a string (number or name to display) matching the given code constant.

Note that the string returned depends completely on the locale's calendar. It is not predictable if the string will be numeric or a name, or if in case it returns a numeric string how many digits that will have. For example, a short year display string will normally be two digits with a Gregorian calendar, but with a Jewish calendar it will have three digits.

Parameters
nCalendarDisplayCodeOne of CalendarDisplayCode
nNativeNumberModeOne of NativeNumberMode.
This argument designates the basic transliteration mode as if specified for the year representation. However, depending on the locale, different conversions for year and month, for example, may be chosen internally. This is beyond the user's control and depends on locale specific conventions of how a date is assembled.

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