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

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