# Python: module fabmetheus_utilities.settings

fabmetheus_utilities.settings ($Date: 2008/23/04 $) | index /home/enrique/Desktop/backup/babbleold/script/reprap/fabmetheus/fabmetheus_utilities/settings.py

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

Modules

``

Tkinter __init__ fabmetheus_utilities.archive | cStringIO fabmetheus_utilities.euclidean fabmetheus_utilities.gcodec | math os shutil | sys traceback webbrowser

Classes

``

CloseListener
DisplayToolButton
FileHelpMenuBar
FrameList
GridHorizontal
GridVertical
HelpPage
HelpPageRepository
LabelDisplay
LabelHelp
LabelSeparator
LatentStringVar
LayerCount
MenuButtonDisplay
PluginFrame
  PluginGroupFrame
RepositoryDialog
StringSetting
  BooleanSetting
    MenuRadio
    Radio
      RadioCapitalized
        RadioPlugin
      RadioCapitalizedButton
  FileNameInput
  FloatSetting
    FloatSpin
      FloatSpinNotOnMenu
      FloatSpinUpdate
      IntSpin
        IntSpinNotOnMenu
        IntSpinUpdate
    IntSetting
  TextSetting
  WindowPosition
TokenConversion
ToolDialog

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.`

__repr__(self)
  `Get the string representation of this StringSetting.`

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.`

writeToRepositoryWriter(self, repositoryWriter)
  `Write tab separated name and value to the repository 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 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.`

__repr__(self)
  `Get the string representation of this 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.`

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.`

writeToRepositoryWriter(self, repositoryWriter)
  `Write tab separated name and value to the repository 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.`

__repr__(self)
  `Get the string representation of this StringSetting.`

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.`

writeToRepositoryWriter(self, repositoryWriter)
  `Write tab separated name and value to the repository 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.`

__repr__(self)
  `Get the string representation of this StringSetting.`

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.`

writeToRepositoryWriter(self, repositoryWriter)
  `Write tab separated name and value to the repository 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.`

__repr__(self)
  `Get the string representation of this StringSetting.`

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.`

writeToRepositoryWriter(self, repositoryWriter)
  `Write tab separated name and value to the repository 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.`

__repr__(self)
  `Get the string representation of this StringSetting.`

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.`

writeToRepositoryWriter(self, repositoryWriter)
  `Write tab separated name and value to the repository 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.`

writeToRepositoryWriter(self, repositoryWriter)
  `Write tab separated name and list to the repository 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:

__init__(self)
  `Initialize column.`

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 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.`

__repr__(self)
  `Get the string representation of this StringSetting.`

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.`

writeToRepositoryWriter(self, repositoryWriter)
  `Write tab separated name and value to the repository 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.`

__repr__(self)
  `Get the string representation of this StringSetting.`

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.`

writeToRepositoryWriter(self, repositoryWriter)
  `Write tab separated name and value to the repository 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.`

__repr__(self)
  `Get the string representation of this StringSetting.`

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.`

writeToRepositoryWriter(self, repositoryWriter)
  `Write tab separated name and value to the repository 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.`

__repr__(self)
  `Get the string representation of this StringSetting.`

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.`

writeToRepositoryWriter(self, repositoryWriter)
  `Write tab separated name and value to the repository 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 LayerCount
`` | `A class to handle the layerIndex.`

Methods defined here:

__init__(self)
  `Initialize.`

printProgressIncrement(self, procedureName)
  `Print progress then increment layerIndex.`

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.`

__repr__(self)
  `Get the string representation of this StringSetting.`

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.`

writeToRepositoryWriter(self, repositoryWriter)
  `Write tab separated name and value to the repository writer.`

class PluginFrame
`` | `A class to display the plugins in a frame.`

Methods defined here:

__init__(self)
  `Initialize.`

addToDialog(self, gridPosition)
  `Add this to the dialog.`

createFrame(self, gridPosition)
  `Create the frame.`

focusSetMaster(self, gridPosition)
  `Set the focus to the plugin master.`

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.`

writeToRepositoryWriter(self, repositoryWriter)
  `Write tab separated name and value to the repository writer.`

class PluginGroupFrame(PluginFrame)
`` | `A class to display the plugin groups in a frame.`

Methods defined here:

createFrame(self, gridPosition)
  `Create the frame.`

focusSetMaster(self, gridPosition)
  `Set the focus to the plugin master.`

Methods inherited from PluginFrame:

__init__(self)
  `Initialize.`

addToDialog(self, gridPosition)
  `Add this to the dialog.`

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.`

writeToRepositoryWriter(self, repositoryWriter)
  `Write tab separated name and value to the repository 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.`

__repr__(self)
  `Get the string representation of this StringSetting.`

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.`

writeToRepositoryWriter(self, repositoryWriter)
  `Write tab separated name and value to the repository 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.`

__repr__(self)
  `Get the string representation of this StringSetting.`

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.`

writeToRepositoryWriter(self, repositoryWriter)
  `Write tab separated name and value to the repository 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.`

__repr__(self)
  `Get the string representation of this StringSetting.`

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.`

writeToRepositoryWriter(self, repositoryWriter)
  `Write tab separated name and value to the repository 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.`

__repr__(self)
  `Get the string representation of this StringSetting.`

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.`

writeToRepositoryWriter(self, repositoryWriter)
  `Write tab separated name and value to the repository 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.`

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.`

__repr__(self)
  `Get the string representation of this StringSetting.`

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.`

writeToRepositoryWriter(self, repositoryWriter)
  `Write tab separated name and value to the repository 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.`

writeToRepositoryWriter(self, repositoryWriter)
  `Write tab separated name and value to the repository writer.`

Methods inherited from StringSetting:

__repr__(self)
  `Get the string representation of this 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.`

__repr__(self)
  `Get the string representation of this 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.`

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.`

writeToRepositoryWriter(self, repositoryWriter)
  `Write tab separated name and value to the repository writer.`

Functions

``

addAcceleratorCommand(acceleratorBinding, commandFunction, master, menu, text)
  `Add accelerator command.`

addEmptyRow(gridPosition)
  `Add an empty row.`

addListsToRepository(fileNameHelp, getProfileDirectory, 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 repository 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.`

getDisplayToolButtonsRepository(directoryPath, importantFileNames, names, repository)
  `Get the display tool buttons.`

getDisplayedDialogFromConstructor(repository)
  `Display the repository dialog.`

getDisplayedDialogFromPath(path)
  `Display the repository dialog.`

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.`

getGlobalRepositoryDialogValues()
  `Get the global repository dialog values.`

getPathInFabmetheusFromFileNameHelp(fileNameHelp)
  `Get the directory path from file name help.`

getProfileBaseName(repository)
  `Get the profile base file name.`

getProfileBaseNameSynonym(repository)
  `Get the profile base file name synonym.`

getProfilesDirectoryInAboveDirectory(subName='')
  `Get the profiles directory path in the above directory.`

getRadioPluginsAddPluginFrame(directoryPath, importantFileNames, names, repository)
  `Get the radio plugins and add the plugin frame.`

getReadRepository(repository)
  `Read and return settings from a file.`

getRepositoryText(repository)
  `Get the text representation of the repository.`

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.`

getShortestUniqueSettingName(settingName, settings)
  `Get the shortest unique name in the settings.`

getSubfolderWithBasename(basename, directory)
  `Get the subfolder in the directory with the basename.`

getTitleFromName(title)
  `Get the title of this setting.`

getUntilFirstBracket(text)
  `Get the text until the first bracket, if any.`

getWidthHex(number, width)
  `Get the first width hexadecimal digits.`

liftRepositoryDialogs(repositoryDialogs)
  `Lift the repository dialogs.`

openSVGPage(fileName, svgViewer)
  `Open svg page with an svg program.`

openWebPage(webPagePath)
  `Open a web page in a browser.`

printProgress(layerIndex, procedureName)
  `Print layerIndex followed by a carriage return.`

printProgressByNumber(layerIndex, numberOfLayers, procedureName)
  `Print layerIndex and numberOfLayers followed by a carriage return.`

printProgressByString(progressString)
  `Print progress string.`

quitWindow(root)
  `Quit a window.`

quitWindows(event=None)
  `Quit all windows.`

readSettingsFromText(repository, text)
  `Read settings from a text.`

saveAll()
  `Save all the dialogs.`

saveRepository(repository)
  `Set the entities to the dialog then write them.`

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.`

setRepositoryToLine(lineIndex, lines, shortDictionary)
  `Set setting dictionary to a setting line.`

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.`

writeSettings(repository)
  `Write the settings to a file.`

writeSettingsPrintMessage(repository)
  `Set the settings to the dialog then write them.`

writeValueListToRepositoryWriter(repositoryWriter, setting)
  `Write tab separated name and list to the repository 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)