LibreOffice LibreOffice 25.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
20
21 module com { module sun { module star { module text {
22
23
42published service TextFrame
43{
47 service BaseFrame;
48
52 interface com::sun::star::text::XTextFrame;
55 [property] long FrameHeightAbsolute;
56
59 [property] long FrameWidthAbsolute;
60
61
67 [property] byte FrameWidthPercent;
68
75 [property] byte FrameHeightPercent;
79 [property] boolean FrameIsAutomaticHeight;
85 [property] short SizeType;
90 [optional, property] boolean EditInReadonly;
91
98 [optional, property] short WidthType;
99
103 [optional, property] short WritingMode;
104
132 [optional, property] boolean IsFollowingTextFlow;
133
139 [optional, property] com::sun::star::drawing::TextVerticalAdjust TextVerticalAdjust;
140
147 [optional, readonly, property] com::sun::star::text::XText ParentText;
148};
149
150
151}; }; }; };
152
153/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
com::sun::star::text::XTextFrame
provides access to the Text of a TextFrame.
Definition: XTextFrame.idl:28
com::sun::star::text::XText
extends a XSimpleText by the capability of inserting XTextContents.
Definition: XText.idl:29
com::sun::star::drawing::TextVerticalAdjust
TextVerticalAdjust
This enumeration specifies the vertical position of text inside a shape in relation to the shape.
Definition: TextVerticalAdjust.idl:30
com
Definition: Ambiguous.idl:20
com::sun::star::text::TextFrame
specifies a rectangular shape which contains a Text object and is attached to a piece of surrounding ...
Definition: TextFrame.idl:43
com::sun::star::text::TextFrame::WritingMode
short WritingMode
contains the writing direction, as represented by the com::sun::star::text::WritingMode2 constants
Definition: TextFrame.idl:103
com::sun::star::text::TextFrame::FrameWidthPercent
byte FrameWidthPercent
specifies a width relative to the width of the surrounding text.
Definition: TextFrame.idl:67
com::sun::star::text::TextFrame::ParentText
com::sun::star::text::XText ParentText
Parent text of this text frame.
Definition: TextFrame.idl:147
com::sun::star::text::TextFrame::WidthType
short WidthType
determines the interpretation of the width and relative width properties.
Definition: TextFrame.idl:98
com::sun::star::text::TextFrame::IsFollowingTextFlow
boolean IsFollowingTextFlow
controls, if the frame follows the text flow or can leave its layout environment
Definition: TextFrame.idl:132
com::sun::star::text::TextFrame::FrameWidthAbsolute
long FrameWidthAbsolute
contains the metric width value of the frame.
Definition: TextFrame.idl:59
com::sun::star::text::TextFrame::EditInReadonly
boolean EditInReadonly
determines if the text frame should be editable in a read-only document.
Definition: TextFrame.idl:90
com::sun::star::text::TextFrame::FrameIsAutomaticHeight
boolean FrameIsAutomaticHeight
If "AutomaticHeight" is set, then the object grows if it is required by the frame content.
Definition: TextFrame.idl:79
com::sun::star::text::TextFrame::BaseFrame
service BaseFrame
contains the definition of interfaces and properties that are supported by text frames,...
Definition: TextFrame.idl:47
com::sun::star::text::TextFrame::FrameHeightPercent
byte FrameHeightPercent
specifies a width relative to the width of the surrounding text.
Definition: TextFrame.idl:75
com::sun::star::text::TextFrame::SizeType
short SizeType
determines the interpretation of the height and relative height properties.
Definition: TextFrame.idl:85
com::sun::star::text::TextFrame::TextVerticalAdjust
com::sun::star::drawing::TextVerticalAdjust TextVerticalAdjust
adjusts the vertical position of the text inside of the frame.
Definition: TextFrame.idl:139
com::sun::star::text::TextFrame::FrameHeightAbsolute
long FrameHeightAbsolute
contains the metric height value of the frame.
Definition: TextFrame.idl:52