LibreOffice
LibreOffice 7.2 SDK API Reference
TextFrame.idl
Go to the documentation of this file.
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_TextFrame_idl__
20 #define __com_sun_star_text_TextFrame_idl__
21 
24 
25 
26  module com { module sun { module star { module text {
27 
28 
47 published service TextFrame
48 {
52  service BaseFrame;
53 
60  [property] long FrameHeightAbsolute;
61 
64  [property] long FrameWidthAbsolute;
65 
66 
72  [property] byte FrameWidthPercent;
73 
80  [property] byte FrameHeightPercent;
84  [property] boolean FrameIsAutomaticHeight;
90  [property] short SizeType;
95  [optional, property] boolean EditInReadonly;
96 
103  [optional, property] short WidthType;
104 
108  [optional, property] short WritingMode;
109 
137  [optional, property] boolean IsFollowingTextFlow;
138 
145 
152  [optional, readonly, property] com::sun::star::text::XText ParentText;
153 };
154 
155 
156 }; }; }; };
157 
158 #endif
159 
160 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
provides access to the Text of a TextFrame.
Definition: XTextFrame.idl:33
extends a XSimpleText by the capability of inserting XTextContents.
Definition: XText.idl:41
TextVerticalAdjust
This enumeration specifies the vertical position of text inside a shape in relation to the shape.
Definition: TextVerticalAdjust.idl:32
Definition: Ambiguous.idl:22
specifies a rectangular shape which contains a Text object and is attached to a piece of surrounding ...
Definition: TextFrame.idl:48
short WritingMode
contains the writing direction, as represented by the com::sun::star::text::WritingMode2 constants
Definition: TextFrame.idl:108
byte FrameWidthPercent
specifies a width relative to the width of the surrounding text.
Definition: TextFrame.idl:72
com::sun::star::text::XText ParentText
Parent text of this text frame.
Definition: TextFrame.idl:152
short WidthType
determines the interpretation of the width and relative width properties.
Definition: TextFrame.idl:103
boolean IsFollowingTextFlow
controls, if the frame follows the text flow or can leave its layout environment
Definition: TextFrame.idl:137
long FrameWidthAbsolute
contains the metric width value of the frame.
Definition: TextFrame.idl:64
boolean EditInReadonly
determines if the text frame should be editable in a read-only document.
Definition: TextFrame.idl:95
boolean FrameIsAutomaticHeight
If "AutomaticHeight" is set, then the object grows if it is required by the frame content.
Definition: TextFrame.idl:84
service BaseFrame
contains the definition of interfaces and properties that are supported by text frames,...
Definition: TextFrame.idl:52
byte FrameHeightPercent
specifies a width relative to the width of the surrounding text.
Definition: TextFrame.idl:80
short SizeType
determines the interpretation of the height and relative height properties.
Definition: TextFrame.idl:90
com::sun::star::drawing::TextVerticalAdjust TextVerticalAdjust
adjusts the vertical position of the text inside of the frame.
Definition: TextFrame.idl:144
long FrameHeightAbsolute
contains the metric height value of the frame.
Definition: TextFrame.idl:57