| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172 |
- .. This is a autogemerated documentation from python docstrings. It was generated using DStrings2Doc.
- .. module:: settings
- .. _settings:
- Module settings
- ===============
- .. py:class:: Settings(kcgw.KCGWidgets)
- Settings Window
- .. py:method:: __init__(self, storage_handler)
- Initialise the Settings Window
- :param storage_handler: the container class used to store settings
- .. py:method:: initUI(self)
- Initialise the UI
- .. py:method:: build_new_setting(self, handle, value)
- Build a new setting.
- This will add the setting to the local_storage.
- :param handle: the handle of the new setting (input field, checkbox etc)
- :param value: (str) key for this setting
- :return: the handle :)
- .. py:method:: _read_setting_from_object(self, object)
- Get the value from a settings object
- :param object: the object to read the value from
- .. py:method:: _setSettings(self)
- Set the values in the settings window to the current values
- .. py:method:: _apply(self)
- Called when the apply button is pressed. It emits the changed signal if anything was changed
- .. py:method:: _ok(self)
- Handler for the ok button. It calls _apply and close
- .. py:method:: _cancel(self)
- Handler for the cancel button. It calls close() and discards changed values
- .. py:method:: show(self)
- Shows the window and sets the current values (calls _setSettings)
- .. py:method:: keyPressEvent(self, QKeyEvent)
- Reimplementation of the keyPressEvent of QWidget to close the window on ESC press.
|
