offapi/com/sun/star/chart2/RelativeSize.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 #ifndef com_sun_star_chart2_RelativeSize_idl
  20 #define com_sun_star_chart2_RelativeSize_idl
  21
  22 module com
  23 {
  24 module sun
  25 {
  26 module star
  27 {
  28 module chart2
  29 {
  30
  31 /** Gives a position relative to some size defined by other means.
  32     Values from 0 to 1 cover the entire reference rectangle.  Values
  33     may also be greater than one, meaning a bigger size than the
  34     reference size.  Negative values are not allowed.
  35  */
  36 struct RelativeSize
  37 {
  38     /** The extension in the primary direction.  The direction is
  39         defined by the object using this point.
  40
  41         <p>Typically, the direction is determined by an
  42         Orientation.  Another typical use would be the
  43         direction of a given orientation-angle.</p>
  44
  45         <p>The values are relative to the page or an object.  Values
  46         between 0 and 1 span the complete bounding rectangle of the
  47         page/object.</p>
  48
  49         <p>For a western Orientation this is the
  50         width.</p>
  51      */
  52     double       Primary;
  53
  54     /** The extension in the secondary direction.  The direction is
  55         defined by the object using this point.
  56
  57         <p>Typically, the direction is determined by an
  58         Orientation.  Another typical use would be the
  59         direction perpendicular to a given orientation-angle.</p>
  60
  61         <p>The values are relative to the page or an object.  Values
  62         between 0 and 1 span the complete bounding rectangle of the
  63         page/object.</p>
  64
  65         <p>For a western Orientation this is the
  66         height.</p>
  67      */
  68     double       Secondary;
  69 };
  70
  71 } ; // chart2
  72 } ; // com
  73 } ; // sun
  74 } ; // star
  75
  76 #endif
  77
  78 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */