"""Standard interfaces. Deprecated in favor of adapters.

  The `implements` selector used to match not only entity classes but also their

  interfaces. This will disappear in a future version. You should define an

  adapter for that interface and use `adaptable('MyIFace')` selector on appobjects

  that require that interface.

# XXX deprecates in favor of IProgressAdapter

    """something that has a cost, a state and a progression"""

# XXX deprecates in favor of IMileStoneAdapter

# XXX deprecates in favor of IEmbedableAdapter

class IEmbedable(Interface):

    """interface for embedable entities"""

    def embeded_url(self):

        """embed action interface"""

# XXX deprecates in favor of ICalendarAdapter

class ICalendarViews(Interface):

    """calendar views interface"""

    def matching_dates(self, begin, end):

        """

        :param begin: day considered as begin of the range (`DateTime`)

        :param end: day considered as end of the range (`DateTime`)

        :return:

          a list of dates (`DateTime`) in the range [`begin`, `end`] on which

          this entity apply

        """

# XXX deprecates in favor of ICalendarableAdapter

class ICalendarable(Interface):

    """interface for items that do have a begin date 'start' and an end date 'stop'

    """

    @property

    def start(self):

        """return start date"""

    @property

    def stop(self):

        """return stop state"""

# XXX deprecates in favor of ICalendarableAdapter

class ITimetableViews(Interface):

    """timetable views interface"""

    def timetable_date(self):

        """XXX explain

        :return: date (`DateTime`)

        """

# XXX deprecates in favor of IGeocodableAdapter

class IGeocodable(Interface):

    """interface required by geocoding views such as gmap-view"""

    @property

    def latitude(self):

        """returns the latitude of the entity"""

    @property

    def longitude(self):

        """returns the longitude of the entity"""

    def marker_icon(self):

        """returns the icon that should be used as the marker"""

# XXX deprecates in favor of ISIOCItemAdapter

class ISiocItem(Interface):

    """interface for entities which may be represented as an ISIOC item"""

    def isioc_content(self):

        """return item's content"""

    def isioc_container(self):

        """return container entity"""

    def isioc_type(self):

        """return container type (post, BlogPost, MailMessage)"""

    def isioc_replies(self):

        """return replies items"""

    def isioc_topics(self):

        """return topics items"""

# XXX deprecates in favor of ISIOCContainerAdapter

class ISiocContainer(Interface):

    """interface for entities which may be represented as an ISIOC container"""

    def isioc_type(self):

        """return container type (forum, Weblog, MailingList)"""

    def isioc_items(self):

        """return contained items"""

# XXX deprecates in favor of IEmailableAdapter

class IFeed(Interface):

    """interface for entities with rss flux"""

    def rss_feed_url(self):

        """"""

# XXX deprecates in favor of IDownloadableAdapter

class IDownloadable(Interface):

    """interface for downloadable entities"""

    def download_url(self): # XXX not really part of this interface

        """return an url to download entity's content"""

    def download_content_type(self):

        """return MIME type of the downloadable content"""

    def download_encoding(self):

        """return encoding of the downloadable content"""

    def download_file_name(self):

        """return file name of the downloadable content"""

    def download_data(self):

        """return actual data of the downloadable content"""

# XXX deprecates in favor of IPrevNextAdapter

class IPrevNext(Interface):

    """interface for entities which can be linked to a previous and/or next

    entity

    """

    def next_entity(self):

        """return the 'next' entity"""

    def previous_entity(self):

        """return the 'previous' entity"""

# XXX deprecates in favor of IBreadCrumbsAdapter

class IBreadCrumbs(Interface):

    def breadcrumbs(self, view, recurs=False):

        pass

# XXX deprecates in favor of ITreeAdapter