File: wx.StatusBarPane.txt

package info (click to toggle)
wxpython4.0 4.0.4%2Bdfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 211,112 kB
  • sloc: cpp: 888,355; python: 223,130; makefile: 52,087; ansic: 45,780; sh: 3,012; xml: 1,534; perl: 264
file content (291 lines) | stat: -rw-r--r-- 6,693 bytes parent folder | download
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
291
.. 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.StatusBarPane:

==========================================================================================================================================
|phoenix_title|  **wx.StatusBarPane**
==========================================================================================================================================

A status bar pane data container used by :ref:`wx.StatusBar`.          







         



.. seealso:: :ref:`wx.StatusBar`    







|

|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>StatusBarPane</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.StatusBarPane_inheritance.png" alt="Inheritance diagram of StatusBarPane" usemap="#dummy" class="inheritance"/></center>
   </div>
   <script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.StatusBarPane.html" title="wx.StatusBarPane" alt="" coords="5,5,141,35"/> </map> 
   </p>

|


|method_summary| Methods Summary
================================

================================================================================ ================================================================================
:meth:`~wx.StatusBarPane.__init__`                                               Constructs the pane with the given `style`  and `width`.
:meth:`~wx.StatusBarPane.GetStyle`                                               Returns the pane style.
:meth:`~wx.StatusBarPane.GetText`                                                Returns the text currently shown in this pane.
:meth:`~wx.StatusBarPane.GetWidth`                                               Returns the pane width; it maybe negative, indicating a variable-width field.
:meth:`~wx.StatusBarPane.IsEllipsized`                                           
:meth:`~wx.StatusBarPane.PopText`                                                Restore the message saved by the last call to Push() (unless it was changed by an intervening call to :meth:`~StatusBarPane.SetText` ) and return ``True`` if we really restored anything.
:meth:`~wx.StatusBarPane.PushText`                                               Save the existing text on top of a stack and make the new text current.
:meth:`~wx.StatusBarPane.SetIsEllipsized`                                        
:meth:`~wx.StatusBarPane.SetStyle`                                               
:meth:`~wx.StatusBarPane.SetText`                                                Set text.
:meth:`~wx.StatusBarPane.SetWidth`                                               
================================================================================ ================================================================================


|


|property_summary| Properties Summary
=====================================

================================================================================ ================================================================================
:attr:`~wx.StatusBarPane.Style`                                                  See :meth:`~wx.StatusBarPane.GetStyle` and :meth:`~wx.StatusBarPane.SetStyle`
:attr:`~wx.StatusBarPane.Text`                                                   See :meth:`~wx.StatusBarPane.GetText` and :meth:`~wx.StatusBarPane.SetText`
:attr:`~wx.StatusBarPane.Width`                                                  See :meth:`~wx.StatusBarPane.GetWidth` and :meth:`~wx.StatusBarPane.SetWidth`
================================================================================ ================================================================================


|


|api| Class API
===============


.. class:: wx.StatusBarPane(object)

   **Possible constructors**::

       StatusBarPane(style=SB_NORMAL, width=0)
       
   
   A status bar pane data container used by StatusBar.



   .. method:: __init__(self, style=SB_NORMAL, width=0)

      Constructs the pane with the given `style`  and `width`.                  


      :param `style`: 
      :type `style`: int
      :param `width`: 
      :type `width`: int







   .. method:: GetStyle(self)

      Returns the pane style.                  

      :rtype: `int`








   .. method:: GetText(self)

      Returns the text currently shown in this pane.                  

      :rtype: `string`








   .. method:: GetWidth(self)

      Returns the pane width; it maybe negative, indicating a variable-width field.                  

      :rtype: `int`








   .. method:: IsEllipsized(self)



      :rtype: `bool`








   .. method:: PopText(self)

      Restore the message saved by the last call to Push() (unless it was changed by an intervening call to :meth:`SetText` ) and return ``True`` if we really restored anything.                  

      :rtype: `bool`








   .. method:: PushText(self, text)

      Save the existing text on top of a stack and make the new text current.                  

      Returns ``True`` if the text really changed.                  


      :param `text`: 
      :type `text`: string




      :rtype: `bool`








   .. method:: SetIsEllipsized(self, isEllipsized)




      :param `isEllipsized`: 
      :type `isEllipsized`: bool







   .. method:: SetStyle(self, style)




      :param `style`: 
      :type `style`: int







   .. method:: SetText(self, text)

      Set text.                  

      Returns ``True`` if it changed or ``False`` if it was already set to this value.                  


      :param `text`: 
      :type `text`: string




      :rtype: `bool`








   .. method:: SetWidth(self, width)




      :param `width`: 
      :type `width`: int







   .. attribute:: Style

      See :meth:`~wx.StatusBarPane.GetStyle` and :meth:`~wx.StatusBarPane.SetStyle`


   .. attribute:: Text

      See :meth:`~wx.StatusBarPane.GetText` and :meth:`~wx.StatusBarPane.SetText`


   .. attribute:: Width

      See :meth:`~wx.StatusBarPane.GetWidth` and :meth:`~wx.StatusBarPane.SetWidth`