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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * Copyright 2000, 2010 Oracle and/or its affiliates.
   7  *
   8  * OpenOffice.org - a multi-platform office productivity suite
   9  *
  10  * This file is part of OpenOffice.org.
  11  *
  12  * OpenOffice.org is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU Lesser General Public License version 3
  14  * only, as published by the Free Software Foundation.
  15  *
  16  * OpenOffice.org is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU Lesser General Public License version 3 for more details
  20  * (a copy is included in the LICENSE file that accompanied this code).
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * version 3 along with OpenOffice.org.  If not, see
  24  * <http://www.openoffice.org/license.html>
  25  * for a copy of the LGPLv3 License.
  26  *
  27  ************************************************************************/
  28
  29 #ifndef __com_sun_star_i18n_Currency2_idl__
  30 #define __com_sun_star_i18n_Currency2_idl__
  31
  32 #include <com/sun/star/i18n/Currency.idl>
  33
  34 //============================================================================
  35
  36 module com { module sun { module star { module i18n {
  37
  38 //============================================================================
  39
  40 /**
  41     Symbols, names, and attributes of a specific currency, returned in a
  42     sequence by <member>XLocaleData2::getAllCurrencies2()</member>.
  43
  44     <p> It is derived from
  45     <type scope="::com::sun::star::i18n">Currency</type> and provides an
  46     additional flag for currency entries that are available only for legacy
  47     reasons in context of loaded documents that use them, but otherwise
  48     should not be offered to the user to be selectable.
  49
  50     @see XLocaleData
  51         for links to DTD of XML locale data files.
  52  */
  53
  54 published struct Currency2 : com::sun::star::i18n::Currency
  55 {
  56     /** If set, the currency and/or its symbol is only to be used in
  57         legacy context.
  58
  59         @since OOo 2.0.3
  60      */
  61     boolean LegacyOnly;
  62 };
  63
  64 //============================================================================
  65 }; }; }; };
  66
  67 #endif
  68
  69 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */