LibreOffice
LibreOffice 6.4 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 #ifndef __com_sun_star_rendering_XTextLayout_idl__
20 #define __com_sun_star_rendering_XTextLayout_idl__
21 
33 
34 
35 module com { module sun { module star { module rendering {
36 
37 interface XCanvas;
38 interface XCanvasFont;
39 interface XPolyPolygon2D;
40 
66 {
75  sequence<XPolyPolygon2D> queryTextShapes();
76 
77 
92  sequence<::com::sun::star::geometry::RealRectangle2D > queryInkMeasures();
93 
94 
108  sequence<::com::sun::star::geometry::RealRectangle2D> queryMeasures();
109 
110 
133  sequence<double> queryLogicalAdvancements();
134 
135 
156  void applyLogicalAdvancements( [in] sequence< double > aAdvancements )
158 
159 
170 
171 
193  double justify( [in] double nSize )
195 
196 
229  double combinedJustify( [in] sequence< XTextLayout > aNextLayouts, [in] double nSize )
231 
232 
244 
245 
266  Caret getCaret( [in] long nInsertionIndex,
267  [in] boolean bExcludeLigatures )
269 
270 
296  long getNextInsertionIndex( [in] long nStartIndex,
297  [in] long nCaretAdvancement,
298  [in] boolean bExcludeLigatures )
300 
301 
320  XPolyPolygon2D queryVisualHighlighting( [in] long nStartIndex,
321  [in] long nEndIndex )
323 
324 
345  XPolyPolygon2D queryLogicalHighlighting( [in] long nStartIndex,
346  [in] long nEndIndex )
348 
349 
364 
365 
374 
375 
381 
382 
388 
389 
390 };
391 
392 }; }; }; };
393 
394 #endif
395 
396 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
XInterface.idl
com::sun::star::rendering::XPolyPolygon2D
Generic interface for poly-polygons in 2D.
Definition: XPolyPolygon2D.idl:35
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::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::Caret
This structure contains the caret information.
Definition: Caret.idl:32
Caret.idl
com::sun::star::rendering::StringContext
Collection of string-related arguments used on all canvas text interfaces.
Definition: StringContext.idl:34
com::sun::star::rendering::TextHit
This structure contains hit information for XTextLayout.
Definition: TextHit.idl:32
com::sun::star::rendering::XTextLayout::queryLogicalAdvancements
sequence< double > queryLogicalAdvancements()
Query the advancements for every character in the input string.
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::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::getNextInsertionIndex
long getNextInsertionIndex([in] long nStartIndex, [in] long nCaretAdvancement, [in] boolean bExcludeLigatures)
This method calculates a new insertion index.
com::sun::star::rendering::XTextLayout::getMainTextDirection
byte getMainTextDirection()
This method returns the main writing direction.
com::sun::star::rendering::XTextLayout
This is the central interface for text layouting.
Definition: XTextLayout.idl:66
RealPoint2D.idl
RealBezierSegment2D.idl
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::getBaselineOffset
double getBaselineOffset()
This method yields the baseline offset.
com::sun::star::rendering::XCanvasFont
This interface provides access to a specific, XCanvas-dependent font incarnation.
Definition: XCanvasFont.idl:44
com::sun::star::geometry::RealRectangle2D
This structure contains the necessary information for a two-dimensional rectangle.
Definition: RealRectangle2D.idl:43
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::queryTextShapes
sequence< XPolyPolygon2D > queryTextShapes()
Extract the polygonal shapes of the layouted text.
com::sun::star::rendering::XTextLayout::getFont
XCanvasFont getFont()
Request the associated font for this layout.
RenderState.idl
TextHit.idl
com
Definition: Ambiguous.idl:22
com::sun::star::rendering::XTextLayout::applyLogicalAdvancements
void applyLogicalAdvancements([in] sequence< double > aAdvancements)
Apply explicit advancements for every character in the layout string.
RealRectangle2D.idl
com::sun::star::lang::IllegalArgumentException
This exception is thrown to indicate that a method has passed an illegal or inappropriate argument.
Definition: IllegalArgumentException.idl:31
ViewState.idl
com::sun::star::uno::XInterface
base interface of all UNO interfaces
Definition: XInterface.idl:48
com::sun::star::geometry::RealPoint2D
This structure defines a two-dimensional point.
Definition: RealPoint2D.idl:32
com::sun::star::rendering::XTextLayout::getText
StringContext getText()
Request the text this layout contains.
IllegalArgumentException.idl
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::justify
double justify([in] double nSize)
Justify the text to the given size.
com::sun::star::lang::IndexOutOfBoundsException
This exception is thrown to indicate that a container has been accessed with an illegal index.
Definition: IndexOutOfBoundsException.idl:35
StringContext.idl
IndexOutOfBoundsException.idl
com::sun::star::rendering::XTextLayout::getCaret
Caret getCaret([in] long nInsertionIndex, [in] boolean bExcludeLigatures)
This method converts an insertion index to a caret.