"""Definitions for atlas."""

from enum import Enum, unique

from lizmap.definitions.base import BaseDefinitions, InputType
from lizmap.qgis_plugin_tools.tools.i18n import tr

__copyright__ = 'Copyright 2020, 3Liz'
__license__ = 'GPL version 3'
__email__ = 'info@3liz.org'


@unique
class ZoomItems(Enum):
    Nothing = {
        'data': '',
        'label': '',
    }
    Center = {
        'data': 'center',
        'label': tr('Center'),
    }
    Zoom = {
        'data': 'zoom',
        'label': tr('Zoom'),
    }


class AtlasDefinitions(BaseDefinitions):

    def __init__(self):
        super().__init__()
        self._use_single_row = True
        self._layer_config['layer'] = {
            'type': InputType.Layer,
            'wfs_required': True,
            'header': tr('Layer'),
            'default': None,
            'tooltip': tr('The vector layer for the atlas.')
        }
        self._layer_config['primaryKey'] = {
            'type': InputType.PrimaryKeyField,
            'wfs_required': True,
            'header': tr('Primary key'),
            'default': None,
            'tooltip': tr('Layer primary key (must be integer for PostgreSQL).')
        }
        self._layer_config['displayLayerDescription'] = {
            'type': InputType.CheckBox,
            'header': tr('Display layer description'),
            'default': True,
            'tooltip': tr('If you want to display the layer description in the dock of your atlas.')
        }
        self._layer_config['featureLabel'] = {
            'type': InputType.Field,
            'wfs_required': True,
            'header': tr('Feature label'),
            'default': None,
            'tooltip': tr(
                'Choose the field who contains the name of your features, it will be shown instead '
                'of the primary key in the list of features.')
        }
        self._layer_config['sortField'] = {
            'type': InputType.Field,
            'wfs_required': True,
            'header': tr('Sort field'),
            'default': None,
            'tooltip': tr('Your atlas will be sorted according to this field.')
        }
        self._layer_config['highlightGeometry'] = {
            'type': InputType.CheckBox,
            'header': tr('Highlight geometry'),
            'default': False,
            'tooltip': tr(
                'You can choose to highlight the feature selected by the atlas, '
                'it will change every time it\'s switching to a new feature.')
        }
        self._layer_config['zoom'] = {
            'type': InputType.List,
            'header': tr('Zoom'),
            'items': ZoomItems,
            'default': ZoomItems.Nothing,
            'tooltip': tr('Choose between a zoom on the feature or to make it the center of your map.')
        }
        self._layer_config['displayPopup'] = {
            'type': InputType.CheckBox,
            'header': tr('Display popup (if activated)'),
            'default': False,
            'tooltip': tr(
                'You can choose to display the popup in the feature in the atlas container or not.'
            ) + '<br>' + tr('The popup <b>must be</b> activated on the current layer by yourself.')
        }
        self._layer_config['triggerFilter'] = {
            'type': InputType.CheckBox,
            'header': tr('Trigger filter'),
            'default': False,
            'tooltip': tr(
                'If you want to activate filter on the feature selected by the atlas, '
                'it will hide all other features of the layer and only show the one selected.')
        }
        self._layer_config['duration'] = {
            'type': InputType.SpinBox,
            'header': tr('Duration'),
            'default': 5,
            'tooltip': tr('You can select the duration between each step when your atlas is in auto-play mode.')
        }

        self._general_config['showAtStartup'] = {
            'type': InputType.CheckBox,
            'default': False,
        }

        self._general_config['autoPlay'] = {
            'type': InputType.CheckBox,
            'default': False,
        }

    @staticmethod
    def primary_keys() -> tuple:
        return 'layer',

    def key(self) -> str:
        return 'atlas'

    def help_path(self) -> str:
        return 'publish/lizmap_plugin/atlas.html'
