<meta name=
"description" content=
"Pmw - a toolkit for building high-level compound widgets in Python">
<meta name=
"content" content=
"python, megawidget, mega widget, compound widget, gui, tkinter">
<title>Pmw functions reference manual
</title>
<body bgcolor=
"#ffffff" text=
"#000000" link=
"#0000ee"
vlink=
"551a8b" alink=
"ff0000">
<h1 ALIGN=
"CENTER">Pmw functions
</h1>
<dt> <strong>Pmw.aboutcontact
</strong>(
<em>value
</em>)
</dt><dd>
The value passed to this function is used to construct the text
displayed by
<a href=
"AboutDialog.html">Pmw.AboutDialog
</a> megawidgets created subsequently.
</p><dt> <strong>Pmw.aboutcopyright
</strong>(
<em>value
</em>)
</dt><dd>
The value passed to this function is used to construct the text
displayed by
<a href=
"AboutDialog.html">Pmw.AboutDialog
</a> megawidgets created subsequently.
</p><dt> <strong>Pmw.aboutversion
</strong>(
<em>value
</em>)
</dt><dd>
The value passed to this function is used to construct the text
displayed by
<a href=
"AboutDialog.html">Pmw.AboutDialog
</a> megawidgets created subsequently.
</p><dt> <strong>Pmw.aligngrouptags
</strong>(
<em>groups
</em>)
</dt><dd>
This function takes a sequence of
<a href=
"Group.html">Pmw.Group
</a>s and adjusts the
vertical position of the tags in each group so that they all have
the height of the tallest tag. This can be used when groups are
positioned side-by-side but the natural height of the tags are
different because, for example, different fonts with different
<dt> <strong>Pmw.alignlabels
</strong>(
<em>widgets
</em>,
<em>sticky
</em> =
<strong>None
</strong>)
</dt><dd>
Adjust the size of the labels of all the
<em>widgets
</em> to be equal, so
that the body of each widget lines up vertically. This assumes
that each widget is a megawidget with a
<strong>label
</strong> component in
column
0 (ie, the
<strong>labelpos
</strong> option was set to
<strong>'w'
</strong>,
<strong>'wn'
</strong> or
<strong>'ws'
</strong>). If
<em>sticky
</em> is set to a combination of
<strong>'n'
</strong>,
<strong>'s'
</strong>,
<strong>'e'
</strong> and
<strong>'w'
</strong>, the label will be positioned within its cell
accordingly. For example to make labels right justified, set
<em>sticky
</em> to
<strong>'e'
</strong>,
<strong>'ne'
</strong> or
<strong>'se'
</strong>.
</p>
<dt> <strong>Pmw.alphabeticvalidator
</strong>(
<em>text
</em>)
</dt><dd>
Validator function for
<a href=
"EntryField.html">Pmw.EntryField
</a> <strong>alphabetic
</strong> standard validator.
</p><dt> <strong>Pmw.alphanumericvalidator
</strong>(
<em>text
</em>)
</dt><dd>
Validator function for
<a href=
"EntryField.html">Pmw.EntryField
</a> <strong>alphanumeric
</strong> standard validator.
</p><dt> <strong>Pmw.busycallback
</strong>(
<em>command
</em>,
<em>updateFunction
</em> =
<strong>None
</strong>)
</dt><dd>
Create a wrapper function which displays a busy cursor while
executing
<em>command
</em> and return the wrapper. When the wrapper
function is called, it first calls
<code>Pmw.showbusycursor()
</code>, then
the
<em>command
</em> (passing any arguments to it), then
<code>Pmw.hidebusycursor()
</code>.
The return value of
<em>command
</em> is returned from the wrapper.
</p><p> If
<em>updateFunction
</em> is specified, it is called just before the
call to
<code>Pmw.hidebusycursor()
</code>. This is intended to be the
Tkinter
<code>update()
</code> method, in which case it will clear any events
that may have occurred while
<em>command
</em> was executing. An example
of this usage is in the
<code>ShowBusy
</code> demonstration: run the
demonstration, click on the entry widget then click on the button
and type some characters while the busy cursor is displayed. No
characters should appear in the entry widget.
</p><p> Note that the Tkinter
<code>update()
</code> method should only be called when
it is known that it can be safely called. One case where a
problem has been found is when a filehandler has been created (on
a non-blocking Oracle database connection), but the filehandler
does not read from the connection. The connection is read (by a
call to the Oracle fetch function
<em>ofen
</em>) in a loop which also
contains a call to
<code>_tkinter.dooneevent()
</code>. If
<code>update()
</code> is
called from
<code>dooneevent()
</code> and there is data to be read on the
connection, then the filehandler will be called continuously, thus
hanging the application.
</p><dt> <strong>Pmw.clearbusycursor
</strong>()
</dt><dd>
Unconditionally remove the event block and busy cursor from all
windows. This undoes all outstanding calls to
<code>Pmw.showbusycursor()
</code>.
</p>
<dt> <strong>Pmw.datestringtojdn
</strong>(
<em>text
</em>,
<em>format
</em> =
<strong>'ymd'
</strong>,
<em>separator
</em> =
<strong>'/'
</strong>)
</dt><dd>
Return the Julian Day Number corresponding to the date in
<em>text
</em>.
A Julian Day Number is defined as the number of days since
1 Jan
4713 BC. The date must be specified as three integers separated by the
<em>separator
</em> character. The integers must be in the order specified by
<em>format
</em>, which must be a combination of
<strong>'d'
</strong>,
<strong>'m'
</strong> and
<strong>'y'
</strong> in
any order. These give the order of the day, month and year
fields. Examples of valid input are:
</p><dl><dd><pre> 'dmy':
31/
01/
99 31/
1/
1999 31/
1/
99
'mdy':
01/
31/
99 1/
31/
1999 1/
31/
99 'ymd':
99/
01/
31 1999/
1/
31 99/
1/
31</pre></dd></dl> <em>pivot
</em> year (default
50) is not
<strong>None
</strong> and the year specified
in
<em>text
</em> has only one or two digits, then the year is
converted to a four digit year. If it is less than or equal to
the pivot year, then it is incremented by the application's
<em>century
</em> value (default
2000). If it is more than the pivot year
then it is incremented by the
<em>century
</em> value less
100.
</p><p> The function
<code>Pmw.setyearpivot()
</code> can be used to change the
default values for the application's
<em>pivot
</em> and
<em>century
</em>.
</p>
<dt> <strong>Pmw.datevalidator
</strong>(
<em>text
</em>,
<em>format
</em> =
<strong>'ymd'
</strong>,
<em>separator
</em> =
<strong>'/'
</strong>)
</dt><dd>
Validator function for
<a href=
"EntryField.html">Pmw.EntryField
</a> <strong>date
</strong> standard validator.
</p><dt> <strong>Pmw.displayerror
</strong>(
<em>text
</em>)
</dt><dd>
This is a general purpose method for displaying background errors
to the user. The errors would normally be programming errors and
may be caused by errors in Tk callbacks or functions called by other
<p> If the global error report file (set by calling
<code>Pmw.reporterrorstofile()
</code>) is
<strong>None
</strong>, the error message `text` is
written to standard error and also shown in a text window. If
<code>displayerror
</code> is called while previous error messages are being
displayed, the window is raised and the new error is queued. The
queued errors may be viewed by the user or ignored by dismissing
<p> If the global error report file is not
<strong>None
</strong>, `text` is written
to the file.
<em>file
</em> may be any object with a
<code>write()
</code> method,
such as
<code>sys.stderr
</code>.
</p><dt> <strong>Pmw.drawarrow
</strong>(
<em>canvas
</em>,
<em>color
</em>,
<em>direction
</em>,
<em>tag
</em>,
<em>baseOffset
</em> =
<strong>0.25</strong>,
<em>edgeOffset
</em> =
<strong>0.15</strong>)
</dt><dd>
Draw a triangle in the Tkinter.Canvas
<em>canvas
</em> in the given
<em>color
</em>. The value of
<em>direction
</em> may be
<strong>'up'
</strong>,
<strong>'down'
</strong>,
<strong>'left'
</strong> or
<strong>'right'
</strong> and specifies which direction the arrow
should point. The values of
<em>baseOffset
</em> and
<em>edgeOffset
</em> specify
how far from the edges of the canvas the points of the triangles
are as a fraction of the size of the canvas.
</p><dt> <strong>Pmw.forwardmethods
</strong>(
<em>fromClass
</em>,
<em>toClass
</em>,
<em>toPart
</em>,
<em>exclude
</em> =
<strong>()
</strong>)
</dt><dd>
Forward methods from one class to another.
</p><p> This function adds methods to the class
<em>fromClass
</em>. The names of
the methods added are the names of the methods of the class
<em>toClass
</em> (and its base classes) except those which are already
defined by
<em>fromClass
</em> or are found in the
<em>exclude
</em> list.
Special methods with one or more leading or trailing underscores
<p> When one of the added methods is called, the method of the same
name is called on an instance defined by
<em>toPart
</em> and the return
value passed back. If
<em>toPart
</em> is a string, then it specifies the
name of an attribute (
<em>not
</em> a component) of the
<em>fromClass
</em> object. The class of this attribute should be
<em>toClass
</em>. If
<em>toPart
</em> is not a string, it must be a function taking a
<em>fromClass
</em> object and returning a
<em>toClass
</em> object.
</p>
<p> This function must be called outside of and after the definition
of
<em>fromClass
</em>.
</p><dl><dd><pre>class MyClass:
self.__target = TargetClass()
Pmw.forwardmethods(MyClass, TargetClass, '__target',
['dangerous1', 'dangerous2'])
Pmw.forwardmethods(MyClass, TargetClass,
MyClass.findtarget, ['dangerous1', 'dangerous2'])
</pre></dd></dl><p> In both cases, all
<code>TargetClass
</code> methods will be forwarded from
<code>MyClass
</code> except for
<code>dangerous1
</code>,
<code>dangerous2
</code>, special methods like
<code>__str__
</code>, and pre-existing methods like
<code>foo
</code>.
</p>
<dt> <strong>Pmw.grabstacktopwindow
</strong>()
</dt><dd>
Return the window at the top of the grab stack (the window
currently with the grab) or
<strong>None
</strong> if the grab stack is empty (no
window has the grab). See also
<code>pushgrab()
</code>.
</p><dt> <strong>Pmw.hexadecimalvalidator
</strong>(
<em>text
</em>)
</dt><dd>
Validator function for
<a href=
"EntryField.html">Pmw.EntryField
</a> <strong>hexadecimal
</strong> standard validator.
</p><dt> <strong>Pmw.hidebusycursor
</strong>(
<em>forceFocusRestore
</em> =
<strong>0</strong>)
</dt><dd>
Undo one call to
<code>Pmw.showbusycursor()
</code>. If there are no
outstanding calls to
<code>Pmw.showbusycursor()
</code>, remove the event
block and busy cursor.
</p><p> If the focus window has not been changed since the corresponding
call to
<code>Pmw.showbusycursor()
</code>, or if
<em>forceFocusRestore
</em> is true,
then the focus is restored to that saved by
<code>Pmw.showbusycursor()
</code>.
</p><dt> <strong>Pmw.initialise
</strong>(
<em>root
</em> =
<strong>None
</strong>,
<em>size
</em> =
<strong>None
</strong>,
<em>fontScheme
</em> =
<strong>None
</strong>,
<em>useTkOptionDb
</em> =
<strong>0</strong>,
<em>noBltBusy
</em> =
<strong>0</strong>,
<em>disableKeyboardWhileBusy
</em> =
<strong>None
</strong>)
</dt><dd>
Initialise Pmw. This performs several functions:
</p><ul><li><p>Set up a trap in the Tkinter Toplevel constructor so that a
list of Toplevels can be maintained. A list of all Toplevel
windows needs to be kept so that
<code>Pmw.showbusycursor()
</code> can
create busy cursors for them.
</p><li><p>Set up a trap in the Tkinter Toplevel and Frame destructors
so that Pmw is notified when these widgets are destroyed.
This allows Pmw to destroy megawidgets when their hull
widget is destroyed and to prune the list of Toplevels.
</p><li><p>Modify Tkinter's CallWrapper class to improve the display of
errors which occur in callbacks. If an error occurs, the
new CallWrapper class calls
<code>Pmw.clearbusycursor()
</code> to
remove any outstanding busy cursors and calls
<code>Pmw.displayerror()
</code> to display the error.
</p>
<li><p>Using the window given by
<em>root
</em>, set the
<strong>WM_DELETE_WINDOW
</strong>
root window protocol to destroy the root window. This means
that the root window is destroyed if the window manager
deletes it. This is only done if the protocol has not been
set before the call to
<code>Pmw.initialise()
</code>. This protocol is
required if there is a modal dialog displayed and the window
manager deletes the root window. Otherwise the application
will not exit, even though there are no windows.
</p><li><p>Set the base font size for the application to
<em>size
</em>. This
is used by
<code>Pmw.logicalfont()
</code> as the default point size for
fonts. If this is not given, the default is
<strong>14</strong>, except
under NT where it is
<strong>16</strong>. These are reasonable default
sizes for most screens, but for unusually high or low screen
resolutions, an appropriate size should be supplied. Note
that Tk's definition of
<em>point size
</em>, is somewhat
<li><p>Set the Tk option database for
<em>root
</em> according to
<em>fontScheme
</em>. This changes the default fonts set by Tk.
<em>fontScheme
</em> may be one of
</p>
<dl><dt><strong>None
</strong> </dt><dd>Do not change the Tk defaults.
<p></p>
<dt><strong>'pmw1'
</strong> </dt><dd>If running under posix (Unix), set the default font to
be Helvetica with bold italic menus, italic scales and
a special balloon font
6 points smaller than the base
font size and with the
<strong>'pixel'
</strong> field set to
<strong>'
12'
</strong>.
For other operating systems (such as NT or Macintosh),
simply set the default font to be Helvetica. All
fonts are as returned by calls to
<code>Pmw.logicalfont()
</code>.
<p></p><dt><strong>'pmw2'
</strong> </dt><dd>This is the same as
<strong>'pmw1'
</strong> except that under posix
the balloon font is
2 points smaller than the base
font size and the
<strong>'pixel'
</strong> field is not set.
<p></p><dt><strong>'default'
</strong> </dt><dd>This sets the default fonts using the Tk font naming
convention, rather than that returned by
<code>Pmw.logicalfont()
</code>. The default font is bold
Helvetica. The font for entry widgets is Helvetica.
The font for text widgets is Courier The size of all
fonts is the application base font size as described
<li><p>If
<em>root
</em> is
<strong>None
</strong>, use the Tkinter default root window as the
root, if it has been created, or create a new Tk root window.
The
<code>initialise()
</code> method returns this
<em>root
</em>.
</p><li><p>If
<em>useTkOptionDb
</em> is true, then, when a megawidget is
created, the Tk option database will be queried to get the
initial values of the options which have not been set in
the call to the constructor. The resource name used in the
query is the same as the option name and the resource class
is the option name with the first letter capitalised. If
<em>useTkOptionDb
</em> is false, then options for newly created
megawidgets will be initialised to default values.
</p><li><p>If
<em>noBltBusy
</em> is true, then
<code>Pmw.showbusycursor()
</code> will not
display a busy cursor, even if the BLT busy command is
<li><p>If
<em>disableKeyboardWhileBusy
</em> is false, then do not disable
keyboard input while displaying the busy cursor. Normally,
Pmw ignores keyboard input while displaying the busy cursor
by setting the focus for each toplevel window to the Blt
busy window. However, under NT, this may cause the toplevel
windows to be raised. If this is not acceptable, programs
running on NT can request show/hidebusycursor to not ignore
keyboard input by setting
<em>disableKeyboardWhileBusy
</em> to true
in
<code>Pmw.initialise()
</code>.
</p><p> It is not absolutely necessary to call this function to be able to use
Pmw. However, some functionality will be lost. Most importantly,
Pmw megawidgets will not be notified when their hull widget is
destroyed. This may prevent the megawidget from cleaning up
timers which will try to access the widget, hence causing a
background error to occur.
</p><dt> <strong>Pmw.installedversions
</strong>(
<em>alpha
</em> =
<strong>0</strong>)
</dt><dd>
If
<em>alpha
</em> is false, return the list of base versions of Pmw
that are currently installed and available for use. If
<em>alpha
</em> is
true, return the list of alpha versions.
</p><dt> <strong>Pmw.integervalidator
</strong>(
<em>text
</em>)
</dt><dd>
Validator function for
<a href=
"EntryField.html">Pmw.EntryField
</a> <strong>integer
</strong> standard validator.
</p><dt> <strong>Pmw.jdntoymd
</strong>(
<em>jdn
</em>,
<em>julian
</em> =
<strong>-
1</strong>,
<em>papal
</em> =
<strong>1</strong>)
</dt><dd>
Return the year, month and day of the Julian Day Number
<em>jdn
</em>. If
<em>julian
</em> is
<strong>1</strong>, then the date returned will be in the Julian
calendar. If
<em>julian
</em> is
<strong>0</strong>, then the date returned will be in
the modern calendar. If
<em>julian
</em> is
<strong>-
1</strong>, then which calendar to
use will be automatically determined by the value of
<em>jdn
</em> and
<em>papal
</em>. If
<em>papal
</em> is true, then the date set by Pope Gregory
XIII's decree (
4 October
1582) will be used as the last day to use
the Julian calendar. If
<em>papal
</em> is false, then the last day to
use the Julian calendar will be according to British-American
usage (
2 September
1752).
</p><dt> <strong>Pmw.logicalfont
</strong>(
<em>name
</em> =
<strong>'Helvetica'
</strong>,
<em>sizeIncr
</em> =
<strong>0</strong>, **
<em>kw
</em>)
</dt><dd>
Return the full name of a Tk font, being a hyphen-separated list
of font properties. The
<em>logical
</em> name of the font is given by
<em>name
</em> and may be one of
<strong>'Helvetica'
</strong>,
<strong>'Times'
</strong>,
<strong>'Fixed'
</strong>,
<strong>'Courier'
</strong> or
<strong>'Typewriter'
</strong>. Pmw uses this name to define the
default values of many of the font properties. The size of the
font is the base font size for the application specified in the
call to
<code>Pmw.initialise()
</code> increased or decreased by the value of
<em>sizeIncr
</em>. The other properties of the font may be specified by
other named arguments. These may be
<strong>'registry'
</strong>,
<strong>'foundry'
</strong>,
<strong>'family'
</strong>,
<strong>'weight'
</strong>,
<strong>'slant'
</strong>,
<strong>'width'
</strong>,
<strong>'style'
</strong>,
<strong>'pixel'
</strong>,
<strong>'size'
</strong>,
<strong>'xres'
</strong>,
<strong>'yres'
</strong>,
<strong>'spacing'
</strong>,
<strong>'avgwidth'
</strong>,
<strong>'charset'
</strong> and
<strong>'encoding'
</strong>.
</p>
<dt> <strong>Pmw.logicalfontnames
</strong>()
</dt><dd>
Return the list of known logical font names that can be given
to
<code>Pmw.logicalfont()
</code>.
</p><dt> <strong>Pmw.numericvalidator
</strong>(
<em>text
</em>)
</dt><dd>
Validator function for
<a href=
"EntryField.html">Pmw.EntryField
</a> <strong>numeric
</strong> standard validator.
</p><dt> <strong>Pmw.popgrab
</strong>(
<em>window
</em>)
</dt><dd>
Remove
<em>window
</em> from the grab stack. If there are not more
windows in the grab stack, release the grab. Otherwise set the
grab and the focus to the next window in the grab stack. See also
<code>pushgrab()
</code>.
</p>
<dt> <strong>Pmw.pushgrab
</strong>(
<em>grabWindow
</em>,
<em>globalMode
</em>,
<em>deactivateFunction
</em>)
</dt><dd>
The grab functions (
<code>pushgrab()
</code>,
<code>popgrab()
</code>,
<code>releasegrabs()
</code> and
<code>grabstacktopwindow()
</code>) are an interface to the Tk
<strong>grab
</strong> command which implements simple pointer and keyboard grabs. When
a grab is set for a particular window, Tk restricts all pointer
events to the grab window and its descendants in Tk's window
hierarchy. The functions are used by the
<code>activate()
</code> and
<code>deactivate()
</code> methods to implement modal dialogs.
</p>
<p> Pmw maintains a stack of grabbed windows, where the window on the
top of the stack is the window currently with the grab. The grab
stack allows nested modal dialogs, where one modal dialog can be
activated while another modal dialog is activated. When the
second dialog is deactivated, the first dialog becomes active
<p> Use
<code>pushgrab()
</code> to add
<em>grabWindow
</em> to the grab stack. This
releases the grab by the window currently on top of the stack (if
there is one) and gives the grab and focus to the
<em>grabWindow
</em>.
If
<em>globalMode
</em> is true, perform a global grab, otherwise perform
a local grab. The value of
<em>deactivateFunction
</em> specifies a
function to call (usually grabWindow.deactivate) if popgrab() is
called (usually from a deactivate() method) on a window which is
not at the top of the stack (that is, does not have the grab or
focus). For example, if a modal dialog is deleted by the window
manager or deactivated by a timer. In this case, all dialogs
above and including this one are deactivated, starting at the top
<p> For more information, see the Tk grab manual page.
</p>
<dt> <strong>Pmw.realvalidator
</strong>(
<em>text
</em>,
<em>separator
</em> =
<strong>'.'
</strong>)
</dt><dd>
Validator function for
<a href=
"EntryField.html">Pmw.EntryField
</a> <strong>real
</strong> standard validator.
</p><dt> <strong>Pmw.releasegrabs
</strong>()
</dt><dd>
Release grab and clear the grab stack. This should normally not
be used, use
<code>popgrab()
</code> instead. See also
<code>pushgrab()
</code>.
</p><dt> <strong>Pmw.reporterrorstofile
</strong>(
<em>file
</em> =
<strong>None
</strong>)
</dt><dd>
Sets the global error report file, which is initially
<strong>None
</strong>. See
<code>Pmw.displayerror()
</code></p>
<dt> <strong>Pmw.setalphaversions
</strong>(*
<em>alpha_versions
</em>)
</dt><dd>
Set the list of alpha versions of Pmw to use for this session to
the arguments. When searching for Pmw classes and functions,
these alpha versions will be searched, in the order given, before
the base version. This must be called before any other Pmw class
or function, except functions setting or querying versions.
</p><dt> <strong>Pmw.setbusycursorattributes
</strong>(
<em>window
</em>, **
<em>kw
</em>)
</dt><dd>
Use the keyword arguments to set attributes controlling the effect
on
<em>window
</em> (which must be a
<strong>Tkinter.Toplevel
</strong>) of future calls
to
<code>Pmw.showbusycursor()
</code>. The attributes are:
</p><dl><dt><strong>exclude
</strong></dt><dd>a boolean value which specifies whether the window
will be affected by calls to
<code>Pmw.showbusycursor()
</code>. If a window
is excluded, then the cursor will not be changed to a busy cursor
and events will still be delivered to the window. By default,
windows are affected by calls to
<code>Pmw.showbusycursor()
</code>.
<p></p><dt><strong>cursorName
</strong></dt><dd>the name of the cursor to use when displaying the
busy cursor. If
<strong>None
</strong>, then the default cursor is used.
<p></p><dt> <strong>Pmw.setgeometryanddeiconify
</strong>(
<em>window
</em>,
<em>geom
</em>)
</dt><dd>
Deiconify and raise the toplevel
<em>window
</em> and set its position and
size according to
<em>geom
</em>. This overcomes some problems with the
window flashing under X and correctly positions the window under
NT (caused by Tk bugs).
</p><dt> <strong>Pmw.setversion
</strong>(
<em>version
</em>)
</dt><dd>
Set the version of Pmw to use for this session to
<em>version
</em>. If
<code>Pmw.setversion()
</code> is not called, the latest installed version of
Pmw will be used. This must be called before any other Pmw class
or function, except functions setting or querying versions.
</p><dt> <strong>Pmw.setyearpivot
</strong>(
<em>pivot
</em>,
<em>century
</em> =
<strong>None
</strong>)
</dt><dd>
Set the pivot year and century for the application's date
processing. These values are used in the
<code>datestringtojdn()
</code> method, which is used by
<a href=
"Counter.html">Pmw.Counter
</a> and
<a href=
"EntryField.html">Pmw.EntryField
</a> and derived classes. The initial values of
<em>pivot
</em> and
<em>century
</em> are
<strong>50</strong> and
<strong>2000</strong> repectively. Return a tuple containing the
old values of
<em>pivot
</em> and
<em>century
</em>.
</p><dt> <strong>Pmw.showbusycursor
</strong>()
</dt><dd>
Block events to and display a busy cursor over all windows in this
application that are in the state
<strong>'normal'
</strong> or
<strong>'iconic'
</strong>, except
those windows whose
<strong>exclude
</strong> busycursor attribute has been set to
true by a call to
<code>Pmw.setbusycursorattributes()
</code>.
</p><p> If a window and its contents have just been created,
<code>update_idletasks()
</code> may have to be called before
<code>Pmw.showbusycursor()
</code> so that the window is mapped to the screen.
Windows created or deiconified after calling
<code>Pmw.showbusycursor()
</code> will not be blocked.
</p>
<p> To unblock events and remove the busy cursor, use
<code>Pmw.hidebusycursor()
</code>. Nested calls to
<code>Pmw.showbusycursor()
</code>
may be made. In this case, a matching number of calls to
<code>Pmw.hidebusycursor()
</code> must be made before the event block and
busy cursor are removed.
</p><p> If the BLT extension to Tk is not present, this function has no
effect other than to save the value of the current focus window,
to be later restored by
<code>Pmw.hidebusycursor()
</code>.
</p><dt> <strong>Pmw.stringtoreal
</strong>(
<em>text
</em>,
<em>separator
</em> =
<strong>'.'
</strong>)
</dt><dd>
Return the real number represented by
<em>text
</em>. This is similar to
<code>string.atof()
</code> except that the character representing the decimal
point in
<em>text
</em> is given by
<em>separator
</em>.
</p><dt> <strong>Pmw.timestringtoseconds
</strong>(
<em>text
</em>,
<em>separator
</em> =
<strong>':'
</strong>)
</dt><dd>
Return the number of seconds corresponding to the time in
<em>text
</em>.
The time must be specified as three integers separated by the
<em>separator
</em> character and must be in the order hours, minutes and
seconds. The first number may be negative, indicating a negative
<dt> <strong>Pmw.timevalidator
</strong>(
<em>text
</em>,
<em>separator
</em> =
<strong>':'
</strong>)
</dt><dd>
Validator function for
<a href=
"EntryField.html">Pmw.EntryField
</a> <strong>time
</strong> standard validator.
</p><dt> <strong>Pmw.tracetk
</strong>(
<em>root
</em> =
<strong>None
</strong>,
<em>on
</em> =
<strong>1</strong>,
<em>withStackTrace
</em> =
<strong>0</strong>,
<em>file
</em> =
<strong>None
</strong>)
</dt><dd>
Print debugging trace of calls to, and callbacks from, the Tk
interpreter associated with the
<em>root
</em> window . If
<em>root
</em> is
<strong>None
</strong>, use the Tkinter default root. If
<em>on
</em> is true, start
tracing, otherwise stop tracing. If
<em>withStackTrace
</em> is true,
print a python function call stacktrace after the trace for each
call to Tk. If
<em>file
</em> is
<strong>None
</strong>, print to standard error,
otherwise print to the file given by
<em>file
</em>.
</p><p> For each call to Tk, the Tk command and its options are printed as
a python tuple, followed by the return value of the command (if
not the empty string). For example:
</p><dl><dd><pre>python executed:
button = Tkinter.Button()
button.configure(text = 'Hi')
CALL TK
> 1: ('button', '
.3662448') -
> '
.3662448'
CALL TK
> 1: ('
.3662448', 'configure', '-text', 'Hi')
</pre></dd></dl><p> Some calls from python to Tk (such as
<strong>update
</strong>,
<strong>tkwait
</strong>,
<strong>invoke
</strong>, etc) result in the execution of callbacks from Tk to
python. These python callbacks can then recursively call into Tk.
When displayed by
<strong>tracetk()
</strong>, these recursive calls are indented
proportionally to the depth of recursion. The depth is also
printed as a leading number. The return value of a call to Tk
which generated recursive calls is printed on a separate line at
the end of the recursion. For example:
</p><dl><dd><pre>python executed:
button.configure(text = 'Bye')
button = Tkinter.Button()
button.configure(command = callback)
button.invoke()
</pre></dd></dl><dl><dd><pre>tracetk output:
CALL TK
> 1: ('button', '
.3587144') -
> '
.3587144'
CALL TK
> 1: ('
.3587144', 'configure', '-command', '
3638368callback')
CALL TK
> 1: ('
.3587144', 'invoke')
CALLBACK
> 2: callback()
CALL TK
> 2: ('
.3587144', 'configure', '-text', 'Bye')
CALL RTN
> 1: -
> 'Got me!'
</pre></dd></dl><p> <strong>Pmw.initialise()
</strong> must be called before
<strong>tracetk()
</strong> so that hooks
are put into the Tkinter CallWrapper class to trace callbacks from
Tk to python and also to handle recursive calls correctly.
</p><dt> <strong>Pmw.version
</strong>(
<em>alpha
</em> =
<strong>0</strong>)
</dt><dd>
If
<em>alpha
</em> is false, return the base version of Pmw being used
for this session. If
<code>Pmw.setversion()
</code> has not been called, this
will be the latest installed version of Pmw. If
<em>alpha
</em> is true,
return the list of alpha versions of Pmw being used for this
session, in search order. If
<code>Pmw.setalphaversions()
</code> has not
been called, this will be the empty list.
</p><dt> <strong>Pmw.ymdtojdn
</strong>(
<em>year
</em>,
<em>month
</em>,
<em>day
</em>,
<em>julian
</em> =
<strong>-
1</strong>,
<em>papal
</em> =
<strong>1</strong>)
</dt><dd>
Return the Julian Day Number corresponding to
<em>year
</em>,
<em>month
</em> and
<em>day
</em>. See
<code>jdntoymd()
</code> for description of other arguments)
</p>
<center><P ALIGN=
"CENTER">
<IMG SRC = blue_line.gif ALT =
"" WIDTH=
320 HEIGHT=
5>
<center><P ALIGN=
"CENTER">
-
<a href=
"index.html">Home
</a>
projects / OpenSPARC-T2-SAM / blob