offapi/com/sun/star/drawing/GluePoint2.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: GluePoint2.idl,v $
  10  * $Revision: 1.8 $
  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_drawing_GluePoint2_idl__
  31 #define __com_sun_star_drawing_GluePoint2_idl__
  32
  33 #ifndef __com_sun_star_drawing_Alignment_idl__
  34 #include <com/sun/star/drawing/Alignment.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_awt_Point_idl__
  38 #include <com/sun/star/awt/Point.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_drawing_EscapeDirection_idl__
  42 #include <com/sun/star/drawing/EscapeDirection.idl>
  43 #endif
  44
  45 //=============================================================================
  46
  47  module com {  module sun {  module star {  module drawing {
  48
  49 //=============================================================================
  50
  51 /** This struct defines the attributes of a glue point.
  52     <p>A glue point is a position inside a drawing shape where an edge
  53     of a connector shape can be connected.</p>
  54  */
  55 published struct GluePoint2
  56 {
  57     /** This is the position of this glue point. Depending on
  58         the flag <code>IsRelative</code>, this is either in 1/100cm
  59         or in 1/100%.
  60
  61     <!-- Dennis: Is the % correct? -->
  62      */
  63     com::sun::star::awt::Point Position;
  64
  65     /** if this flag is set to true, the position of this glue point
  66         is given in 1/100% values instead of 1/100cm. */
  67     boolean IsRelative;
  68
  69     /** if this glue points position is not relative, this enum
  70         specifies the vertical and horizontal alignment of this
  71         point. The alignment specifies how the glue point is
  72         moved if the shape is resized. */
  73     com::sun::star::drawing::Alignment PositionAlignment;
  74
  75     /** this member specifies the escape direction for a glue
  76         point. The escape direction is the direction the connecting
  77         line escapes the shape. */
  78
  79     com::sun::star::drawing::EscapeDirection Escape;
  80
  81     /** if this flag is set to false, this is a default glue
  82         point. Some shapes may have default glue points attached
  83         to them which cannot be altered or removed. */
  84     boolean IsUserDefined;
  85 };
  86
  87 //=============================================================================
  88
  89 }; }; }; };
  90
  91 #endif
  92