# -*- coding: utf-8 -*-
# This file has been autogenerated by the pywayland scanner

# Copyright © 2012, 2013 Intel Corporation
#
#     Permission is hereby granted, free of charge, to any person obtaining a
#     copy of this software and associated documentation files (the "Software"),
#     to deal in the Software without restriction, including without limitation
#     the rights to use, copy, modify, merge, publish, distribute, sublicense,
#     and/or sell copies of the Software, and to permit persons to whom the
#     Software is furnished to do so, subject to the following conditions:
#
#     The above copyright notice and this permission notice (including the next
#     paragraph) shall be included in all copies or substantial portions of the
#     Software.
#
#     THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
#     IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
#     FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
#     THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
#     LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
#     FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
#     DEALINGS IN THE SOFTWARE.

from pywayland.interface import Interface
from ..wayland.seat import Seat as wl_Seat
from ..wayland.surface import Surface as wl_Surface

import enum


class TextInputV1(Interface):
    """Text input

    An object used for text input. Adds support for text input and input
    methods to applications. A text-input object is created from a
    :class:`~pywayland.protocol.wayland.textinputmanager.TextInputManager` and
    corresponds typically to a text entry in an application. Requests are used
    to activate/deactivate the text-input object and set state information like
    surrounding and selected text or the content type. The information about
    entered text is sent to the text-input object via the pre-edit and commit
    events. Using this interface removes the need for applications to directly
    process hardware key events and compose text out of them.

    Text is generally UTF-8 encoded, indices and lengths are in bytes.

    Serials are used to synchronize the state between the text input and an
    input method. New serials are sent by the text input in the commit_state
    request and are used by the input method to indicate the known text input
    state in events like preedit_string, commit_string, and keysym. The text
    input can then ignore events from the input method which are based on an
    outdated state (for example after a reset).

    Warning! The protocol described in this file is experimental and backward
    incompatible changes may be made. Backward compatible changes may be added
    together with the corresponding interface version bump. Backward
    incompatible changes are done by bumping the version number in the protocol
    and interface names and resetting the interface version. Once the protocol
    is to be declared stable, the 'z' prefix and the version number in the
    protocol and interface names are removed and the interface version number
    is reset.
    """
    name = "zwp_text_input_v1"
    version = 1

    content_hint = enum.Enum("content_hint", {
        "none": 0x0,
        "default": 0x7,
        "password": 0xc0,
        "auto_completion": 0x1,
        "auto_correction": 0x2,
        "auto_capitalization": 0x4,
        "lowercase": 0x8,
        "uppercase": 0x10,
        "titlecase": 0x20,
        "hidden_text": 0x40,
        "sensitive_data": 0x80,
        "latin": 0x100,
        "multiline": 0x200,
    })

    content_purpose = enum.Enum("content_purpose", {
        "normal": 0,
        "alpha": 1,
        "digits": 2,
        "number": 3,
        "phone": 4,
        "url": 5,
        "email": 6,
        "name": 7,
        "password": 8,
        "date": 9,
        "time": 10,
        "datetime": 11,
        "terminal": 12,
    })

    preedit_style = enum.Enum("preedit_style", {
        "default": 0,
        "none": 1,
        "active": 2,
        "inactive": 3,
        "highlight": 4,
        "underline": 5,
        "selection": 6,
        "incorrect": 7,
    })

    text_direction = enum.Enum("text_direction", {
        "auto": 0,
        "ltr": 1,
        "rtl": 2,
    })


@TextInputV1.request("oo", [wl_Seat, wl_Surface])
def activate(self, seat, surface):
    """Request activation

    Requests the text-input object to be activated (typically when the text
    entry gets focus). The seat argument is a
    :class:`~pywayland.protocol.wayland.seat.Seat` which maintains the focus
    for this activation. The surface argument is a
    :class:`~pywayland.protocol.wayland.surface.Surface` assigned to the text-
    input object and tracked for focus lost. The enter event is emitted on
    successful activation.

    :param seat:
    :type seat: :class:`~pywayland.protocol.wayland.seat.Seat`
    :param surface:
    :type surface: :class:`~pywayland.protocol.wayland.surface.Surface`
    """
    self._marshal(0, seat, surface)


@TextInputV1.request("o", [wl_Seat])
def deactivate(self, seat):
    """Request deactivation

    Requests the text-input object to be deactivated (typically when the text
    entry lost focus). The seat argument is a
    :class:`~pywayland.protocol.wayland.seat.Seat` which was used for
    activation.

    :param seat:
    :type seat: :class:`~pywayland.protocol.wayland.seat.Seat`
    """
    self._marshal(1, seat)


@TextInputV1.request("", [])
def show_input_panel(self):
    """Show input panels

    Requests input panels (virtual keyboard) to show.
    """
    self._marshal(2)


@TextInputV1.request("", [])
def hide_input_panel(self):
    """Hide input panels

    Requests input panels (virtual keyboard) to hide.
    """
    self._marshal(3)


@TextInputV1.request("", [])
def reset(self):
    """Reset

    Should be called by an editor widget when the input state should be reset,
    for example after the text was changed outside of the normal input method
    flow.
    """
    self._marshal(4)


@TextInputV1.request("suu", [None, None, None])
def set_surrounding_text(self, text, cursor, anchor):
    """Sets the surrounding text

    Sets the plain surrounding text around the input position. Text is UTF-8
    encoded. Cursor is the byte offset within the surrounding text. Anchor is
    the byte offset of the selection anchor within the surrounding text. If
    there is no selected text anchor is the same as cursor.

    :param text:
    :type text: `string`
    :param cursor:
    :type cursor: `uint`
    :param anchor:
    :type anchor: `uint`
    """
    self._marshal(5, text, cursor, anchor)


@TextInputV1.request("uu", [None, None])
def set_content_type(self, hint, purpose):
    """Set content purpose and hint

    Sets the content purpose and content hint. While the purpose is the basic
    purpose of an input field, the hint flags allow to modify some of the
    behavior.

    When no content type is explicitly set, a normal content purpose with
    default hints (auto completion, auto correction, auto capitalization)
    should be assumed.

    :param hint:
    :type hint: `uint`
    :param purpose:
    :type purpose: `uint`
    """
    self._marshal(6, hint, purpose)


@TextInputV1.request("iiii", [None, None, None, None])
def set_cursor_rectangle(self, x, y, width, height):
    """set_cursor_rectangle

    :param x:
    :type x: `int`
    :param y:
    :type y: `int`
    :param width:
    :type width: `int`
    :param height:
    :type height: `int`
    """
    self._marshal(7, x, y, width, height)


@TextInputV1.request("s", [None])
def set_preferred_language(self, language):
    """Sets preferred language

    Sets a specific language. This allows for example a virtual keyboard to
    show a language specific layout. The "language" argument is a RFC-3066
    format language tag.

    It could be used for example in a word processor to indicate language of
    currently edited document or in an instant message application which tracks
    languages of contacts.

    :param language:
    :type language: `string`
    """
    self._marshal(8, language)


@TextInputV1.request("u", [None])
def commit_state(self, serial):
    """commit_state

    :param serial: used to identify the known state
    :type serial: `uint`
    """
    self._marshal(9, serial)


@TextInputV1.request("uu", [None, None])
def invoke_action(self, button, index):
    """invoke_action

    :param button:
    :type button: `uint`
    :param index:
    :type index: `uint`
    """
    self._marshal(10, button, index)


@TextInputV1.event("o", [wl_Surface])
def enter(self, surface):
    """Enter event

    Notify the text-input object when it received focus. Typically in response
    to an activate request.

    :param surface:
    :type surface: :class:`~pywayland.protocol.wayland.surface.Surface`
    """
    self._post_event(0, surface)


@TextInputV1.event("", [])
def leave(self):
    """Leave event

    Notify the text-input object when it lost focus. Either in response to a
    deactivate request or when the assigned surface lost focus or was
    destroyed.
    """
    self._post_event(1)


@TextInputV1.event("a", [None])
def modifiers_map(self, map):
    """Modifiers map

    Transfer an array of 0-terminated modifiers names. The position in the
    array is the index of the modifier as used in the modifiers bitmask in the
    keysym event.

    :param map:
    :type map: `array`
    """
    self._post_event(2, map)


@TextInputV1.event("u", [None])
def input_panel_state(self, state):
    """State of the input panel

    Notify when the visibility state of the input panel changed.

    :param state:
    :type state: `uint`
    """
    self._post_event(3, state)


@TextInputV1.event("uss", [None, None, None])
def preedit_string(self, serial, text, commit):
    """Pre-edit

    Notify when a new composing text (pre-edit) should be set around the
    current cursor position. Any previously set composing text should be
    removed.

    The commit text can be used to replace the preedit text on reset (for
    example on unfocus).

    The text input should also handle all preedit_style and preedit_cursor
    events occurring directly before preedit_string.

    :param serial: serial of the latest known text input state
    :type serial: `uint`
    :param text:
    :type text: `string`
    :param commit:
    :type commit: `string`
    """
    self._post_event(4, serial, text, commit)


@TextInputV1.event("uuu", [None, None, None])
def preedit_styling(self, index, length, style):
    """Pre-edit styling

    Sets styling information on composing text. The style is applied for length
    bytes from index relative to the beginning of the composing text (as byte
    offset). Multiple styles can be applied to a composing text by sending
    multiple preedit_styling events.

    This event is handled as part of a following preedit_string event.

    :param index:
    :type index: `uint`
    :param length:
    :type length: `uint`
    :param style:
    :type style: `uint`
    """
    self._post_event(5, index, length, style)


@TextInputV1.event("i", [None])
def preedit_cursor(self, index):
    """Pre-edit cursor

    Sets the cursor position inside the composing text (as byte offset)
    relative to the start of the composing text. When index is a negative
    number no cursor is shown.

    This event is handled as part of a following preedit_string event.

    :param index:
    :type index: `int`
    """
    self._post_event(6, index)


@TextInputV1.event("us", [None, None])
def commit_string(self, serial, text):
    """Commit

    Notify when text should be inserted into the editor widget. The text to
    commit could be either just a single character after a key press or the
    result of some composing (pre-edit). It could be also an empty text when
    some text should be removed (see delete_surrounding_text) or when the input
    cursor should be moved (see cursor_position).

    Any previously set composing text should be removed.

    :param serial: serial of the latest known text input state
    :type serial: `uint`
    :param text:
    :type text: `string`
    """
    self._post_event(7, serial, text)


@TextInputV1.event("ii", [None, None])
def cursor_position(self, index, anchor):
    """Set cursor to new position

    Notify when the cursor or anchor position should be modified.

    This event should be handled as part of a following commit_string event.

    :param index:
    :type index: `int`
    :param anchor:
    :type anchor: `int`
    """
    self._post_event(8, index, anchor)


@TextInputV1.event("iu", [None, None])
def delete_surrounding_text(self, index, length):
    """Delete surrounding text

    Notify when the text around the current cursor position should be deleted.

    Index is relative to the current cursor (in bytes). Length is the length of
    deleted text (in bytes).

    This event should be handled as part of a following commit_string event.

    :param index:
    :type index: `int`
    :param length:
    :type length: `uint`
    """
    self._post_event(9, index, length)


@TextInputV1.event("uuuuu", [None, None, None, None, None])
def keysym(self, serial, time, sym, state, modifiers):
    """Keysym

    Notify when a key event was sent. Key events should not be used for normal
    text input operations, which should be done with commit_string,
    delete_surrounding_text, etc. The key event follows the
    :class:`~pywayland.protocol.wayland.keyboard.Keyboard` key event
    convention. Sym is a XKB keysym, state a
    :class:`~pywayland.protocol.wayland.keyboard.Keyboard` key_state. Modifiers
    are a mask for effective modifiers (where the modifier indices are set by
    the modifiers_map event)

    :param serial: serial of the latest known text input state
    :type serial: `uint`
    :param time:
    :type time: `uint`
    :param sym:
    :type sym: `uint`
    :param state:
    :type state: `uint`
    :param modifiers:
    :type modifiers: `uint`
    """
    self._post_event(10, serial, time, sym, state, modifiers)


@TextInputV1.event("us", [None, None])
def language(self, serial, language):
    """Language

    Sets the language of the input text. The "language" argument is a RFC-3066
    format language tag.

    :param serial: serial of the latest known text input state
    :type serial: `uint`
    :param language:
    :type language: `string`
    """
    self._post_event(11, serial, language)


@TextInputV1.event("uu", [None, None])
def text_direction(self, serial, direction):
    """Text direction

    Sets the text direction of input text.

    It is mainly needed for showing input cursor on correct side of the editor
    when there is no input yet done and making sure neutral direction text is
    laid out properly.

    :param serial: serial of the latest known text input state
    :type serial: `uint`
    :param direction:
    :type direction: `uint`
    """
    self._post_event(12, serial, direction)


TextInputV1._gen_c()
