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