ICU 62.1 62.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
37typedef void pl_paragraph;
38
44typedef void pl_line;
45
51typedef void pl_visualRun;
52
98U_INTERNAL pl_paragraph * U_EXPORT2
99pl_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
118U_INTERNAL void U_EXPORT2
120
134U_INTERNAL le_bool U_EXPORT2
135pl_isComplex(const LEUnicode chars[],
136 le_int32 count);
137
149U_INTERNAL UBiDiLevel U_EXPORT2
151
165
181U_INTERNAL le_int32 U_EXPORT2
182pl_getAscent(const pl_paragraph *paragraph);
183
194U_INTERNAL le_int32 U_EXPORT2
195pl_getDescent(const pl_paragraph *paragraph);
196
207U_INTERNAL le_int32 U_EXPORT2
208pl_getLeading(const pl_paragraph *paragraph);
209
217U_INTERNAL void U_EXPORT2
219
238U_INTERNAL pl_line * U_EXPORT2
239pl_nextLine(pl_paragraph *paragraph, float width);
240
250U_INTERNAL void U_EXPORT2
252
262U_INTERNAL le_int32 U_EXPORT2
264
275U_INTERNAL le_int32 U_EXPORT2
277
288U_INTERNAL le_int32 U_EXPORT2
290
301U_INTERNAL le_int32 U_EXPORT2
303
315U_INTERNAL le_int32 U_EXPORT2
317
334U_INTERNAL const pl_visualRun * U_EXPORT2
335pl_getLineVisualRun(const pl_line *line, le_int32 runIndex);
336
351U_INTERNAL const le_font * U_EXPORT2
353
366
376U_INTERNAL le_int32 U_EXPORT2
378
391U_INTERNAL const LEGlyphID * U_EXPORT2
393
409U_INTERNAL const float * U_EXPORT2
411
424U_INTERNAL const le_int32 * U_EXPORT2
426
437U_INTERNAL le_int32 U_EXPORT2
439
450U_INTERNAL le_int32 U_EXPORT2
452
463U_INTERNAL le_int32 U_EXPORT2
465
466#endif /* U_HIDE_INTERNAL_API */
467#endif
468#endif
le_int32 pl_getVisualRunDescent(const pl_visualRun *run)
A convenience method which returns the descent value for the font associated with this run.
le_int32 pl_getVisualRunAscent(const pl_visualRun *run)
A convenience method which returns the ascent value for the font associated with this run.
void pl_paragraph
The opaque type for a paragraph layout.
Definition playout.h:37
void pl_closeLine(pl_line *line)
Close the given line object.
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.
const le_font * pl_getVisualRunFont(const pl_visualRun *run)
Get the le_font object which represents the font of the visual run.
pl_line * pl_nextLine(pl_paragraph *paragraph, float width)
Return a pl_line object which represents next line in the paragraph.
UBiDiLevel pl_getParagraphLevel(pl_paragraph *paragraph)
Return the resolved paragraph level.
le_int32 pl_getAscent(const pl_paragraph *paragraph)
Get the max ascent value for all the fonts in the paragraph.
le_int32 pl_getLineDescent(const pl_line *line)
Get the descent of the line.
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...
void pl_visualRun
The opaque type for a visual run in a line.
Definition playout.h:51
void pl_reflow(pl_paragraph *paragraph)
Reset line breaking to start from the beginning of the paragraph.
void pl_close(pl_paragraph *paragraph)
Close the given paragraph layout object.
le_int32 pl_getLineWidth(const pl_line *line)
Get the width of the line.
void pl_line
The opaque type for a line in a paragraph layout.
Definition playout.h:44
const float * pl_getVisualRunPositions(const pl_visualRun *run)
Get the (x, y) positions of the glyphs in the visual run.
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.
le_int32 pl_countLineRuns(const pl_line *line)
Count the number of visual runs in the line.
le_int32 pl_getLineAscent(const pl_line *line)
Get the ascent of the line.
le_int32 pl_getVisualRunGlyphCount(const pl_visualRun *run)
Get the number of glyphs in the visual run.
le_int32 pl_getDescent(const pl_paragraph *paragraph)
Return the max descent value for all the fonts in the paragraph.
le_int32 pl_getLeading(const pl_paragraph *paragraph)
Return the max leading value for all the fonts in the paragraph.
const LEGlyphID * pl_getVisualRunGlyphs(const pl_visualRun *run)
Get the glyphs in the visual run.
UBiDiDirection pl_getTextDirection(pl_paragraph *paragraph)
Return the directionality of the text in the paragraph.
le_int32 pl_getLineLeading(const pl_line *line)
Get the leading of the line.
le_int32 pl_getVisualRunLeading(const pl_visualRun *run)
A convenience method which returns the leading value for the font associated with this run.
UBiDiDirection pl_getVisualRunDirection(const pl_visualRun *run)
Get the direction of the visual run.
const le_int32 * pl_getVisualRunGlyphToCharMap(const pl_visualRun *run)
Get the glyph-to-character map for this visual run.
C API for run arrays.
void pl_localeRuns
Opaque datatype representing an array of locale runs.
Definition plruns.h:35
void pl_valueRuns
Opaque datatype representing an array of value runs.
Definition plruns.h:30
void pl_fontRuns
Opaque datatype representing an array of font runs.
Definition plruns.h:25
C API: Bidi algorithm.
UBiDiDirection
UBiDiDirection values indicate the text direction.
Definition ubidi.h:419
uint8_t UBiDiLevel
UBiDiLevel is the type of the level values in this Bidi implementation.
Definition ubidi.h:332
#define U_INTERNAL
This is used to declare a function as an internal ICU C API
Definition umachine.h:119