neovim.api.Window

Complexity

Total Complexity

11

Size/Duplication

Total Lines	60
Duplicated Lines	0 %

Test Coverage

Coverage

100%

8 Methods

Rating	Name	Duplication	Size	Complexity
A	row()	0	4	1
A	height()	0	4	1
A	buffer()	0	4	1
A	width()	0	4	1
A	valid()	0	4	1
A	tabpage()	0	4	1
A	col()	0	4	1
A	cursor()	0	4	1

"""API for working with Nvim windows."""
from .common import Remote


__all__ = ('Window')


class Window(Remote):

    """A remote Nvim window."""

    _api_prefix = "window_"

    @property
    def buffer(self):
        """Get the `Buffer` currently being displayed by the window."""
        return self.request('window_get_buffer')

    @property
    def cursor(self):
        """Get the (row, col) tuple with the current cursor position."""
        return self.request('window_get_cursor')

    @cursor.setter
    def cursor(self, pos):
        """Set the (row, col) tuple as the new cursor position."""
        return self.request('window_set_cursor', pos)

    @property
    def height(self):
        """Get the window height in rows."""
        return self.request('window_get_height')

    @height.setter
    def height(self, height):
        """Set the window height in rows."""
        return self.request('window_set_height', height)

    @property
    def width(self):
        """Get the window width in rows."""
        return self.request('window_get_width')

    @width.setter
    def width(self, width):
        """Set the window height in rows."""
        return self.request('window_set_width', width)

    @property
    def row(self):
        """0-indexed, on-screen window position(row) in display cells."""
        return self.request('window_get_position')[0]

    @property
    def col(self):
        """0-indexed, on-screen window position(col) in display cells."""
        return self.request('window_get_position')[1]

    @property
    def tabpage(self):
        """Get the `Tabpage` that contains the window."""
        return self.request('window_get_tabpage')

    @property
    def valid(self):
        """Return True if the window still exists."""
        return self.request('window_is_valid')