tabpage.c File Reference

#include <stdbool.h>
#include <stdint.h>
#include <stdlib.h>
#include "nvim/api/private/defs.h"
#include "nvim/api/private/helpers.h"
#include "nvim/api/tabpage.h"
#include "nvim/api/vim.h"
#include "nvim/memory.h"
#include "nvim/window.h"

Functions
	ArrayOf (Window)
Object	nvim_tabpage_get_var (Tabpage tabpage, String name, Error *err) FUNC_API_SINCE(1)
void	nvim_tabpage_set_var (Tabpage tabpage, String name, Object value, Error *err) FUNC_API_SINCE(1)
void	nvim_tabpage_del_var (Tabpage tabpage, String name, Error *err) FUNC_API_SINCE(1)
Window	nvim_tabpage_get_win (Tabpage tabpage, Error *err) FUNC_API_SINCE(1)
Integer	nvim_tabpage_get_number (Tabpage tabpage, Error *err) FUNC_API_SINCE(1)
Boolean	nvim_tabpage_is_valid (Tabpage tabpage) FUNC_API_SINCE(1)

Function Documentation

ArrayOf()

ArrayOf

(

Window

)

Gets the windows in a tabpage

Parameters

	tabpage	Tabpage handle, or 0 for current tabpage
[out]	err	Error details, if any

Returns

List of windows in tabpage

nvim_tabpage_del_var()

void nvim_tabpage_del_var	(	Tabpage	tabpage,
		String	name,
		Error *	err
	)

Removes a tab-scoped (t:) variable

Parameters

	tabpage	Tabpage handle, or 0 for current tabpage
	name	Variable name
[out]	err	Error details, if any

nvim_tabpage_get_number()

Integer nvim_tabpage_get_number	(	Tabpage	tabpage,
		Error *	err
	)

Gets the tabpage number

Parameters

	tabpage	Tabpage handle, or 0 for current tabpage
[out]	err	Error details, if any

Returns

Tabpage number

nvim_tabpage_get_var()

Object nvim_tabpage_get_var	(	Tabpage	tabpage,
		String	name,
		Error *	err
	)

Gets a tab-scoped (t:) variable

Parameters

	tabpage	Tabpage handle, or 0 for current tabpage
	name	Variable name
[out]	err	Error details, if any

Returns

Variable value

nvim_tabpage_get_win()

Window nvim_tabpage_get_win	(	Tabpage	tabpage,
		Error *	err
	)

Gets the current window in a tabpage

Parameters

	tabpage	Tabpage handle, or 0 for current tabpage
[out]	err	Error details, if any

Returns

Window handle

nvim_tabpage_is_valid()

Boolean nvim_tabpage_is_valid

(

Tabpage

tabpage

)

Checks if a tabpage is valid

Parameters

tabpage

Tabpage handle, or 0 for current tabpage

Returns

true if the tabpage is valid, false otherwise

nvim_tabpage_set_var()

void nvim_tabpage_set_var	(	Tabpage	tabpage,
		String	name,
		Object	value,
		Error *	err
	)

Sets a tab-scoped (t:) variable

Parameters

	tabpage	Tabpage handle, or 0 for current tabpage
	name	Variable name
	value	Variable value
[out]	err	Error details, if any