skeinforge_tools.skeinforge_utilities.settings ($Date: 2008/23/04 $)
index
/home/enrique/Desktop/backup/babbleold/script/reprap/pyRepRap/skeinforge_tools/skeinforge_utilities/settings.py

Settings is a collection of utilities to display, read & write the settings and position widgets.

 
Modules
       
Tkinter
__init__
cStringIO
skeinforge_tools.skeinforge_utilities.euclidean
skeinforge_tools.skeinforge_utilities.gcodec
os
shutil
webbrowser

 
Classes
       
Tkinter.Scrollbar(Tkinter.Widget)
HiddenScrollbar
AddProfile
DeleteProfile
CloseListener
DeleteProfileDialog
DisplayToolButton
FileHelpMenuBar
FrameList
GridHorizontal
GridVertical
HelpPage
HelpPageRepository
LabelDisplay
LabelHelp
LabelSeparator
LatentStringVar
MenuButtonDisplay
PluginFrame
ProfileList
RepositoryDialog
StringSetting
BooleanSetting
MenuRadio
Radio
RadioCapitalized
RadioPlugin
RadioCapitalizedButton
FileNameInput
FloatSetting
FloatSpin
FloatSpinNotOnMenu
FloatSpinUpdate
IntSpin
IntSpinNotOnMenu
IntSpinUpdate
IntSetting
ProfileListboxSetting
TextSetting
WindowPosition
TokenConversion
ToolDialog
WindowVisibilities

 
class AddProfile
    A class to add a profile.
 
  Methods defined here:
addSelection(self)
Add the selection of a listbox setting.
addSelectionWithEvent(self, event)
Add the selection of a listbox setting, given an event.
addToDialog(self, gridPosition)
Add this to the dialog.
getFromProfileListboxSettingRepository(self, profileListboxSetting, repository)
Initialize.

 
class BooleanSetting(StringSetting)
    A class to display, read & write a boolean.
 
  Methods defined here:
addToDialog(self, gridPosition)
Add this to the dialog.
addToMenu(self, repositoryMenu)
Add this to the repository menu.
addToMenuFrameable(self, repositoryMenu)
Add this to the frameable repository menu.
setStateToValue(self)
Set the checkbutton to the boolean.
setToDisplay(self)
Do nothing because toggleCheckbutton is handling the value.
setValueToString(self, valueString)
Set the boolean to the string.
toggleCheckbutton(self)
Workaround for Tkinter bug, toggle the value.
toggleMenuCheckbutton(self)
Workaround for Tkinter bug, toggle the value.

Methods inherited from StringSetting:
__init__(self)
Set the update function to none.
addToWindow(self)
Add this to the repository frame list.
bindEntry(self)
Bind the entry to the update function.
createEntry(self, root)
Create the entry.
getFromValue(self, name, repository, value)
Initialize.
getFromValueOnly(self, name, repository, value)
Initialize.
getFromValueOnlyAddToRepository(self, name, repository, value)
Initialize.
removeFromWindow(self)
Remove this from the repository frame list.
setUpdateFunction(self, updateFunction)
Set the update function.
setValueToSplitLine(self, lineIndex, lines, splitLine)
Set the value to the second word of a split line.
writeToArchiveWriter(self, archiveWriter)
Write tab separated name and value to the archive writer.

 
class CloseListener
    A class to listen to link a window to the global repository dialog list table.
 
  Methods defined here:
__init__(self, window, closeFunction=None)
Add the window to the global repository dialog list table.
listenToWidget(self, widget)
Listen to the destroy message of the widget.
wasClosed(self, event)
The dialog was closed.

 
class DeleteProfile(AddProfile)
    A class to delete the selection of a listbox profile.
 
  Methods defined here:
addToDialog(self, gridPosition)
Add this to the dialog.
deleteSelection(self)
Delete the selection of a listbox setting.

Methods inherited from AddProfile:
addSelection(self)
Add the selection of a listbox setting.
addSelectionWithEvent(self, event)
Add the selection of a listbox setting, given an event.
getFromProfileListboxSettingRepository(self, profileListboxSetting, repository)
Initialize.

 
class DeleteProfileDialog
     Methods defined here:
__init__(self, profileListboxSetting, root)
Display a delete dialog.
delete(self)
Delete the selection of a listbox setting.
no(self)
The dialog was closed.

 
class DisplayToolButton
    A class to display the tool dialog button, in a two column wide table.
 
  Methods defined here:
addToDialog(self, gridPosition)
Add this to the dialog.
displayDialog(self)
Display function.
getFromPath(self, important, name, path, repository)
Initialize.

 
class FileHelpMenuBar
     Methods defined here:
__init__(self, root)
Create a menu bar with a file and help menu.
addMenuToMenuBar(self, labelText, menu)
Add a menu to the menu bar.
addPluginToMenuBar(self, modulePath, repository, window)
Add a menu to the menu bar from a tool.
completeMenu(self, closeFunction, repository, saveFunction, window)
Complete the menu.
saveClose(self)
Call the save function then the close function.

 
class FileNameInput(StringSetting)
    A class to display, read & write a fileName.
 
  Methods defined here:
addToDialog(self, gridPosition)
Add this to the dialog.
execute(self)
Open the file picker.
getFileNameFirstTypes(self)
Get the file types with the file type of the fileName moved to the front of the list.
getFromFileName(self, fileTypes, name, repository, value)
Initialize.
setCancelledValue(self, fileName)
Set the value to the file name and wasCancelled true if a file was not picked.
setToDisplay(self)
Do nothing because the file dialog is handling the value.

Methods inherited from StringSetting:
__init__(self)
Set the update function to none.
addToMenu(self, repositoryMenu)
Do nothing because this should only be added to a frameable repository menu.
addToMenuFrameable(self, repositoryMenu)
Add this to the frameable repository menu.
addToWindow(self)
Add this to the repository frame list.
bindEntry(self)
Bind the entry to the update function.
createEntry(self, root)
Create the entry.
getFromValue(self, name, repository, value)
Initialize.
getFromValueOnly(self, name, repository, value)
Initialize.
getFromValueOnlyAddToRepository(self, name, repository, value)
Initialize.
removeFromWindow(self)
Remove this from the repository frame list.
setStateToValue(self)
Set the entry to the value.
setUpdateFunction(self, updateFunction)
Set the update function.
setValueToSplitLine(self, lineIndex, lines, splitLine)
Set the value to the second word of a split line.
setValueToString(self, valueString)
Set the value to the value string.
writeToArchiveWriter(self, archiveWriter)
Write tab separated name and value to the archive writer.

 
class FloatSetting(StringSetting)
    A class to display, read & write a float.
 
  Methods defined here:
setValueToString(self, valueString)
Set the float to the string.

Methods inherited from StringSetting:
__init__(self)
Set the update function to none.
addToDialog(self, gridPosition)
Add this to the dialog.
addToMenu(self, repositoryMenu)
Do nothing because this should only be added to a frameable repository menu.
addToMenuFrameable(self, repositoryMenu)
Add this to the frameable repository menu.
addToWindow(self)
Add this to the repository frame list.
bindEntry(self)
Bind the entry to the update function.
createEntry(self, root)
Create the entry.
getFromValue(self, name, repository, value)
Initialize.
getFromValueOnly(self, name, repository, value)
Initialize.
getFromValueOnlyAddToRepository(self, name, repository, value)
Initialize.
removeFromWindow(self)
Remove this from the repository frame list.
setStateToValue(self)
Set the entry to the value.
setToDisplay(self)
Set the string to the entry field.
setUpdateFunction(self, updateFunction)
Set the update function.
setValueToSplitLine(self, lineIndex, lines, splitLine)
Set the value to the second word of a split line.
writeToArchiveWriter(self, archiveWriter)
Write tab separated name and value to the archive writer.

 
class FloatSpin(FloatSetting)
    A class to display, read & write an float in a spin box.
 
 
Method resolution order:
FloatSpin
FloatSetting
StringSetting

Methods defined here:
addToMenuFrameable(self, repositoryMenu)
Add this to the frameable repository menu.
bindEntry(self)
Bind the entry to the update function.
createEntry(self, root)
Create the entry.
decrease(self)
Decrease the value then set the state and color to the value.
entryUpdated(self, event=None)
Create the entry.
getFromValue(self, from_, name, repository, to, value)
Initialize.
increase(self)
Increase the value then set the state and color to the value.
setColor(self, event=None)
Set the color to the value, yellow if it is lower than the default and blue if it is higher.
setColorToDisplay(self, event=None)
Set the color to the value, yellow if it is lower than the default and blue if it is higher.
setStateToValue(self)
Set the entry to the value.
setStateUpdateColor(self)
Set the state to the value, call the update function, then set the color.

Methods inherited from FloatSetting:
setValueToString(self, valueString)
Set the float to the string.

Methods inherited from StringSetting:
__init__(self)
Set the update function to none.
addToDialog(self, gridPosition)
Add this to the dialog.
addToMenu(self, repositoryMenu)
Do nothing because this should only be added to a frameable repository menu.
addToWindow(self)
Add this to the repository frame list.
getFromValueOnly(self, name, repository, value)
Initialize.
getFromValueOnlyAddToRepository(self, name, repository, value)
Initialize.
removeFromWindow(self)
Remove this from the repository frame list.
setToDisplay(self)
Set the string to the entry field.
setUpdateFunction(self, updateFunction)
Set the update function.
setValueToSplitLine(self, lineIndex, lines, splitLine)
Set the value to the second word of a split line.
writeToArchiveWriter(self, archiveWriter)
Write tab separated name and value to the archive writer.

 
class FloatSpinNotOnMenu(FloatSpin)
    A class to display, read & write an float in a spin box, which is not to be added to a menu.
 
 
Method resolution order:
FloatSpinNotOnMenu
FloatSpin
FloatSetting
StringSetting

Methods defined here:
getFromValueOnlyAddToRepository(self, name, repository, value)
Initialize.

Methods inherited from FloatSpin:
addToMenuFrameable(self, repositoryMenu)
Add this to the frameable repository menu.
bindEntry(self)
Bind the entry to the update function.
createEntry(self, root)
Create the entry.
decrease(self)
Decrease the value then set the state and color to the value.
entryUpdated(self, event=None)
Create the entry.
getFromValue(self, from_, name, repository, to, value)
Initialize.
increase(self)
Increase the value then set the state and color to the value.
setColor(self, event=None)
Set the color to the value, yellow if it is lower than the default and blue if it is higher.
setColorToDisplay(self, event=None)
Set the color to the value, yellow if it is lower than the default and blue if it is higher.
setStateToValue(self)
Set the entry to the value.
setStateUpdateColor(self)
Set the state to the value, call the update function, then set the color.

Methods inherited from FloatSetting:
setValueToString(self, valueString)
Set the float to the string.

Methods inherited from StringSetting:
__init__(self)
Set the update function to none.
addToDialog(self, gridPosition)
Add this to the dialog.
addToMenu(self, repositoryMenu)
Do nothing because this should only be added to a frameable repository menu.
addToWindow(self)
Add this to the repository frame list.
getFromValueOnly(self, name, repository, value)
Initialize.
removeFromWindow(self)
Remove this from the repository frame list.
setToDisplay(self)
Set the string to the entry field.
setUpdateFunction(self, updateFunction)
Set the update function.
setValueToSplitLine(self, lineIndex, lines, splitLine)
Set the value to the second word of a split line.
writeToArchiveWriter(self, archiveWriter)
Write tab separated name and value to the archive writer.

 
class FloatSpinUpdate(FloatSpin)
    A class to display, read, update & write an float in a spin box.
 
 
Method resolution order:
FloatSpinUpdate
FloatSpin
FloatSetting
StringSetting

Methods defined here:
createEntry(self, root)
Create the entry.

Methods inherited from FloatSpin:
addToMenuFrameable(self, repositoryMenu)
Add this to the frameable repository menu.
bindEntry(self)
Bind the entry to the update function.
decrease(self)
Decrease the value then set the state and color to the value.
entryUpdated(self, event=None)
Create the entry.
getFromValue(self, from_, name, repository, to, value)
Initialize.
increase(self)
Increase the value then set the state and color to the value.
setColor(self, event=None)
Set the color to the value, yellow if it is lower than the default and blue if it is higher.
setColorToDisplay(self, event=None)
Set the color to the value, yellow if it is lower than the default and blue if it is higher.
setStateToValue(self)
Set the entry to the value.
setStateUpdateColor(self)
Set the state to the value, call the update function, then set the color.

Methods inherited from FloatSetting:
setValueToString(self, valueString)
Set the float to the string.

Methods inherited from StringSetting:
__init__(self)
Set the update function to none.
addToDialog(self, gridPosition)
Add this to the dialog.
addToMenu(self, repositoryMenu)
Do nothing because this should only be added to a frameable repository menu.
addToWindow(self)
Add this to the repository frame list.
getFromValueOnly(self, name, repository, value)
Initialize.
getFromValueOnlyAddToRepository(self, name, repository, value)
Initialize.
removeFromWindow(self)
Remove this from the repository frame list.
setToDisplay(self)
Set the string to the entry field.
setUpdateFunction(self, updateFunction)
Set the update function.
setValueToSplitLine(self, lineIndex, lines, splitLine)
Set the value to the second word of a split line.
writeToArchiveWriter(self, archiveWriter)
Write tab separated name and value to the archive writer.

 
class FrameList
    A class to list the frames.
 
  Methods defined here:
addToList(self, word)
Add the word to the sorted list.
getFromValue(self, name, repository, value)
Initialize.
removeFromList(self, word)
Remove the word from the sorted list.
setToDisplay(self)
Do nothing because frame list does not have a display.
setValueToSplitLine(self, lineIndex, lines, splitLine)
Set the value to the second and later words of a split line.
writeToArchiveWriter(self, archiveWriter)
Write tab separated name and list to the archive writer.

 
class GridHorizontal
    A class to place elements horizontally on a grid.
 
  Methods defined here:
__init__(self, column, row)
Initialize the column and row.
getCopy(self)
Get a copy.
increment(self)
Increment the position horizontally.

 
class GridVertical
    A class to place elements vertically on a grid.
 
  Methods defined here:
__init__(self, column, row)
Initialize the column and row.
execute(self)
The execute button was clicked.
getCopy(self)
Get a copy.
increment(self)
Increment the position vertically.
incrementGivenNumberOfColumns(self, numberOfColumns)
Increment the position vertically and offset it horizontally by the given number of columns.
setExecutablesRepository(self, repository)
Set the executables to an empty list and set the repository.

 
class HelpPage
    A class to open a help page.
 
  Methods defined here:
addToDialog(self, gridPosition)
Add this to the dialog.
addToMenu(self, repositoryMenu)
Add this to the repository menu.
addToMenuFrameable(self, repositoryMenu)
Add this to the frameable repository menu.
getFromNameAfterHTTP(self, afterHTTP, name, repository)
Initialize.
getFromNameAfterWWW(self, afterWWW, name, repository)
Initialize.
getFromNameSubName(self, name, repository, subName='')
Initialize.
getOpenFromAbsolute(self, hypertextAddress)
Get the open help page function from the hypertext address.
getOpenFromAfterHTTP(self, afterHTTP)
Get the open help page function from the part of the address after the HTTP.
getOpenFromAfterWWW(self, afterWWW)
Get the open help page function from the afterWWW of the address after the www.
getOpenFromDocumentationSubName(self, subName='')
Get the open help page function from the afterWWW of the address after the www.
openPage(self, event=None)
Open the browser to the hypertext address.
setToNameRepository(self, name, repository)
Set to the name and repository.

 
class HelpPageRepository
    A class to open a repository help page.
 
  Methods defined here:
__init__(self, repository)
Add this to the dialog.
openPage(self, event=None)
Open the browser to the repository help page.

 
class HiddenScrollbar(Tkinter.Scrollbar)
    A class to hide the scrollbar if it is not needed.
 
 
Method resolution order:
HiddenScrollbar
Tkinter.Scrollbar
Tkinter.Widget
Tkinter.BaseWidget
Tkinter.Misc
Tkinter.Pack
Tkinter.Place
Tkinter.Grid

Methods defined here:
set(self, lo, hi)
Add to grid is needed, remove if not.

Methods inherited from Tkinter.Scrollbar:
__init__(self, master=None, cnf={}, **kw)
Construct a scrollbar widget with the parent MASTER.
 
Valid resource names: activebackground, activerelief,
background, bd, bg, borderwidth, command, cursor,
elementborderwidth, highlightbackground,
highlightcolor, highlightthickness, jump, orient,
relief, repeatdelay, repeatinterval, takefocus,
troughcolor, width.
activate(self, index)
Display the element at INDEX with activebackground and activerelief.
INDEX can be "arrow1","slider" or "arrow2".
delta(self, deltax, deltay)
Return the fractional change of the scrollbar setting if it
would be moved by DELTAX or DELTAY pixels.
fraction(self, x, y)
Return the fractional value which corresponds to a slider
position of X,Y.
get(self)
Return the current fractional values (upper and lower end)
of the slider position.
identify(self, x, y)
Return the element under position X,Y as one of
"arrow1","slider","arrow2" or "".

Methods inherited from Tkinter.BaseWidget:
destroy(self)
Destroy this and all descendants widgets.

Methods inherited from Tkinter.Misc:
__getitem__ = cget(self, key)
Return the resource value for a KEY given as string.
__setitem__(self, key, value)
__str__(self)
Return the window path name of this widget.
after(self, ms, func=None, *args)
Call function once after given time.
 
MS specifies the time in milliseconds. FUNC gives the
function which shall be called. Additional parameters
are given as parameters to the function call.  Return
identifier to cancel scheduling with after_cancel.
after_cancel(self, id)
Cancel scheduling of function identified with ID.
 
Identifier returned by after or after_idle must be
given as first parameter.
after_idle(self, func, *args)
Call FUNC once if the Tcl main loop has no event to
process.
 
Return an identifier to cancel the scheduling with
after_cancel.
bbox = grid_bbox(self, column=None, row=None, col2=None, row2=None)
Return a tuple of integer coordinates for the bounding
box of this widget controlled by the geometry manager grid.
 
If COLUMN, ROW is given the bounding box applies from
the cell with row and column 0 to the specified
cell. If COL2 and ROW2 are given the bounding box
starts at that cell.
 
The returned integers specify the offset of the upper left
corner in the master widget and the width and height.
bell(self, displayof=0)
Ring a display's bell.
bind(self, sequence=None, func=None, add=None)
Bind to this widget at event SEQUENCE a call to function FUNC.
 
SEQUENCE is a string of concatenated event
patterns. An event pattern is of the form
<MODIFIER-MODIFIER-TYPE-DETAIL> where MODIFIER is one
of Control, Mod2, M2, Shift, Mod3, M3, Lock, Mod4, M4,
Button1, B1, Mod5, M5 Button2, B2, Meta, M, Button3,
B3, Alt, Button4, B4, Double, Button5, B5 Triple,
Mod1, M1. TYPE is one of Activate, Enter, Map,
ButtonPress, Button, Expose, Motion, ButtonRelease
FocusIn, MouseWheel, Circulate, FocusOut, Property,
Colormap, Gravity Reparent, Configure, KeyPress, Key,
Unmap, Deactivate, KeyRelease Visibility, Destroy,
Leave and DETAIL is the button number for ButtonPress,
ButtonRelease and DETAIL is the Keysym for KeyPress and
KeyRelease. Examples are
<Control-Button-1> for pressing Control and mouse button 1 or
<Alt-A> for pressing A and the Alt key (KeyPress can be omitted).
An event pattern can also be a virtual event of the form
<<AString>> where AString can be arbitrary. This
event can be generated by event_generate.
If events are concatenated they must appear shortly
after each other.
 
FUNC will be called if the event sequence occurs with an
instance of Event as argument. If the return value of FUNC is
"break" no further bound function is invoked.
 
An additional boolean parameter ADD specifies whether FUNC will
be called additionally to the other bound function or whether
it will replace the previous function.
 
Bind will return an identifier to allow deletion of the bound function with
unbind without memory leak.
 
If FUNC or SEQUENCE is omitted the bound function or list
of bound events are returned.
bind_all(self, sequence=None, func=None, add=None)
Bind to all widgets at an event SEQUENCE a call to function FUNC.
An additional boolean parameter ADD specifies whether FUNC will
be called additionally to the other bound function or whether
it will replace the previous function. See bind for the return value.
bind_class(self, className, sequence=None, func=None, add=None)
Bind to widgets with bindtag CLASSNAME at event
SEQUENCE a call of function FUNC. An additional
boolean parameter ADD specifies whether FUNC will be
called additionally to the other bound function or
whether it will replace the previous function. See bind for
the return value.
bindtags(self, tagList=None)
Set or get the list of bindtags for this widget.
 
With no argument return the list of all bindtags associated with
this widget. With a list of strings as argument the bindtags are
set to this list. The bindtags determine in which order events are
processed (see bind).
cget(self, key)
Return the resource value for a KEY given as string.
clipboard_append(self, string, **kw)
Append STRING to the Tk clipboard.
 
A widget specified at the optional displayof keyword
argument specifies the target display. The clipboard
can be retrieved with selection_get.
clipboard_clear(self, **kw)
Clear the data in the Tk clipboard.
 
A widget specified for the optional displayof keyword
argument specifies the target display.
clipboard_get(self, **kw)
Retrieve data from the clipboard on window's display.
 
The window keyword defaults to the root window of the Tkinter
application.
 
The type keyword specifies the form in which the data is
to be returned and should be an atom name such as STRING
or FILE_NAME.  Type defaults to STRING.
 
This command is equivalent to:
 
selection_get(CLIPBOARD)
colormodel(self, value=None)
Useless. Not implemented in Tk.
columnconfigure = grid_columnconfigure(self, index, cnf={}, **kw)
Configure column INDEX of a grid.
 
Valid resources are minsize (minimum size of the column),
weight (how much does additional space propagate to this column)
and pad (how much space to let additionally).
config = configure(self, cnf=None, **kw)
Configure resources of a widget.
 
The values for resources are specified as keyword
arguments. To get an overview about
the allowed keyword arguments call the method keys.
configure(self, cnf=None, **kw)
Configure resources of a widget.
 
The values for resources are specified as keyword
arguments. To get an overview about
the allowed keyword arguments call the method keys.
deletecommand(self, name)
Internal function.
 
Delete the Tcl command provided in NAME.
event_add(self, virtual, *sequences)
Bind a virtual event VIRTUAL (of the form <<Name>>)
to an event SEQUENCE such that the virtual event is triggered
whenever SEQUENCE occurs.
event_delete(self, virtual, *sequences)
Unbind a virtual event VIRTUAL from SEQUENCE.
event_generate(self, sequence, **kw)
Generate an event SEQUENCE. Additional
keyword arguments specify parameter of the event
(e.g. x, y, rootx, rooty).
event_info(self, virtual=None)
Return a list of all virtual events or the information
about the SEQUENCE bound to the virtual event VIRTUAL.
focus = focus_set(self)
Direct input focus to this widget.
 
If the application currently does not have the focus
this widget will get the focus if the application gets
the focus through the window manager.
focus_displayof(self)
Return the widget which has currently the focus on the
display where this widget is located.
 
Return None if the application does not have the focus.
focus_force(self)
Direct input focus to this widget even if the
application does not have the focus. Use with
caution!
focus_get(self)
Return the widget which has currently the focus in the
application.
 
Use focus_displayof to allow working with several
displays. Return None if application does not have
the focus.
focus_lastfor(self)
Return the widget which would have the focus if top level
for this widget gets the focus from the window manager.
focus_set(self)
Direct input focus to this widget.
 
If the application currently does not have the focus
this widget will get the focus if the application gets
the focus through the window manager.
getboolean(self, s)
Return a boolean value for Tcl boolean values true and false given as parameter.
getvar(self, name='PY_VAR')
Return value of Tcl variable NAME.
grab_current(self)
Return widget which has currently the grab in this application
or None.
grab_release(self)
Release grab for this widget if currently set.
grab_set(self)
Set grab for this widget.
 
A grab directs all events to this and descendant
widgets in the application.
grab_set_global(self)
Set global grab for this widget.
 
A global grab directs all events to this and
descendant widgets on the display. Use with caution -
other applications do not get events anymore.
grab_status(self)
Return None, "local" or "global" if this widget has
no, a local or a global grab.
grid_bbox(self, column=None, row=None, col2=None, row2=None)
Return a tuple of integer coordinates for the bounding
box of this widget controlled by the geometry manager grid.
 
If COLUMN, ROW is given the bounding box applies from
the cell with row and column 0 to the specified
cell. If COL2 and ROW2 are given the bounding box
starts at that cell.
 
The returned integers specify the offset of the upper left
corner in the master widget and the width and height.
grid_columnconfigure(self, index, cnf={}, **kw)
Configure column INDEX of a grid.
 
Valid resources are minsize (minimum size of the column),
weight (how much does additional space propagate to this column)
and pad (how much space to let additionally).
grid_location(self, x, y)
Return a tuple of column and row which identify the cell
at which the pixel at position X and Y inside the master
widget is located.
grid_propagate(self, flag=['_noarg_'])
Set or get the status for propagation of geometry information.
 
A boolean argument specifies whether the geometry information
of the slaves will determine the size of this widget. If no argument
is given, the current setting will be returned.
grid_rowconfigure(self, index, cnf={}, **kw)
Configure row INDEX of a grid.
 
Valid resources are minsize (minimum size of the row),
weight (how much does additional space propagate to this row)
and pad (how much space to let additionally).
grid_size(self)
Return a tuple of the number of column and rows in the grid.
grid_slaves(self, row=None, column=None)
Return a list of all slaves of this widget
in its packing order.
image_names(self)
Return a list of all existing image names.
image_types(self)
Return a list of all available image types (e.g. phote bitmap).
keys(self)
Return a list of all resource names of this widget.
lift = tkraise(self, aboveThis=None)
Raise this widget in the stacking order.
lower(self, belowThis=None)
Lower this widget in the stacking order.
mainloop(self, n=0)
Call the mainloop of Tk.
nametowidget(self, name)
Return the Tkinter instance of a widget identified by
its Tcl name NAME.
option_add(self, pattern, value, priority=None)
Set a VALUE (second parameter) for an option
PATTERN (first parameter).
 
An optional third parameter gives the numeric priority
(defaults to 80).
option_clear(self)
Clear the option database.
 
It will be reloaded if option_add is called.
option_get(self, name, className)
Return the value for an option NAME for this widget
with CLASSNAME.
 
Values with higher priority override lower values.
option_readfile(self, fileName, priority=None)
Read file FILENAME into the option database.
 
An optional second parameter gives the numeric
priority.
pack_propagate(self, flag=['_noarg_'])
Set or get the status for propagation of geometry information.
 
A boolean argument specifies whether the geometry information
of the slaves will determine the size of this widget. If no argument
is given the current setting will be returned.
pack_slaves(self)
Return a list of all slaves of this widget
in its packing order.
place_slaves(self)
Return a list of all slaves of this widget
in its packing order.
propagate = pack_propagate(self, flag=['_noarg_'])
Set or get the status for propagation of geometry information.
 
A boolean argument specifies whether the geometry information
of the slaves will determine the size of this widget. If no argument
is given the current setting will be returned.
quit(self)
Quit the Tcl interpreter. All widgets will be destroyed.
register = _register(self, func, subst=None, needcleanup=1)
Return a newly created Tcl function. If this
function is called, the Python function FUNC will
be executed. An optional function SUBST can
be given which will be executed before FUNC.
rowconfigure = grid_rowconfigure(self, index, cnf={}, **kw)
Configure row INDEX of a grid.
 
Valid resources are minsize (minimum size of the row),
weight (how much does additional space propagate to this row)
and pad (how much space to let additionally).
selection_clear(self, **kw)
Clear the current X selection.
selection_get(self, **kw)
Return the contents of the current X selection.
 
A keyword parameter selection specifies the name of
the selection and defaults to PRIMARY.  A keyword
parameter displayof specifies a widget on the display
to use.
selection_handle(self, command, **kw)
Specify a function COMMAND to call if the X
selection owned by this widget is queried by another
application.
 
This function must return the contents of the
selection. The function will be called with the
arguments OFFSET and LENGTH which allows the chunking
of very long selections. The following keyword
parameters can be provided:
selection - name of the selection (default PRIMARY),
type - type of the selection (e.g. STRING, FILE_NAME).
selection_own(self, **kw)
Become owner of X selection.
 
A keyword parameter selection specifies the name of
the selection (default PRIMARY).
selection_own_get(self, **kw)
Return owner of X selection.
 
The following keyword parameter can
be provided:
selection - name of the selection (default PRIMARY),
type - type of the selection (e.g. STRING, FILE_NAME).
send(self, interp, cmd, *args)
Send Tcl command CMD to different interpreter INTERP to be executed.
setvar(self, name='PY_VAR', value='1')
Set Tcl variable NAME to VALUE.
size = grid_size(self)
Return a tuple of the number of column and rows in the grid.
slaves = pack_slaves(self)
Return a list of all slaves of this widget
in its packing order.
tk_bisque(self)
Change the color scheme to light brown as used in Tk 3.6 and before.
tk_focusFollowsMouse(self)
The widget under mouse will get automatically focus. Can not
be disabled easily.
tk_focusNext(self)
Return the next widget in the focus order which follows
widget which has currently the focus.
 
The focus order first goes to the next child, then to
the children of the child recursively and then to the
next sibling which is higher in the stacking order.  A
widget is omitted if it has the takefocus resource set
to 0.
tk_focusPrev(self)
Return previous widget in the focus order. See tk_focusNext for details.
tk_menuBar(self, *args)
Do not use. Needed in Tk 3.6 and earlier.
tk_setPalette(self, *args, **kw)
Set a new color scheme for all widget elements.
 
A single color as argument will cause that all colors of Tk
widget elements are derived from this.
Alternatively several keyword parameters and its associated
colors can be given. The following keywords are valid:
activeBackground, foreground, selectColor,
activeForeground, highlightBackground, selectBackground,
background, highlightColor, selectForeground,
disabledForeground, insertBackground, troughColor.
tk_strictMotif(self, boolean=None)
Set Tcl internal variable, whether the look and feel
should adhere to Motif.
 
A parameter of 1 means adhere to Motif (e.g. no color
change if mouse passes over slider).
Returns the set value.
tkraise(self, aboveThis=None)
Raise this widget in the stacking order.
unbind(self, sequence, funcid=None)
Unbind for this widget for event SEQUENCE  the
function identified with FUNCID.
unbind_all(self, sequence)
Unbind for all widgets for event SEQUENCE all functions.
unbind_class(self, className, sequence)
Unbind for a all widgets with bindtag CLASSNAME for event SEQUENCE
all functions.
update(self)
Enter event loop until all pending events have been processed by Tcl.
update_idletasks(self)
Enter event loop until all idle callbacks have been called. This
will update the display of windows but not process events caused by
the user.
wait_variable(self, name='PY_VAR')
Wait until the variable is modified.
 
A parameter of type IntVar, StringVar, DoubleVar or
BooleanVar must be given.
wait_visibility(self, window=None)
Wait until the visibility of a WIDGET changes
(e.g. it appears).
 
If no parameter is given self is used.
wait_window(self, window=None)
Wait until a WIDGET is destroyed.
 
If no parameter is given self is used.
waitvar = wait_variable(self, name='PY_VAR')
Wait until the variable is modified.
 
A parameter of type IntVar, StringVar, DoubleVar or
BooleanVar must be given.
winfo_atom(self, name, displayof=0)
Return integer which represents atom NAME.
winfo_atomname(self, id, displayof=0)
Return name of atom with identifier ID.
winfo_cells(self)
Return number of cells in the colormap for this widget.
winfo_children(self)
Return a list of all widgets which are children of this widget.
winfo_class(self)
Return window class name of this widget.
winfo_colormapfull(self)
Return true if at the last color request the colormap was full.
winfo_containing(self, rootX, rootY, displayof=0)
Return the widget which is at the root coordinates ROOTX, ROOTY.
winfo_depth(self)
Return the number of bits per pixel.
winfo_exists(self)
Return true if this widget exists.
winfo_fpixels(self, number)
Return the number of pixels for the given distance NUMBER
(e.g. "3c") as float.
winfo_geometry(self)
Return geometry string for this widget in the form "widthxheight+X+Y".
winfo_height(self)
Return height of this widget.
winfo_id(self)
Return identifier ID for this widget.
winfo_interps(self, displayof=0)
Return the name of all Tcl interpreters for this display.
winfo_ismapped(self)
Return true if this widget is mapped.
winfo_manager(self)
Return the window mananger name for this widget.
winfo_name(self)
Return the name of this widget.
winfo_parent(self)
Return the name of the parent of this widget.
winfo_pathname(self, id, displayof=0)
Return the pathname of the widget given by ID.
winfo_pixels(self, number)
Rounded integer value of winfo_fpixels.
winfo_pointerx(self)
Return the x coordinate of the pointer on the root window.
winfo_pointerxy(self)
Return a tuple of x and y coordinates of the pointer on the root window.
winfo_pointery(self)
Return the y coordinate of the pointer on the root window.
winfo_reqheight(self)
Return requested height of this widget.
winfo_reqwidth(self)
Return requested width of this widget.
winfo_rgb(self, color)
Return tuple of decimal values for red, green, blue for
COLOR in this widget.
winfo_rootx(self)
Return x coordinate of upper left corner of this widget on the
root window.
winfo_rooty(self)
Return y coordinate of upper left corner of this widget on the
root window.
winfo_screen(self)
Return the screen name of this widget.
winfo_screencells(self)
Return the number of the cells in the colormap of the screen
of this widget.
winfo_screendepth(self)
Return the number of bits per pixel of the root window of the
screen of this widget.
winfo_screenheight(self)
Return the number of pixels of the height of the screen of this widget
in pixel.
winfo_screenmmheight(self)
Return the number of pixels of the height of the screen of
this widget in mm.
winfo_screenmmwidth(self)
Return the number of pixels of the width of the screen of
this widget in mm.
winfo_screenvisual(self)
Return one of the strings directcolor, grayscale, pseudocolor,
staticcolor, staticgray, or truecolor for the default
colormodel of this screen.
winfo_screenwidth(self)
Return the number of pixels of the width of the screen of
this widget in pixel.
winfo_server(self)
Return information of the X-Server of the screen of this widget in
the form "XmajorRminor vendor vendorVersion".
winfo_toplevel(self)
Return the toplevel widget of this widget.
winfo_viewable(self)
Return true if the widget and all its higher ancestors are mapped.
winfo_visual(self)
Return one of the strings directcolor, grayscale, pseudocolor,
staticcolor, staticgray, or truecolor for the
colormodel of this widget.
winfo_visualid(self)
Return the X identifier for the visual for this widget.
winfo_visualsavailable(self, includeids=0)
Return a list of all visuals available for the screen
of this widget.
 
Each item in the list consists of a visual name (see winfo_visual), a
depth and if INCLUDEIDS=1 is given also the X identifier.
winfo_vrootheight(self)
Return the height of the virtual root window associated with this
widget in pixels. If there is no virtual root window return the
height of the screen.
winfo_vrootwidth(self)
Return the width of the virtual root window associated with this
widget in pixel. If there is no virtual root window return the
width of the screen.
winfo_vrootx(self)
Return the x offset of the virtual root relative to the root
window of the screen of this widget.
winfo_vrooty(self)
Return the y offset of the virtual root relative to the root
window of the screen of this widget.
winfo_width(self)
Return the width of this widget.
winfo_x(self)
Return the x coordinate of the upper left corner of this widget
in the parent.
winfo_y(self)
Return the y coordinate of the upper left corner of this widget
in the parent.

Data and other attributes inherited from Tkinter.Misc:
getdouble = <type 'float'>
float(x) -> floating point number
 
Convert a string or number to a floating point number, if possible.
getint = <type 'int'>
int(x[, base]) -> integer
 
Convert a string or number to an integer, if possible.  A floating point
argument will be truncated towards zero (this does not include a string
representation of a floating point number!)  When converting a string, use
the optional base.  It is an error to supply a base when converting a
non-string. If the argument is outside the integer range a long object
will be returned instead.

Methods inherited from Tkinter.Pack:
forget = pack_forget(self)
Unmap this widget and do not use it for the packing order.
info = pack_info(self)
Return information about the packing options
for this widget.
pack = pack_configure(self, cnf={}, **kw)
Pack a widget in the parent widget. Use as options:
after=widget - pack it after you have packed widget
anchor=NSEW (or subset) - position widget according to
                          given direction
        before=widget - pack it before you will pack widget
expand=bool - expand widget if parent size grows
fill=NONE or X or Y or BOTH - fill widget if widget grows
in=master - use master to contain this widget
ipadx=amount - add internal padding in x direction
ipady=amount - add internal padding in y direction
padx=amount - add padding in x direction
pady=amount - add padding in y direction
side=TOP or BOTTOM or LEFT or RIGHT -  where to add this widget.
pack_configure(self, cnf={}, **kw)
Pack a widget in the parent widget. Use as options:
after=widget - pack it after you have packed widget
anchor=NSEW (or subset) - position widget according to
                          given direction
        before=widget - pack it before you will pack widget
expand=bool - expand widget if parent size grows
fill=NONE or X or Y or BOTH - fill widget if widget grows
in=master - use master to contain this widget
ipadx=amount - add internal padding in x direction
ipady=amount - add internal padding in y direction
padx=amount - add padding in x direction
pady=amount - add padding in y direction
side=TOP or BOTTOM or LEFT or RIGHT -  where to add this widget.
pack_forget(self)
Unmap this widget and do not use it for the packing order.
pack_info(self)
Return information about the packing options
for this widget.

Methods inherited from Tkinter.Place:
place = place_configure(self, cnf={}, **kw)
Place a widget in the parent widget. Use as options:
in=master - master relative to which the widget is placed.
x=amount - locate anchor of this widget at position x of master
y=amount - locate anchor of this widget at position y of master
relx=amount - locate anchor of this widget between 0.0 and 1.0
              relative to width of master (1.0 is right edge)
    rely=amount - locate anchor of this widget between 0.0 and 1.0
              relative to height of master (1.0 is bottom edge)
    anchor=NSEW (or subset) - position anchor according to given direction
width=amount - width of this widget in pixel
height=amount - height of this widget in pixel
relwidth=amount - width of this widget between 0.0 and 1.0
                  relative to width of master (1.0 is the same width
          as the master)
    relheight=amount - height of this widget between 0.0 and 1.0
                   relative to height of master (1.0 is the same
           height as the master)
    bordermode="inside" or "outside" - whether to take border width of master widget
                                       into account
place_configure(self, cnf={}, **kw)
Place a widget in the parent widget. Use as options:
in=master - master relative to which the widget is placed.
x=amount - locate anchor of this widget at position x of master
y=amount - locate anchor of this widget at position y of master
relx=amount - locate anchor of this widget between 0.0 and 1.0
              relative to width of master (1.0 is right edge)
    rely=amount - locate anchor of this widget between 0.0 and 1.0
              relative to height of master (1.0 is bottom edge)
    anchor=NSEW (or subset) - position anchor according to given direction
width=amount - width of this widget in pixel
height=amount - height of this widget in pixel
relwidth=amount - width of this widget between 0.0 and 1.0
                  relative to width of master (1.0 is the same width
          as the master)
    relheight=amount - height of this widget between 0.0 and 1.0
                   relative to height of master (1.0 is the same
           height as the master)
    bordermode="inside" or "outside" - whether to take border width of master widget
                                       into account
place_forget(self)
Unmap this widget.
place_info(self)
Return information about the placing options
for this widget.

Methods inherited from Tkinter.Grid:
grid = grid_configure(self, cnf={}, **kw)
Position a widget in the parent widget in a grid. Use as options:
column=number - use cell identified with given column (starting with 0)
columnspan=number - this widget will span several columns
in=master - use master to contain this widget
ipadx=amount - add internal padding in x direction
ipady=amount - add internal padding in y direction
padx=amount - add padding in x direction
pady=amount - add padding in y direction
row=number - use cell identified with given row (starting with 0)
rowspan=number - this widget will span several rows
sticky=NSEW - if cell is larger on which sides will this
              widget stick to the cell boundary
grid_configure(self, cnf={}, **kw)
Position a widget in the parent widget in a grid. Use as options:
column=number - use cell identified with given column (starting with 0)
columnspan=number - this widget will span several columns
in=master - use master to contain this widget
ipadx=amount - add internal padding in x direction
ipady=amount - add internal padding in y direction
padx=amount - add padding in x direction
pady=amount - add padding in y direction
row=number - use cell identified with given row (starting with 0)
rowspan=number - this widget will span several rows
sticky=NSEW - if cell is larger on which sides will this
              widget stick to the cell boundary
grid_forget(self)
Unmap this widget.
grid_info(self)
Return information about the options
for positioning this widget in a grid.
grid_remove(self)
Unmap this widget but remember the grid options.
location = grid_location(self, x, y)
Return a tuple of column and row which identify the cell
at which the pixel at position X and Y inside the master
widget is located.

 
class IntSetting(FloatSetting)
    A class to display, read & write an int.
 
 
Method resolution order:
IntSetting
FloatSetting
StringSetting

Methods defined here:
setValueToString(self, valueString)
Set the integer to the string.

Methods inherited from StringSetting:
__init__(self)
Set the update function to none.
addToDialog(self, gridPosition)
Add this to the dialog.
addToMenu(self, repositoryMenu)
Do nothing because this should only be added to a frameable repository menu.
addToMenuFrameable(self, repositoryMenu)
Add this to the frameable repository menu.
addToWindow(self)
Add this to the repository frame list.
bindEntry(self)
Bind the entry to the update function.
createEntry(self, root)
Create the entry.
getFromValue(self, name, repository, value)
Initialize.
getFromValueOnly(self, name, repository, value)
Initialize.
getFromValueOnlyAddToRepository(self, name, repository, value)
Initialize.
removeFromWindow(self)
Remove this from the repository frame list.
setStateToValue(self)
Set the entry to the value.
setToDisplay(self)
Set the string to the entry field.
setUpdateFunction(self, updateFunction)
Set the update function.
setValueToSplitLine(self, lineIndex, lines, splitLine)
Set the value to the second word of a split line.
writeToArchiveWriter(self, archiveWriter)
Write tab separated name and value to the archive writer.

 
class IntSpin(FloatSpin)
    A class to display, read & write an int in a spin box.
 
 
Method resolution order:
IntSpin
FloatSpin
FloatSetting
StringSetting

Methods defined here:
getFromValue(self, from_, name, repository, to, value)
Initialize.
getSingleIncrementFromValue(self, from_, name, repository, to, value)
Initialize.
setValueToString(self, valueString)
Set the integer to the string.

Methods inherited from FloatSpin:
addToMenuFrameable(self, repositoryMenu)
Add this to the frameable repository menu.
bindEntry(self)
Bind the entry to the update function.
createEntry(self, root)
Create the entry.
decrease(self)
Decrease the value then set the state and color to the value.
entryUpdated(self, event=None)
Create the entry.
increase(self)
Increase the value then set the state and color to the value.
setColor(self, event=None)
Set the color to the value, yellow if it is lower than the default and blue if it is higher.
setColorToDisplay(self, event=None)
Set the color to the value, yellow if it is lower than the default and blue if it is higher.
setStateToValue(self)
Set the entry to the value.
setStateUpdateColor(self)
Set the state to the value, call the update function, then set the color.

Methods inherited from StringSetting:
__init__(self)
Set the update function to none.
addToDialog(self, gridPosition)
Add this to the dialog.
addToMenu(self, repositoryMenu)
Do nothing because this should only be added to a frameable repository menu.
addToWindow(self)
Add this to the repository frame list.
getFromValueOnly(self, name, repository, value)
Initialize.
getFromValueOnlyAddToRepository(self, name, repository, value)
Initialize.
removeFromWindow(self)
Remove this from the repository frame list.
setToDisplay(self)
Set the string to the entry field.
setUpdateFunction(self, updateFunction)
Set the update function.
setValueToSplitLine(self, lineIndex, lines, splitLine)
Set the value to the second word of a split line.
writeToArchiveWriter(self, archiveWriter)
Write tab separated name and value to the archive writer.

 
class IntSpinNotOnMenu(IntSpin)
    A class to display, read & write an integer in a spin box, which is not to be added to a menu.
 
 
Method resolution order:
IntSpinNotOnMenu
IntSpin
FloatSpin
FloatSetting
StringSetting

Methods defined here:
getFromValueOnlyAddToRepository(self, name, repository, value)
Initialize.

Methods inherited from IntSpin:
getFromValue(self, from_, name, repository, to, value)
Initialize.
getSingleIncrementFromValue(self, from_, name, repository, to, value)
Initialize.
setValueToString(self, valueString)
Set the integer to the string.

Methods inherited from FloatSpin:
addToMenuFrameable(self, repositoryMenu)
Add this to the frameable repository menu.
bindEntry(self)
Bind the entry to the update function.
createEntry(self, root)
Create the entry.
decrease(self)
Decrease the value then set the state and color to the value.
entryUpdated(self, event=None)
Create the entry.
increase(self)
Increase the value then set the state and color to the value.
setColor(self, event=None)
Set the color to the value, yellow if it is lower than the default and blue if it is higher.
setColorToDisplay(self, event=None)
Set the color to the value, yellow if it is lower than the default and blue if it is higher.
setStateToValue(self)
Set the entry to the value.
setStateUpdateColor(self)
Set the state to the value, call the update function, then set the color.

Methods inherited from StringSetting:
__init__(self)
Set the update function to none.
addToDialog(self, gridPosition)
Add this to the dialog.
addToMenu(self, repositoryMenu)
Do nothing because this should only be added to a frameable repository menu.
addToWindow(self)
Add this to the repository frame list.
getFromValueOnly(self, name, repository, value)
Initialize.
removeFromWindow(self)
Remove this from the repository frame list.
setToDisplay(self)
Set the string to the entry field.
setUpdateFunction(self, updateFunction)
Set the update function.
setValueToSplitLine(self, lineIndex, lines, splitLine)
Set the value to the second word of a split line.
writeToArchiveWriter(self, archiveWriter)
Write tab separated name and value to the archive writer.

 
class IntSpinUpdate(IntSpin)
    A class to display, read, update & write an int in a spin box.
 
 
Method resolution order:
IntSpinUpdate
IntSpin
FloatSpin
FloatSetting
StringSetting

Methods defined here:
createEntry(self, root)
Create the entry.

Methods inherited from IntSpin:
getFromValue(self, from_, name, repository, to, value)
Initialize.
getSingleIncrementFromValue(self, from_, name, repository, to, value)
Initialize.
setValueToString(self, valueString)
Set the integer to the string.

Methods inherited from FloatSpin:
addToMenuFrameable(self, repositoryMenu)
Add this to the frameable repository menu.
bindEntry(self)
Bind the entry to the update function.
decrease(self)
Decrease the value then set the state and color to the value.
entryUpdated(self, event=None)
Create the entry.
increase(self)
Increase the value then set the state and color to the value.
setColor(self, event=None)
Set the color to the value, yellow if it is lower than the default and blue if it is higher.
setColorToDisplay(self, event=None)
Set the color to the value, yellow if it is lower than the default and blue if it is higher.
setStateToValue(self)
Set the entry to the value.
setStateUpdateColor(self)
Set the state to the value, call the update function, then set the color.

Methods inherited from StringSetting:
__init__(self)
Set the update function to none.
addToDialog(self, gridPosition)
Add this to the dialog.
addToMenu(self, repositoryMenu)
Do nothing because this should only be added to a frameable repository menu.
addToWindow(self)
Add this to the repository frame list.
getFromValueOnly(self, name, repository, value)
Initialize.
getFromValueOnlyAddToRepository(self, name, repository, value)
Initialize.
removeFromWindow(self)
Remove this from the repository frame list.
setToDisplay(self)
Set the string to the entry field.
setUpdateFunction(self, updateFunction)
Set the update function.
setValueToSplitLine(self, lineIndex, lines, splitLine)
Set the value to the second word of a split line.
writeToArchiveWriter(self, archiveWriter)
Write tab separated name and value to the archive writer.

 
class LabelDisplay
    A class to add a label.
 
  Methods defined here:
addToDialog(self, gridPosition)
Add this to the dialog.
getFromName(self, name, repository)
Initialize.

 
class LabelHelp
    A class to add help to a widget.
 
  Methods defined here:
__init__(self, fileNameHelp, master, name, widget)
Add menu to the widget.
displayPopupMenu(self, event=None)
Display the popup menu when the button is right clicked.
unpostPopupMenu(self, event=None)
Unpost the popup menu.

 
class LabelSeparator
    A class to add a label and menu separator.
 
  Methods defined here:
addToDialog(self, gridPosition)
Add this to the dialog.
addToMenu(self, repositoryMenu)
Add this to the repository menu.
addToMenuFrameable(self, repositoryMenu)
Add this to the frameable repository menu.
getFromRepository(self, repository)
Initialize.

 
class LatentStringVar
    A class to provide a StringVar when needed.
 
  Methods defined here:
__init__(self)
Set the string var.
getString(self)
Get the string.
getVar(self)
Get the string var.
setString(self, word)
Set the string.

 
class MenuButtonDisplay
    A class to add a menu button.
 
  Methods defined here:
addRadiosToDialog(self, gridPosition)
Add the menu radios to the dialog.
addToMenu(self, repositoryMenu)
Add this to the repository menu.
addToMenuFrameable(self, repositoryMenu)
Add this to the frameable repository menu.
getFromName(self, name, repository)
Initialize.
removeMenus(self)
Remove all menus.
setRadioVarToName(self, name)
Get the menu button.
setToNameAddToDialog(self, name, gridPosition)
Get the menu button.

 
class MenuRadio(BooleanSetting)
    A class to display, read & write a boolean with associated menu radio button.
 
 
Method resolution order:
MenuRadio
BooleanSetting
StringSetting

Methods defined here:
addToDialog(self, gridPosition)
Add this to the dialog.
addToMenu(self, repositoryMenu)
Add this to the submenu set by MenuButtonDisplay, the repository menu is ignored
addToMenuFrameable(self, repositoryMenu)
Add this to the frameable repository menu.
addToSubmenu(self)
Add this to the submenu.
clickRadio(self)
Workaround for Tkinter bug, invoke and set the value when clicked.
getFromMenuButtonDisplay(self, menuButtonDisplay, name, repository, value)
Initialize.
invoke(self)
Workaround for Tkinter bug, invoke to set the value when changed.
setStateToValue(self)
Set the checkbutton to the boolean.
setToDisplay(self)
Set the boolean to the checkbutton.

Methods inherited from BooleanSetting:
setValueToString(self, valueString)
Set the boolean to the string.
toggleCheckbutton(self)
Workaround for Tkinter bug, toggle the value.
toggleMenuCheckbutton(self)
Workaround for Tkinter bug, toggle the value.

Methods inherited from StringSetting:
__init__(self)
Set the update function to none.
addToWindow(self)
Add this to the repository frame list.
bindEntry(self)
Bind the entry to the update function.
createEntry(self, root)
Create the entry.
getFromValue(self, name, repository, value)
Initialize.
getFromValueOnly(self, name, repository, value)
Initialize.
getFromValueOnlyAddToRepository(self, name, repository, value)
Initialize.
removeFromWindow(self)
Remove this from the repository frame list.
setUpdateFunction(self, updateFunction)
Set the update function.
setValueToSplitLine(self, lineIndex, lines, splitLine)
Set the value to the second word of a split line.
writeToArchiveWriter(self, archiveWriter)
Write tab separated name and value to the archive writer.

 
class PluginFrame
    A class to list the profiles.
 
  Methods defined here:
__init__(self)
Set the radio.
addToDialog(self, gridPosition)
Add this to the dialog.
createFrame(self, gridPosition)
Create the frame.
getFromPath(self, defaultRadioButton, directoryPath, repository)
Initialize.
setStateToValue(self)
Set the state of all the plugins to the value.
setToDisplay(self)
Set the plugins to the display.
update(self)
Update the frame.
writeToArchiveWriter(self, archiveWriter)
Write tab separated name and value to the archive writer.

 
class ProfileList
    A class to list the profiles.
 
  Methods defined here:
getFromName(self, name, repository)
Initialize.
setValueToFolders(self)
Set the value to the folders in the profiles directories.

 
class ProfileListboxSetting(StringSetting)
    A class to handle the profile listbox.
 
  Methods defined here:
addToDialog(self, gridPosition)
Add this to the dialog.
buttonReleaseOne(self, event)
Button one released.
focusIn(self, event)
The root has gained focus.
getFromListSetting(self, listSetting, name, repository, value)
Initialize.
getSelectedFolder(self)
Get the selected folder.
setStateToValue(self)
Set the listbox items to the list setting.
setToDisplay(self)
Set the selection value to the listbox selection.
setValueToIndex(self, index)
Set the selection value to the index.
setValueToString(self, valueString)
Set the value to the value string.

Methods inherited from StringSetting:
__init__(self)
Set the update function to none.
addToMenu(self, repositoryMenu)
Do nothing because this should only be added to a frameable repository menu.
addToMenuFrameable(self, repositoryMenu)
Add this to the frameable repository menu.
addToWindow(self)
Add this to the repository frame list.
bindEntry(self)
Bind the entry to the update function.
createEntry(self, root)
Create the entry.
getFromValue(self, name, repository, value)
Initialize.
getFromValueOnly(self, name, repository, value)
Initialize.
getFromValueOnlyAddToRepository(self, name, repository, value)
Initialize.
removeFromWindow(self)
Remove this from the repository frame list.
setUpdateFunction(self, updateFunction)
Set the update function.
setValueToSplitLine(self, lineIndex, lines, splitLine)
Set the value to the second word of a split line.
writeToArchiveWriter(self, archiveWriter)
Write tab separated name and value to the archive writer.

 
class Radio(BooleanSetting)
    A class to display, read & write a boolean with associated radio button.
 
 
Method resolution order:
Radio
BooleanSetting
StringSetting

Methods defined here:
addToDialog(self, gridPosition)
Add this to the dialog.
clickRadio(self)
Workaround for Tkinter bug, set the value.
createRadioButton(self, gridPosition)
Create the radio button.
getFromRadio(self, latentStringVar, name, repository, value)
Initialize.
setSelect(self)
Set the int var and select the radio button.
setStateToValue(self)
Set the checkbutton to the boolean.
setToDisplay(self)
Set the boolean to the checkbutton.

Methods inherited from BooleanSetting:
addToMenu(self, repositoryMenu)
Add this to the repository menu.
addToMenuFrameable(self, repositoryMenu)
Add this to the frameable repository menu.
setValueToString(self, valueString)
Set the boolean to the string.
toggleCheckbutton(self)
Workaround for Tkinter bug, toggle the value.
toggleMenuCheckbutton(self)
Workaround for Tkinter bug, toggle the value.

Methods inherited from StringSetting:
__init__(self)
Set the update function to none.
addToWindow(self)
Add this to the repository frame list.
bindEntry(self)
Bind the entry to the update function.
createEntry(self, root)
Create the entry.
getFromValue(self, name, repository, value)
Initialize.
getFromValueOnly(self, name, repository, value)
Initialize.
getFromValueOnlyAddToRepository(self, name, repository, value)
Initialize.
removeFromWindow(self)
Remove this from the repository frame list.
setUpdateFunction(self, updateFunction)
Set the update function.
setValueToSplitLine(self, lineIndex, lines, splitLine)
Set the value to the second word of a split line.
writeToArchiveWriter(self, archiveWriter)
Write tab separated name and value to the archive writer.

 
class RadioCapitalized(Radio)
    A class to display, read & write a boolean with associated radio button.
 
 
Method resolution order:
RadioCapitalized
Radio
BooleanSetting
StringSetting

Methods defined here:
createRadioButton(self, gridPosition)
Create the radio button.

Methods inherited from Radio:
addToDialog(self, gridPosition)
Add this to the dialog.
clickRadio(self)
Workaround for Tkinter bug, set the value.
getFromRadio(self, latentStringVar, name, repository, value)
Initialize.
setSelect(self)
Set the int var and select the radio button.
setStateToValue(self)
Set the checkbutton to the boolean.
setToDisplay(self)
Set the boolean to the checkbutton.

Methods inherited from BooleanSetting:
addToMenu(self, repositoryMenu)
Add this to the repository menu.
addToMenuFrameable(self, repositoryMenu)
Add this to the frameable repository menu.
setValueToString(self, valueString)
Set the boolean to the string.
toggleCheckbutton(self)
Workaround for Tkinter bug, toggle the value.
toggleMenuCheckbutton(self)
Workaround for Tkinter bug, toggle the value.

Methods inherited from StringSetting:
__init__(self)
Set the update function to none.
addToWindow(self)
Add this to the repository frame list.
bindEntry(self)
Bind the entry to the update function.
createEntry(self, root)
Create the entry.
getFromValue(self, name, repository, value)
Initialize.
getFromValueOnly(self, name, repository, value)
Initialize.
getFromValueOnlyAddToRepository(self, name, repository, value)
Initialize.
removeFromWindow(self)
Remove this from the repository frame list.
setUpdateFunction(self, updateFunction)
Set the update function.
setValueToSplitLine(self, lineIndex, lines, splitLine)
Set the value to the second word of a split line.
writeToArchiveWriter(self, archiveWriter)
Write tab separated name and value to the archive writer.

 
class RadioCapitalizedButton(Radio)
    A class to display, read & write a boolean with associated radio button.
 
 
Method resolution order:
RadioCapitalizedButton
Radio
BooleanSetting
StringSetting

Methods defined here:
createRadioButton(self, gridPosition)
Create the radio button.
displayDialog(self)
Display function.
getFromPath(self, latentStringVar, name, path, repository, value)
Initialize.

Methods inherited from Radio:
addToDialog(self, gridPosition)
Add this to the dialog.
clickRadio(self)
Workaround for Tkinter bug, set the value.
getFromRadio(self, latentStringVar, name, repository, value)
Initialize.
setSelect(self)
Set the int var and select the radio button.
setStateToValue(self)
Set the checkbutton to the boolean.
setToDisplay(self)
Set the boolean to the checkbutton.

Methods inherited from BooleanSetting:
addToMenu(self, repositoryMenu)
Add this to the repository menu.
addToMenuFrameable(self, repositoryMenu)
Add this to the frameable repository menu.
setValueToString(self, valueString)
Set the boolean to the string.
toggleCheckbutton(self)
Workaround for Tkinter bug, toggle the value.
toggleMenuCheckbutton(self)
Workaround for Tkinter bug, toggle the value.

Methods inherited from StringSetting:
__init__(self)
Set the update function to none.
addToWindow(self)
Add this to the repository frame list.
bindEntry(self)
Bind the entry to the update function.
createEntry(self, root)
Create the entry.
getFromValue(self, name, repository, value)
Initialize.
getFromValueOnly(self, name, repository, value)
Initialize.
getFromValueOnlyAddToRepository(self, name, repository, value)
Initialize.
removeFromWindow(self)
Remove this from the repository frame list.
setUpdateFunction(self, updateFunction)
Set the update function.
setValueToSplitLine(self, lineIndex, lines, splitLine)
Set the value to the second word of a split line.
writeToArchiveWriter(self, archiveWriter)
Write tab separated name and value to the archive writer.

 
class RadioPlugin(RadioCapitalized)
    A class to display, read & write a boolean with associated radio button.
 
 
Method resolution order:
RadioPlugin
RadioCapitalized
Radio
BooleanSetting
StringSetting

Methods defined here:
addToDialog(self, gridPosition)
Add this to the dialog.
getFromRadio(self, important, latentStringVar, name, repository, value)
Initialize.
incrementGridPosition(self, gridPosition)
Increment the grid position.

Methods inherited from RadioCapitalized:
createRadioButton(self, gridPosition)
Create the radio button.

Methods inherited from Radio:
clickRadio(self)
Workaround for Tkinter bug, set the value.
setSelect(self)
Set the int var and select the radio button.
setStateToValue(self)
Set the checkbutton to the boolean.
setToDisplay(self)
Set the boolean to the checkbutton.

Methods inherited from BooleanSetting:
addToMenu(self, repositoryMenu)
Add this to the repository menu.
addToMenuFrameable(self, repositoryMenu)
Add this to the frameable repository menu.
setValueToString(self, valueString)
Set the boolean to the string.
toggleCheckbutton(self)
Workaround for Tkinter bug, toggle the value.
toggleMenuCheckbutton(self)
Workaround for Tkinter bug, toggle the value.

Methods inherited from StringSetting:
__init__(self)
Set the update function to none.
addToWindow(self)
Add this to the repository frame list.
bindEntry(self)
Bind the entry to the update function.
createEntry(self, root)
Create the entry.
getFromValue(self, name, repository, value)
Initialize.
getFromValueOnly(self, name, repository, value)
Initialize.
getFromValueOnlyAddToRepository(self, name, repository, value)
Initialize.
removeFromWindow(self)
Remove this from the repository frame list.
setUpdateFunction(self, updateFunction)
Set the update function.
setValueToSplitLine(self, lineIndex, lines, splitLine)
Set the value to the second word of a split line.
writeToArchiveWriter(self, archiveWriter)
Write tab separated name and value to the archive writer.

 
class RepositoryDialog
     Methods defined here:
__init__(self, repository, root)
Add entities to the dialog.
__repr__(self)
Get the string representation of this RepositoryDialog.
addButtons(self, repository, root)
Add buttons to the dialog.
cancel(self, event=None)
Set all entities to their saved state.
close(self, event=None)
The dialog was closed.
save(self, event=None)
Set the entities to the dialog then write them.
saveAll(self)
Save all the dialogs.
setWindowPositionDeiconify(self)
Set the window position if that setting exists.

 
class StringSetting
    A class to display, read & write a string.
 
  Methods defined here:
__init__(self)
Set the update function to none.
addToDialog(self, gridPosition)
Add this to the dialog.
addToMenu(self, repositoryMenu)
Do nothing because this should only be added to a frameable repository menu.
addToMenuFrameable(self, repositoryMenu)
Add this to the frameable repository menu.
addToWindow(self)
Add this to the repository frame list.
bindEntry(self)
Bind the entry to the update function.
createEntry(self, root)
Create the entry.
getFromValue(self, name, repository, value)
Initialize.
getFromValueOnly(self, name, repository, value)
Initialize.
getFromValueOnlyAddToRepository(self, name, repository, value)
Initialize.
removeFromWindow(self)
Remove this from the repository frame list.
setStateToValue(self)
Set the entry to the value.
setToDisplay(self)
Set the string to the entry field.
setUpdateFunction(self, updateFunction)
Set the update function.
setValueToSplitLine(self, lineIndex, lines, splitLine)
Set the value to the second word of a split line.
setValueToString(self, valueString)
Set the value to the value string.
writeToArchiveWriter(self, archiveWriter)
Write tab separated name and value to the archive writer.

 
class TextSetting(StringSetting)
    A class to display, read & write a text.
 
  Methods defined here:
__init__(self)
Set the update function to none.
addToDialog(self, gridPosition)
Add this to the dialog.
getFromValue(self, name, repository, value)
Initialize.
setStateToValue(self)
Set the entry to the value.
setToDisplay(self)
Set the string to the entry field.
setValueToSplitLine(self, lineIndex, lines, splitLine)
Set the value to the second word of a split line.
writeToArchiveWriter(self, archiveWriter)
Write tab separated name and value to the archive writer.

Methods inherited from StringSetting:
addToMenu(self, repositoryMenu)
Do nothing because this should only be added to a frameable repository menu.
addToMenuFrameable(self, repositoryMenu)
Add this to the frameable repository menu.
addToWindow(self)
Add this to the repository frame list.
bindEntry(self)
Bind the entry to the update function.
createEntry(self, root)
Create the entry.
getFromValueOnly(self, name, repository, value)
Initialize.
getFromValueOnlyAddToRepository(self, name, repository, value)
Initialize.
removeFromWindow(self)
Remove this from the repository frame list.
setUpdateFunction(self, updateFunction)
Set the update function.
setValueToString(self, valueString)
Set the value to the value string.

 
class TokenConversion
    A class to convert tokens in a string.
 
  Methods defined here:
__init__(self, name='replaceToken', token='___replaced___')
Set the name and token.
getNamedString(self, text)
Get a string with the tokens changed to names.
getTokenizedString(self, text)
Get a string with the names changed to tokens.

 
class ToolDialog
    A class to display the tool repository dialog.
 
  Methods defined here:
addPluginToMenu(self, menu, path)
Add the display command to the menu.
display(self)
Display the tool repository dialog.
getFromPath(self, path)
Initialize and return display function.

 
class WindowPosition(StringSetting)
    A class to display, read & write a window position.
 
  Methods defined here:
addToDialog(self, gridPosition)
Set the root to later get the geometry.
getFromValue(self, repository, value)
Initialize.
setToDisplay(self)
Set the string to the window position.
setWindowPosition(self)
Set the window position.

Methods inherited from StringSetting:
__init__(self)
Set the update function to none.
addToMenu(self, repositoryMenu)
Do nothing because this should only be added to a frameable repository menu.
addToMenuFrameable(self, repositoryMenu)
Add this to the frameable repository menu.
addToWindow(self)
Add this to the repository frame list.
bindEntry(self)
Bind the entry to the update function.
createEntry(self, root)
Create the entry.
getFromValueOnly(self, name, repository, value)
Initialize.
getFromValueOnlyAddToRepository(self, name, repository, value)
Initialize.
removeFromWindow(self)
Remove this from the repository frame list.
setStateToValue(self)
Set the entry to the value.
setUpdateFunction(self, updateFunction)
Set the update function.
setValueToSplitLine(self, lineIndex, lines, splitLine)
Set the value to the second word of a split line.
setValueToString(self, valueString)
Set the value to the value string.
writeToArchiveWriter(self, archiveWriter)
Write tab separated name and value to the archive writer.

 
class WindowVisibilities
    A class to read & write window visibilities and display them.
 
  Methods defined here:
addToDialog(self, gridPosition)
Add this to the dialog.
getFromRepository(self, repository)
Initialize.
openDialog(self)
Create the display button.
setStateToValue(self)
Do nothing because the window visibility is not to be cancelled.
setToDisplay(self)
Set the string to the window position.
setValueToSplitLine(self, lineIndex, lines, splitLine)
Set the value to the second and later words of a split line.
writeToArchiveWriter(self, archiveWriter)
Write tab separated name and list to the archive writer.

 
Functions
       
addAcceleratorCommand(acceleratorBinding, commandFunction, master, menu, text)
Add accelerator command.
addElementToListTableIfNotThere(element, key, listTable)
Add the value to the lists.
addEmptyRow(gridPosition)
Add an empty row.
addListsSetCraftProfileArchive(craftSequence, defaultProfile, repository, fileNameHelp)
Set the craft profile archive.
addListsToRepository(fileNameHelp, profileDirectory, repository)
Add the value to the lists.
addMenuEntitiesToMenu(menu, menuEntities)
Add the menu entities to the menu.
addMenuEntitiesToMenuFrameable(menu, menuEntities)
Add the menu entities to the menu.
addPluginsParentToMenu(directoryPath, menu, parentPath, pluginFileNames)
Add plugins and the parent to the menu.
addPluginsToMenu(directoryPath, menu, pluginFileNames)
Add plugins to the menu.
cancelRepository(repository)
Read the repository then set all the entities to the read archive values.
deleteDirectory(directory, subfolderName)
Delete the directory if it exists.
deleteMenuItems(menu)
Delete the menu items.
getAlongWayHexadecimalColor(beginBrightness, colorWidth, difference, endColorTuple, wayLength)
Get a color along the way from begin brightness to the end color.
getAlongWayHexadecimalPrimary(beginBrightness, beginRatio, colorWidth, endBrightness, endRatio)
Get a primary color along the way from grey to the end color.
getArchiveText(repository)
Get the text representation of the archive.
getDirectoryInAboveDirectory(directory)
Get the directory in the above directory.
getDisplayToolButtonsRepository(directoryPath, importantFileNames, names, repository)
Get the display tool buttons.
getDisplayedDialogFromConstructor(repository)
Display the repository dialog.
getDisplayedDialogFromPath(path)
Display the repository dialog.
getDocumentationPath(subName='')
Get the documentation file path.
getEachWordCapitalized(name)
Get the capitalized name.
getFileInAlterationsOrGivenDirectory(directory, fileName)
Get the file from the fileName or the lowercase fileName in the alterations directories, if there is no file look in the given directory.
getFileInGivenDirectory(directory, fileName)
Get the file from the fileName or the lowercase fileName in the given directory.
getFileTextGivenDirectoryFileName(directory, fileName)
Get the entire text of a file with the given file name in the given directory.
getFolders(directory)
Get the folder list in a directory.
getPathFromFileNameHelp(fileNameHelp)
Get the directory path from file name help.
getProfilesDirectoryInAboveDirectory(subName='')
Get the profiles directory path in the above directory.
getProfilesDirectoryPath(subfolder='')
Get the profiles directory path, which is the settings directory joined with profiles.
getRadioPluginsAddPluginFrame(directoryPath, importantFileNames, names, repository)
Get the radio plugins and add the plugin frame.
getReadRepository(repository)
Read and return settings from a file.
getSelectedPluginModuleFromPath(filePath, plugins)
Get the selected plugin module.
getSelectedPluginName(plugins)
Get the selected plugin name.
getSelectedRadioPlugin(names, radioPlugins)
Get the selected radio button if it exists, None otherwise.
getSettingsDirectoryPath(subfolder='')
Get the settings directory path, which is the home directory joined with .skeinforge.
getSkeinforgeDirectoryPath()
Get the skeinforge directory path.
getSkeinforgeToolsDirectoryPath()
Get the skeinforge tools directory path.
getSubfolderWithBasename(basename, directory)
Get the subfolder in the directory with the basename.
getTitleFromName(title)
Get the title of this setting.
getWidthHex(number, width)
Get the first width hexadecimal digits.
liftRepositoryDialogs(repositoryDialogs)
Lift the repository dialogs.
makeDirectory(directory)
Make a directory if it does not already exist.
openWebPage(webPagePath)
Open a web page in a browser.
quitWindow(root)
Quit a window.
quitWindows(event=None)
Quit all windows.
readSettingsFromText(repository, text)
Read settings from a text.
saveRepository(repository)
Set the entities to the dialog then write them.
setArchiveToLine(lineIndex, lines, settingTable)
Set an archive to a setting line.
setButtonFontWeightString(button, isBold)
Set button font weight given isBold.
setEntryText(entry, value)
Set the entry text.
setIntegerValueToString(integerSetting, valueString)
Set the integer to the string.
setSpinColor(setting)
Set the spin box color to the value, yellow if it is lower than the default and blue if it is higher.
startMainLoopFromConstructor(repository)
Display the repository dialog and start the main loop.
updateProfileSaveListeners()
Call the save function of all the update profile save listeners.
writeSettings(repository)
Write the settings to a file.
writeSettingsPrintMessage(repository)
Set the settings to the dialog then write them.
writeValueListToArchiveWriter(archiveWriter, setting)
Write tab separated name and list to the archive writer.

 
Data
        __author__ = 'Enrique Perez (perez_enrique@yahoo.com)'
__date__ = '$Date: 2008/23/04 $'
__license__ = 'GPL 3.0'
absolute_import = _Feature((2, 5, 0, 'alpha', 1), (2, 7, 0, 'alpha', 0), 16384)
globalCloseListTables = [{}, {}]
globalProfileSaveListenerListTable = {}
globalRepositoryDialogListTable = {}
globalSpreadsheetSeparator = '\t'

 
Author
        Enrique Perez (perez_enrique@yahoo.com)