KaptureControlGui/KCG/Documentation/source/Dev/code/base/kcg.rst

.. This is a autogemerated documentation from python docstrings. It was generated using DStrings2Doc.


.. module:: kcg


.. _kcg:



Module kcg
==========



.. py:method:: readconfig(parent)

    Reads the config and evalues certain variables  
    Also: Validates config to check if all necessary values are there  

    :param parent: parent for popup windows  

.. py:class:: CentralWidget(kcgw.KCGWidgets)

    Central Widget for the KCG gui main window  

    .. py:method:: __init__(self, parent=None)


.. py:class:: Gui(QtGui.QMainWindow)

    Main Window of the KCG gui  

    .. py:method:: __init__(self)


    .. py:method:: initUI(self)

        Initialize ui  


    .. py:method:: createEmptyGroups(self)

        This creates empty groups with the GroupedObjects class in groupedelements module.  
        This has to be done to avoid warnings when groups are enabled or disabled before creation.  


    .. py:method:: finalizeInit(self)

        Final things done at initialisation  


    .. py:method:: doMenu(self)

        Create and show the menu and it's entries  


    .. py:method:: saveConfig(self, board_id)

        Save the current configuration to a configuration file  

        :param board_id: the board to save the configuration for  

    .. py:method:: loadConfig(self, board_id)

        Load the configuration for the given board from a file  

        :param board_id: the board to read the configuration for  

    .. py:method:: rerunConfig(self)

        Rerun the initial configuration wizard  

    .. py:method:: showAbout(self)

        Show the about window.  


    .. py:method:: addWindowMenuEntries(self)

        Adds Window Menu entries for custom widgets  


    .. py:method:: showSettings(self)

        Create and show settings window  


    .. py:method:: updateSettings(self, changedsettings)

        Update settings in storage if settings were changed in the settings window.  

        :param changedsettings: list of settings that have been changed  

    .. py:method:: showAdvancedControl(self, value)

        Enable or disable advanced table control view (Tables for registers)  

        :param value: (bool) True to show and False to hide advanced view  

    .. py:method:: after_start_status_handler(self)

        Method to check for boards and perform a status_readout after the gui is fully started  


    .. py:method:: populate_storage(self)

        Initially fills storage with predefined settings and configuration values  


    .. py:method:: update_configuration_file(self, new_conf)

        Update variablevalues in config file  
        NOTE: this doesn't use standard ConfigParser as that would delete comments  

        :param new_conf: Dictionary with variable, value pair  

    .. py:method:: closeEvent(self, ev)

        Handles closing of the GUI - this function is called by pyqt upon a close event.  
        Asks if user really wants to close the gui  

        :param ev: event