offapi/com/sun/star/awt/XUnitConversion.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 awt {
  22
  23
  24 /** allows converting between different measurement units
  25
  26     @since OOo 3.0
  27  */
  28 interface XUnitConversion: com::sun::star::uno::XInterface
  29 {
  30     /** converts the given Point, which is specified in pixels, into the given logical unit
  31
  32         @param Point
  33             A given Point in a well known type
  34         @param TargetUnit
  35             A type from com::sun::star::util::MeasureUnit in which the Point will convert to.
  36
  37         @return
  38             Returns a new Point in the TargetUnit type format.
  39      */
  40     com::sun::star::awt::Point convertPointToLogic( [in] com::sun::star::awt::Point Point, [in] short TargetUnit )
  41             raises ( com::sun::star::lang::IllegalArgumentException );
  42
  43     /** converts the given Point, which is specified in the given logical unit, into pixels
  44
  45         @param Point
  46             A given Point in the SourceUnit type
  47         @param SourceUnit
  48             The type from com::sun::star::util::MeasureUnit of the Point.
  49
  50         @return
  51             Return a new Point in Pixel type format.
  52      */
  53     com::sun::star::awt::Point convertPointToPixel( [in] com::sun::star::awt::Point Point, [in] short SourceUnit )
  54             raises ( com::sun::star::lang::IllegalArgumentException );
  55
  56
  57     /** converts the given Size, which is specified in pixels, into the given logical unit
  58
  59         @param Size
  60             A given Size in a well known type
  61         @param TargetUnit
  62             A type from com::sun::star::util::MeasureUnit in which the Size will convert to.
  63
  64         @return
  65             Returns a new Size in the TargetUnit type format.
  66      */
  67     com::sun::star::awt::Size convertSizeToLogic( [in] com::sun::star::awt::Size Size, [in] short TargetUnit )
  68             raises ( com::sun::star::lang::IllegalArgumentException );
  69
  70     /** converts the given Size, which is specified in the given logical unit, into pixels
  71
  72         @param Size
  73             A given Size in a well known type
  74         @param SourceUnit
  75             The type from com::sun::star::util::MeasureUnit of the Size.
  76
  77         @return
  78             Returns a new Size in the TargetUnit type format.
  79      */
  80     com::sun::star::awt::Size convertSizeToPixel( [in] com::sun::star::awt::Size Size, [in] short SourceUnit )
  81             raises ( com::sun::star::lang::IllegalArgumentException );
  82
  83
  84 };
  85
  86
  87 }; }; }; };
  88
  89 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */