File: Gnumed.wxpython.gmMultiSash.cMultiSash-class.html

package info (click to toggle)
gnumed-client 1.7.5%2Bdfsg-3
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 236,656 kB
  • sloc: python: 117,577; sh: 1,118; xml: 35; makefile: 33
file content (358 lines) | stat: -rw-r--r-- 14,441 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
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>Gnumed.wxpython.gmMultiSash.cMultiSash</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="Gnumed-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            ><a class="navbar" target="_top" href="http://www.gnumed.org">GNUmed Never Sleeps</a></th>
          </tr></table></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        <a href="Gnumed-module.html">Package&nbsp;Gnumed</a> ::
        <a href="Gnumed.wxpython-module.html">Package&nbsp;wxpython</a> ::
        <a href="Gnumed.wxpython.gmMultiSash-module.html">Module&nbsp;gmMultiSash</a> ::
        Class&nbsp;cMultiSash
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options"
            >[<a href="frames.html" target="_top">frames</a
            >]&nbsp;|&nbsp;<a href="Gnumed.wxpython.gmMultiSash.cMultiSash-class.html"
            target="_top">no&nbsp;frames</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class cMultiSash</h1><p class="nomargin-top"><span class="codelink"><a href="Gnumed.wxpython.gmMultiSash-pysrc.html#cMultiSash">source&nbsp;code</a></span></p>
<pre class="base-tree">
wx.Window --+
            |
           <strong class="uidshort">cMultiSash</strong>
</pre>

<hr />
<p>Main multisash widget. Dynamically displays a stack of child 
  widgets.</p>

<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td align="left" colspan="2" class="table-header">
    <span class="table-header">Instance Methods</span></td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="__init__"></a><span class="summary-sig-name">__init__</span>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">*_args</span>,
        <span class="summary-sig-arg">**_kwargs</span>)</span></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="Gnumed.wxpython.gmMultiSash-pysrc.html#cMultiSash.__init__">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="Gnumed.wxpython.gmMultiSash.cMultiSash-class.html#get_focussed_leaf" class="summary-sig-name">get_focussed_leaf</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Retrieves the currently focused leaf.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="Gnumed.wxpython.gmMultiSash-pysrc.html#cMultiSash.get_focussed_leaf">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="get_displayed_leafs"></a><span class="summary-sig-name">get_displayed_leafs</span>(<span class="summary-sig-arg">self</span>)</span><br />
      Retrieves the currently displayed leafs.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="Gnumed.wxpython.gmMultiSash-pysrc.html#cMultiSash.get_displayed_leafs">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="Gnumed.wxpython.gmMultiSash.cMultiSash-class.html#add_content" class="summary-sig-name">add_content</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">content</span>)</span><br />
      Adds he supplied content widget to the multisash, setting it as child
      of the bottom leaf.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="Gnumed.wxpython.gmMultiSash-pysrc.html#cMultiSash.add_content">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="Clear"></a><span class="summary-sig-name">Clear</span>(<span class="summary-sig-arg">self</span>)</span><br />
      Clear all mulsisash leafs and restores initial values</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="Gnumed.wxpython.gmMultiSash-pysrc.html#cMultiSash.Clear">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="Gnumed.wxpython.gmMultiSash.cMultiSash-class.html#refresh_bottom_leaf" class="summary-sig-name">refresh_bottom_leaf</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">bottom_leaf</span>=<span class="summary-sig-default">None</span>)</span><br />
      Updates the field that keeps track of the bottom leaf.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="Gnumed.wxpython.gmMultiSash-pysrc.html#cMultiSash.refresh_bottom_leaf">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="Gnumed.wxpython.gmMultiSash.cMultiSash-class.html#refresh_displayed_leafs" class="summary-sig-name">refresh_displayed_leafs</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">splitter</span>)</span><br />
      Recursively find all displayed leafs.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="Gnumed.wxpython.gmMultiSash-pysrc.html#cMultiSash.refresh_displayed_leafs">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td align="left" colspan="2" class="table-header">
    <span class="table-header">Method Details</span></td>
</tr>
</table>
<a name="get_focussed_leaf"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_focussed_leaf</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="Gnumed.wxpython.gmMultiSash-pysrc.html#cMultiSash.get_focussed_leaf">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Retrieves the currently focused leaf. Typically, used to process some 
  action over the focused widget.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="add_content"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">add_content</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">content</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="Gnumed.wxpython.gmMultiSash-pysrc.html#cMultiSash.add_content">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Adds he supplied content widget to the multisash, setting it as child 
  of the bottom leaf.</p>
  <p>@param content The new content widget to add. @type content Any 
  wx.Window derived object.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="refresh_bottom_leaf"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">refresh_bottom_leaf</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">bottom_leaf</span>=<span class="sig-default">None</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="Gnumed.wxpython.gmMultiSash-pysrc.html#cMultiSash.refresh_bottom_leaf">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Updates the field that keeps track of the bottom leaf. It is required 
  to ensure new leafs are created under the bottom one. If the bottom leaf 
  is supplied as parameter, it is set. Typically, after a new leaf has been
  added/created. If the bottom leaf ins not supplied ad parameter, it will 
  be dinamically obtained. Typically, after leaf destruction.</p>
  <p>@param bottom_leaf The leaf to be set as bottom one @type bottom_leaf 
  wx.MultiViewLeaf</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="refresh_displayed_leafs"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">refresh_displayed_leafs</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">splitter</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="Gnumed.wxpython.gmMultiSash-pysrc.html#cMultiSash.refresh_displayed_leafs">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Recursively find all displayed leafs. @param splitter The multisash 
  splitter to traverse its leafs for. @type splitter cMultiSashSplitter</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="Gnumed-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            ><a class="navbar" target="_top" href="http://www.gnumed.org">GNUmed Never Sleeps</a></th>
          </tr></table></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0.1
    on Fri Jan 25 02:55:27 2019
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>