# contact http://www.logilab.fr/ -- mailto:contact@logilab.fr

#

# This file is part of CubicWeb.

#

# CubicWeb is free software: you can redistribute it and/or modify it under the

# terms of the GNU Lesser General Public License as published by the Free

# Software Foundation, either version 2.1 of the License, or (at your option)

# any later version.

#

# CubicWeb is distributed in the hope that it will be useful, but WITHOUT

# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS

# FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more

# details.

#

# You should have received a copy of the GNU Lesser General Public License along

# with CubicWeb.  If not, see <http://www.gnu.org/licenses/>.

"""This module provide highlevel helpers to avoid uicfg boilerplate

for most common tasks such as fields ordering, widget customization, etc.

Here are a few helpers to customize *action box* rendering:

.. autofunction:: cubicweb.web.uihelper.append_to_addmenu

.. autofunction:: cubicweb.web.uihelper.remove_from_addmenu

and a few other ones for *form configuration*:

.. autofunction:: cubicweb.web.uihelper.set_fields_order

.. autofunction:: cubicweb.web.uihelper.hide_field

.. autofunction:: cubicweb.web.uihelper.hide_fields

.. autofunction:: cubicweb.web.uihelper.set_field_kwargs

.. autofunction:: cubicweb.web.uihelper.set_field

.. autofunction:: cubicweb.web.uihelper.edit_inline

.. autofunction:: cubicweb.web.uihelper.edit_as_attr

.. autofunction:: cubicweb.web.uihelper.set_muledit_editable

The module also provides a :class:`FormConfig` base class that lets you gather

uicfg declaration in the scope of a single class, which can sometimes

be clearer to read than a bunch of sequential function calls.

.. autoclass:: cubicweb.web.uihelper.FormConfig

"""

__docformat__ = "restructuredtext en"

from cubicweb.web.views import uicfg

## generic uicfg helpers ######################################################

class meta_formconfig(type):

    """metaclass of FormConfig classes, only for easier declaration purpose"""

    def __init__(cls, name, bases, classdict):

        if cls.etype is None:

            return

        for attr_role in cls.hidden:

        for attr_role in cls.rels_as_attrs:

        for attr_role in cls.inlined:

        for rtype, widget in cls.widgets.items():

        for rtype, field in cls.fields.items():

        super(meta_formconfig, cls).__init__(name, bases, classdict)

class FormConfig:

    """helper base class to define uicfg rules on a given entity type.

    In all descriptions below, attributes list can either be a list of

    attribute names of a list of 2-tuples (relation name, role of

    the edited entity in the relation).

    **Attributes**

    :attr:`etype`

      which entity type the form config is for. This attribute is **mandatory**

    :attr:`formtype`

      the formtype the class tries toc customize (i.e. *main*, *inlined*, or *muledit*),

      default is *main*.

    :attr:`hidden`

      the list of attributes or relations to hide.

    :attr:`rels_as_attrs`

      the list of attributes to edit in the *attributes* section.

    :attr:`inlined`

      the list of attributes to edit in the *inlined* section.

    :attr:`fields_order`

      the list of attributes to edit, in the desired order. Unspecified

      fields will be displayed after specified ones, their order

      being consistent with the schema definition.

    :attr:`widgets`

      a dictionary mapping attribute names to widget instances.

    :attr:`fields`

      a dictionary mapping attribute names to field instances.

    Examples:

.. sourcecode:: python

  from cubicweb.web import uihelper, formwidgets as fwdgs

  class LinkFormConfig(uihelper.FormConfig):

      etype = 'Link'

      hidden = ('title', 'description', 'embed')

      widgets = dict(

          url=fwdgs.TextInput(attrs={'size':40}),

          )

  class UserFormConfig(uihelper.FormConfig):

      etype = 'CWUser'

      hidden = ('login',)

      rels_as_attrs = ('in_group',)

      fields_order = ('firstname', 'surname', 'in_group', 'use_email')

      inlined = ('use_email',)

    """

    __metaclass__ = meta_formconfig

    formtype = 'main'

    etype = None # must be defined in concrete subclasses

    hidden = ()

    rels_as_attrs = ()

    inlined = ()

    fields_order = ()

    widgets = {}

    fields = {}