.. _l-modules:

Modules
=======

.. contents::
    :local:
    :depth: 1


Summary
+++++++

+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| module                                        | truncated documentation                                                                                                                                                |
+===============================================+========================================================================================================================================================================+
| :ref:`__init__ <f-init>`                      | module ``tkinterquickhelper``    Module *tkinterquickhelper*.  Helpers for :epkg:`*py:tkinter`.      :githublink:`%|py|7`                                              |
+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`__init__ <f-initz>`                     | module ``tkinterquickhelper.funcwin``    shortcuts to *funcwin*      :githublink:`%|py|5`                                                                              |
+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`default_functions <f-defaultfunctions>` | module ``tkinterquickhelper.funcwin.default_functions``    various basic functions often needed      :githublink:`%|py|6`                                              |
+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`frame_function <f-framefunction>`       | module ``tkinterquickhelper.funcwin.frame_function``    :class:`FrameFunction`      :githublink:`%|py|6`                                                               |
+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`frame_params <f-frameparams>`           | module ``tkinterquickhelper.funcwin.frame_params``    Defines :class:`FrameParams`.      :githublink:`%|py|7`                                                          |
+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`function_helper <f-functionhelper>`     | module ``tkinterquickhelper.funcwin.function_helper``    Various function needed when using the windows used to ask for parameters      :githublink:`%|py|6`           |
+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`main_window <f-mainwindow>`             | module ``tkinterquickhelper.funcwin.main_window``    building windows to use a function and specify its parameter based on a python function      :githublink:`%|py|7` |
+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`patchs_windows <f-patchswindows>`       | module ``tkinterquickhelper.funcwin.patchs_windows``    Patches installation    .. versionadded:: 1.3      :githublink:`%|py|7`                                        |
+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`storing_functions <f-storingfunctions>` | module ``tkinterquickhelper.funcwin.storing_functions``    Common functions used for :class:`FrameFunction` and :class:`FrameParams`.      :githublink:`%|py|6`        |
+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`tk_window <f-tkwindow>`                 | module ``tkinterquickhelper.funcwin.tk_window``    Handles window `Tk <https://docs.python.org/3.4/library/tkinter.html#tkinter.Tk>`_      :githublink:`%|py|6`        |
+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+


.. toctree::
    :maxdepth: 1

    tkinterquickhelper/__init__
    tkinterquickhelper/funcwin/__init__
    tkinterquickhelper/funcwin/default_functions
    tkinterquickhelper/funcwin/frame_function
    tkinterquickhelper/funcwin/frame_params
    tkinterquickhelper/funcwin/function_helper
    tkinterquickhelper/funcwin/main_window
    tkinterquickhelper/funcwin/patchs_windows
    tkinterquickhelper/funcwin/storing_functions
    tkinterquickhelper/funcwin/tk_window