.. _l-methods: Methods ======= .. contents:: :local: :depth: 1 Summary +++++++ +--------------------------------------------------------------------------------------------------------+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ | method | class parent | truncated documentation | +========================================================================================================+==============================+=================================================================================================================================================+ | :py:meth:`__init__ ` | FrameFunction | | +--------------------------------------------------------------------------------------------------------+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | FrameFunction_ThreadFunction | constructor | +--------------------------------------------------------------------------------------------------------+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | FrameParams | | +--------------------------------------------------------------------------------------------------------+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | MainFrame | | +--------------------------------------------------------------------------------------------------------+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`change_frame_function ` | MainFrame | Updates the frame :class:`FrameFunction` to select a new function. | +--------------------------------------------------------------------------------------------------------+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`change_selection ` | MainFrame | Functions called when the selection changes. | +--------------------------------------------------------------------------------------------------------+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`destroy ` | FrameFunction | Stops the thread and destroy the function. The behaviour of method `Thread._stop `_ ... | +--------------------------------------------------------------------------------------------------------+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`get_parameters ` | FrameFunction | Returns the parameters in a dictionary. | +--------------------------------------------------------------------------------------------------------+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`get_parameters ` | FrameParams | returns the parameters | +--------------------------------------------------------------------------------------------------------+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`get_title ` | FrameFunction | | +--------------------------------------------------------------------------------------------------------+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`get_title ` | FrameParams | Returns the title. | +--------------------------------------------------------------------------------------------------------+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`get_title ` | MainFrame | Returns the default title. | +--------------------------------------------------------------------------------------------------------+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`history_down ` | FrameFunction | Looks forward in the history of used parameters and change the parameters. | +--------------------------------------------------------------------------------------------------------+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`history_down ` | FrameParams | look forward in the history (log of used parameters) and update the parameters | +--------------------------------------------------------------------------------------------------------+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`history_up ` | FrameFunction | Looks back in the history of used parameters and change the parameters. | +--------------------------------------------------------------------------------------------------------+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`history_up ` | FrameParams | look back in the history (log of used parameters) and update the parameters | +--------------------------------------------------------------------------------------------------------+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`refresh ` | FrameFunction | Refreshes the screen. | +--------------------------------------------------------------------------------------------------------+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`refresh ` | FrameParams | Refreshes the screen. | +--------------------------------------------------------------------------------------------------------+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`run ` | FrameFunction_ThreadFunction | run the thread | +--------------------------------------------------------------------------------------------------------+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`run_cancel ` | FrameFunction | cancel | +--------------------------------------------------------------------------------------------------------+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`run_cancel ` | FrameParams | what to do when Cancel is pressed | +--------------------------------------------------------------------------------------------------------+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`run_cancel ` | MainFrame | cancel | +--------------------------------------------------------------------------------------------------------+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`run_function ` | FrameFunction | Runs the function. | +--------------------------------------------------------------------------------------------------------+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`run_function ` | FrameParams | Runs the function. | +--------------------------------------------------------------------------------------------------------+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`stop_thread ` | FrameFunction | Stops the function execution. | +--------------------------------------------------------------------------------------------------------+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`update ` | FrameFunction | Updates the parameters (ie ``self.info``). | +--------------------------------------------------------------------------------------------------------+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`update ` | FrameParams | update the parameters (ie ``self.info``) | +--------------------------------------------------------------------------------------------------------+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+