offapi/com/sun/star/i18n/FormatElement.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: FormatElement.idl,v $
  10  * $Revision: 1.6 $
  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 #ifndef __com_sun_star_i18n_FormatElement_idl__
  31 #define __com_sun_star_i18n_FormatElement_idl__
  32
  33 //============================================================================
  34
  35 module com {  module sun {  module star {  module i18n {
  36
  37 //============================================================================
  38
  39 /**
  40     One number format code and its attributes, returned in a sequence by
  41     <member>XLocaleData::getAllFormats()</member>.
  42
  43     <p> Contains raw data defined in the XML locale data files. </p>
  44
  45     @see XLocaleData
  46         for links to DTD of XML locale data files.
  47  */
  48
  49 published struct FormatElement
  50 {
  51     /** The format code, for example, "YYYY-MM-DD". */
  52     string  formatCode;
  53
  54     /** A name or description that is displayed in the number formatter
  55         dialog. */
  56     string  formatName;
  57
  58     /** A unique (within one locale) identifier. */
  59     string  formatKey;
  60
  61     /** Type may be one of "short", "medium", "long". */
  62     string  formatType;
  63
  64     /** Usage category, for example, "DATE" or "FIXED_NUMBER",
  65         corresponding with <type>KNumberFormatUsage</type> values. */
  66     string  formatUsage;
  67
  68     /** The index used by the number formatter, predefined values
  69         corresponding with <type>NumberFormatIndex</type> values. */
  70     short   formatIndex;
  71
  72     /** If a format code is the default code of a <em>formatType</em>
  73         group. */
  74     boolean isDefault;
  75 };
  76
  77 //============================================================================
  78 }; }; }; };
  79
  80 #endif