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