LibreOffice LibreOffice 26.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
21module com { module sun { module star { module rendering {
22
23 interface XCanvas;
24 interface XCanvasFont;
25 interface XPolyPolygon2D;
26
51 interface XTextLayout : ::com::sun::star::uno::XInterface
52{
61 sequence<XPolyPolygon2D> queryTextShapes();
62
63
78 sequence<::com::sun::star::geometry::RealRectangle2D > queryInkMeasures();
79
80
94 sequence<::com::sun::star::geometry::RealRectangle2D> queryMeasures();
95
96
119 sequence<double> queryLogicalAdvancements();
120
121
142 void applyLogicalAdvancements( [in] sequence< double > aAdvancements )
143 raises (com::sun::star::lang::IllegalArgumentException);
144
145
168 sequence<boolean> queryKashidaPositions();
169
170
189 void applyKashidaPositions( [in] sequence< boolean > aPositions )
190 raises (com::sun::star::lang::IllegalArgumentException);
191
192
202 ::com::sun::star::geometry::RealRectangle2D queryTextBounds();
203
204
226 double justify( [in] double nSize )
227 raises (com::sun::star::lang::IllegalArgumentException);
228
229
262 double combinedJustify( [in] sequence< XTextLayout > aNextLayouts, [in] double nSize )
263 raises (com::sun::star::lang::IllegalArgumentException);
264
265
276 TextHit getTextHit( [in] ::com::sun::star::geometry::RealPoint2D aHitPoint );
277
278
299 Caret getCaret( [in] long nInsertionIndex,
300 [in] boolean bExcludeLigatures )
301 raises (com::sun::star::lang::IndexOutOfBoundsException);
302
303
329 long getNextInsertionIndex( [in] long nStartIndex,
330 [in] long nCaretAdvancement,
331 [in] boolean bExcludeLigatures )
332 raises (com::sun::star::lang::IndexOutOfBoundsException);
333
334
353 XPolyPolygon2D queryVisualHighlighting( [in] long nStartIndex,
354 [in] long nEndIndex )
355 raises (com::sun::star::lang::IndexOutOfBoundsException);
356
357
378 XPolyPolygon2D queryLogicalHighlighting( [in] long nStartIndex,
379 [in] long nEndIndex )
380 raises (com::sun::star::lang::IndexOutOfBoundsException);
381
382
396 double getBaselineOffset();
397
398
406 byte getMainTextDirection();
407
408
413 XCanvasFont getFont();
414
415
420 StringContext getText();
421
422
423};
424
425}; }; }; };
426
427/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
com::sun::star::lang::IllegalArgumentException
This exception is thrown to indicate that a method has passed an illegal or inappropriate argument.
Definition: IllegalArgumentException.idl:27
com::sun::star::lang::IndexOutOfBoundsException
This exception is thrown to indicate that a container has been accessed with an illegal index.
Definition: IndexOutOfBoundsException.idl:31
com::sun::star::rendering::XCanvasFont
This interface provides access to a specific, XCanvas-dependent font incarnation.
Definition: XCanvasFont.idl:32
com::sun::star::rendering::XPolyPolygon2D
Generic interface for poly-polygons in 2D.
Definition: XPolyPolygon2D.idl:27
com::sun::star::rendering::XTextLayout
This is the central interface for text layouting.
Definition: XTextLayout.idl:52
com::sun::star::rendering::XTextLayout::applyLogicalAdvancements
void applyLogicalAdvancements([in] sequence< double > aAdvancements)
Apply explicit advancements for every character in the layout string.
com::sun::star::rendering::XTextLayout::queryTextShapes
sequence< XPolyPolygon2D > queryTextShapes()
Extract the polygonal shapes of the layouted text.
com::sun::star::rendering::XTextLayout::getNextInsertionIndex
long getNextInsertionIndex([in] long nStartIndex, [in] long nCaretAdvancement, [in] boolean bExcludeLigatures)
This method calculates a new insertion index.
com::sun::star::rendering::XTextLayout::combinedJustify
double combinedJustify([in] sequence< XTextLayout > aNextLayouts, [in] double nSize)
Justify a number of text layouts to the given size.
com::sun::star::rendering::XTextLayout::getBaselineOffset
double getBaselineOffset()
This method yields the baseline offset.
com::sun::star::rendering::XTextLayout::getText
StringContext getText()
Request the text this layout contains.
com::sun::star::rendering::XTextLayout::queryLogicalAdvancements
sequence< double > queryLogicalAdvancements()
Query the advancements for every character in the input string.
com::sun::star::rendering::XTextLayout::getCaret
Caret getCaret([in] long nInsertionIndex, [in] boolean bExcludeLigatures)
This method converts an insertion index to a caret.
com::sun::star::rendering::XTextLayout::applyKashidaPositions
void applyKashidaPositions([in] sequence< boolean > aPositions)
Apply Kashida insertion positions for the layout string.
com::sun::star::rendering::XTextLayout::queryMeasures
sequence<::com::sun::star::geometry::RealRectangle2D > queryMeasures()
Query the logical bounding boxes of every character in the given text string.
com::sun::star::rendering::XTextLayout::getTextHit
TextHit getTextHit([in] ::com::sun::star::geometry::RealPoint2D aHitPoint)
This method determines the hit position in the text.
com::sun::star::rendering::XTextLayout::queryVisualHighlighting
XPolyPolygon2D queryVisualHighlighting([in] long nStartIndex, [in] long nEndIndex)
This method generates a highlight polygon.
com::sun::star::rendering::XTextLayout::getMainTextDirection
byte getMainTextDirection()
This method returns the main writing direction.
com::sun::star::rendering::XTextLayout::queryInkMeasures
sequence<::com::sun::star::geometry::RealRectangle2D > queryInkMeasures()
Query the ink bounding boxes for every glyph in the layouted text.
com::sun::star::rendering::XTextLayout::getFont
XCanvasFont getFont()
Request the associated font for this layout.
com::sun::star::rendering::XTextLayout::queryLogicalHighlighting
XPolyPolygon2D queryLogicalHighlighting([in] long nStartIndex, [in] long nEndIndex)
This method generates a highlight polygon.
com::sun::star::rendering::XTextLayout::queryTextBounds
::com::sun::star::geometry::RealRectangle2D queryTextBounds()
Query the overall bounding box of the text.
com::sun::star::rendering::XTextLayout::queryKashidaPositions
sequence< boolean > queryKashidaPositions()
Query the Kashida insertion positions in the input string.
com::sun::star::rendering::XTextLayout::justify
double justify([in] double nSize)
Justify the text to the given size.
com::sun::star::uno::XInterface
base interface of all UNO interfaces
Definition: XInterface.idl:46
com
Definition: Ambiguous.idl:20
com::sun::star::geometry::RealPoint2D
This structure defines a two-dimensional point.
Definition: RealPoint2D.idl:30
com::sun::star::geometry::RealRectangle2D
This structure contains the necessary information for a two-dimensional rectangle.
Definition: RealRectangle2D.idl:41
com::sun::star::rendering::Caret
This structure contains the caret information.
Definition: Caret.idl:30
com::sun::star::rendering::StringContext
Collection of string-related arguments used on all canvas text interfaces.
Definition: StringContext.idl:32
com::sun::star::rendering::TextHit
This structure contains hit information for XTextLayout.
Definition: TextHit.idl:30