.. _f-framefunction:

module ``funcwin.frame_function``
=================================





.. inheritance-diagram:: tkinterquickhelper.funcwin.frame_function


Short summary
+++++++++++++

module ``tkinterquickhelper.funcwin.frame_function``

:class:`FrameFunction`


:githublink:`%|py|6`




Classes
+++++++

+----------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| class                                                                                                          | truncated documentation                                                                                                     |
+================================================================================================================+=============================================================================================================================+
| :class:`FrameFunction <tkinterquickhelper.funcwin.frame_function.FrameFunction>`                               | Creating a Frame window for a function. It will create an entry control for every parameter. If one of the parameter ...    |
+----------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :class:`FrameFunction_ThreadFunction <tkinterquickhelper.funcwin.frame_function.FrameFunction_ThreadFunction>` | Class associated to FrameFunction, it runs the function in a separate thread (in order to be able to stop its execution ... |
+----------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+




Functions
+++++++++

+-----------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
| function                                                                                      | truncated documentation                                                                                                   |
+===============================================================================================+===========================================================================================================================+
| :func:`open_window_function <tkinterquickhelper.funcwin.frame_function.open_window_function>` | Opens a :epkg:`tkinter` window to run a function. It adds entries for the parameters, it displays the help associated ... |
+-----------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+




Properties
++++++++++

+--------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| property                                                                                               | truncated documentation                                                                                                     |
+========================================================================================================+=============================================================================================================================+
| :py:meth:`_windowingsystem <tkinterquickhelper.funcwin.frame_function.FrameFunction._windowingsystem>` | Internal function.                                                                                                          |
+--------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`daemon <tkinterquickhelper.funcwin.frame_function.FrameFunction_ThreadFunction.daemon>`         | A boolean value indicating whether this thread is a daemon thread. This must be set before start() is called, otherwise ... |
+--------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`ident <tkinterquickhelper.funcwin.frame_function.FrameFunction_ThreadFunction.ident>`           | Thread identifier of this thread or None if it has not been started. This is a nonzero integer. See the get_ident() ...     |
+--------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`name <tkinterquickhelper.funcwin.frame_function.FrameFunction_ThreadFunction.name>`             | A string used for identification purposes only. It has no semantics. Multiple threads may be given the same name. ...       |
+--------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`native_id <tkinterquickhelper.funcwin.frame_function.FrameFunction_ThreadFunction.native_id>`   | Native integral thread ID of this thread, or None if it has not been started. This is a non-negative integer. ...           |
+--------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+




Static Methods
++++++++++++++

+-------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
| staticmethod                                                                              | truncated documentation                                                                                                   |
+===========================================================================================+===========================================================================================================================+
| :meth:`open_window <tkinterquickhelper.funcwin.frame_function.FrameFunction.open_window>` | Opens a :epkg:`tkinter` window to run a function. It adds entries for the parameters, it displays the help associated ... |
+-------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+




Methods
+++++++

+-------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| method                                                                                                | truncated documentation                                                                                                                         |
+=======================================================================================================+=================================================================================================================================================+
| :py:meth:`__init__ <tkinterquickhelper.funcwin.frame_function.FrameFunction.__init__>`                |                                                                                                                                                 |
+-------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| :py:meth:`__init__ <tkinterquickhelper.funcwin.frame_function.FrameFunction_ThreadFunction.__init__>` | constructor                                                                                                                                     |
+-------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| :meth:`destroy <tkinterquickhelper.funcwin.frame_function.FrameFunction.destroy>`                     | Stops the thread and destroy the function. The behaviour of method `Thread._stop <http://hg.python.org/cpython/file/3.4/Lib/threading.py>`_ ... |
+-------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| :meth:`get_parameters <tkinterquickhelper.funcwin.frame_function.FrameFunction.get_parameters>`       | Returns the parameters in a dictionary.                                                                                                         |
+-------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| :meth:`get_title <tkinterquickhelper.funcwin.frame_function.FrameFunction.get_title>`                 |                                                                                                                                                 |
+-------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| :meth:`history_down <tkinterquickhelper.funcwin.frame_function.FrameFunction.history_down>`           | Looks forward in the history of used parameters and change the parameters.                                                                      |
+-------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| :meth:`history_up <tkinterquickhelper.funcwin.frame_function.FrameFunction.history_up>`               | Looks back in the history of used parameters and change the parameters.                                                                         |
+-------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| :meth:`refresh <tkinterquickhelper.funcwin.frame_function.FrameFunction.refresh>`                     | Refreshes the screen.                                                                                                                           |
+-------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| :meth:`run <tkinterquickhelper.funcwin.frame_function.FrameFunction_ThreadFunction.run>`              | run the thread                                                                                                                                  |
+-------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| :meth:`run_cancel <tkinterquickhelper.funcwin.frame_function.FrameFunction.run_cancel>`               | cancel                                                                                                                                          |
+-------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| :meth:`run_function <tkinterquickhelper.funcwin.frame_function.FrameFunction.run_function>`           | Runs the function.                                                                                                                              |
+-------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| :meth:`stop_thread <tkinterquickhelper.funcwin.frame_function.FrameFunction.stop_thread>`             | Stops the function execution.                                                                                                                   |
+-------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| :meth:`update <tkinterquickhelper.funcwin.frame_function.FrameFunction.update>`                       | Updates the parameters (ie ``self.info``).                                                                                                      |
+-------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+


Documentation
+++++++++++++

.. automodule:: tkinterquickhelper.funcwin.frame_function
    :members:
    :special-members: __init__
    :show-inheritance: