• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# OH_Drawing_StrutStyle
2
3
4## Overview
5
6The OH_Drawing_StrutStyle struct describes a strut style. The strut style determines the line spacing, baseline alignment mode, and other properties related to the line height when drawing text.
7
8**Since**: 12
9
10**Related module**: [Drawing](_drawing.md)
11
12**Header file**: [drawing_text_typography.h](drawing__text__typography_8h.md)
13
14## Summary
15
16
17### Member Variables
18
19| Name| Description|
20| -------- | -------- |
21| [OH_Drawing_FontWeight](_drawing.md#oh_drawing_fontweight) [weight](#weight) | Font weight used for calculating the strut. |
22| [OH_Drawing_FontStyle](_drawing.md#oh_drawing_fontstyle) [style](#style) | Font style used for calculating the strut. |
23| double [size](#size) | Size of the ascent plus descent in the logical pixels. |
24| double [heightScale](#heightscale) | Scale factor of the line height. |
25| bool [heightOverride](#heightoverride) | Whether to enable the feature to override the height. The value **true** means to enable the feature, and **false** means the opposite. |
26| bool [halfLeading](#halfleading) | Whether to enable half leading. The value **true** means to enable half leading, and **false** means the opposite. |
27| double [leading](#leading) | Custom leading to be applied to the strut. |
28| bool [forceStrutHeight](#forcestrutheight) | Whether to forcibly use the strut height for all rows. The value **true** means to forcibly use the strut height for all rows, and **false** means the opposite. |
29| size_t [familiesSize](#familiessize) | Number of font families. |
30| char \*\* [families](#families) | Double pointer to the font families used for calculating the strut. |
31
32
33## Member Variable Description
34
35
36### families
37
38```
39char** OH_Drawing_StrutStyle::families
40```
41**Description**
42
43Double pointer to the font families used for calculating the strut.
44
45
46### familiesSize
47
48```
49size_t OH_Drawing_StrutStyle::familiesSize
50```
51
52**Description**
53
54Number of font families.
55
56
57### forceStrutHeight
58
59```
60bool OH_Drawing_StrutStyle::forceStrutHeight
61```
62**Description**
63
64Whether to forcibly use the strut height for all rows. The value **true** means to forcibly use the strut height for all rows, and **false** means the opposite.
65
66
67### halfLeading
68
69```
70bool OH_Drawing_StrutStyle::halfLeading
71```
72**Description**
73
74Whether to enable half leading. The value **true** means to enable half leading, and **false** means the opposite.
75
76
77### heightOverride
78
79```
80bool OH_Drawing_StrutStyle::heightOverride
81```
82
83**Description**
84
85Whether to enable the feature to override the height. The value **true** means to enable the feature, and **false** means the opposite.
86
87
88### heightScale
89
90```
91double OH_Drawing_StrutStyle::heightScale
92```
93
94**Description**
95
96Scale factor of the line height.
97
98
99### leading
100
101```
102double OH_Drawing_StrutStyle::leading
103```
104
105**Description**
106
107Custom leading to be applied to the strut.
108
109
110### size
111
112```
113double OH_Drawing_StrutStyle::size
114```
115
116**Description**
117
118Size of the ascent plus descent in the logical pixels.
119
120
121### style
122
123```
124OH_Drawing_FontStyle OH_Drawing_StrutStyle::style
125```
126
127**Description**
128
129Font style used for calculating the strut.
130
131
132### weight
133
134```
135OH_Drawing_FontWeight OH_Drawing_StrutStyle::weight
136```
137
138**Description**
139
140Font weight used for calculating the strut.
141