udkapi/com/sun/star/bridge/oleautomation/Currency.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
  20
  21 module com {  module sun {  module star {  module bridge {  module oleautomation {
  22
  23 /** is the UNO representation of the Automation type <code>CY</code>, also know
  24     as <code>CURRENCY</code>.
  25     <p>
  26     A <code>CY</code> could actually be represented as `hyper` in UNO
  27     and therefore a typedef from `hyper` to a currency type would do.
  28     But a typedef cannot be expressed in all language bindings. In the case
  29     where no typedefs are supported the actual type is used. That is, a
  30     typedef'd currency type would be represented as <code>long</code> in Java.
  31     The information that the <code>long</code> is a currency type is lost.
  32     </p>
  33     <p>
  34     When calling Automation objects from UNO the distinction between
  35     `hyper` and a currency type is important. Therefore
  36     Currency is declared as struct.
  37     </p>
  38
  39     @since OOo 1.1.2
  40  */
  41 struct Currency
  42 {
  43     /** corresponds to the Automation type <code>CY</code>.
  44      */
  45     hyper Value;
  46 };
  47
  48 }; }; }; }; };
  49
  50
  51 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */