File: pwman.rst

package info (click to toggle)
neuron 8.2.6-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 34,760 kB
  • sloc: cpp: 149,571; python: 58,465; ansic: 50,329; sh: 3,510; xml: 213; pascal: 51; makefile: 35; sed: 5
file content (491 lines) | stat: -rwxr-xr-x 7,801 bytes parent folder | download | duplicates (3)
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
.. _pwman:

         
PWManager
---------



.. class:: PWManager


    Syntax:
        ``p = h.PWManager()``


    Description:
        A variety of hooks into the :ref:`pwm` to allow program control 
        of that tool. The implementation of the 
        Window item of the NeuronMainMenu makes 
        heavy use of this class. Note that the first window created is called 
        the leader. It cannot be closed. 

         

----



.. method:: PWManager.count


    Syntax:
        ``cnt = p.count()``


    Description:
        Returns number of "Printable" windows on the screen. 

    Example:

    .. code-block::
        python

        from neuron import h, gui
        p = h.PWManager()
        print(p.count())


----



.. method:: PWManager.is_mapped


    Syntax:
        ``boolean = p.is_mapped(index)``


    Description:
        Return 1 if the index'th window is visible. 

    Example:

    .. code-block::
        python

        from neuron import h, gui
        p = h.PWManager()
        # not mapped
        print(p.is_mapped(1))
        p.map(1)
        # mapped
        print(p.is_mapped(1))



----



.. method:: PWManager.map


    Syntax:
        ``p.map(index)``


    Description:
        Makes the index'th window visible. 

    Example:

    .. code-block::
        python
        
        from neuron import h, gui
        p = h.PWManager()
        # mapped
        p.map(1)


----



.. method:: PWManager.hide


    Syntax:
        ``p.hide(index)``


    Description:
        Unmaps the index'th window. The window is NOT closed.

    Example:

    .. code-block::
        python
        
        from neuron import h, gui
        p = h.PWManager()
        # mapped
        p.map(1)
        print(p.is_mapped(1))
        # not mapped 
        p.hide(1)
        print(p.is_mapped(1))


----



.. method:: PWManager.close


    Syntax:
        ``p.close(index)``


    Description:
        Closes the index'th window. This will destroy the window and decrement the 
        reference count of the associated hoc object (if any). 

    Example:

    .. code-block::
        python
        
        from neuron import h, gui
        p = h.PWManager()
        p.map(1)
        p.close(1)


----



.. method:: PWManager.iconify


    Syntax:
        ``p.iconify()``


    Description:
        Hides all windows and iconifies the leader. 

    Example:

    .. code-block::
        python
        
        from neuron import h, gui
        p = h.PWManager()
        p.map(1)
        p.iconify()


----



.. method:: PWManager.deiconify


    Syntax:
        ``p.deiconify()``


    Description:
        Un-iconifies the leader window and maps any windows not hidden before it was 
        iconified. 


----



.. method:: PWManager.leader


    Syntax:
        ``index = p.leader()``


    Description:
        Window index of the leader window. 


----



.. method:: PWManager.manager


    Syntax:
        ``index = p.manager()``


    Description:
        Window index of the :ref:`PWM` window. 

    
    Example:

    .. code-block::
        python

        from neuron import h, gui
        p = h.PWManager()
        print(p.manager())



----



.. method:: PWManager.save


    Syntax:
        ``n = p.save("filename", group_object, ["header"])``

        ``n = p.save("filename", selected, ["header"])``


    Description:
        Create a session file with the given filename 
        consisting oo all windows associated with a 
        particular group_object in a session file 
         
        If selected == 0 then all windows are saved. If selected==1 then only 
        the windows on the paper icon are saved in the session file. 
         
        If the header argument exists, it is copied to the beginning of the file. 

    .. seealso::
        :func:`save_session`

    Example:

    .. code-block::
        python

        from neuron import h, gui
        p = h.PWManager()
        p.map(1)
        selected = 1
        n = p.save("file", selected, "Header")


----



.. method:: PWManager.group


    Syntax:
        ``group_obj = p.group(index, group_obj)``

        ``group_obj = p.group(index)``


    Description:
        Associate the index'th window with the group object and returns the 
        group object associated with that window. 

    Example:

    .. code-block::
        python

        from neuron import h, gui
        p = h.PWManager()
        g1 = p.group(0)
        g2 = p.group(1, g1)

----



.. method:: PWManager.snap


    Syntax:
        ``p.snap()``

        ``p.snap("filename")``


    Description:
        Only works on the unix version. 
        Puts the GUI in snapshot mode until the 'p' keyboard character is pressed. 
        During this time the mouse can be used normally to pop up menus or drag 
        rubberbands on graphs. When the p character is pressed all windows including 
        drawings of the window decorations, menus, rubberband, and mouse arrow cursor is 
        printed to a postscript file with the "filename" or filebrowser selection. 

    Example:

    .. code-block::
        python

        from neuron import h, gui
        p = h.PWManager()
        p.snape("filename")

----



.. method:: PWManager.scale


    Syntax:
        ``p.scale(x)``


    Description:
        Works only under mswin. 
        Immediately rescales all the windows (including font size) and their position 
        relative to the top, left corner of the screen according to the absolute 
        scale factor x. 
        i.e, a scale value of 1 gives normal size windows. 

    Example:

    .. code-block::
        python

        from neuron import h, gui
        p = h.PWManager()
        p.scale(2)
----



.. method:: PWManager.name


    Syntax:
        ``strdef = p.name(index)``


    Description:
        Returns the window title bar string of the index'th window. 

    Example:

    .. code-block::
        python

        from neuron import h, gui
        p = h.PWManager()
        print(p.name(0))

         

----



.. method:: PWManager.window_place


    Syntax:
        ``p.window_place(index, left, top)``


    Description:
        moves the index window to the left,top pixel 
        coordinates of the screen. 

    Example:

    .. code-block::
        python

        from neuron import h, gui
        p = h.PWManager()
        p.window_place(0, 1000, 1000)

         

----



.. method:: PWManager.paper_place


    Syntax:
        ``p.paper_place(index, show)``

        ``p.paper_place(index, left, bottom, scale)``


    Description:
        Shows or hides the ith window on the 
        paper icon. If showing, this constitutes adding this window to the list of 
        selected windows. 
         
        The 4 arg form shows, places, and scales 
        the index window on the paper icon. The scale and location only has an effect when 
        the paper is printed in postscript mode. 

         

----



.. method:: PWManager.landscape


    Syntax:
        ``p.landscape(boolean)``


    Description:
        Determines if postscript printing is in landscape 
        or portrait mode. 

         

----



.. method:: PWManager.deco


    Syntax:
        ``p.deco(mode)``


    Description:
        When printing in postscript mode, 
        0 print only the interior of the window. 
         
        1 print the interior and the title above each window 
         
        2 print the interior and all window decorations including the window title. 

         

----



.. method:: PWManager.printfile


    Syntax:
        ``p.printfile("filename", mode, selected)``


    Description:
        Print to a file in postcript, idraw, or ascii mode (mode=0,1,2) the selected windows 
        or all the windows( selected=0,1)