# -*- coding: utf-8 -*-
from abjad.tools.documentationtools.ReSTDirective import ReSTDirective


class ReSTOnlyDirective(ReSTDirective):
    r'''A ReST `only` directive.

    ::

        >>> import abjad

    ..  container:: example

        ::

            >>> only = abjad.documentationtools.ReSTOnlyDirective(argument='latex')

        ::

            >>> heading = abjad.documentationtools.ReSTHeading(
            ...     level=3, text='A LaTeX-Only Heading')
            >>> only.append(heading)
            >>> only
            ReSTOnlyDirective(
                argument='latex',
                children=(
                    ReSTHeading(
                        level=3,
                        text='A LaTeX-Only Heading'
                        ),
                    )
                )

        ::

            >>> print(only.rest_format)
            .. only:: latex
            <BLANKLINE>
            A LaTeX-Only Heading
            --------------------

    '''

    ### CLASS VARIABLES ###

    __documentation_section__ = 'reStructuredText'

    __slots__ = (
        )

    ### INITIALIZER ###

    def __init__(self, argument=None, children=None, name=None):
        ReSTDirective.__init__(
            self,
            argument=argument,
            children=children,
            name=name,
            )

    ### PUBLIC PROPERTIES ###

    @property
    def directive(self):
        r'''Returns ``'only'``.
        '''
        return 'only'
