summaryrefslogtreecommitdiff log msg author committer range
path: root/offapi/com/sun/star/text/TextFrame.idl
blob: e43b3d79197cb53760e7c8cd68bf13c3f5e8a057 (plain)
 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172  /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite * * This file is part of OpenOffice.org. * * OpenOffice.org is free software: you can redistribute it and/or modify * it under the terms of the GNU Lesser General Public License version 3 * only, as published by the Free Software Foundation. * * OpenOffice.org is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU Lesser General Public License version 3 for more details * (a copy is included in the LICENSE file that accompanied this code). * * You should have received a copy of the GNU Lesser General Public License * version 3 along with OpenOffice.org. If not, see * * for a copy of the LGPLv3 License. * ************************************************************************/ #ifndef __com_sun_star_text_TextFrame_idl__ #define __com_sun_star_text_TextFrame_idl__ #ifndef __com_sun_star_text_XTextFrame_idl__ #include #endif #ifndef __com_sun_star_text_BaseFrame_idl__ #include #endif //============================================================================= module com { module sun { module star { module text { //============================================================================= /** specifies a rectangular shape which contains a Text object and is attached to a piece of surrounding Text. @see Text @example StarBasic

This example shows how to create a TextFrame and insert it at the very beginning of Text component. The macro is ready to run, if it is a script within a text document.

Sub Main oFrame = ThisComponent.createInstance( "com.sun.star.text.TextFrame" ) oFrame.Width = 6000 ThisComponent.Text.insertTextContent( ThisComponent.Text.Start, oFrame, false ) oFrame.Text.String = "Hello, this text is within the frame." End Sub */ published service TextFrame { /** contains the definition of interfaces and properties that are supported by text frames, graphic objects and embeddedobjects. */ service BaseFrame; /** This interface makes it possible to access the text within this text frame. */ interface com::sun::star::text::XTextFrame; //------------------------------------------------------------------------- /** contains the metric height value of the frame. */ [property] long FrameHeightAbsolute; //------------------------------------------------------------------------- /** contains the metric width value of the frame. */ [property] long FrameWidthAbsolute; //------------------------------------------------------------------------- /** specifies a width relative to the width of the surrounding text.

If the value for "WidthPercent" is 0, the absolute value from is used.

*/ [property] byte FrameWidthPercent; //------------------------------------------------------------------------- /** specifies a width relative to the width of the surrounding text.

If the value for "HeightPercent" is 0, the absolute value from is used.

*/ [property] byte FrameHeightPercent; //------------------------------------------------------------------------- /** If "AutomaticHeight" is set, then the object grows if it is required by the frame content. */ [property] boolean FrameIsAutomaticHeight; //------------------------------------------------------------------------- /** determines the interpretation of the height and relative height properties. @see SizeType */ [property] short SizeType; //------------------------------------------------------------------------- /** determines if the text frame should be editable in a read-only document. (This is usually used in forms.) */ [optional, property] boolean EditInReadonly; //------------------------------------------------------------------------- /** determines the interpretation of the width and relative width properties. @see SizeType @since OOo 2.4 */ [optional, property] short WidthType; //----------------------------------------------------------------------------- /** contains the writing direction, as represented by the WritingMode2 constants */ [optional, property] short WritingMode; //----------------------------------------------------------------------------- /** controls, if the frame follows the text flow or can leave its layout environment

If set, the frame follows the text flow and doesn't leaves the layout environment, which is given by its anchor, above and below. E.g.: Anchor resides in the document body then the frame doesn't leave the document body above and below and follows the text flow through the document bodies of the different pages. If not set, the frame doesn't follow the text flow and stays on the page, on which its anchor is found, but it may leave the layout environment, which is given by its anchor. E.g.: Anchor resides in the document body then the frame stays on page, where this document body is, but it could leave the document body above and below, e.g. overlapping with the page header. Note: The areas for the vertical orientation relation at page areas are interpreted in dependence to this property (@see BaseFrameProperties.VertOrientRelation). If property is set, the page area is interpreted as the layout environment, given by its anchor. E.g.: Anchor resides in the page header then the page header determines the page area. If property isn't set, the page area is determined by the document page, the anchor is on. E.g.: Anchor resides in the page header then the document page, the page header is on, determines the page area. An exception of this interpretation rule is applied, if the anchor resides in a table cell. In this situation the page area is always detemined by the table cell.

*/ [optional, property] boolean IsFollowingTextFlow; }; //============================================================================= }; }; }; }; #endif