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