offapi/com/sun/star/text/BaseFrameProperties.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: BaseFrameProperties.idl,v $
  10  * $Revision: 1.12 $
  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_text_BaseFrameProperties_idl__
  31 #define __com_sun_star_text_BaseFrameProperties_idl__
  32
  33 #ifndef __com_sun_star_style_GraphicLocation_idl__
  34 #include <com/sun/star/style/GraphicLocation.idl>
  35 #endif
  36 #ifndef __com_sun_star_table_BorderLine_idl__
  37 #include <com/sun/star/table/BorderLine.idl>
  38 #endif
  39 #ifndef __com_sun_star_table_ShadowFormat_idl__
  40 #include <com/sun/star/table/ShadowFormat.idl>
  41 #endif
  42 #ifndef __com_sun_star_text_XTextFrame_idl__
  43 #include <com/sun/star/text/XTextFrame.idl>
  44 #endif
  45 #ifndef __com_sun_star_text_WrapTextMode_idl__
  46 #include <com/sun/star/text/WrapTextMode.idl>
  47 #endif
  48 #ifndef __com_sun_star_awt_Size_idl__
  49 #include <com/sun/star/awt/Size.idl>
  50 #endif
  51 #ifndef __com_sun_star_util_Color_idl__
  52 #include <com/sun/star/util/Color.idl>
  53 #endif
  54 #ifndef _com_sun_star_xml_UserDefinedAttributesSupplier_idl_
  55 #include <com/sun/star/xml/UserDefinedAttributesSupplier.idl>
  56 #endif
  57
  58 //=============================================================================
  59
  60  module com {  module sun {  module star {  module text {
  61
  62 //=============================================================================
  63
  64 /** specifies the properties that are provided by all text frames, graphic objects, embedded objects
  65  and frame styles.
  66  */
  67 published service BaseFrameProperties
  68 {
  69     /** gives access to the UserDefinedAttributes property.
  70         @since  OOo 2.1
  71      */
  72     [optional] service com::sun::star::xml::UserDefinedAttributesSupplier;
  73
  74     //-------------------------------------------------------------------------
  75     /** contains the number of the page where the objects are anchored.
  76         <p> The value is valid only if the
  77         AnchorType is
  78         <const>TextContentAnchorType::AT_PAGE</const>.</p>
  79      */
  80     [property] short AnchorPageNo;
  81     //-------------------------------------------------------------------------
  82     /** contains the text frame the current frame is anchored to.
  83         <p> The value is valid only if the
  84         AnchorType is <const>TextContentAnchorType::AT_FRAME</const>.</p>
  85      */
  86     [property] com::sun::star::text::XTextFrame AnchorFrame;
  87     //-------------------------------------------------------------------------
  88     /** contains the color of the background of the object.
  89      */
  90     [property] com::sun::star::util::Color BackColor;
  91     //-------------------------------------------------------------------------
  92     /** contains the URL for the background graphic.
  93      */
  94     [property] string BackGraphicURL;
  95
  96     //-------------------------------------------------------------------------
  97     /** contains the name of the file filter for the background graphic.
  98      */
  99     [property] string BackGraphicFilter;
 100
 101     //-------------------------------------------------------------------------
 102     /** determines the position of the background graphic.
 103      */
 104     [property] com::sun::star::style::GraphicLocation BackGraphicLocation;
 105
 106     //-------------------------------------------------------------------------
 107     /** contains the left border of the object.
 108
 109         @see BaseFrame::com::sun::star::table::BorderLine
 110      */
 111     [property] com::sun::star::table::BorderLine LeftBorder;
 112
 113     //-------------------------------------------------------------------------
 114     /** contains the right border of the object.
 115
 116         @see BaseFrame::com::sun::star::table::BorderLine
 117      */
 118     [property] com::sun::star::table::BorderLine RightBorder;
 119
 120     //-------------------------------------------------------------------------
 121     /** contains the top border of the object.
 122
 123         @see BaseFrame::com::sun::star::table::BorderLine
 124      */
 125     [property] com::sun::star::table::BorderLine TopBorder;
 126
 127     //-------------------------------------------------------------------------
 128     /** contains the bottom border of the object.
 129
 130         @see BaseFrame::com::sun::star::table::BorderLine
 131      */
 132     [property] com::sun::star::table::BorderLine BottomBorder;
 133
 134     //-------------------------------------------------------------------------
 135     /** contains the distance from the border to the object.
 136      */
 137     [property] long BorderDistance;
 138
 139     //-------------------------------------------------------------------------
 140     /** contains the distance from the left border to the object.
 141      */
 142     [property] long LeftBorderDistance;
 143
 144     //-------------------------------------------------------------------------
 145     /** contains the distance from the right border to the object.
 146      */
 147     [property] long RightBorderDistance;
 148
 149     //-------------------------------------------------------------------------
 150     /** contains the distance from the top border to the object.
 151      */
 152     [property] long TopBorderDistance;
 153
 154     //-------------------------------------------------------------------------
 155     /** contains the distance from the bottom border to the object.
 156      */
 157     [property] long BottomBorderDistance;
 158
 159     //-------------------------------------------------------------------------
 160     /** If TRUE, the "BackColor" is ignored.
 161      */
 162     [property] boolean BackTransparent;
 163
 164     //-------------------------------------------------------------------------
 165
 166     /** determines if the content is protected.
 167      */
 168     [property] boolean ContentProtected;
 169     //-------------------------------------------------------------------------
 170     /** contains the left margin of the object.
 171      */
 172     [property] long LeftMargin;
 173
 174     //-------------------------------------------------------------------------
 175     /** contains the right margin of the object.
 176      */
 177     [property] long RightMargin;
 178
 179     //-------------------------------------------------------------------------
 180
 181     /** contains the top margin of the object.
 182      */
 183     [property] long TopMargin;
 184
 185     //-------------------------------------------------------------------------
 186     /** contains the bottom margin of the object.
 187      */
 188     [property] long BottomMargin;
 189
 190     //-------------------------------------------------------------------------
 191     /** contains the height of the object (1/100 mm).
 192         <p>It is only valid if <member>TextEmbeddedObject::RelativeHeight</member> is zero.</p>
 193      */
 194     [property] long Height;
 195
 196     //-------------------------------------------------------------------------
 197     /** contains the width of the object (1/100 mm).
 198         <p>It is only valid if <member>TextEmbeddedObject::RelativeWidth</member> is zero.</p>
 199      */
 200     [property] long Width;
 201     //-------------------------------------------------------------------------
 202     /** contains the relative height of the object.
 203         <p> It is only valid if it is greater than zero.</p>
 204      */
 205     [property] short RelativeHeight;
 206
 207     //-------------------------------------------------------------------------
 208     /** contains the relative width of the object.
 209         <p> It is only valid if it is greater than zero. </p>
 210      */
 211     [property] short RelativeWidth;
 212     //-------------------------------------------------------------------------
 213     /** determins whether the width follows the height.
 214      */
 215     [property] boolean IsSyncWidthToHeight;
 216     //-------------------------------------------------------------------------
 217     /** determins whether the height follows the width.
 218      */
 219     [property] boolean IsSyncHeightToWidth;
 220     //-------------------------------------------------------------------------
 221     /** determines the horizontal orientation of the object.
 222
 223         @see BaseFrame::HoriOrientation
 224      */
 225     [property] short HoriOrient;
 226     //-------------------------------------------------------------------------
 227     /** contains the horizontal position of the object (1/100 mm).
 228         <p> It is only valid if "HoriOrient" is HoriOrientation_NONE.</p>
 229      */
 230     [property] long HoriOrientPosition;
 231
 232     //-------------------------------------------------------------------------
 233     /** determines the environment of the object to which the orientation
 234         is related.
 235
 236         @see BaseFrame::RelOrientation
 237      */
 238     [property] short HoriOrientRelation;
 239
 240     //-------------------------------------------------------------------------
 241     /** determines the vertical orientation of the object.
 242
 243         @see BaseFrame::VertOrientation
 244      */
 245     [property] short VertOrient;
 246
 247     //-------------------------------------------------------------------------
 248     /** contains the vertical position of the object (1/100 mm).
 249
 250         It is only valid if <member>TextEmbeddedObject::VertOrient</member> is
 251         <const>VertOrientation::NONE</const>.
 252      */
 253     [property] long VertOrientPosition;
 254
 255     //-------------------------------------------------------------------------
 256
 257     /** determines the environment of the object to which the orientation is related.
 258
 259         @see BaseFrame::RelOrientation
 260      */
 261     [property] short VertOrientRelation;
 262
 263     //-------------------------------------------------------------------------
 264     /** contains the URL of a hyperlink that is set at the object.
 265      */
 266     [property] string HyperLinkURL;
 267
 268     //-------------------------------------------------------------------------
 269     /** contains the name of the target for a hyperlink that is set at the object.
 270      */
 271     [property] string HyperLinkTarget;
 272
 273     //-------------------------------------------------------------------------
 274     /** contains the name of the hyperlink that is set at the object.
 275      */
 276     [property] string HyperLinkName;
 277
 278     //-------------------------------------------------------------------------
 279     /** determines if the object is opaque or transparent for text.
 280      */
 281     [property] boolean Opaque;
 282
 283     //-------------------------------------------------------------------------
 284     /** determines if the object is mirrored on even pages.
 285      */
 286     [property] boolean PageToggle;
 287
 288     //-------------------------------------------------------------------------
 289     /** determines if the position is protected.
 290      */
 291     [property] boolean PositionProtected;
 292
 293     //-------------------------------------------------------------------------
 294     /** determines if the object is included in printing.
 295      */
 296     [property] boolean Print;
 297
 298     //-------------------------------------------------------------------------
 299     /** contains the type of the shadow of the object.
 300      */
 301     [property] com::sun::star::table::ShadowFormat ShadowFormat;
 302
 303     //-------------------------------------------------------------------------
 304     /** determines if the object gets an image map from a server.
 305      */
 306     [property] boolean ServerMap;
 307
 308     //-------------------------------------------------------------------------
 309     /** contains the size of the object.
 310
 311         @see BaseFrame::Height
 312         @see BaseFrame::Width
 313      */
 314     [property] com::sun::star::awt::Size Size;
 315
 316     //-------------------------------------------------------------------------
 317     /** determines if the size is protected.
 318      */
 319     [property] boolean SizeProtected;
 320     //-------------------------------------------------------------------------
 321     /** determines the type of the surrounding text.
 322
 323         @deprecated
 324      */
 325         [property] com::sun::star::text::WrapTextMode Surround;
 326
 327     //-------------------------------------------------------------------------
 328     /** determines if the text of the paragraph in which the object
 329         is anchored, wraps around the object.
 330      */
 331     [property] boolean SurroundAnchorOnly;
 332
 333     //-------------------------------------------------------------------------
 334     /** determines the influence of the text wrap on the positioning of the
 335         shape
 336
 337         <p>The value of this property is only evaluated for the positioning
 338         of the shape, if the text document setting ConsiderTextWrapOnObjPos
 339         is <TRUE/>. Valid values are given by <member>WrapInfluenceOnPosition</member></p>
 340
 341         @since OOo 2.0.0
 342      */
 343     [optional, property] short WrapInfluenceOnPosition;
 344
 345     //-------------------------------------------------------------------------
 346     /** returns the actual size of the object.
 347
 348         <p>Since to obtain the correct actual size of the object not only
 349         the  layouting for the frame needs to be finished but the whole
 350         document needs to be formatted as well. Thus if that was not done
 351         previously it may take some while to retrieve this value.</p>
 352
 353         @since OOo 2.0.4
 354      */
 355     [optional, property, maybevoid] com::sun::star::awt::Size LayoutSize;
 356
 357     //-------------------------------------------------------------------------
 358         /** contains short title for the object
 359
 360             <p>This short title is visible as an alternative tag in HTML format.
 361             Accessibility tools can read this text.</p>
 362
 363             @since OOo 3.2
 364         */
 365         [optional, property] string Title;
 366
 367     //-------------------------------------------------------------------------
 368         /** contains description for the object
 369
 370             <p>The long description text can be entered to describe a object in
 371             more detail to users with screen reader software. The description is
 372             visible as an alternative tag for accessibility tools.</p>
 373
 374             @since OOo 3.2
 375         */
 376         [optional, property] string Description;
 377 };
 378
 379 //=============================================================================
 380
 381 }; }; }; };
 382
 383 #endif