Functions
tabpage.c File Reference
#include <stdbool.h>
#include <stdint.h>
#include <stdlib.h>
#include "nvim/api/tabpage.h"
#include "nvim/api/vim.h"
#include "nvim/api/private/defs.h"
#include "nvim/api/private/helpers.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)
 
Object tabpage_set_var (Tabpage tabpage, String name, Object value, Error *err)
 
Object tabpage_del_var (Tabpage tabpage, String name, Error *err)
 
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 ( Window  )

Gets the windows in a tabpage

Parameters
tabpageTabpage
[out]errError details, if any
Returns
List of windows in tabpage
void nvim_tabpage_del_var ( Tabpage  tabpage,
String  name,
Error err 
)

Removes a tab-scoped (t:) variable

Parameters
tabpageTabpage handle
nameVariable name
[out]errError details, if any
Integer nvim_tabpage_get_number ( Tabpage  tabpage,
Error err 
)

Gets the tabpage number

Parameters
tabpageTabpage handle
[out]errError details, if any
Returns
Tabpage number
Object nvim_tabpage_get_var ( Tabpage  tabpage,
String  name,
Error err 
)

Gets a tab-scoped (t:) variable

Parameters
tabpageTabpage handle
nameVariable name
[out]errError details, if any
Returns
Variable value
Window nvim_tabpage_get_win ( Tabpage  tabpage,
Error err 
)

Gets the current window in a tabpage

Parameters
tabpageTabpage handle
[out]errError details, if any
Returns
Window handle
Boolean nvim_tabpage_is_valid ( Tabpage  tabpage)

Checks if a tabpage is valid

Parameters
tabpageTabpage handle
Returns
true if the tabpage is valid, false otherwise
void nvim_tabpage_set_var ( Tabpage  tabpage,
String  name,
Object  value,
Error err 
)

Sets a tab-scoped (t:) variable

Parameters
tabpageTabpage handle
nameVariable name
valueVariable value
[out]errError details, if any
Object tabpage_del_var ( Tabpage  tabpage,
String  name,
Error err 
)

Removes a tab-scoped (t:) variable

Deprecated:
Parameters
tabpageTabpage handle
nameVariable name
[out]errError details, if any
Returns
Old value
Object tabpage_set_var ( Tabpage  tabpage,
String  name,
Object  value,
Error err 
)

Sets a tab-scoped (t:) variable

Deprecated:
Parameters
tabpageTabpage handle
nameVariable name
valueVariable value
[out]errError details, if any
Returns
Old value or nil if there was no previous value.
    @warning It may return nil if there was no previous value
             or if previous value was `v:null`.