Top

neovim.api.tabpage module

API for working with Nvim tabpages.

Show source ≡

"""API for working with Nvim tabpages."""
from .common import Remote, RemoteSequence


__all__ = ('Tabpage')


class Tabpage(Remote):
    """A remote Nvim tabpage."""

    _api_prefix = "nvim_tabpage_"

    def __init__(self, *args):
        """Initialize from session and code_data immutable object.

        The `code_data` contains serialization information required for
        msgpack-rpc calls. It must be immutable for Buffer equality to work.
        """
        super(Tabpage, self).__init__(*args)
        self.windows = RemoteSequence(self, 'nvim_tabpage_list_wins')

    @property
    def window(self):
        """Get the `Window` currently focused on the tabpage."""
        return self.request('nvim_tabpage_get_win')

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

    @property
    def number(self):
        """Get the tabpage number."""
        return self.request('nvim_tabpage_get_number')

Classes

class Tabpage

A remote Nvim tabpage.

Show source ≡

class Tabpage(Remote):
    """A remote Nvim tabpage."""

    _api_prefix = "nvim_tabpage_"

    def __init__(self, *args):
        """Initialize from session and code_data immutable object.

        The `code_data` contains serialization information required for
        msgpack-rpc calls. It must be immutable for Buffer equality to work.
        """
        super(Tabpage, self).__init__(*args)
        self.windows = RemoteSequence(self, 'nvim_tabpage_list_wins')

    @property
    def window(self):
        """Get the `Window` currently focused on the tabpage."""
        return self.request('nvim_tabpage_get_win')

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

    @property
    def number(self):
        """Get the tabpage number."""
        return self.request('nvim_tabpage_get_number')

Ancestors (in MRO)

  • Tabpage
  • neovim.api.common.Remote
  • builtins.object

Static methods

def __init__(

self, *args)

Initialize from session and code_data immutable object.

The code_data contains serialization information required for msgpack-rpc calls. It must be immutable for Buffer equality to work.

Show source ≡

def __init__(self, *args):
    """Initialize from session and code_data immutable object.
    The `code_data` contains serialization information required for
    msgpack-rpc calls. It must be immutable for Buffer equality to work.
    """
    super(Tabpage, self).__init__(*args)
    self.windows = RemoteSequence(self, 'nvim_tabpage_list_wins')

def request(

self, name, *args, **kwargs)

Wrapper for nvim.request.

Show source ≡

def request(self, name, *args, **kwargs):
    """Wrapper for nvim.request."""
    return self._session.request(name, self, *args, **kwargs)

Instance variables

var number

Get the tabpage number.

var valid

Return True if the tabpage still exists.

var window

Get the Window currently focused on the tabpage.

var windows