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