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

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