File: Gnumed.wxpython.gmEditArea.cGenericEditAreaMixin-class.html

package info (click to toggle)
gnumed-client 1.1.17%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: wheezy
  • size: 117,940 kB
  • sloc: python: 63,340; sh: 713; makefile: 23
file content (522 lines) | stat: -rw-r--r-- 20,542 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
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
<?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.gmEditArea.cGenericEditAreaMixin</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.gmEditArea-module.html">Module&nbsp;gmEditArea</a> ::
        Class&nbsp;cGenericEditAreaMixin
      </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.gmEditArea.cGenericEditAreaMixin-class.html"
            target="_top">no&nbsp;frames</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class cGenericEditAreaMixin</h1><p class="nomargin-top"><span class="codelink"><a href="Gnumed.wxpython.gmEditArea-pysrc.html#cGenericEditAreaMixin">source&nbsp;code</a></span></p>
<pre class="base-tree">
object --+
         |
        <strong class="uidshort">cGenericEditAreaMixin</strong>
</pre>

<dl><dt>Known Subclasses:</dt>
<dd>
      <ul class="subclass-list">
<li><a href="Gnumed.wxpython.gmContactWidgets.cCommChannelEditAreaPnl-class.html">gmContactWidgets.cCommChannelEditAreaPnl</a></li><li>, <a href="Gnumed.wxpython.gmOrganizationWidgets.cOrgUnitEAPnl-class.html">gmOrganizationWidgets.cOrgUnitEAPnl</a></li><li>, <a href="Gnumed.wxpython.gmOrganizationWidgets.cOrganizationEAPnl-class.html">gmOrganizationWidgets.cOrganizationEAPnl</a></li><li>, <a href="Gnumed.wxpython.gmI18nWidgets.cDatabaseTranslationEAPnl-class.html">gmI18nWidgets.cDatabaseTranslationEAPnl</a></li><li>, <a href="Gnumed.wxpython.gmAddressWidgets.cProvinceEAPnl-class.html">gmAddressWidgets.cProvinceEAPnl</a></li><li>, <a href="Gnumed.wxpython.gmTextExpansionWidgets.cTextExpansionEditAreaPnl-class.html">gmTextExpansionWidgets.cTextExpansionEditAreaPnl</a></li>  </ul>
</dd></dl>

<hr />
<pre class="literalblock">
Mixin for edit area panels providing generic functionality.

        **************** start of template ****************

#====================================================================
# Class definition:

from Gnumed.wxGladeWidgets import wxgXxxEAPnl

class cXxxEAPnl(wxgXxxEAPnl.wxgXxxEAPnl, gmEditArea.cGenericEditAreaMixin):

        def __init__(self, *args, **kwargs):

                try:
                        data = kwargs['xxx']
                        del kwargs['xxx']
                except KeyError:
                        data = None

                wxgXxxEAPnl.wxgXxxEAPnl.__init__(self, *args, **kwargs)
                gmEditArea.cGenericEditAreaMixin.__init__(self)

                # Code using this mixin should set mode and data
                # after instantiating the class:
                self.mode = 'new'
                self.data = data
                if data is not None:
                        self.mode = 'edit'

                #self.__init_ui()
        #----------------------------------------------------------------
#       def __init_ui(self):
#               # adjust phrasewheels etc
        #----------------------------------------------------------------
        # generic Edit Area mixin API
        #----------------------------------------------------------------
        def _valid_for_save(self):

                # its best to validate bottom -&gt; top such that the
                # cursor ends up in the topmost failing field

                # remove when implemented:
                return False

                validity = True

                if self._TCTRL_xxx.GetValue().strip() == u'':
                        validity = False
                        self.display_tctrl_as_valid(tctrl = self._TCTRL_xxx, valid = False)
                        self._TCTRL_xxx.SetFocus()
                else:
                        self.display_tctrl_as_valid(tctrl = self._TCTRL_xxx, valid = True)

                if self._PRW_xxx.GetData() is None:
                        validity = False
                        self._PRW_xxx.display_as_valid(False)
                        self._PRW_xxx.SetFocus()
                else:
                        self._PRW_xxx.display_as_valid(True)

                return validity
        #----------------------------------------------------------------
        def _save_as_new(self):

                # remove when implemented:
                return False

                # save the data as a new instance
                data = gmXXXX.create_xxxx()

                data[''] = self._
                data[''] = self._

                data.save()

                # must be done very late or else the property access
                # will refresh the display such that later field
                # access will return empty values
                self.data = data
                return False
                return True
        #----------------------------------------------------------------
        def _save_as_update(self):

                # remove when implemented:
                return False

                # update self.data and save the changes
                self.data[''] = self._TCTRL_xxx.GetValue().strip()
                self.data[''] = self._PRW_xxx.GetData()
                self.data[''] = self._CHBOX_xxx.GetValue()
                self.data.save()
                return True
        #----------------------------------------------------------------
        def _refresh_as_new(self):
                pass
        #----------------------------------------------------------------
        def _refresh_as_new_from_existing(self):
                self._refresh_as_new()
        #----------------------------------------------------------------
        def _refresh_from_existing(self):
                pass
        #----------------------------------------------------------------

        **************** end of template ****************
        

</pre>

<!-- ==================== 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 href="Gnumed.wxpython.gmEditArea.cGenericEditAreaMixin-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>)</span><br />
      x.__init__(...) initializes x; see x.__class__.__doc__ for signature</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="Gnumed.wxpython.gmEditArea-pysrc.html#cGenericEditAreaMixin.__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 name="display_ctrl_as_valid"></a><span class="summary-sig-name">display_ctrl_as_valid</span>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">ctrl</span>=<span class="summary-sig-default">None</span>,
        <span class="summary-sig-arg">valid</span>=<span class="summary-sig-default">None</span>)</span></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="Gnumed.wxpython.gmEditArea-pysrc.html#cGenericEditAreaMixin.display_ctrl_as_valid">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="display_tctrl_as_valid"></a><span class="summary-sig-name">display_tctrl_as_valid</span>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">tctrl</span>=<span class="summary-sig-default">None</span>,
        <span class="summary-sig-arg">valid</span>=<span class="summary-sig-default">None</span>)</span></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="Gnumed.wxpython.gmEditArea-pysrc.html#cGenericEditAreaMixin.display_tctrl_as_valid">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.gmEditArea.cGenericEditAreaMixin-class.html#refresh" class="summary-sig-name">refresh</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Invoked from the generic edit area dialog.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="Gnumed.wxpython.gmEditArea-pysrc.html#cGenericEditAreaMixin.refresh">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.gmEditArea.cGenericEditAreaMixin-class.html#save" class="summary-sig-name">save</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Invoked from the generic edit area dialog.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="Gnumed.wxpython.gmEditArea-pysrc.html#cGenericEditAreaMixin.save">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
  <tr>
    <td colspan="2" class="summary">
    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
      <code>__delattr__</code>,
      <code>__format__</code>,
      <code>__getattribute__</code>,
      <code>__hash__</code>,
      <code>__new__</code>,
      <code>__reduce__</code>,
      <code>__reduce_ex__</code>,
      <code>__repr__</code>,
      <code>__setattr__</code>,
      <code>__sizeof__</code>,
      <code>__str__</code>,
      <code>__subclasshook__</code>
      </p>
    </td>
  </tr>
</table>
<!-- ==================== PROPERTIES ==================== -->
<a name="section-Properties"></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">Properties</span></td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="Gnumed.wxpython.gmEditArea.cGenericEditAreaMixin-class.html#data" class="summary-name">data</a>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="Gnumed.wxpython.gmEditArea.cGenericEditAreaMixin-class.html#mode" class="summary-name">mode</a>
    </td>
  </tr>
  <tr>
    <td colspan="2" class="summary">
    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
      <code>__class__</code>
      </p>
    </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="__init__"></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">__init__</span>(<span class="sig-arg">self</span>)</span>
    <br /><em class="fname">(Constructor)</em>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="Gnumed.wxpython.gmEditArea-pysrc.html#cGenericEditAreaMixin.__init__">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>x.__init__(...) initializes x; see x.__class__.__doc__ for 
  signature</p>
  <dl class="fields">
    <dt>Overrides:
        object.__init__
        <dd><em class="note">(inherited documentation)</em></dd>
    </dt>
  </dl>
</td></tr></table>
</div>
<a name="refresh"></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</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="Gnumed.wxpython.gmEditArea-pysrc.html#cGenericEditAreaMixin.refresh">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <pre class="literalblock">
Invoked from the generic edit area dialog.

Invokes
        _refresh_as_new()
        _refresh_from_existing()
        _refresh_as_new_from_existing()
on the implementing edit area as needed.

Then calls _valid_for_save().

</pre>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="save"></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">save</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="Gnumed.wxpython.gmEditArea-pysrc.html#cGenericEditAreaMixin.save">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <pre class="literalblock">
Invoked from the generic edit area dialog.

Invokes
        _valid_for_save,
        _save_as_new,
        _save_as_update
on the implementing edit area as needed.

_save_as_* must set self.__data and return True/False

</pre>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== PROPERTY DETAILS ==================== -->
<a name="section-PropertyDetails"></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">Property Details</span></td>
</tr>
</table>
<a name="data"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">data</h3>
  
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><a href="Gnumed.wxpython.gmEditArea.cGenericEditAreaMixin-class.html#_get_data" class="summary-sig-name" onclick="show_private();">_get_data</a>(<span class="summary-sig-arg">self</span>)</span>
    </dd>
    <dt>Set Method:</dt>
    <dd class="value"><span class="summary-sig"><a href="Gnumed.wxpython.gmEditArea.cGenericEditAreaMixin-class.html#_set_data" class="summary-sig-name" onclick="show_private();">_set_data</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">data</span>=<span class="summary-sig-default">None</span>)</span>
    </dd>
  </dl>
</td></tr></table>
</div>
<a name="mode"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">mode</h3>
  
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><a href="Gnumed.wxpython.gmEditArea.cGenericEditAreaMixin-class.html#_get_mode" class="summary-sig-name" onclick="show_private();">_get_mode</a>(<span class="summary-sig-arg">self</span>)</span>
    </dd>
    <dt>Set Method:</dt>
    <dd class="value"><span class="summary-sig"><a href="Gnumed.wxpython.gmEditArea.cGenericEditAreaMixin-class.html#_set_mode" class="summary-sig-name" onclick="show_private();">_set_mode</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">mode</span>=<span class="summary-sig-default">None</span>)</span>
    </dd>
  </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 Mon Jun 25 03:58:15 2012
    </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>