LibreOfficeDev
LibreOfficeDev 27.2 SDK API Reference
XTextLayout.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 rendering {
22 
23 interface XCanvas;
24 interface XCanvasFont;
25 interface XPolyPolygon2D;
26 
52 {
67  sequence<::com::sun::star::geometry::RealRectangle2D > queryInkMeasures();
68 
69 
83  sequence<::com::sun::star::geometry::RealRectangle2D> queryMeasures();
84 
85 
108  sequence<double> queryLogicalAdvancements();
109 
110 
131  void applyLogicalAdvancements( [in] sequence< double > aAdvancements )
133 
134 
157  sequence<boolean> queryKashidaPositions();
158 
159 
178  void applyKashidaPositions( [in] sequence< boolean > aPositions )
180 
181 
192 
193 
215  double justify( [in] double nSize )
217 
218 
251  double combinedJustify( [in] sequence< XTextLayout > aNextLayouts, [in] double nSize )
253 
254 
266 
267 
288  Caret getCaret( [in] long nInsertionIndex,
289  [in] boolean bExcludeLigatures )
291 
292 
301 
302 
308 
309 
315 
316 
317 };
318 
319 }; }; }; };
320 
321 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
This exception is thrown to indicate that a method has passed an illegal or inappropriate argument.
Definition: IllegalArgumentException.idl:27
This exception is thrown to indicate that a container has been accessed with an illegal index.
Definition: IndexOutOfBoundsException.idl:31
This interface provides access to a specific, XCanvas-dependent font incarnation.
Definition: XCanvasFont.idl:32
This is the central interface for text layouting.
Definition: XTextLayout.idl:52
void applyLogicalAdvancements([in] sequence< double > aAdvancements)
Apply explicit advancements for every character in the layout string.
double combinedJustify([in] sequence< XTextLayout > aNextLayouts, [in] double nSize)
Justify a number of text layouts to the given size.
sequence< boolean > queryKashidaPositions()
Query the Kashida insertion positions in the input string.
sequence< double > queryLogicalAdvancements()
Query the advancements for every character in the input string.
StringContext getText()
Request the text this layout contains.
Caret getCaret([in] long nInsertionIndex, [in] boolean bExcludeLigatures)
This method converts an insertion index to a caret.
void applyKashidaPositions([in] sequence< boolean > aPositions)
Apply Kashida insertion positions for the layout string.
sequence<::com::sun::star::geometry::RealRectangle2D > queryMeasures()
Query the logical bounding boxes of every character in the given text string.
TextHit getTextHit([in] ::com::sun::star::geometry::RealPoint2D aHitPoint)
This method determines the hit position in the text.
byte getMainTextDirection()
This method returns the main writing direction.
sequence<::com::sun::star::geometry::RealRectangle2D > queryInkMeasures()
Query the ink bounding boxes for every glyph in the layouted text.
XCanvasFont getFont()
Request the associated font for this layout.
::com::sun::star::geometry::RealRectangle2D queryTextBounds()
Query the overall bounding box of the text.
double justify([in] double nSize)
Justify the text to the given size.
base interface of all UNO interfaces
Definition: XInterface.idl:46
Definition: Ambiguous.idl:20
This structure defines a two-dimensional point.
Definition: RealPoint2D.idl:30
This structure contains the necessary information for a two-dimensional rectangle.
Definition: RealRectangle2D.idl:41
This structure contains the caret information.
Definition: Caret.idl:30
Collection of string-related arguments used on all canvas text interfaces.
Definition: StringContext.idl:32
This structure contains hit information for XTextLayout.
Definition: TextHit.idl:30