| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980 |
- .. This is a autogemerated documentation from python docstrings. It was generated using DStrings2Doc.
- .. module:: initialconfig
- .. _initialconfig:
- Module initialconfig
- ====================
- This defines the window for initial configuration
- .. py:class:: ConfigEntry(kcgw.KCGWidgets)
- Container for a single entry in the init config window
- .. py:method:: __init__(self, comm='', conf='', type=str, multiline=False)
- Initialise an entry
- :param comm: comment
- :param conf: configuration option
- :param type: data type for this option
- :param multiline: if multiline editfield or not
- .. py:method:: toggle(self)
- Toggle the visibility of the comment
- .. py:method:: set_comment(self, comm)
- Set the comment
- :param comm:
- .. py:method:: set_config(self, conf)
- Set the config option
- :param conf:
- .. py:method:: validate(self, mark=False)
- Validate if entered value is valid
- :param mark: mark false entered values?
- .. py:method:: san(self, val)
- Sanitise string entries (adding " or ' and converting mixed ones)
- :param val: the value to sanitise
- :return: sanitised value and errors
- .. py:method:: __str__(self)
- Convert this entry to a string that can be saved to a configuration file
- .. py:class:: ConfigSetup(kcgw.KCGWidgets)
- This is the Config window
- .. py:method:: __init__(self, restart=False)
- Initialise this config window
- .. py:method:: save(self)
- Save the configuration entered in the config window to a configuration file
- namely: os.path.expanduser("~")+"/.kcg/config.cfg"
- This also makes shure the entered information is valid to some level
|
