.. _f-frameparams:

module ``funcwin.frame_params``
===============================





.. inheritance-diagram:: tkinterquickhelper.funcwin.frame_params


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

module ``tkinterquickhelper.funcwin.frame_params``

Defines :class:`FrameParams`.


:githublink:`%|py|7`




Classes
+++++++

+----------------------------------------------------------------------------+--------------------------------------------------+
| class                                                                      | truncated documentation                          |
+============================================================================+==================================================+
| :class:`FrameParams <tkinterquickhelper.funcwin.frame_params.FrameParams>` | Creates a Frame window for a list of parameters. |
+----------------------------------------------------------------------------+--------------------------------------------------+




Functions
+++++++++

+-----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| function                                                                                | truncated documentation                                                                                                |
+=========================================================================================+========================================================================================================================+
| :func:`open_window_params <tkinterquickhelper.funcwin.frame_params.open_window_params>` | Open a :epkg:`tkinter` window to set up parameters. It adds entries for the parameters, it displays the help given ... |
+-----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+




Properties
++++++++++

+----------------------------------------------------------------------------------------------------+-------------------------+
| property                                                                                           | truncated documentation |
+====================================================================================================+=========================+
| :py:meth:`_windowingsystem <tkinterquickhelper.funcwin.frame_params.FrameParams._windowingsystem>` | Internal function.      |
+----------------------------------------------------------------------------------------------------+-------------------------+




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

+---------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+
| staticmethod                                                                          | truncated documentation                                                                                      |
+=======================================================================================+==============================================================================================================+
| :meth:`open_window <tkinterquickhelper.funcwin.frame_params.FrameParams.open_window>` | Opens a :epkg:`tkinter` window to set up parameters. It adds entries for the parameters, it displays the ... |
+---------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+




Methods
+++++++

+---------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------+
| method                                                                                      | truncated documentation                                                        |
+=============================================================================================+================================================================================+
| :py:meth:`__init__ <tkinterquickhelper.funcwin.frame_params.FrameParams.__init__>`          |                                                                                |
+---------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------+
| :meth:`get_parameters <tkinterquickhelper.funcwin.frame_params.FrameParams.get_parameters>` | returns the parameters                                                         |
+---------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------+
| :meth:`get_title <tkinterquickhelper.funcwin.frame_params.FrameParams.get_title>`           | Returns the title.                                                             |
+---------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------+
| :meth:`history_down <tkinterquickhelper.funcwin.frame_params.FrameParams.history_down>`     | look forward in the history (log of used parameters) and update the parameters |
+---------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------+
| :meth:`history_up <tkinterquickhelper.funcwin.frame_params.FrameParams.history_up>`         | look back in the history (log of used parameters) and update the parameters    |
+---------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------+
| :meth:`refresh <tkinterquickhelper.funcwin.frame_params.FrameParams.refresh>`               | Refreshes the screen.                                                          |
+---------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------+
| :meth:`run_cancel <tkinterquickhelper.funcwin.frame_params.FrameParams.run_cancel>`         | what to do when Cancel is pressed                                              |
+---------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------+
| :meth:`run_function <tkinterquickhelper.funcwin.frame_params.FrameParams.run_function>`     | Runs the function.                                                             |
+---------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------+
| :meth:`update <tkinterquickhelper.funcwin.frame_params.FrameParams.update>`                 | update the parameters (ie ``self.info``)                                       |
+---------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------+


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

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