LibreOffice
LibreOffice 5.3 SDK API Reference
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Variables
com::sun::star::i18n::CalendarFieldIndex Constant Group Referencepublished

Field indices to be passed to various XCalendar methods. More...

Variables

const short AM_PM = 0
 Get AmPmValue. More...
 
const short DAY_OF_MONTH = 1
 Get/Set day of month [1-31]. More...
 
const short DAY_OF_WEEK = 2
 Get day of week [0-6]. More...
 
const short DAY_OF_YEAR = 3
 Get day of year. More...
 
const short DST_OFFSET = 4
 Get daylight saving time offset in minutes, e.g. More...
 
const short HOUR = 5
 Get/Set hour [0-23]. More...
 
const short MINUTE = 6
 Get/Set minute [0-59]. More...
 
const short SECOND = 7
 Get/Set second [0-59]. More...
 
const short MILLISECOND = 8
 Get/Set milliseconds [0-999]. More...
 
const short WEEK_OF_MONTH = 9
 Get week of month. More...
 
const short WEEK_OF_YEAR = 10
 Get week of year. More...
 
const short YEAR = 11
 Get/Set year. More...
 
const short MONTH = 12
 Get/Set month [0-...]. More...
 
const short ERA = 13
 Get/Set era, for example, 0:= Before Christ, 1:= After Christ. More...
 
const short ZONE_OFFSET = 14
 Get/Set time zone offset in minutes, e.g. [-14*60..14*60]. More...
 
const short FIELD_COUNT = 15
 Total number of fields for < OOo 3.1. More...
 
const short ZONE_OFFSET_SECOND_MILLIS = 15
 Get/Set additional offset in milliseconds that adds to the value of ZONE_OFFSET. More...
 
const short DST_OFFSET_SECOND_MILLIS = 16
 Get additional offset in milliseconds that adds to the value of DST_OFFSET. More...
 
const short FIELD_COUNT2 = 17
 Total number of fields as of OOo 3.1. More...
 

Detailed Description

Field indices to be passed to various XCalendar methods.

Field is writable only if marked both Get/Set.

ZONE_OFFSET and DST_OFFSET cooperate such that both values are added, for example, ZoneOffset=1*60 and DstOffset=1*60 results in a time difference of GMT+2. The calculation in minutes is GMT = LocalTime - ZoneOffset - DstOffset

With introduction of ZONE_OFFSET_SECOND_MILLIS and DST_OFFSET_SECOND_MILLIS the exact calculation in milliseconds is GMT = LocalTime

Variable Documentation

const short AM_PM = 0

Get AmPmValue.

const short DAY_OF_MONTH = 1

Get/Set day of month [1-31].

const short DAY_OF_WEEK = 2

Get day of week [0-6].

const short DAY_OF_YEAR = 3

Get day of year.

const short DST_OFFSET = 4

Get daylight saving time offset in minutes, e.g.

[0*60..1*60]

The DST offset value depends on the actual date set at the calendar and is determined according to the timezone rules of the locale used with the calendar.

Note that there is a bug in OpenOffice.org 1.0 / StarOffice 6.0 that prevents interpreting this value correctly.

const short DST_OFFSET_SECOND_MILLIS = 16

Get additional offset in milliseconds that adds to the value of DST_OFFSET.

This may be necessary to correctly interpret historical timezone data that consists of fractions of minutes, e.g. seconds. 1 minute == 60000 milliseconds.

Attention
Though the field's type is signed 16-bit, the field value is treated as unsigned 16-bit to allow for values up to 60000 and expresses an absolute value that inherits its sign from the parent DST_OFFSET field.
Since
OOo 3.1
const short ERA = 13

Get/Set era, for example, 0:= Before Christ, 1:= After Christ.

const short FIELD_COUNT = 15

Total number of fields for < OOo 3.1.

const short FIELD_COUNT2 = 17

Total number of fields as of OOo 3.1.

Since
OOo 3.1
const short HOUR = 5

Get/Set hour [0-23].

const short MILLISECOND = 8

Get/Set milliseconds [0-999].

const short MINUTE = 6

Get/Set minute [0-59].

const short MONTH = 12

Get/Set month [0-...].

Note that the maximum value is not necessarily 11 for December but depends on the calendar used instead.

const short SECOND = 7

Get/Set second [0-59].

const short WEEK_OF_MONTH = 9

Get week of month.

const short WEEK_OF_YEAR = 10

Get week of year.

const short YEAR = 11

Get/Set year.

const short ZONE_OFFSET = 14

Get/Set time zone offset in minutes, e.g. [-14*60..14*60].

const short ZONE_OFFSET_SECOND_MILLIS = 15

Get/Set additional offset in milliseconds that adds to the value of ZONE_OFFSET.

This may be necessary to correctly interpret historical timezone data that consists of fractions of minutes, e.g. seconds. 1 minute == 60000 milliseconds.

Attention
Though the field's type is signed 16-bit, the field value is treated as unsigned 16-bit to allow for values up to 60000 and expresses an absolute value that inherits its sign from the parent ZONE_OFFSET field.
Since
OOo 3.1