1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
|
.. wxPython Phoenix documentation
This file was generated by Phoenix's sphinx generator and associated
tools, do not edit by hand.
Copyright: (c) 2011-2018 by Total Control Software
License: wxWindows License
.. include:: headings.inc
.. _wx.richtext.RichTextListStyleDefinition:
==========================================================================================================================================
|phoenix_title| **wx.richtext.RichTextListStyleDefinition**
==========================================================================================================================================
This class represents a list style definition, usually added to a :ref:`wx.richtext.RichTextStyleSheet`.
The class inherits paragraph attributes from RichTextStyleParagraphDefinition, and adds 10 further attribute objects, one for each level of a list. When applying a list style to a paragraph, the list style's base and appropriate level attributes are merged with the paragraph's existing attributes.
You can apply a list style to one or more paragraphs using :meth:`wx.richtext.RichTextCtrl.SetListStyle` . You can also use the functions :meth:`wx.richtext.RichTextCtrl.NumberList` , :meth:`wx.richtext.RichTextCtrl.PromoteList` and :meth:`wx.richtext.RichTextCtrl.ClearListStyle` .
As usual, there are :ref:`wx.richtext.RichTextBuffer` versions of these functions so that you can apply them directly to a buffer without requiring a control.
|
|class_hierarchy| Class Hierarchy
=================================
.. raw:: html
<div id="toggleBlock" onclick="return toggleVisibility(this)" class="closed" style="cursor:pointer;">
<img id="toggleBlock-trigger" src="_static/images/closed.png"/>
Inheritance diagram for class <strong>RichTextListStyleDefinition</strong>:
</div>
<div id="toggleBlock-summary" style="display:block;"></div>
<div id="toggleBlock-content" style="display:none;">
<p class="graphviz">
<center><img src="_static/images/inheritance/wx.richtext.RichTextListStyleDefinition_inheritance.png" alt="Inheritance diagram of RichTextListStyleDefinition" usemap="#dummy" class="inheritance"/></center>
<script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
<map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.richtext.RichTextListStyleDefinition.html" title="wx.richtext.RichTextListStyleDefinition" alt="" coords="26,237,299,267"/> <area shape="rect" id="node2" href="wx.richtext.RichTextParagraphStyleDefinition.html" title="wx.richtext.RichTextParagraphStyleDefinition" alt="" coords="5,160,320,189"/> <area shape="rect" id="node3" href="wx.richtext.RichTextStyleDefinition.html" title="wx.richtext.RichTextStyleDefinition" alt="" coords="37,83,288,112"/> <area shape="rect" id="node4" href="wx.Object.html" title="wx.Object" alt="" coords="119,5,206,35"/> </map>
</p>
</div>
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.richtext.RichTextListStyleDefinition.__init__` Constructor.
:meth:`~wx.richtext.RichTextListStyleDefinition.CombineWithParagraphStyle` This function combines the given paragraph style with the list style's base attributes and level style matching the given indent, returning the combined attributes.
:meth:`~wx.richtext.RichTextListStyleDefinition.FindLevelForIndent` This function finds the level (from 0 to 9) whose indentation attribute mostly closely matches `indent` (expressed in tenths of a millimetre).
:meth:`~wx.richtext.RichTextListStyleDefinition.GetCombinedStyle` This function combines the list style's base attributes and the level style matching the given indent, returning the combined attributes.
:meth:`~wx.richtext.RichTextListStyleDefinition.GetCombinedStyleForLevel` This function combines the list style's base attributes and the style for the specified level, returning the combined attributes.
:meth:`~wx.richtext.RichTextListStyleDefinition.GetLevelAttributes` Returns the style for the given level.
:meth:`~wx.richtext.RichTextListStyleDefinition.GetLevelCount` Returns the number of levels.
:meth:`~wx.richtext.RichTextListStyleDefinition.IsNumbered` Returns ``True`` if the given level has numbered list attributes.
:meth:`~wx.richtext.RichTextListStyleDefinition.SetLevelAttributes` Sets the style for the given level.
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.richtext.RichTextListStyleDefinition.LevelCount` See :meth:`~wx.richtext.RichTextListStyleDefinition.GetLevelCount`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.richtext.RichTextListStyleDefinition(RichTextParagraphStyleDefinition)
**Possible constructors**::
RichTextListStyleDefinition(name="")
This class represents a list style definition, usually added to a
RichTextStyleSheet.
.. method:: __init__(self, name=EmptyString)
Constructor.
:param `name`:
:type `name`: string
.. method:: CombineWithParagraphStyle(self, indent, paraStyle, styleSheet=None)
This function combines the given paragraph style with the list style's base attributes and level style matching the given indent, returning the combined attributes.
If `styleSheet` is specified, the base style for this definition will also be included in the result.
:param `indent`:
:type `indent`: int
:param `paraStyle`:
:type `paraStyle`: wx.richtext.RichTextAttr
:param `styleSheet`:
:type `styleSheet`: wx.richtext.RichTextStyleSheet
:rtype: :ref:`wx.richtext.RichTextAttr`
.. method:: FindLevelForIndent(self, indent)
This function finds the level (from 0 to 9) whose indentation attribute mostly closely matches `indent` (expressed in tenths of a millimetre).
:param `indent`:
:type `indent`: int
:rtype: `int`
.. method:: GetCombinedStyle(self, indent, styleSheet=None)
This function combines the list style's base attributes and the level style matching the given indent, returning the combined attributes.
If `styleSheet` is specified, the base style for this definition will also be included in the result.
:param `indent`:
:type `indent`: int
:param `styleSheet`:
:type `styleSheet`: wx.richtext.RichTextStyleSheet
:rtype: :ref:`wx.richtext.RichTextAttr`
.. method:: GetCombinedStyleForLevel(self, level, styleSheet=None)
This function combines the list style's base attributes and the style for the specified level, returning the combined attributes.
If `styleSheet` is specified, the base style for this definition will also be included in the result.
:param `level`:
:type `level`: int
:param `styleSheet`:
:type `styleSheet`: wx.richtext.RichTextStyleSheet
:rtype: :ref:`wx.richtext.RichTextAttr`
.. method:: GetLevelAttributes(self, level)
Returns the style for the given level.
`level` is a number between 0 and 9.
:param `level`:
:type `level`: int
:rtype: :ref:`wx.richtext.RichTextAttr`
.. method:: GetLevelCount(self)
Returns the number of levels.
This is hard-wired to 10. Returns the style for the given level. `level` is a number between 0 and 9.
:rtype: `int`
.. method:: IsNumbered(self, level)
Returns ``True`` if the given level has numbered list attributes.
:param `level`:
:type `level`: int
:rtype: `bool`
.. method:: SetLevelAttributes(self, level, attr)
Sets the style for the given level.
`level` is a number between 0 and 9. The first and most flexible form uses a :ref:`wx.TextAttr` object, while the second form is for convenient setting of the most commonly-used attributes.
:param `level`:
:type `level`: int
:param `attr`:
:type `attr`: wx.richtext.RichTextAttr
.. attribute:: LevelCount
See :meth:`~wx.richtext.RichTextListStyleDefinition.GetLevelCount`
|
