offapi/com/sun/star/drawing/LineProperties.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: LineProperties.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_LineProperties_idl__
  31 #define __com_sun_star_drawing_LineProperties_idl__
  32
  33 #ifndef __com_sun_star_drawing_LineStyle_idl__
  34 #include <com/sun/star/drawing/LineStyle.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_util_Color_idl__
  38 #include <com/sun/star/util/Color.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_drawing_LineDash_idl__
  42 #include <com/sun/star/drawing/LineDash.idl>
  43 #endif
  44
  45 #ifndef __com_sun_star_drawing_PolyPolygonBezierCoords_idl__
  46 #include <com/sun/star/drawing/PolyPolygonBezierCoords.idl>
  47 #endif
  48
  49 #ifndef __com_sun_star_drawing_LineJoint_idl__
  50 #include <com/sun/star/drawing/LineJoint.idl>
  51 #endif
  52
  53
  54 //=============================================================================
  55
  56  module com {  module sun {  module star {  module drawing {
  57
  58 //=============================================================================
  59
  60 /** This is a set of properties to describe the style for rendering a Line.
  61     <p>The properties for line ends and line starts are only supported by
  62     shapes with open line ends.
  63  */
  64 published service LineProperties
  65 {
  66     /** This property contains the type of the line.
  67      */
  68     [property] com::sun::star::drawing::LineStyle LineStyle;
  69
  70     //-------------------------------------------------------------------------
  71
  72     /** This property contains the dash of the line.
  73      */
  74     [property] com::sun::star::drawing::LineDash LineDash;
  75
  76     //-------------------------------------------------------------------------
  77
  78     /** This property contains the name of the dash of the line.
  79      */
  80     [optional, property] string LineDashName;
  81
  82     //-------------------------------------------------------------------------
  83
  84     /** This property contains the line color.
  85      */
  86     [property] com::sun::star::util::Color LineColor;
  87
  88     //-------------------------------------------------------------------------
  89
  90     /** This property contains the extent of transparency.
  91      */
  92     [property] short LineTransparence;
  93
  94     //-------------------------------------------------------------------------
  95
  96     /** This property contains the width of the line in 1/100th mm.
  97      */
  98     [property] long LineWidth;
  99
 100     //-------------------------------------------------------------------------
 101
 102     /** This property defines the rendering of joints between thick lines
 103      */
 104     [property] com::sun::star::drawing::LineJoint LineJoint;
 105
 106     //-------------------------------------------------------------------------
 107
 108     /** This property contains the name of the line start poly polygon bezier.
 109         <p>If this string is empty, no line start polygon is rendered.
 110      */
 111     [optional, property] string LineStartName;
 112
 113     //-------------------------------------------------------------------------
 114
 115     /** This property contains the name of the line end poly polygon bezier.
 116         <p>If this string is empty, no line end polygon is rendered.
 117      */
 118     [optional, property] string LineEndName;
 119
 120     //-------------------------------------------------------------------------
 121
 122     /** This property contains the line start in the form of a poly polygon bezier.
 123      */
 124     [optional, property] com::sun::star::drawing::PolyPolygonBezierCoords LineStart;
 125
 126     //-------------------------------------------------------------------------
 127
 128     /** This property contains the line end in the form of a poly polygon bezier.
 129      */
 130     [optional, property] com::sun::star::drawing::PolyPolygonBezierCoords LineEnd;
 131
 132     //-------------------------------------------------------------------------
 133
 134     /** If this property is <TRUE/>, the line will
 135         start from the center of the polygon.
 136      */
 137     [optional, property] boolean LineStartCenter;
 138
 139     //-------------------------------------------------------------------------
 140
 141     /** This property contains the width of the line start polygon.
 142      */
 143     [optional, property] long LineStartWidth;
 144
 145     //-------------------------------------------------------------------------
 146
 147     /** If this property is <TRUE/>, the line will end
 148         in the center of the polygon.
 149      */
 150     [optional, property] boolean LineEndCenter;
 151
 152     //-------------------------------------------------------------------------
 153
 154     /** This property contains the width of the line end polygon.
 155      */
 156     [optional, property] long LineEndWidth;
 157 };
 158
 159 //=============================================================================
 160
 161 }; }; }; };
 162
 163 #endif
 164