offapi/com/sun/star/chart2/RelativePosition.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: RelativePosition.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_RelativePosition_idl
  31 #define com_sun_star_chart2_RelativePosition_idl
  32
  33 #ifndef __com_sun_star_drawing_Alignment_idl__
  34 #include <com/sun/star/drawing/Alignment.idl>
  35 #endif
  36
  37 module com
  38 {
  39 module sun
  40 {
  41 module star
  42 {
  43 module chart2
  44 {
  45
  46 /** Determines a position of an object relative to a size defined by other means.
  47     Values from 0 to 1 cover the entire reference rectangle. Values
  48     may also be outside this range, especially negative.
  49  */
  50 struct RelativePosition
  51 {
  52     /** The position in the primary direction.
  53         The direction is defined by the object using this point.
  54
  55         <p>For example for western languages the primary direction may be
  56         the horizontal distance measured from left to right.</p>
  57
  58         <p>The values are relative to a reference size (for example the page size).
  59         Values between 0 and 1 span the complete bounding rectangle.</p>
  60      */
  61     double       Primary;
  62
  63     /** The position in the secondary direction.
  64         The direction is defined by the object using this point.
  65
  66         <p>For example for western languages the secondary direction may be
  67         the vertical distance measured from top to bottom.</p>
  68
  69         <p>The values are relative to a reference size (for example the page size).
  70         Values between 0 and 1 span the complete bounding rectangle.</p>
  71      */
  72     double       Secondary;
  73
  74     /** This indicates how the object is placed at the relative position.
  75
  76         <p>The Anchor indicates which point of the placed object
  77         will be placed at the coordinates given within Primary and Secondary.</p>
  78
  79         <p>For example if Anchor is TOP_LEFT the top left corner of an object will
  80         be placed at the given coorediantes. If Anchor is RIGHT the right middle corner of the object will
  81         be placed at the given coorediantes.</p>
  82      */
  83     ::com::sun::star::drawing::Alignment Anchor;
  84 };
  85
  86 } ; // chart2
  87 } ; // com
  88 } ; // sun
  89 } ; // star
  90
  91 #endif