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
|
.. wxPython Phoenix documentation
This file was generated by Phoenix's sphinx generator and associated
tools, do not edit by hand.
Copyright: (c) 2011-2020 by Total Control Software
License: wxWindows License
.. include:: headings.inc
.. _wx.grid.GridFitMode:
==========================================================================================================================================
|phoenix_title| **wx.grid.GridFitMode**
==========================================================================================================================================
Allows to specify the behaviour when the cell contents doesn't fit into its allotted space.
Objects of this class are used with :meth:`wx.grid.GridCellAttr.SetFitMode` and :meth:`wx.grid.Grid.SetDefaultCellFitMode` and :meth:`wx.grid.Grid.SetCellFitMode` functions and allow to specify what should happen if the cell contents doesn't fit into the available space. The possibilities are:
- Overflow into the cell to the right if it is empty, or possibly several cells, if the cell contents still doesn't fit after overflowing into the immediately neighbouring cell.
- Clip the cell contents, discarding the part which doesn't fit.
- Ellipsize the cell contents, i.e. replace the non-fitting part with ellipsis (
The default behaviour is to overflow, use :meth:`wx.grid.Grid.SetDefaultCellFitMode` to change this, for example: ::
grid.SetDefaultCellFitMode(wx.grid.GridFitMode.Clip())
Objects of this class are created using static functions instead of constructors for better readability and can't be changed after creating them except by using the assignment operator.
.. versionadded:: 4.1/wxWidgets-3.1.4
|
|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>GridFitMode</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.grid.GridFitMode_inheritance.png" alt="Inheritance diagram of GridFitMode" 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.grid.GridFitMode.html" title="wx.grid.GridFitMode" alt="" coords="5,5,156,35"/> </map>
</p>
</div>
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.grid.GridFitMode.__init__` Default constructor creates an object not specifying any behaviour.
:meth:`~wx.grid.GridFitMode.Clip` Pseudo-constructor for object specifying clipping behaviour.
:meth:`~wx.grid.GridFitMode.Ellipsize` Pseudo-constructor for object specifying ellipsize behaviour.
:meth:`~wx.grid.GridFitMode.GetEllipsizeMode` Return ellipsize mode, possibly ``ELLIPSIZE_NONE`` .
:meth:`~wx.grid.GridFitMode.IsClip` Return ``True`` if the object specifies clipping behaviour.
:meth:`~wx.grid.GridFitMode.IsOverflow` Return ``True`` if the object specifies overflow behaviour.
:meth:`~wx.grid.GridFitMode.IsSpecified` Return ``True`` if the object specifies some particular behaviour.
:meth:`~wx.grid.GridFitMode.Overflow` Pseudo-constructor for object specifying overflow behaviour.
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.grid.GridFitMode.EllipsizeMode` See :meth:`~wx.grid.GridFitMode.GetEllipsizeMode`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.grid.GridFitMode(object)
**Possible constructors**::
GridFitMode()
Allows to specify the behaviour when the cell contents doesn't fit
into its allotted space.
.. method:: __init__(self)
Default constructor creates an object not specifying any behaviour.
This constructor is not very useful, use static methods :meth:`Clip` and :meth:`Overflow` below to create objects of this class instead.
.. staticmethod:: Clip()
Pseudo-constructor for object specifying clipping behaviour.
:rtype: :ref:`wx.grid.GridFitMode`
.. staticmethod:: Ellipsize(ellipsize=ELLIPSIZE_END)
Pseudo-constructor for object specifying ellipsize behaviour.
:param `ellipsize`:
:type `ellipsize`: wx.EllipsizeMode
:rtype: :ref:`wx.grid.GridFitMode`
.. method:: GetEllipsizeMode(self)
Return ellipsize mode, possibly ``ELLIPSIZE_NONE`` .
For the objects constructed using :meth:`Ellipsize` , the same ellipsization mode as was passed to it is returned. For all the other objects, ``ELLIPSIZE_NONE`` is.
:rtype: :ref:`wx.EllipsizeMode`
.. method:: IsClip(self)
Return ``True`` if the object specifies clipping behaviour.
This method returns ``True`` only for the objects returned by :meth:`Clip` .
:rtype: `bool`
.. method:: IsOverflow(self)
Return ``True`` if the object specifies overflow behaviour.
This method returns ``True`` only for the objects returned by :meth:`Overflow` .
:rtype: `bool`
.. method:: IsSpecified(self)
Return ``True`` if the object specifies some particular behaviour.
This method returns ``False`` for default-constructed objects of this type only.
:rtype: `bool`
.. staticmethod:: Overflow()
Pseudo-constructor for object specifying overflow behaviour.
:rtype: :ref:`wx.grid.GridFitMode`
.. attribute:: EllipsizeMode
See :meth:`~wx.grid.GridFitMode.GetEllipsizeMode`
|
