offapi/com/sun/star/chart2/RelativeSize.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27 #ifndef com_sun_star_chart2_RelativeSize_idl
  28 #define com_sun_star_chart2_RelativeSize_idl
  29
  30 module com
  31 {
  32 module sun
  33 {
  34 module star
  35 {
  36 module chart2
  37 {
  38
  39 /** Gives a position relative to some size defined by other means.
  40     Values from 0 to 1 cover the entire reference rectangle.  Values
  41     may also be greater than one, meaning a bigger size than the
  42     reference size.  Negative values are not allowed.
  43  */
  44 struct RelativeSize
  45 {
  46     /** The extension in the primary direction.  The direction is
  47         defined by the object using this point.
  48
  49         <p>Typically, the direction is determined by an
  50         <type>Orientation</type>.  Another typical use would be the
  51         direction of a given orientation-angle.</p>
  52
  53         <p>The values are relative to the page or an object.  Values
  54         between 0 and 1 span the complete bounding rectangle of the
  55         page/object.</p>
  56
  57         <p>For a western <type>Orientation</type> this is the
  58         width.</p>
  59      */
  60     double       Primary;
  61
  62     /** The extension in the secondary direction.  The direction is
  63         defined by the object using this point.
  64
  65         <p>Typically, the direction is determined by an
  66         <type>Orientation</type>.  Another typical use would be the
  67         direction perpendicular to a given orientation-angle.</p>
  68
  69         <p>The values are relative to the page or an object.  Values
  70         between 0 and 1 span the complete bounding rectangle of the
  71         page/object.</p>
  72
  73         <p>For a western <type>Orientation</type> this is the
  74         height.</p>
  75      */
  76     double       Secondary;
  77 };
  78
  79 } ; // chart2
  80 } ; // com
  81 } ; // sun
  82 } ; // star
  83
  84 #endif