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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_i18n_FormatElement_idl__
  20 #define __com_sun_star_i18n_FormatElement_idl__
  21
  22
  23 module com {  module sun {  module star {  module i18n {
  24
  25
  26 /**
  27     One number format code and its attributes, returned in a sequence by
  28     XLocaleData::getAllFormats().
  29
  30     <p> Contains raw data defined in the XML locale data files. </p>
  31
  32     @see XLocaleData
  33         for links to DTD of XML locale data files.
  34  */
  35
  36 published struct FormatElement
  37 {
  38     /** The format code, for example, "YYYY-MM-DD". */
  39     string  formatCode;
  40
  41     /** A name or description that is displayed in the number formatter
  42         dialog. */
  43     string  formatName;
  44
  45     /** A unique (within one locale) identifier. */
  46     string  formatKey;
  47
  48     /** Type may be one of "short", "medium", "long". */
  49     string  formatType;
  50
  51     /** Usage category, for example, "DATE" or "FIXED_NUMBER",
  52         corresponding with KNumberFormatUsage values. */
  53     string  formatUsage;
  54
  55     /** The index used by the number formatter, predefined values
  56         corresponding with NumberFormatIndex values. */
  57     short   formatIndex;
  58
  59     /** If a format code is the default code of a <em>formatType</em>
  60         group. */
  61     boolean isDefault;
  62 };
  63
  64 }; }; }; };
  65
  66 #endif
  67
  68 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */