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