.. _l-functions:

Functions
=========

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


Summary
+++++++

+----------------------------------------------------------------------------------------------------------------+--------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| function                                                                                                       | class parent | truncated documentation                                                                                                                                |
+================================================================================================================+==============+========================================================================================================================================================+
| :func:`IsEmptyString <tkinterquickhelper.funcwin.default_functions.IsEmptyString>`                             |              | Tells if a string is empty.                                                                                                                            |
+----------------------------------------------------------------------------------------------------------------+--------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`X_is_running <tkinterquickhelper.funcwin.tk_window.X_is_running>`                                       |              | Checks that *X* is running.                                                                                                                            |
+----------------------------------------------------------------------------------------------------------------+--------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`_clean_name_variable <tkinterquickhelper.funcwin.default_functions._clean_name_variable>`               |              | Cleans a string.                                                                                                                                       |
+----------------------------------------------------------------------------------------------------------------+--------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`_get_format_zero_nb_integer <tkinterquickhelper.funcwin.default_functions._get_format_zero_nb_integer>` |              |                                                                                                                                                        |
+----------------------------------------------------------------------------------------------------------------+--------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`_private_restore <tkinterquickhelper.funcwin.storing_functions._private_restore>`                       |              | Restores the parameters stored by *_private_store*, returns a list of dictionaries (one of each line stored by *_private_store*). ...                  |
+----------------------------------------------------------------------------------------------------------------+--------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`_private_store <tkinterquickhelper.funcwin.storing_functions._private_store>`                           |              | Stores the parameters into a file, the function adds the parameter in a new line. It a parameter is a password (*name=password*, ...                   |
+----------------------------------------------------------------------------------------------------------------+--------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`_setup_hook <tkinterquickhelper._setup_hook>`                                                           |              | If this function is added to the module, the help automation and unit tests call it first before anything goes on ...                                  |
+----------------------------------------------------------------------------------------------------------------+--------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`check <tkinterquickhelper.check>`                                                                       |              | Checks the library is working. It raises an exception if it does not.                                                                                  |
+----------------------------------------------------------------------------------------------------------------+--------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`check_icon <tkinterquickhelper.funcwin.check_icon>`                                                     |              | Checks the ico was installed with the module.                                                                                                          |
+----------------------------------------------------------------------------------------------------------------+--------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`create_tixtk <tkinterquickhelper.funcwin.tk_window.create_tixtk>`                                       |              | Calls `Tk <https://docs.python.org/3.4/library/tkinter.html#tkinter.Tk>`_ or `Tcl <https://docs.python.org/3.4/library/tkinter.html#tkinter.Tcl>`_ ... |
+----------------------------------------------------------------------------------------------------------------+--------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`create_tk <tkinterquickhelper.funcwin.tk_window.create_tk>`                                             |              | Calls `Tk <https://docs.python.org/3/library/tkinter.html#tkinter.Tk>`_ or `Tcl <https://docs.python.org/3/library/tkinter.html#tkinter.Tcl>`_ ...     |
+----------------------------------------------------------------------------------------------------------------+--------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`extract_function_information <tkinterquickhelper.funcwin.function_helper.extract_function_information>` |              | Extracts information about a function. The function assumes all parameters receive a default value.                                                    |
+----------------------------------------------------------------------------------------------------------------+--------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`file_grep <tkinterquickhelper.funcwin.default_functions.file_grep>`                                     |              | Grep.                                                                                                                                                  |
+----------------------------------------------------------------------------------------------------------------+--------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`file_head <tkinterquickhelper.funcwin.default_functions.file_head>`                                     |              | Keeps the head of a file.                                                                                                                              |
+----------------------------------------------------------------------------------------------------------------+--------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`file_list <tkinterquickhelper.funcwin.default_functions.file_list>`                                     |              | Prints the list of files and sub files in a text file.                                                                                                 |
+----------------------------------------------------------------------------------------------------------------+--------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`file_split <tkinterquickhelper.funcwin.default_functions.file_split>`                                   |              | Splits a file.                                                                                                                                         |
+----------------------------------------------------------------------------------------------------------------+--------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`fix_python35_dll <tkinterquickhelper.funcwin.patchs_windows.fix_python35_dll>`                          |              | This function tries to adress a known issue when creating a virtual environment on Windows with Python 3.5                                             |
+----------------------------------------------------------------------------------------------------------------+--------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`get_function_list <tkinterquickhelper.funcwin.function_helper.get_function_list>`                       |              | Extracts all functions in a module.                                                                                                                    |
+----------------------------------------------------------------------------------------------------------------+--------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`get_icon <tkinterquickhelper.funcwin.storing_functions.get_icon>`                                       |              | Returns a filename corresponding the tkinterquickhelper icon.                                                                                          |
+----------------------------------------------------------------------------------------------------------------+--------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`has_unknown_parameters <tkinterquickhelper.funcwin.function_helper.has_unknown_parameters>`             |              | Returns True if the function contains a parameter like ``**params``.                                                                                   |
+----------------------------------------------------------------------------------------------------------------+--------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`has_x_server <tkinterquickhelper.funcwin.tk_window.has_x_server>`                                       |              | Detects the presences of X server.                                                                                                                     |
+----------------------------------------------------------------------------------------------------------------+--------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`interpret_parameter <tkinterquickhelper.funcwin.storing_functions.interpret_parameter>`                 |              | Interprets a parameter.                                                                                                                                |
+----------------------------------------------------------------------------------------------------------------+--------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`is_empty_string <tkinterquickhelper.funcwin.default_functions.is_empty_string>`                         |              | Tells if a string is empty.                                                                                                                            |
+----------------------------------------------------------------------------------------------------------------+--------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`main_loop_functions <tkinterquickhelper.funcwin.main_window.main_loop_functions>`                       |              | Uses :class:`MainFrame` as the main window.                                                                                                            |
+----------------------------------------------------------------------------------------------------------------+--------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :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 ...                              |
+----------------------------------------------------------------------------------------------------------------+--------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :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 ...                                 |
+----------------------------------------------------------------------------------------------------------------+--------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`private_adjust_parameters <tkinterquickhelper.funcwin.function_helper.private_adjust_parameters>`       |              | Change the value of some parameters when they are NULL: *user*. Changes the parameters inplace.                                                        |
+----------------------------------------------------------------------------------------------------------------+--------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`private_get_function <tkinterquickhelper.funcwin.function_helper.private_get_function>`                 |              | Returns the function object from its name, the name must contains a dot "." otherwise the function will assume it ...                                  |
+----------------------------------------------------------------------------------------------------------------+--------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`test_regular_expression <tkinterquickhelper.funcwin.default_functions.test_regular_expression>`         |              | Tests a regular expression.                                                                                                                            |
+----------------------------------------------------------------------------------------------------------------+--------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+