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