File: Gnumed.wxpython.gmCryptoText.gmCryptoText-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 (411 lines) | stat: -rw-r--r-- 17,120 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
<?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.gmCryptoText.gmCryptoText</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.gmCryptoText-module.html">Module&nbsp;gmCryptoText</a> ::
        Class&nbsp;gmCryptoText
      </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.gmCryptoText.gmCryptoText-class.html"
            target="_top">no&nbsp;frames</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class gmCryptoText</h1><p class="nomargin-top"><span class="codelink"><a href="Gnumed.wxpython.gmCryptoText-pysrc.html#gmCryptoText">source&nbsp;code</a></span></p>
<pre class="base-tree">
wxPython.wx.TextCtrl --+
                       |
                      <strong class="uidshort">gmCryptoText</strong>
</pre>

<hr />
<p>A special text widget that supports cryptography</p>
  <p>A right mouse click pops up a manu that allows to encrypt or decrypt 
  selected text segments. You can drag and drop any number of text files 
  into the text widget, and that text will be inserted at the current 
  cursor position</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">parent</span>,
        <span class="summary-sig-arg">id</span>,
        <span class="summary-sig-arg">size</span>=<span class="summary-sig-default">wx.DefaultSize</span>,
        <span class="summary-sig-arg">style</span>=<span class="summary-sig-default">wx.TE_MULTILINE | wx.TE_RICH</span>,
        <span class="summary-sig-arg">defaulttext</span>=<span class="summary-sig-default">None</span>)</span></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="Gnumed.wxpython.gmCryptoText-pysrc.html#gmCryptoText.__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="OnRightClick"></a><span class="summary-sig-name">OnRightClick</span>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">event</span>)</span><br />
      A right mouse click triggers a popup menu for cryptographic 
      functionality</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="Gnumed.wxpython.gmCryptoText-pysrc.html#gmCryptoText.OnRightClick">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="OnEncrypt"></a><span class="summary-sig-name">OnEncrypt</span>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">event</span>)</span><br />
      triggered by popup contect menu event</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="Gnumed.wxpython.gmCryptoText-pysrc.html#gmCryptoText.OnEncrypt">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="OnDecrypt"></a><span class="summary-sig-name">OnDecrypt</span>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">event</span>)</span></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="Gnumed.wxpython.gmCryptoText-pysrc.html#gmCryptoText.OnDecrypt">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="OnSetPassphrase"></a><span class="summary-sig-name">OnSetPassphrase</span>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">event</span>)</span></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="Gnumed.wxpython.gmCryptoText-pysrc.html#gmCryptoText.OnSetPassphrase">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="OnRightDown"></a><span class="summary-sig-name">OnRightDown</span>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">event</span>)</span><br />
      dummy function; if this event was not intercepted, GTK would clear 
      the text selection the very moment the mouse button is clicked</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="Gnumed.wxpython.gmCryptoText-pysrc.html#gmCryptoText.OnRightDown">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="AskForPassphrase"></a><span class="summary-sig-name">AskForPassphrase</span>(<span class="summary-sig-arg">self</span>)</span><br />
      asks for a pass phrase and returns it</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="Gnumed.wxpython.gmCryptoText-pysrc.html#gmCryptoText.AskForPassphrase">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="Encrypt"></a><span class="summary-sig-name">Encrypt</span>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">cleartext</span>,
        <span class="summary-sig-arg">key</span>)</span><br />
      override this function for your own crypto funcs</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="Gnumed.wxpython.gmCryptoText-pysrc.html#gmCryptoText.Encrypt">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="Decrypt"></a><span class="summary-sig-name">Decrypt</span>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">ciphertext</span>,
        <span class="summary-sig-arg">key</span>,
        <span class="summary-sig-arg">identtag</span>)</span><br />
      override this function for your own crypto funcs</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="Gnumed.wxpython.gmCryptoText-pysrc.html#gmCryptoText.Decrypt">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="StripIdentTag"></a><span class="summary-sig-name">StripIdentTag</span>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">text</span>)</span><br />
      Remove the 'ident tag' from text and return both tag and test</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="Gnumed.wxpython.gmCryptoText-pysrc.html#gmCryptoText.StripIdentTag">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="GetIdentTag"></a><span class="summary-sig-name">GetIdentTag</span>(<span class="summary-sig-arg">self</span>)</span><br />
      This is a 'virtual' function which should be overridden to provide 
      your own meaningful tag</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="Gnumed.wxpython.gmCryptoText-pysrc.html#gmCryptoText.GetIdentTag">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.gmCryptoText.gmCryptoText-class.html#SetFuzzyMargin" class="summary-sig-name">SetFuzzyMargin</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">margin</span>)</span><br />
      The fuzzy margin is the number of characters on each side of the text
      selection the decryption algorithm will search for correct 
      delimiters.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="Gnumed.wxpython.gmCryptoText-pysrc.html#gmCryptoText.SetFuzzyMargin">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="FuzzyScanSelection"></a><span class="summary-sig-name">FuzzyScanSelection</span>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">frompos</span>,
        <span class="summary-sig-arg">topos</span>,
        <span class="summary-sig-arg">margin</span>)</span></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="Gnumed.wxpython.gmCryptoText-pysrc.html#gmCryptoText.FuzzyScanSelection">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="SetFuzzyMargin"></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">SetFuzzyMargin</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">margin</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="Gnumed.wxpython.gmCryptoText-pysrc.html#gmCryptoText.SetFuzzyMargin">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>The fuzzy margin is the number of characters on each side of the text 
  selection the decryption algorithm will search for correct delimiters. It
  should be at least as long as the IdentTag is plus an extra 3 characters 
  to allow for the crypto tag</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 Mon Jun 25 03:58:13 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>