offapi/com/sun/star/i18n/NumberFormatCode.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: NumberFormatCode.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_NumberFormatCode_idl__
  31 #define __com_sun_star_i18n_NumberFormatCode_idl__
  32
  33 //=============================================================================
  34
  35 module com {  module sun {  module star {  module i18n {
  36
  37 //=============================================================================
  38
  39 /**
  40     Number format code information returned by various
  41     <type>XNumberFormatCode</type> methods.
  42  */
  43
  44 published struct NumberFormatCode
  45 {
  46     /// One of <type>KNumberFormatType</type> values.
  47     short Type;
  48     /// One of <type>KNumberFormatUsage</type> values.
  49     short Usage;
  50     /// Format code, for example, "YYYY-MM-DD".
  51     string Code;
  52     /// Descriptive name of the format for this locale.
  53     string DefaultName;
  54     /// Message identifier to be used if the name of the format is localized.
  55     string NameID;
  56     /// Index of the code as defined in <type>NumberFormatIndex</type>.
  57     short Index;
  58     /// If this format is the default format of the <em>Usage</em> group.
  59     boolean Default;
  60 };
  61
  62 //=============================================================================
  63 }; }; }; };
  64
  65 #endif