Source code for feretui.resources

# This file is a part of the FeretUI project
#
#    Copyright (C) 2023-2024 Jean-Sebastien SUZANNE <js.suzanne@gmail.com>
#
# This Source Code Form is subject to the terms of the Mozilla Public License,
# v. 2.0. If a copy of the MPL was not distributed with this file,You can
# obtain one at http://mozilla.org/MPL/2.0/.
"""Resource modules.

The resource is generally a set of views (page and form). This view construct
the page and define the render and the action for the resource.

To help the contruction of the view some mixins exist:

* :class:`feretui.resources.list.LResource`
* :class:`feretui.resources.create.CResource`
* :class:`feretui.resources.read.RResource`
* :class:`feretui.resources.update.UResource`
* :class:`feretui.resources.delete.DResource`
* :class:`.LCRUDResource`

The decorator :meth:`feretui.feretui.FeretUI.register_resource` call the
:meth:`feretui.resources.resource.Resource.build` method and register
the resource in feretui.

::

    @myferet.register_resource()
    class MyResource(LResource, Resource):
        code = 'the identifier of the resource'
        label = 'The label'


To add the resource in the toolbar menu, an attribute exist in the Resource
class (only if build).

::

    myferet.register_toolbar_left_menus([
        MyResource.menu,
    ])
"""

from feretui.resources.actions import (  # noqa: F401
    Action,
    Actionset,
    GotoViewAction,
    SelectedRowsAction,
)
from feretui.resources.create import CResource
from feretui.resources.delete import DResource
from feretui.resources.list import LResource
from feretui.resources.read import RResource
from feretui.resources.resource import Resource  # noqa: F401
from feretui.resources.update import UResource




[docs]
class LCRUDResource(LResource, CResource, RResource, UResource, DResource):
    """LCRUDResource class.

    This class is a mixin, it inherit the mixins:

    * :class:`feretui.resources.list.LResource`
    * :class:`feretui.resources.create.CResource`
    * :class:`feretui.resources.read.RResource`
    * :class:`feretui.resources.update.UResource`
    * :class:`feretui.resources.delete.DResource`

    """

    default_view = "list"



[docs]
    class MetaViewList:
        """Meta view class for list."""

        create_button_redirect_to: str = "create"
        delete_button_redirect_to: str = "delete"
        do_click_on_entry_redirect_to: str = "read"





[docs]
    class MetaViewCreate:
        """Meta view class for create."""

        after_create_redirect_to: str = "read"





[docs]
    class MetaViewRead:
        """Meta view class for read."""

        create_button_redirect_to: str = "create"
        delete_button_redirect_to: str = "delete"
        edit_button_redirect_to: str = "edit"
        return_button_redirect_to: str = "list"





[docs]
    class MetaViewUpdate:
        """Meta view class for update."""

        after_update_redirect_to: str = "read"
        cancel_button_redirect_to: str = "read"





[docs]
    class MetaViewDelete:
        """Meta view class for delete."""

        after_delete_redirect_to: str = "list"