aboutsummaryrefslogtreecommitdiffhomepage
path: root/core/.view.luadoc
diff options
context:
space:
mode:
authorGravatar mitchell <70453897+667e-11@users.noreply.github.com>2011-09-25 22:37:24 -0400
committerGravatar mitchell <70453897+667e-11@users.noreply.github.com>2011-09-25 22:37:24 -0400
commitf10a48801dd09bb6cb058b4f783f879720d22bf0 (patch)
tree8b22a252a4b6f60cc7cb8acf862d5c770be8a28a /core/.view.luadoc
parent8461d29251895160755695b74ca6356a9cd8e6f3 (diff)
Refactored textadept.c and changed Lua interface a bit.
'_BUFFERS' and '_VIEWS' now also have buffer and view keys with index values; 'buffer.doc_pointer', 'view.doc_pointer', and 'gui.focused_doc_pointer' are no longer used; 'buffer:check_global()' replaces 'gui.check_focused_buffer()'; Added 'view.buffer' field; 'view:goto_buffer()' and 'gui.goto_view()' arguments changed to make more sense.
Diffstat (limited to 'core/.view.luadoc')
-rw-r--r--core/.view.luadoc19
1 files changed, 8 insertions, 11 deletions
diff --git a/core/.view.luadoc b/core/.view.luadoc
index bf2fe95c..6bf1fe37 100644
--- a/core/.view.luadoc
+++ b/core/.view.luadoc
@@ -10,14 +10,14 @@ module('view')
-- Markdown:
-- ## Fields
--
--- * `doc_pointer` [number]: The pointer to the document associated with this
--- view's buffer. (Read-only)
+-- * `buffer` [table]: The buffer this view contains. (Read-only)
-- * `size` [number]: The position of the split resizer (if this view is part of
-- a split view).
---
-- Splits the indexed view vertically or horizontally and focuses the new view.
--- @param vertical Flag indicating a vertical split. False for horizontal.
+-- @param vertical Flag indicating a vertical split. Defaults to false for
+-- horizontal.
-- @return old view and new view tables.
function view:split(vertical) end
@@ -29,11 +29,8 @@ function view:unsplit() end
---
-- Goes to the specified buffer in the indexed view.
-- Activates the 'buffer_*_switch' signals.
--- @param n A relative or absolute buffer index.
--- @param absolute Flag indicating if n is an absolute index or not.
-function view:goto_buffer(n, absolute) end
-
----
--- Focuses the indexed view if it hasn't been already.
-function view:focus() end
-
+-- @param n A relative or absolute buffer index. An absolute index of -1 goes
+-- to the last buffer.
+-- @param relative Flag indicating if n is a relative index or not. Defaults to
+-- false.
+function view:goto_buffer(n, relative) end