Sophie

Sophie

distrib > * > cooker > x86_64 > by-pkgid > 5fb1c39f9f9130a3cc01e8b1ffa5c0f8 > files > 3699

libreoffice-devel-3.5.4-4.x86_64.rpm

<html>
<head>
<title>Interface XCalendar</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" type="text/css" href="../../../../idl.css">
</head>
<body>
<div id="adc-idlref">

<a name="_top_"> </a><table class="navimain" border="0" cellpadding="3">
<tr>
<td class="navimain"><a href="../module-ix.html" class="navimain">Overview</a></td>
<td class="navimain"><a href="module-ix.html" class="navimain">Module</a></td>
<td class="navimain"><a href="XCalendar-xref.html" class="navimain">Use</a></td>
<td class="navimain"><a href="#devmanual" class="navimain">Devguide</a></td>
<td class="navimain"><a href="../../../../index-files/index-1.html" class="navimain">Index</a></td>
</tr>
</table>
<table class="navisub" border="0" cellpadding="0">
<tr>
<td class="navisub"><a href="#MethodsSummary" class="navisub">Methods' Summary</a></td>
<td class="navisub">Attributes' Summary</td>
<td class="navisub"><a href="#MethodsDetails" class="navisub">Methods' Details</a></td>
<td class="navisub">Attributes' Details</td>
</tr>
</table>
<hr>
<table border="0" width="100%" cellpadding="5" cellspacing="3" class="title-table" style="margin-bottom:6pt;">
<tr>
<td><p class="namechain"><a href="../../../../module-ix.html" class="namechain">::</a> <a href="../../../module-ix.html" class="namechain">com</a> :: <a href="../../module-ix.html" class="namechain">sun</a> :: <a href="../module-ix.html" class="namechain">star</a> :: <a href="module-ix.html" class="namechain">i18n</a> :: </p>
</td>
</tr>
<tr>
<td class="title">interface XCalendar</td>
</tr>
<tr>
<td/></tr>
<tr>
<td><dl>
<dt><b>Description</b></dt>
<dd>Access to locale specific calendar systems.
 </dd>
</dl>
<a name="devmanual"> </a><dl>
<dt><b>Developers Guide</b></dt>
<dd><a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/OfficeDev/Implementing_a_New_Locale#XCalendar">OfficeDev - Implementing a New Locale - XCalendar</a></dd>
<dd><a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/OfficeDev/Overview_and_Using_the_API#XCalendar">OfficeDev - Overview and Using the API - XCalendar</a></dd>
</dl>
</td>
</tr>
</table>
<hr>
<a name="MethodsSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle">
<tr>
<td class="subtitle" colspan="2">Methods' Summary</td>
</tr>
<tr>
<td class="imsum_left"><a href="#loadDefaultCalendar">loadDefaultCalendar</a></td>
<td class="imsum_right">Load the default calendar for the given locale.&nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#loadCalendar">loadCalendar</a></td>
<td class="imsum_right">Load a specific calendar for the given locale.&nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getLoadedCalendar">getLoadedCalendar</a></td>
<td class="imsum_right">Get the currently loaded <a href="Calendar.html">Calendar</a>.&nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getAllCalendars">getAllCalendars</a></td>
<td class="imsum_right">Returns all available calendars for the given locale.&nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getUniqueID">getUniqueID</a></td>
<td class="imsum_right">Returns the ID string of the loaded calendar, for example,
 <b>"Gregorian"</b>
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#setDateTime">setDateTime</a></td>
<td class="imsum_right">Set the 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.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getDateTime">getDateTime</a></td>
<td class="imsum_right">Get the 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.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#setValue">setValue</a></td>
<td class="imsum_right">Set the value of a field.

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getValue">getValue</a></td>
<td class="imsum_right">Get the value of a field.

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#isValid">isValid</a></td>
<td class="imsum_right">Verify if the date fields set by a combination of
 <a href="XCalendar.html">XCalendar</a>::<a href="XCalendar.html#setValue">setValue()</a> calls is valid. It has a
 side-effect because it will internally calculate the final value
 for the date fields
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#addValue">addValue</a></td>
<td class="imsum_right">Add an amount to a field.

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getFirstDayOfWeek">getFirstDayOfWeek</a></td>
<td class="imsum_right">returns the first day of a week, one of <a href="Weekdays.html">Weekdays</a>
 values.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#setFirstDayOfWeek">setFirstDayOfWeek</a></td>
<td class="imsum_right">Set the first day of a week, one of <a href="Weekdays.html">Weekdays</a>
 values.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#setMinimumNumberOfDaysForFirstWeek">setMinimumNumberOfDaysForFirstWeek</a></td>
<td class="imsum_right">Set how many days of a week must reside in the first week of a
 year.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getMinimumNumberOfDaysForFirstWeek">getMinimumNumberOfDaysForFirstWeek</a></td>
<td class="imsum_right">returns how many days of a week must reside in the first week of
 a year.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getNumberOfMonthsInYear">getNumberOfMonthsInYear</a></td>
<td class="imsum_right">returns the number of months in a year, e.g. <b>12</b>&nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getNumberOfDaysInWeek">getNumberOfDaysInWeek</a></td>
<td class="imsum_right">returns the number of days in a week, e.g. <b>7</b>&nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getMonths">getMonths</a></td>
<td class="imsum_right">returns a sequence of <a href="CalendarItem.html">CalendarItem</a> describing the
 month names.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getDays">getDays</a></td>
<td class="imsum_right">returns a sequence of <a href="CalendarItem.html">CalendarItem</a> describing the
 day names.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getDisplayName">getDisplayName</a></td>
<td class="imsum_right">Returns a string (name to display) matching the given parameters.

 &nbsp;</td>
</tr>
</table>
<a name="MethodsDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle">
<tr>
<td class="subtitle">Methods' Details</td>
</tr>
<tr>
<td class="imdetail"><a name="loadDefaultCalendar" class="membertitle">loadDefaultCalendar</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">void</td>
</tr>
<tr>
<td valign="top"><b>loadDefaultCalendar</b>(</td>
<td valign="top">[in] ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/Locale.html">Locale</a></td>
<td valign="bottom">&nbsp;rLocale );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Load the default calendar for the given locale.</dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="loadCalendar" class="membertitle">loadCalendar</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">void</td>
</tr>
<tr>
<td valign="top"><b>loadCalendar</b>(</td>
<td valign="top">[in] string</td>
<td valign="bottom">&nbsp;uniqueID,</td>
</tr>
<tr>
<td/><td valign="top">[in] ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/Locale.html">Locale</a></td>
<td valign="bottom">&nbsp;rLocale );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Load a specific calendar for the given locale.</dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getLoadedCalendar" class="membertitle">getLoadedCalendar</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3"><a href="Calendar.html">Calendar</a></td>
</tr>
<tr>
<td valign="top"><b>getLoadedCalendar</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Get the currently loaded <a href="Calendar.html">Calendar</a>.</dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getAllCalendars" class="membertitle">getAllCalendars</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">sequence&lt; string &gt;</td>
</tr>
<tr>
<td valign="top"><b>getAllCalendars</b>(</td>
<td valign="top">[in] ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/Locale.html">Locale</a></td>
<td valign="bottom">&nbsp;rLocale );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Returns all available calendars for the given locale.</dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getUniqueID" class="membertitle">getUniqueID</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">string</td>
</tr>
<tr>
<td valign="top"><b>getUniqueID</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Returns the ID string of the loaded calendar, for example,
 <b>"Gregorian"</b>
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="setDateTime" class="membertitle">setDateTime</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">void</td>
</tr>
<tr>
<td valign="top"><b>setDateTime</b>(</td>
<td valign="top">[in] double</td>
<td valign="bottom">&nbsp;nTimeInDays );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Set the 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.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getDateTime" class="membertitle">getDateTime</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">double</td>
</tr>
<tr>
<td valign="top"><b>getDateTime</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Get the 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.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="setValue" class="membertitle">setValue</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">void</td>
</tr>
<tr>
<td valign="top"><b>setValue</b>(</td>
<td valign="top">[in] short</td>
<td valign="bottom">&nbsp;nCalendarFieldIndex,</td>
</tr>
<tr>
<td/><td valign="top">[in] short</td>
<td valign="bottom">&nbsp;nValue );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Set the value of a field.

 </dd>
<dt><b>Parameter nCalendarFieldIndex</b></dt>
<dd>One of <a href="CalendarFieldIndex.html">CalendarFieldIndex</a> values.

 </dd>
<dt><b>Parameter nValue</b></dt>
<dd>A value of the allowed range for the field index.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getValue" class="membertitle">getValue</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">short</td>
</tr>
<tr>
<td valign="top"><b>getValue</b>(</td>
<td valign="top">[in] short</td>
<td valign="bottom">&nbsp;nCalendarFieldIndex );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Get the value of a field.

 </dd>
<dt><b>Parameter nCalendarFieldIndex</b></dt>
<dd>One of <a href="CalendarFieldIndex.html">CalendarFieldIndex</a> values.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="isValid" class="membertitle">isValid</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">boolean</td>
</tr>
<tr>
<td valign="top"><b>isValid</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Verify if the date fields set by a combination of
 <a href="XCalendar.html">XCalendar</a>::<a href="XCalendar.html#setValue">setValue()</a> calls is valid. It has a
 side-effect because it will internally calculate the final value
 for the date fields
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="addValue" class="membertitle">addValue</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">void</td>
</tr>
<tr>
<td valign="top"><b>addValue</b>(</td>
<td valign="top">[in] short</td>
<td valign="bottom">&nbsp;nCalendarFieldIndex,</td>
</tr>
<tr>
<td/><td valign="top">[in] long</td>
<td valign="bottom">&nbsp;nAmount );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Add an amount to a field.

 </dd>
<dt><b>Parameter nCalendarFieldIndex</b></dt>
<dd>One of <a href="CalendarFieldIndex.html">CalendarFieldIndex</a> values.

 </dd>
<dt><b>Parameter nAmount</b></dt>
<dd>The amount to add.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getFirstDayOfWeek" class="membertitle">getFirstDayOfWeek</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">short</td>
</tr>
<tr>
<td valign="top"><b>getFirstDayOfWeek</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>returns the first day of a week, one of <a href="Weekdays.html">Weekdays</a>
 values.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="setFirstDayOfWeek" class="membertitle">setFirstDayOfWeek</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">void</td>
</tr>
<tr>
<td valign="top"><b>setFirstDayOfWeek</b>(</td>
<td valign="top">[in] short</td>
<td valign="bottom">&nbsp;nDay );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Set the first day of a week, one of <a href="Weekdays.html">Weekdays</a>
 values.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="setMinimumNumberOfDaysForFirstWeek" class="membertitle">setMinimumNumberOfDaysForFirstWeek</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">void</td>
</tr>
<tr>
<td valign="top"><b>setMinimumNumberOfDaysForFirstWeek</b>(</td>
<td valign="top">[in] short</td>
<td valign="bottom">&nbsp;nDays );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Set how many days of a week must reside in the first week of a
 year.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getMinimumNumberOfDaysForFirstWeek" class="membertitle">getMinimumNumberOfDaysForFirstWeek</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">short</td>
</tr>
<tr>
<td valign="top"><b>getMinimumNumberOfDaysForFirstWeek</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>returns how many days of a week must reside in the first week of
 a year.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getNumberOfMonthsInYear" class="membertitle">getNumberOfMonthsInYear</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">short</td>
</tr>
<tr>
<td valign="top"><b>getNumberOfMonthsInYear</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>returns the number of months in a year, e.g. <b>12</b></dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getNumberOfDaysInWeek" class="membertitle">getNumberOfDaysInWeek</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">short</td>
</tr>
<tr>
<td valign="top"><b>getNumberOfDaysInWeek</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>returns the number of days in a week, e.g. <b>7</b></dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getMonths" class="membertitle">getMonths</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">sequence&lt; <a href="CalendarItem.html">CalendarItem</a> &gt;</td>
</tr>
<tr>
<td valign="top"><b>getMonths</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>returns a sequence of <a href="CalendarItem.html">CalendarItem</a> describing the
 month names.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getDays" class="membertitle">getDays</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">sequence&lt; <a href="CalendarItem.html">CalendarItem</a> &gt;</td>
</tr>
<tr>
<td valign="top"><b>getDays</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>returns a sequence of <a href="CalendarItem.html">CalendarItem</a> describing the
 day names.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getDisplayName" class="membertitle">getDisplayName</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">string</td>
</tr>
<tr>
<td valign="top"><b>getDisplayName</b>(</td>
<td valign="top">[in] short</td>
<td valign="bottom">&nbsp;nCalendarDisplayIndex,</td>
</tr>
<tr>
<td/><td valign="top">[in] short</td>
<td valign="bottom">&nbsp;nIdx,</td>
</tr>
<tr>
<td/><td valign="top">[in] short</td>
<td valign="bottom">&nbsp;nNameType );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Returns a string (name to display) matching the given parameters.

 </dd>
<dt><b>Parameter nCalendarDisplayIndex</b></dt>
<dd>One of <a href="CalendarDisplayIndex.html">CalendarDisplayIndex</a> values

 </dd>
<dt><b>Parameter nIdx</b></dt>
<dd>A value matching the <em>nCalendarDisplayIndex</em> type:
 <dl>
 <dt><b>CalendarDisplayIndex::AM_PM</b></dt>
 <dd>one of <a href="AmPmValue.html">AmPmValue</a></dd>
 <dt><b>CalendarDisplayIndex::DAY</b></dt>
 <dd>one of <a href="Weekdays.html">Weekdays</a> or a number used as
 an offset into the corresponding
 <a href="Calendar.html">Calendar</a>::<a href="Calendar.html#Days">Days</a> sequence</dd>
 <dt><b>CalendarDisplayIndex::MONTH</b></dt>
 <dd>one of <a href="Months.html">Months</a> or a number used as
 an offset into the corresponding
 <a href="Calendar.html">Calendar</a>::<a href="Calendar.html#Months">Months</a> sequence</dd>
 <dt><b>CalendarDisplayIndex::YEAR</b></dt>
 <dd>not used, empty string returned</dd>
 <dt><b>CalendarDisplayIndex::ERA</b></dt>
 <dd>a number used as an offset into the
 corresponding <a href="Calendar.html">Calendar</a>::<a href="Calendar.html#ras">ras</a>
 sequence</dd>
 <dt><b>CalendarDisplayIndex::GENITIVE_MONTH</b></dt>
 <dd>a number used as an offset into the
 corresponding <a href="Calendar2.html">Calendar2</a>::<a href="Calendar2.html#enitiveMonth">enitiveMonth</a>
 sequence</dd>
 </dl>

 <p> The value should be obtained by a previous call to
 <a href="XCalendar.html">XCalendar</a>::<a href="XCalendar.html#getValue">getValue()</a> with an appropriate
 <a href="CalendarFieldIndex.html">CalendarFieldIndex</a> argument. </p>

 </dd>
<dt><b>Parameter nNameType</b></dt>
<dd>A value indicating whether to return the abbreviated or the
 full name, or the narrow name for some 
 <a href="CalendarDisplayIndex.html">CalendarDisplayIndex</a> values.
 <dl>
 <dt> 0 </dt>
 <dd>abbreviated name, e.g. <b>"Jan"</b></dd>
 <dt> 1 </dt>
 <dd>full name, e.g. <b>"January"</b></dd>
 <dt> 2 </dt>
 <dd>narrow name, e.g. <b>"J"</b> <br>
 Valid only for <b>CalendarDisplayIndex::DAY</b>, 
 <b>CalendarDisplayIndex::MONTH</b> and 
 <b>CalendarDisplayIndex::GENITIVE_MONTH</b> <br>
 </dd>
<dt><b>Since </b></dt>
<dd>LibreOffice 3.5   This parameter is not used if the nCalendarDisplayIndex argument equals CalendarDisplayIndex::AM_PM  </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
</table>
<a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright &copy; 2000, 2012 LibreOffice contributors and/or their affiliates. All rights reserved.</p><p class="copyright" align="center">LibreOffice was created by The Document Foundation, based on OpenOffice.org, which is Copyright 2000, 2010 Oracle and/or its affiliates.</p><p class="copyright" align="center">The Document Foundation acknowledges all community members, please find more info <a href="http://www.libreoffice.org/about-us/credits/" target="_blank">at our website</a>.<p>&nbsp;</p><p class="copyright" align="center"><a href="http://www.libreoffice.org/privacy" target="_blank">Privacy Policy</a> | <a href="http://www.libreoffice.org/imprint" target="_blank">Impressum (Legal Info)</a> | Copyright information: The source code of LibreOffice is licensed under the GNU Lesser General Public License (<a href="http://www.libreoffice.org/download/license/" target="_blank">LGPLv3</a>). "LibreOffice" and "The Document Foundation" are registered trademarks of their corresponding registered owners or are in actual use as trademarks in one or more countries. Their respective logos and icons are also subject to international copyright laws. Use thereof is explained in our <a href="http://wiki.documentfoundation.org/TradeMark_Policy" target="_blank">trademark policy</a>.</p>

</div> <!-- id="adc-idlref" -->
</body>

</html>