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