.. _l-classes:

Classes
=======

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


Summary
+++++++

+----------------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| class                                                                                              | class parent | truncated documentation                                                                                                                                                               |
+====================================================================================================+==============+=======================================================================================================================================================================================+
| :class:`Activity <mathenjeu.activities.base_classes.Activity>`                                     |              | Defines an activity, a question, a game...                                                                                                                                            |
+----------------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`ActivityGroup <mathenjeu.activities.base_classes.ActivityGroup>`                           |              | Defines a set of activities.                                                                                                                                                          |
+----------------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`AuthMount <mathenjeu.apps.staticapp.authmount.AuthMount>`                                  |              | The router checks for authentification by looking for a cookie which contains an alias. This alias can only be set if ...                                                             |
+----------------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`AuthStaticFiles <mathenjeu.apps.staticapp.authmount.AuthStaticFiles>`                      |              | Overloads *StaticFiles* to check authentification.                                                                                                                                    |
+----------------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`AuthentificationAnswers <mathenjeu.apps.common.auth_app.AuthentificationAnswers>`          |              | Defines answers for an application with authentification. It stores a cookie with only the user alias. The method ...                                                                 |
+----------------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`Base <mathenjeu.activities.base_classes.Base>`                                             |              | Base class.                                                                                                                                                                           |
+----------------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`Display <mathenjeu.activities.base_classes.Display>`                                       |              | Defines how an activity should be displayed.                                                                                                                                          |
+----------------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`DisplayQuestionChoiceHTML <mathenjeu.apps.display.html_display.DisplayQuestionChoiceHTML>` |              | Renders a question into :epkg:`HTML`.                                                                                                                                                 |
+----------------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`LanguageBase <mathenjeu.activities.base_classes.LanguageBase>`                             |              | Base class for language specific content.                                                                                                                                             |
+----------------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`LogApp <mathenjeu.apps.common.log_app.LogApp>`                                             |              | Defines methods to easily log information for a web application. The function *fct_session* returns information ...                                                                   |
+----------------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`Notion <mathenjeu.activities.base_classes.Notion>`                                         |              | Defines what an activity intents to introduce.                                                                                                                                        |
+----------------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`QCMApp <mathenjeu.apps.qcm.qcm_app.QCMApp>`                                                |              | Implements routes for a web application.                                                                                                                                              |
+----------------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`QuestionChoice <mathenjeu.activities.act_question.QuestionChoice>`                         |              | Defines a question with multiple choices.                                                                                                                                             |
+----------------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`ServerHypercorn <mathenjeu.apps.server.server_hypercorn.ServerHypercorn>`                  |              | Implements a server based on :epkg:`hypercorn`.                                                                                                                                       |
+----------------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`StaticApp <mathenjeu.apps.staticapp.staticsite.StaticApp>`                                 |              | Implements routes for a web application which serves static files protected with a password. See :ref:`Which server to server starlette application? <faq-server-app-starlette>`. ... |
+----------------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`_CommonMethods <mathenjeu.apps.staticapp.authmount._CommonMethods>`                        |              |                                                                                                                                                                                       |
+----------------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+