.. hoc:class:: PWManager
Syntax:
``p = new PWManager()``
Description:
A variety of hooks into the :ref:`hoc_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.
.. hoc:method:: PWManager.count
Syntax:
``cnt = p.count()``
Description:
Returns number of "Printable" windows on the screen.
.. hoc:method:: PWManager.is_mapped
Syntax:
``boolean = p.is_mapped(index)``
Description:
Return 1 if the index'th window is visible.
.. hoc:method:: PWManager.map
Syntax:
``p.map(index)``
Description:
Makes the index'th window visible.
.. hoc:method:: PWManager.hide
Syntax:
``p.hide(index)``
Description:
Unmaps the index'th window. The window is NOT closed.
.. hoc: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).
.. hoc:method:: PWManager.iconify
Syntax:
``p.iconify()``
Description:
Hides all windows and iconifies the leader.
.. hoc:method:: PWManager.deiconify
Syntax:
``p.deiconify()``
Description:
Un-iconifies the leader window and maps any windows not hidden before it was
iconified.
.. hoc:method:: PWManager.leader
Syntax:
``index = p.leader()``
Description:
Window index of the leader window.
.. hoc:method:: PWManager.manager
Syntax:
``index = p.manager()``
Description:
Window index of the :ref:`hoc_PWM` window.
.. hoc: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::
:hoc:func:`save_session`
.. hoc: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.
.. hoc: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.
.. hoc: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.
.. hoc:method:: PWManager.name
Syntax:
``strdef = p.name(index)``
Description:
Returns the window title bar string of the index'th window.
.. hoc: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.
.. hoc: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.
.. hoc:method:: PWManager.landscape
Syntax:
``p.landscape(boolean)``
Description:
Determines if postscript printing is in landscape
or portrait mode.
.. hoc: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.
.. hoc: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)