offapi/com/sun/star/i18n/CalendarDisplayCode.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27
  28 #ifndef __com_sun_star_i18n_CalendarDisplayCode_idl__
  29 #define __com_sun_star_i18n_CalendarDisplayCode_idl__
  30
  31 //=============================================================================
  32
  33 module com { module sun { module star { module i18n {
  34
  35 //=============================================================================
  36
  37
  38 /**
  39     Constants to use with <member>XExtendedCalendar::getDisplayString()</member>.
  40
  41     <p> The examples given are for an English Gregorian calendar, note
  42     that other calendars or locales may return completely different
  43     strings, for example not a four digit year but a CJK name instead.
  44     <p/>
  45
  46      @since OOo 1.1.2
  47  */
  48 published constants CalendarDisplayCode
  49 {
  50     /// Day of month, one or two digits, no leading zero.
  51     const long SHORT_DAY            = 1;
  52     /// Day of month, two digits, with leading zero.
  53     const long LONG_DAY             = 2;
  54     /// Day of week, abbreviated name.
  55     const long SHORT_DAY_NAME       = 3;
  56     /// Day of week, full name.
  57     const long LONG_DAY_NAME        = 4;
  58
  59     /// Month of year, one or two digits, no leading zero.
  60     const long SHORT_MONTH          = 5;
  61     /// Month of year, with leading zero.
  62     const long LONG_MONTH           = 6;
  63     /// Full month name.
  64     const long SHORT_MONTH_NAME     = 7;
  65     /// Abbreviated month name.
  66     const long LONG_MONTH_NAME      = 8;
  67
  68     /// Year, two digits.
  69     const long SHORT_YEAR           = 9;
  70     /// Year, four digits.
  71     const long LONG_YEAR            = 10;
  72     /// Full era name, for example, "Before Christ" or "Anno Dominus".
  73     const long SHORT_ERA            = 11;
  74     /// Abbreviated era name, for example, BC or AD.
  75     const long LONG_ERA             = 12;
  76     /// Combined short year and era, order depends on locale/calendar.
  77     const long SHORT_YEAR_AND_ERA   = 13;
  78     /// Combined full year and era, order depends on locale/calendar.
  79     const long LONG_YEAR_AND_ERA    = 14;
  80
  81     /// Short quarter, for example, "Q1"
  82     const long SHORT_QUARTER        = 15;
  83     /// Long quarter, for example, "1st quarter"
  84     const long LONG_QUARTER         = 16;
  85 };
  86
  87 //=============================================================================
  88 }; }; }; };
  89
  90 #endif