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

Preferences 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
       
AddProfile
DeleteProfile
CloseListener
DeleteProfileDialog
DisplayToolButton
EntityDialog
FileHelpMenuBar
GridHorizontal
GridVertical
HelpPage
LabelDisplay
LabelSeparator
MenuButtonDisplay
ProfileList
ProfileMenuRadio
ProfileRepository
ProfileSelectionMenuRadio
ProfileTypeMenuRadio
RepositoryDialog
StringPreference
BooleanPreference
MenuRadio
Radio
RadioCapitalized
RadioCapitalizedButton
RadioCapitalizedProfileButton
FileNameInput
FloatPreference
FloatSpin
FloatSpinNotOnMenu
FloatSpinUpdate
IntPreference
IntSpin
IntSpinNotOnMenu
IntSpinUpdate
ProfileListboxPreference
TextPreference
WindowPosition
TokenConversion
ToolDialog
WindowVisibilities

 
class AddProfile
    A class to add a profile.
 
  Methods defined here:
addSelection(self)
Add the selection of a listbox preference.
addSelectionWithEvent(self, event)
Add the selection of a listbox preference, given an event.
addToDialog(self, repositoryDialog)
Add this to the dialog.
getFromProfileListboxPreferenceRepository(self, profileListboxPreference, repository)
Initialize.

 
class BooleanPreference(StringPreference)
    A class to display, read & write a boolean.
 
  Methods defined here:
addToDialog(self, repositoryDialog)
Add this to the dialog.
addToMenu(self, repositoryMenu)
Add this to the 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 StringPreference:
__init__(self)
Set the update function to none.
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.
openEntityDialog(self)
Open the preference dialog.
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, repositoryDialog)
Add this to the dialog.
deleteSelection(self)
Delete the selection of a listbox preference.

Methods inherited from AddProfile:
addSelection(self)
Add the selection of a listbox preference.
addSelectionWithEvent(self, event)
Add the selection of a listbox preference, given an event.
getFromProfileListboxPreferenceRepository(self, profileListboxPreference, repository)
Initialize.

 
class DeleteProfileDialog
     Methods defined here:
__init__(self, profileListboxPreference, root)
Display a delete dialog.
delete(self)
Delete the selection of a listbox preference.
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, repositoryDialog)
Add this to the dialog.
displayDialog(self)
Display function.
getFromPath(self, important, name, path, repository)
Initialize.

 
class EntityDialog
     Methods defined here:
__init__(self, entity, root)
Create display preference dialog.
close(self)
The dialog was closed.
completeDialog(self)
Complet the display preference dialog.
save(self)
Set the preferences to the dialog then write them.
saveClose(self)
Set the preferences to the dialog, write them, then destroy the window.

 
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(StringPreference)
    A class to display, read & write a fileName.
 
  Methods defined here:
addToDialog(self, repositoryDialog)
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 StringPreference:
__init__(self)
Set the update function to none.
addToMenu(self, repositoryMenu)
Add this to the repository menu.
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.
openEntityDialog(self)
Open the preference dialog.
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 string to the value string.
writeToArchiveWriter(self, archiveWriter)
Write tab separated name and value to the archive writer.

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

Methods inherited from StringPreference:
__init__(self)
Set the update function to none.
addToDialog(self, repositoryDialog)
Add this to the dialog.
addToMenu(self, repositoryMenu)
Add this to the repository menu.
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.
openEntityDialog(self)
Open the preference dialog.
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(FloatPreference)
    A class to display, read & write an float in a spin box.
 
 
Method resolution order:
FloatSpin
FloatPreference
StringPreference

Methods defined here:
bindEntry(self)
Bind the entry to the update function.
createEntry(self, root)
Create the entry.
entryUpdated(self, event=None)
Create the entry.
getFromValue(self, from_, name, repository, to, value)
Initialize.
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.

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

Methods inherited from StringPreference:
__init__(self)
Set the update function to none.
addToDialog(self, repositoryDialog)
Add this to the dialog.
addToMenu(self, repositoryMenu)
Add this to the repository menu.
getFromValueOnly(self, name, repository, value)
Initialize.
getFromValueOnlyAddToRepository(self, name, repository, value)
Initialize.
openEntityDialog(self)
Open the preference dialog.
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 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
FloatPreference
StringPreference

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

Methods inherited from FloatSpin:
bindEntry(self)
Bind the entry to the update function.
createEntry(self, root)
Create the entry.
entryUpdated(self, event=None)
Create the entry.
getFromValue(self, from_, name, repository, to, value)
Initialize.
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.

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

Methods inherited from StringPreference:
__init__(self)
Set the update function to none.
addToDialog(self, repositoryDialog)
Add this to the dialog.
addToMenu(self, repositoryMenu)
Add this to the repository menu.
getFromValueOnly(self, name, repository, value)
Initialize.
openEntityDialog(self)
Open the preference dialog.
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 FloatSpinUpdate(FloatSpin)
    A class to display, read, update & write an float in a spin box.
 
 
Method resolution order:
FloatSpinUpdate
FloatSpin
FloatPreference
StringPreference

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

Methods inherited from FloatSpin:
bindEntry(self)
Bind the entry to the update function.
entryUpdated(self, event=None)
Create the entry.
getFromValue(self, from_, name, repository, to, value)
Initialize.
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.

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

Methods inherited from StringPreference:
__init__(self)
Set the update function to none.
addToDialog(self, repositoryDialog)
Add this to the dialog.
addToMenu(self, repositoryMenu)
Add this to the repository menu.
getFromValueOnly(self, name, repository, value)
Initialize.
getFromValueOnlyAddToRepository(self, name, repository, value)
Initialize.
openEntityDialog(self)
Open the preference dialog.
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 GridHorizontal
    A class to place elements horizontally on a grid.
 
  Methods defined here:
__init__(self, column, row)
Initialize the column and row.
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.
increment(self)
Increment the position vertically.
incrementOffset(self)
Increment the position vertically and offset it horizontally.

 
class HelpPage
     Methods defined here:
addToDialog(self, repositoryDialog)
Add this to the dialog.
addToMenu(self, repositoryMenu)
Add this to the 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 IntPreference(FloatPreference)
    A class to display, read & write an int.
 
 
Method resolution order:
IntPreference
FloatPreference
StringPreference

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

Methods inherited from StringPreference:
__init__(self)
Set the update function to none.
addToDialog(self, repositoryDialog)
Add this to the dialog.
addToMenu(self, repositoryMenu)
Add this to the repository menu.
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.
openEntityDialog(self)
Open the preference dialog.
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(IntPreference)
    A class to display, read & write an int in a spin box.
 
 
Method resolution order:
IntSpin
IntPreference
FloatPreference
StringPreference

Methods defined here:
bindEntry(self)
Bind the entry to the update function.
createEntry(self, root)
Create the entry.
entryUpdated(self, event=None)
Create the entry.
getFromValue(self, from_, name, repository, to, value)
Initialize.
getSingleIncrementFromValue(self, from_, name, repository, to, value)
Initialize.
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.

Methods inherited from IntPreference:
setValueToString(self, valueString)
Set the integer to the string.

Methods inherited from StringPreference:
__init__(self)
Set the update function to none.
addToDialog(self, repositoryDialog)
Add this to the dialog.
addToMenu(self, repositoryMenu)
Add this to the repository menu.
getFromValueOnly(self, name, repository, value)
Initialize.
getFromValueOnlyAddToRepository(self, name, repository, value)
Initialize.
openEntityDialog(self)
Open the preference dialog.
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 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
IntPreference
FloatPreference
StringPreference

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

Methods inherited from IntSpin:
bindEntry(self)
Bind the entry to the update function.
createEntry(self, root)
Create the entry.
entryUpdated(self, event=None)
Create the entry.
getFromValue(self, from_, name, repository, to, value)
Initialize.
getSingleIncrementFromValue(self, from_, name, repository, to, value)
Initialize.
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.

Methods inherited from IntPreference:
setValueToString(self, valueString)
Set the integer to the string.

Methods inherited from StringPreference:
__init__(self)
Set the update function to none.
addToDialog(self, repositoryDialog)
Add this to the dialog.
addToMenu(self, repositoryMenu)
Add this to the repository menu.
getFromValueOnly(self, name, repository, value)
Initialize.
openEntityDialog(self)
Open the preference dialog.
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 IntSpinUpdate(IntSpin)
    A class to display, read, update & write an int in a spin box.
 
 
Method resolution order:
IntSpinUpdate
IntSpin
IntPreference
FloatPreference
StringPreference

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

Methods inherited from IntSpin:
bindEntry(self)
Bind the entry to the update function.
entryUpdated(self, event=None)
Create the entry.
getFromValue(self, from_, name, repository, to, value)
Initialize.
getSingleIncrementFromValue(self, from_, name, repository, to, value)
Initialize.
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.

Methods inherited from IntPreference:
setValueToString(self, valueString)
Set the integer to the string.

Methods inherited from StringPreference:
__init__(self)
Set the update function to none.
addToDialog(self, repositoryDialog)
Add this to the dialog.
addToMenu(self, repositoryMenu)
Add this to the repository menu.
getFromValueOnly(self, name, repository, value)
Initialize.
getFromValueOnlyAddToRepository(self, name, repository, value)
Initialize.
openEntityDialog(self)
Open the preference dialog.
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 LabelDisplay
    A class to add a label.
 
  Methods defined here:
addToDialog(self, repositoryDialog)
Add this to the dialog.
getFromName(self, name, repository)
Initialize.

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

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

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

Methods defined here:
addToDialog(self, repositoryDialog)
Add this to the dialog.
addToMenu(self, repositoryMenu)
Add this to the submenu set by MenuButtonDisplay, the repository menu is ignored
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.
setToDisplay(self)
Set the boolean to the checkbutton.

Methods inherited from BooleanPreference:
setStateToValue(self)
Set the checkbutton to the boolean.
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 StringPreference:
__init__(self)
Set the update function to none.
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.
openEntityDialog(self)
Open the preference dialog.
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 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 ProfileListboxPreference(StringPreference)
     Methods defined here:
addToDialog(self, repositoryDialog)
Add this to the dialog.
buttonReleaseOne(self, event)
Button one released.
focusIn(self, event)
The root has gained focus.
getFromListPreference(self, listPreference, name, repository, value)
Initialize.
getSelectedFolder(self)
Get the selected folder.
setListboxItems(self)
Set the listbox items to the list preference.
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 string to the value string.

Methods inherited from StringPreference:
__init__(self)
Set the update function to none.
addToMenu(self, repositoryMenu)
Add this to the repository menu.
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.
openEntityDialog(self)
Open the preference dialog.
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.
writeToArchiveWriter(self, archiveWriter)
Write tab separated name and value to the archive writer.

 
class ProfileMenuRadio
    A class to display a profile menu radio button.
 
  Methods defined here:
__init__(self, profilePluginFileName, menu, name, radioVar, value)
Create a profile menu radio.
clickRadio(self)
Workaround for Tkinter bug, invoke and set the value when clicked.

 
class ProfileRepository
    A class to handle the profile entities.
 
  Methods defined here:
__init__(self)
Set the default entities, execute title & repository fileName.

 
class ProfileSelectionMenuRadio
    A class to display a profile selection menu radio button.
 
  Methods defined here:
addToDialog(self, repositoryDialog)
Add this to the dialog.
clickRadio(self)
Workaround for Tkinter bug, invoke and set the value when clicked.
getFromMenuButtonDisplay(self, menuButtonDisplay, name, repository, value)
Initialize.
setToMenuButtonDisplay(self, menuButtonDisplay, name, repository, value)
Initialize.

 
class ProfileTypeMenuRadio(ProfileSelectionMenuRadio)
    A class to display a profile type menu radio button.
 
  Methods defined here:
clickRadio(self)
Workaround for Tkinter bug, invoke and set the value when clicked.
getFromMenuButtonDisplay(self, menuButtonDisplay, name, repository, value)
Initialize.

Methods inherited from ProfileSelectionMenuRadio:
addToDialog(self, repositoryDialog)
Add this to the dialog.
setToMenuButtonDisplay(self, menuButtonDisplay, name, repository, value)
Initialize.

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

Methods defined here:
addToDialog(self, repositoryDialog)
Add this to the dialog.
clickRadio(self)
Workaround for Tkinter bug, set the value.
getFromRadio(self, name, radio, repository, value)
Initialize.
getIntVar(self)
Get the IntVar for this radio button group.
setDisplayState(self)
Set the checkbutton to the boolean.
setSelect(self)
Set the int var and select the radio button.
setToDisplay(self)
Set the boolean to the checkbutton.

Methods inherited from BooleanPreference:
addToMenu(self, repositoryMenu)
Add this to the repository menu.
setStateToValue(self)
Set the checkbutton to the boolean.
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 StringPreference:
__init__(self)
Set the update function to none.
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.
openEntityDialog(self)
Open the preference dialog.
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
BooleanPreference
StringPreference

Methods defined here:
addRadioCapitalizedToDialog(self, repositoryDialog)
Add radio capitalized button to the dialog.
addToDialog(self, repositoryDialog)
Add this to the dialog.

Methods inherited from Radio:
clickRadio(self)
Workaround for Tkinter bug, set the value.
getFromRadio(self, name, radio, repository, value)
Initialize.
getIntVar(self)
Get the IntVar for this radio button group.
setDisplayState(self)
Set the checkbutton to the boolean.
setSelect(self)
Set the int var and select the radio button.
setToDisplay(self)
Set the boolean to the checkbutton.

Methods inherited from BooleanPreference:
addToMenu(self, repositoryMenu)
Add this to the repository menu.
setStateToValue(self)
Set the checkbutton to the boolean.
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 StringPreference:
__init__(self)
Set the update function to none.
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.
openEntityDialog(self)
Open the preference dialog.
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(RadioCapitalized)
    A class to display, read & write a boolean with associated radio button.
 
 
Method resolution order:
RadioCapitalizedButton
RadioCapitalized
Radio
BooleanPreference
StringPreference

Methods defined here:
addRadioCapitalizedButtonToDialog(self, repositoryDialog)
Add this to the dialog.
addToDialog(self, repositoryDialog)
Add this to the dialog.
displayDialog(self)
Display function.
getFromPath(self, name, path, radio, repository, value)
Initialize.

Methods inherited from RadioCapitalized:
addRadioCapitalizedToDialog(self, repositoryDialog)
Add radio capitalized button to the dialog.

Methods inherited from Radio:
clickRadio(self)
Workaround for Tkinter bug, set the value.
getFromRadio(self, name, radio, repository, value)
Initialize.
getIntVar(self)
Get the IntVar for this radio button group.
setDisplayState(self)
Set the checkbutton to the boolean.
setSelect(self)
Set the int var and select the radio button.
setToDisplay(self)
Set the boolean to the checkbutton.

Methods inherited from BooleanPreference:
addToMenu(self, repositoryMenu)
Add this to the repository menu.
setStateToValue(self)
Set the checkbutton to the boolean.
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 StringPreference:
__init__(self)
Set the update function to none.
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.
openEntityDialog(self)
Open the preference dialog.
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 RadioCapitalizedProfileButton(RadioCapitalizedButton)
    A class to display, read & write a boolean with associated radio button.
 
 
Method resolution order:
RadioCapitalizedProfileButton
RadioCapitalizedButton
RadioCapitalized
Radio
BooleanPreference
StringPreference

Methods defined here:
addToDialog(self, repositoryDialog)
Add this to the dialog.

Methods inherited from RadioCapitalizedButton:
addRadioCapitalizedButtonToDialog(self, repositoryDialog)
Add this to the dialog.
displayDialog(self)
Display function.
getFromPath(self, name, path, radio, repository, value)
Initialize.

Methods inherited from RadioCapitalized:
addRadioCapitalizedToDialog(self, repositoryDialog)
Add radio capitalized button to the dialog.

Methods inherited from Radio:
clickRadio(self)
Workaround for Tkinter bug, set the value.
getFromRadio(self, name, radio, repository, value)
Initialize.
getIntVar(self)
Get the IntVar for this radio button group.
setDisplayState(self)
Set the checkbutton to the boolean.
setSelect(self)
Set the int var and select the radio button.
setToDisplay(self)
Set the boolean to the checkbutton.

Methods inherited from BooleanPreference:
addToMenu(self, repositoryMenu)
Add this to the repository menu.
setStateToValue(self)
Set the checkbutton to the boolean.
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 StringPreference:
__init__(self)
Set the update function to none.
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.
openEntityDialog(self)
Open the preference dialog.
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.
addEmptyRow(self)
Add an empty row.
close(self, event=None)
The dialog was closed.
execute(self)
The execute button was clicked.
iconify(self)
The dialog was iconified.
save(self, event=None)
Set the entities to the dialog then write them.
saveAll(self)
Save all the dialogs.
saveClose(self)
Set the entities to the dialog, write them, then destroy the window.
saveReturnAll(self)
Save and return all the dialogs.
setWindowPositionDeiconify(self)
Set the window position if that preference exists.

 
class StringPreference
    A class to display, read & write a string.
 
  Methods defined here:
__init__(self)
Set the update function to none.
addToDialog(self, repositoryDialog)
Add this to the dialog.
addToMenu(self, repositoryMenu)
Add this to the repository menu.
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.
openEntityDialog(self)
Open the preference dialog.
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 string to the value string.
writeToArchiveWriter(self, archiveWriter)
Write tab separated name and value to the archive writer.

 
class TextPreference(StringPreference)
    A class to display, read & write a text.
 
  Methods defined here:
__init__(self)
Set the update function to none.
addToDialog(self, repositoryDialog)
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 StringPreference:
addToMenu(self, repositoryMenu)
Add this to the repository menu.
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.
openEntityDialog(self)
Open the preference dialog.
setUpdateFunction(self, updateFunction)
Set the update function.
setValueToString(self, valueString)
Set the string 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(StringPreference)
    A class to display, read & write a window position.
 
  Methods defined here:
addToDialog(self, repositoryDialog)
Set the root to later get the geometry.
getFromValue(self, name, repository, value)
Initialize.
setToDisplay(self)
Set the string to the window position.
setWindowPosition(self)
Set the window position.

Methods inherited from StringPreference:
__init__(self)
Set the update function to none.
addToMenu(self, repositoryMenu)
Add this to the repository menu.
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.
openEntityDialog(self)
Open the preference dialog.
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 string 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, repositoryDialog)
Add this to the dialog.
getFromRepository(self, repository)
Initialize.
openDialog(self)
Create the display button.
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.
addListsSetCraftProfileArchive(craftSequence, defaultProfile, repository, fileNameHelp)
Set the craft profile archive.
addListsToCraftTypeRepository(fileNameHelp, repository)
Add the value to the lists.
addListsToRepository(fileNameHelp, profileDirectory, repository)
Add the value to the lists.
addMenuEntitiesToMenu(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.
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.
getCraftTypeName(subName='')
Get the craft type from the profile.
getCraftTypePluginModule(craftTypeName='')
Get the craft type plugin module.
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.
getPluginFileNames()
Get analyze plugin fileNames.
getPluginsDirectoryPath()
Get the plugins directory path.
getPreferencesDirectoryPath(subfolder='')
Get the preferences directory path, which is the home directory joined with .skeinforge.
getProfileName(craftTypeName)
Get the profile name from the craft type name.
getProfilesDirectoryInAboveDirectory(subName='')
Get the profiles directory path in the above directory.
getProfilesDirectoryPath(subfolder='')
Get the profiles directory path, which is the preferences directory joined with profiles.
getReadProfileRepository()
Get the read profile repository.
getReadRepository(repository)
Read and return preferences from a file.
getSelectedPluginModuleFromPath(filePath, plugins)
Get the selected plugin module.
getSelectedPluginName(plugins)
Get the selected plugin name.
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 preference.
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.
readPreferencesFromText(repository, text)
Read preferences from a text.
setArchiveToLine(lineIndex, lines, preferenceTable)
Set an archive to a preference line.
setEntryText(entry, value)
Set the entry text.
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.
writePreferences(repository)
Write the preferences to a file.
writePreferencesPrintMessage(repository)
Set the preferences to the dialog then write them.

 
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)