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