offapi/com/sun/star/i18n/Currency2.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
  28 #ifndef __com_sun_star_i18n_Currency2_idl__
  29 #define __com_sun_star_i18n_Currency2_idl__
  30
  31 #ifndef __com_sun_star_i18n_Currency_idl__
  32 #include <com/sun/star/i18n/Currency.idl>
  33 #endif
  34
  35 //============================================================================
  36
  37 module com { module sun { module star { module i18n {
  38
  39 //============================================================================
  40
  41 /**
  42     Symbols, names, and attributes of a specific currency, returned in a
  43     sequence by <member>XLocaleData2::getAllCurrencies2()</member>.
  44
  45     <p> It is derived from
  46     <type scope="::com::sun::star::i18n">Currency</type> and provides an
  47     additional flag for currency entries that are available only for legacy
  48     reasons in context of loaded documents that use them, but otherwise
  49     should not be offered to the user to be selectable.
  50
  51     @see XLocaleData
  52         for links to DTD of XML locale data files.
  53  */
  54
  55 published struct Currency2 : com::sun::star::i18n::Currency
  56 {
  57     /** If set, the currency and/or its symbol is only to be used in
  58         legacy context.
  59
  60         @since OOo 2.0.3
  61      */
  62     boolean LegacyOnly;
  63 };
  64
  65 //============================================================================
  66 }; }; }; };
  67
  68 #endif