ICU 70.1 70.1

playout.h
Go to the documentation of this file.
1// © 2016 and later: Unicode, Inc. and others.
2// License & terms of use: http://www.unicode.org/copyright.html
3/*
4 *
5 * (C) Copyright IBM Corp. 1998-2011 - All Rights Reserved
6 *
7 */
8
9#ifndef __PLAYOUT_H
10#define __PLAYOUT_H
11
12/*
13 * ParagraphLayout doesn't make much sense without
14 * BreakIterator...
15 */
16#include "unicode/ubidi.h"
17#if ! UCONFIG_NO_BREAK_ITERATION
18#ifndef U_HIDE_INTERNAL_API
19
20#include "layout/LETypes.h"
21#include "plruns.h"
22
37 typedef void pl_paragraph;
38
44 typedef void pl_line;
45
51 typedef void pl_visualRun;
52
98 U_CAPI pl_paragraph * U_EXPORT2
99 pl_create(const LEUnicode chars[],
100 le_int32 count,
101 const pl_fontRuns *fontRuns,
102 const pl_valueRuns *levelRuns,
103 const pl_valueRuns *scriptRuns,
104 const pl_localeRuns *localeRuns,
105 UBiDiLevel paragraphLevel,
106 le_bool vertical,
107 LEErrorCode *status);
108
118 U_CAPI void U_EXPORT2
119 pl_close(pl_paragraph *paragraph);
120
134 U_CAPI le_bool U_EXPORT2
135 pl_isComplex(const LEUnicode chars[],
136 le_int32 count);
137
149 U_CAPI UBiDiLevel U_EXPORT2
150 pl_getParagraphLevel(pl_paragraph *paragraph);
151
163 U_CAPI UBiDiDirection U_EXPORT2
164 pl_getTextDirection(pl_paragraph *paragraph);
165
176 U_CAPI le_int32 U_EXPORT2
177 pl_getAscent(const pl_paragraph *paragraph);
178
189 U_CAPI le_int32 U_EXPORT2
190 pl_getDescent(const pl_paragraph *paragraph);
191
202 U_CAPI le_int32 U_EXPORT2
203 pl_getLeading(const pl_paragraph *paragraph);
204
212 U_CAPI void U_EXPORT2
213 pl_reflow(pl_paragraph *paragraph);
214
233 U_CAPI pl_line * U_EXPORT2
234 pl_nextLine(pl_paragraph *paragraph, float width);
235
245 U_CAPI void U_EXPORT2
246 pl_closeLine(pl_line *line);
247
257 U_CAPI le_int32 U_EXPORT2
258 pl_countLineRuns(const pl_line *line);
259
270 U_CAPI le_int32 U_EXPORT2
271 pl_getLineAscent(const pl_line *line);
272
283 U_CAPI le_int32 U_EXPORT2
284 pl_getLineDescent(const pl_line *line);
285
296 U_CAPI le_int32 U_EXPORT2
297 pl_getLineLeading(const pl_line *line);
298
310 U_CAPI le_int32 U_EXPORT2
311 pl_getLineWidth(const pl_line *line);
312
329 U_CAPI const pl_visualRun * U_EXPORT2
330 pl_getLineVisualRun(const pl_line *line, le_int32 runIndex);
331
346 U_CAPI const le_font * U_EXPORT2
347 pl_getVisualRunFont(const pl_visualRun *run);
348
359 U_CAPI UBiDiDirection U_EXPORT2
360 pl_getVisualRunDirection(const pl_visualRun *run);
361
371 U_CAPI le_int32 U_EXPORT2
372 pl_getVisualRunGlyphCount(const pl_visualRun *run);
373
386 U_CAPI const LEGlyphID * U_EXPORT2
387 pl_getVisualRunGlyphs(const pl_visualRun *run);
388
404 U_CAPI const float * U_EXPORT2
405 pl_getVisualRunPositions(const pl_visualRun *run);
406
419 U_CAPI const le_int32 * U_EXPORT2
420 pl_getVisualRunGlyphToCharMap(const pl_visualRun *run);
421
432 U_CAPI le_int32 U_EXPORT2
433 pl_getVisualRunAscent(const pl_visualRun *run);
434
445 U_CAPI le_int32 U_EXPORT2
446 pl_getVisualRunDescent(const pl_visualRun *run);
447
458 U_CAPI le_int32 U_EXPORT2
459 pl_getVisualRunLeading(const pl_visualRun *run);
460
461#endif /* U_HIDE_INTERNAL_API */
462#endif
463#endif
pl_paragraph
void pl_paragraph
The opaque type for a paragraph layout.
Definition: playout.h:37
pl_getLineAscent
U_CAPI le_int32 pl_getLineAscent(const pl_line *line)
Get the ascent of the line.
pl_getLineVisualRun
U_CAPI const pl_visualRun * pl_getLineVisualRun(const pl_line *line, le_int32 runIndex)
Get a ParagraphLayout::VisualRun object for a given visual run in the line.
pl_create
U_CAPI pl_paragraph * pl_create(const LEUnicode chars[], le_int32 count, const pl_fontRuns *fontRuns, const pl_valueRuns *levelRuns, const pl_valueRuns *scriptRuns, const pl_localeRuns *localeRuns, UBiDiLevel paragraphLevel, le_bool vertical, LEErrorCode *status)
Construct a ParagraphLayout object for a styled paragraph.
pl_countLineRuns
U_CAPI le_int32 pl_countLineRuns(const pl_line *line)
Count the number of visual runs in the line.
pl_getVisualRunDirection
U_CAPI UBiDiDirection pl_getVisualRunDirection(const pl_visualRun *run)
Get the direction of the visual run.
pl_getVisualRunPositions
U_CAPI const float * pl_getVisualRunPositions(const pl_visualRun *run)
Get the (x, y) positions of the glyphs in the visual run.
pl_closeLine
U_CAPI void pl_closeLine(pl_line *line)
Close the given line object.
pl_visualRun
void pl_visualRun
The opaque type for a visual run in a line.
Definition: playout.h:51
pl_getVisualRunLeading
U_CAPI le_int32 pl_getVisualRunLeading(const pl_visualRun *run)
A convenience method which returns the leading value for the font associated with this run.
pl_getLineDescent
U_CAPI le_int32 pl_getLineDescent(const pl_line *line)
Get the descent of the line.
pl_getVisualRunFont
U_CAPI const le_font * pl_getVisualRunFont(const pl_visualRun *run)
Get the le_font object which represents the font of the visual run.
pl_close
U_CAPI void pl_close(pl_paragraph *paragraph)
Close the given paragraph layout object.
pl_getLeading
U_CAPI le_int32 pl_getLeading(const pl_paragraph *paragraph)
Return the max leading value for all the fonts in the paragraph.
pl_line
void pl_line
The opaque type for a line in a paragraph layout.
Definition: playout.h:44
pl_getLineLeading
U_CAPI le_int32 pl_getLineLeading(const pl_line *line)
Get the leading of the line.
pl_nextLine
U_CAPI pl_line * pl_nextLine(pl_paragraph *paragraph, float width)
Return a pl_line object which represents next line in the paragraph.
pl_getAscent
U_CAPI le_int32 pl_getAscent(const pl_paragraph *paragraph)
Return the max ascent value for all the fonts in the paragraph.
pl_getVisualRunGlyphs
U_CAPI const LEGlyphID * pl_getVisualRunGlyphs(const pl_visualRun *run)
Get the glyphs in the visual run.
pl_getVisualRunAscent
U_CAPI le_int32 pl_getVisualRunAscent(const pl_visualRun *run)
A convenience method which returns the ascent value for the font associated with this run.
pl_isComplex
U_CAPI le_bool pl_isComplex(const LEUnicode chars[], le_int32 count)
Examine the given text and determine if it contains characters in any script which requires complex p...
pl_getLineWidth
U_CAPI le_int32 pl_getLineWidth(const pl_line *line)
Get the width of the line.
pl_getVisualRunGlyphCount
U_CAPI le_int32 pl_getVisualRunGlyphCount(const pl_visualRun *run)
Get the number of glyphs in the visual run.
pl_getDescent
U_CAPI le_int32 pl_getDescent(const pl_paragraph *paragraph)
Return the max descent value for all the fonts in the paragraph.
pl_getParagraphLevel
U_CAPI UBiDiLevel pl_getParagraphLevel(pl_paragraph *paragraph)
Return the resolved paragraph level.
pl_getVisualRunGlyphToCharMap
U_CAPI const le_int32 * pl_getVisualRunGlyphToCharMap(const pl_visualRun *run)
Get the glyph-to-character map for this visual run.
pl_getTextDirection
U_CAPI UBiDiDirection pl_getTextDirection(pl_paragraph *paragraph)
Return the directionality of the text in the paragraph.
pl_getVisualRunDescent
U_CAPI le_int32 pl_getVisualRunDescent(const pl_visualRun *run)
A convenience method which returns the descent value for the font associated with this run.
pl_reflow
U_CAPI void pl_reflow(pl_paragraph *paragraph)
Reset line breaking to start from the beginning of the paragraph.
plruns.h
C API for run arrays.
pl_localeRuns
void pl_localeRuns
Opaque datatype representing an array of locale runs.
Definition: plruns.h:35
pl_valueRuns
void pl_valueRuns
Opaque datatype representing an array of value runs.
Definition: plruns.h:30
pl_fontRuns
void pl_fontRuns
Opaque datatype representing an array of font runs.
Definition: plruns.h:25
ubidi.h
C API: Bidi algorithm.
UBiDiDirection
UBiDiDirection
UBiDiDirection values indicate the text direction.
Definition: ubidi.h:429
UBiDiLevel
uint8_t UBiDiLevel
UBiDiLevel is the type of the level values in this Bidi implementation.
Definition: ubidi.h:340
U_CAPI
#define U_CAPI
This is used to declare a function as a public ICU C API.
Definition: umachine.h:110