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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * Copyright 2000, 2010 Oracle and/or its affiliates.
   7  *
   8  * OpenOffice.org - a multi-platform office productivity suite
   9  *
  10  * This file is part of OpenOffice.org.
  11  *
  12  * OpenOffice.org is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU Lesser General Public License version 3
  14  * only, as published by the Free Software Foundation.
  15  *
  16  * OpenOffice.org is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU Lesser General Public License version 3 for more details
  20  * (a copy is included in the LICENSE file that accompanied this code).
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * version 3 along with OpenOffice.org.  If not, see
  24  * <http://www.openoffice.org/license.html>
  25  * for a copy of the LGPLv3 License.
  26  *
  27  ************************************************************************/
  28 #ifndef com_sun_star_chart2_RelativePosition_idl
  29 #define com_sun_star_chart2_RelativePosition_idl
  30
  31 #include <com/sun/star/drawing/Alignment.idl>
  32
  33 module com
  34 {
  35 module sun
  36 {
  37 module star
  38 {
  39 module chart2
  40 {
  41
  42 /** Determines a position of an object relative to a size defined by other means.
  43     Values from 0 to 1 cover the entire reference rectangle. Values
  44     may also be outside this range, especially negative.
  45  */
  46 struct RelativePosition
  47 {
  48     /** The position in the primary direction.
  49         The direction is defined by the object using this point.
  50
  51         <p>For example for western languages the primary direction may be
  52         the horizontal distance measured from left to right.</p>
  53
  54         <p>The values are relative to a reference size (for example the page size).
  55         Values between 0 and 1 span the complete bounding rectangle.</p>
  56      */
  57     double       Primary;
  58
  59     /** The position in the secondary direction.
  60         The direction is defined by the object using this point.
  61
  62         <p>For example for western languages the secondary direction may be
  63         the vertical distance measured from top to bottom.</p>
  64
  65         <p>The values are relative to a reference size (for example the page size).
  66         Values between 0 and 1 span the complete bounding rectangle.</p>
  67      */
  68     double       Secondary;
  69
  70     /** This indicates how the object is placed at the relative position.
  71
  72         <p>The Anchor indicates which point of the placed object
  73         will be placed at the coordinates given within Primary and Secondary.</p>
  74
  75         <p>For example if Anchor is TOP_LEFT the top left corner of an object will
  76         be placed at the given coordinates. If Anchor is RIGHT the right middle corner of the object will
  77         be placed at the given coordinates.</p>
  78      */
  79     ::com::sun::star::drawing::Alignment Anchor;
  80 };
  81
  82 } ; // chart2
  83 } ; // com
  84 } ; // sun
  85 } ; // star
  86
  87 #endif
  88
  89 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */