aboutsummaryrefslogtreecommitdiff
path: root/core/.view.luadoc
blob: c658ddfb36ad91c3773063f29161aa3e0977fff2 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
-- Copyright 2007-2012 Mitchell mitchell.att.foicica.com. See LICENSE.
-- This is a DUMMY FILE used for making LuaDoc for built-in functions in the
-- global view table.

---
-- A Textadept view object.
-- @field size (number)
--   The position of the split resizer (if this view is part of a split view).
module('view')

---
-- The [buffer](buffer.html) the view contains. (Read-only)
-- @class table
-- @name buffer
local buffer

---
-- Splits the given view vertically or horizontally and focuses the new view.
-- Emits a `VIEW_NEW` event.
-- @param view The view to split.
-- @param vertical Flag indicating a vertical split. The default value is
--   `false` for horizontal.
-- @return old view and new view.
-- @see events.VIEW_NEW
function split(view, vertical) end

---
-- Unsplits the given view if possible.
-- @param view The view to unsplit.
-- @return boolean if the view was unsplit or not.
function view.unsplit(view) end

---
-- Goes to the specified buffer in the given view.
-- Emits `BUFFER_BEFORE_SWITCH` and `BUFFER_AFTER_SWITCH` events.
-- @param view The view to switch buffers in.
-- @param n A relative or absolute buffer index in `_G._BUFFERS`. An absolute
--   index of `-1` goes to the last buffer.
-- @param relative Flag indicating if `n` is a relative index or not. The
--   default value is `false`.
-- @see _G._G._BUFFERS
-- @see events.BUFFER_BEFORE_SWITCH
-- @see events.BUFFER_AFTER_SWITCH
function goto_buffer(view, n, relative) end