aboutsummaryrefslogtreecommitdiff
path: root/core/.textadept.lua
diff options
context:
space:
mode:
authormitchell <70453897+667e-11@users.noreply.github.com>2010-06-11 18:51:16 -0400
committermitchell <70453897+667e-11@users.noreply.github.com>2010-06-11 18:51:16 -0400
commit8e66381a040f695f4203b28bc3f1d6818d0da7a2 (patch)
treee30e8115d27b423b579e60178f36a151dc795f50 /core/.textadept.lua
parent7a4800f05f26067a1cef77e5431256aab4c3d675 (diff)
downloadtextadept-8e66381a040f695f4203b28bc3f1d6818d0da7a2.tar.gz
textadept-8e66381a040f695f4203b28bc3f1d6818d0da7a2.zip
Removed _G.textadept.
Created new _SCINTILLA core module. Renamed textadept.constants to _SCINTILLA.constants Renamed textadept.buffer_functions to _SCINTILLA.functions Renamed textadept.buffer_properties to _SCINTILLA.properties Created new gui core module. Renamed textadept._print() to gui._print(). Renamed textadept.check_focused_buffer() to gui.check_focused_buffer(). Renamed textadept.clipboard_text to gui.clipboard_text. Renamed textadept.context_menu to gui.context_menu Renamed textadept.command_entry to gui.command_entry. Renamed textadept.dialog to gui.dialog. Renamed textadept.docstatusbar_text to gui.docstatusbar_text. Renamed textadept.find to gui.find. Renamed textadept.focused_doc_pointer to gui.focused_doc_pointer. Renamed textadept.get_split_table() to gui.get_split_table(). Renamed textadept.gtkmenu() to gui.gtkmenu(). Renamed textadept.goto_view() to gui.goto_view(). Renamed textadept.menubar to gui.menubar. Renamed textadept.print() to gui.print(). Renamed textadept.size to gui.size. Renamed textadept.statusbar_text to gui.statusbar_text. Renamed textadept.switch_buffer() to gui.switch_buffer(). Renamed textadept.title to gui.title. Renamed textadept.buffers to _G._BUFFERS. Renamed textadept.new_buffer() to _G.new_buffer(). Renamed textadept.quit() to _G.quit(). Renamed textadept.reset() to _G.reset(). Renamed textadept.views to _G._VIEWS. Renamed textadept.user_dofile() to _G.user_dofile(). Renamed textadept.iconv to string.iconv. Renamed textadept.session_file to _SESSIONFILE. Renamed appropriate C functions.
Diffstat (limited to 'core/.textadept.lua')
-rw-r--r--core/.textadept.lua137
1 files changed, 0 insertions, 137 deletions
diff --git a/core/.textadept.lua b/core/.textadept.lua
deleted file mode 100644
index 5fe9776d..00000000
--- a/core/.textadept.lua
+++ /dev/null
@@ -1,137 +0,0 @@
--- Copyright 2007-2010 Mitchell mitchell<att>caladbolg.net. See LICENSE.
--- This is a DUMMY FILE used for making LuaDoc for built-in functions in the
--- global textadept table.
-
----
--- The core textadept table.
-module('textadept')
-
--- Markdown:
--- ## Fields
---
--- * `title`: The title of the Textadept window.
--- * `focused_doc_pointer`: The pointer to the document associated with the
--- buffer of the currently focused view. (Used internally; read-only.)
--- * `menubar`: A table of GTK menus defining a menubar (write-only).
--- * `context_menu`: A GTK menu defining the editor's context menu.
--- * `clipboard_text`: The text on the clipboard (read-only).
--- * `statusbar_text`: The text displayed by the statusbar (write-only).
--- * `docstatusbar_text`: The text displayed by the doc statusbar (write-only).
--- * `size`: The size of the Textadept window (`{ width, height}`).
--- * `constants`: Table containing Scintilla constants.
--- * `buffer_functions`: Table containing Scintilla functions.
--- * `buffer_properties`: Table containing Scintilla set/get functions.
-
----
--- A numerically indexed table of open buffers in Textadept.
--- @class table
--- @name buffers
-buffers = {}
-
----
--- A numerically indexed table of views in Textadept.
--- @class table
--- @name views
-views = {}
-
----
--- Creates a new buffer.
--- Activates the 'buffer_new' signal.
--- @return the new buffer.
-function new_buffer() end
-
----
--- Goes to the specified view.
--- Activates the 'view_*_switch' signal.
--- @param n A relative or absolute view index.
--- @param absolute Flag indicating if n is an absolute index or not.
-function goto_view(n, absolute) end
-
----
--- Gets the current split view structure.
--- @return table of split views. Each split view entry is a table with 4
--- fields: 1, 2, vertical, and size. 1 and 2 have values of either
--- split view entries or the index of the buffer shown in each view.
--- vertical is a flag indicating if the split is vertical or not, and
--- size is the integer position of the split resizer.
-function get_split_table() end
-
----
--- Creates a GTK menu, returning the userdata.
--- @param menu_table A table defining the menu. It is an ordered list of tables
--- with a string menu item and integer menu ID.
--- The string menu item is handled as follows:
--- 'gtk-*' - a stock menu item is created based on the GTK stock-id.
--- 'separator' - a menu separator item is created.
--- Otherwise a regular menu item with a mnemonic is created.
--- Submenus are just nested menu-structure tables. Their title text is defined
--- with a 'title' key.
-function gtkmenu(menu_table) end
-
----
--- Converts a string from one character set to another using iconv().
--- Valid character sets are ones GLib's g_convert() accepts, typically GNU
--- iconv's character sets.
--- @param text The text to convert.
--- @param to The character set to convert to.
--- @param from The character set to convert from.
-function iconv(text, to, from) end
-
----
--- Resets the Lua state by reloading all init scripts.
--- Language-specific modules for opened files are NOT reloaded. Re-opening the
--- files that use them will reload those modules.
--- This function is useful for modifying init scripts (such as key_commands.lua)
--- on the fly without having to restart Textadept.
--- A global RESETTING variable is set to true when re-initing the Lua State. Any
--- scripts that need to differentiate between startup and reset can utilize this
--- variable.
-function reset() end
-
---- Quits Textadept.
-function quit() end
-
----
--- Checks if the buffer being indexed is the currently focused buffer.
--- This is necessary because any buffer actions are performed in the focused
--- views' buffer, which may not be the buffer being indexed. Throws an error
--- if the check fails.
--- @param buffer The buffer in question.
-function check_focused_buffer(buffer) end
-
----
--- Helper function for printing messages to buffers.
--- Splits the view and opens a new buffer for printing messages. If the message
--- buffer is already open and a view is currently showing it, the message is
--- printed to that view. Otherwise the view is split, goes to the open message
--- buffer, and prints to it.
--- @param buffer_type String type of message buffer.
--- @param ... Message strings.
--- @usage textadept._print(locale.ERROR_BUFFER, error_message)
--- @usage textadept._print(locale.MESSAGE_BUFFER, message)
-function _print(buffer_type, ...) end
-
----
--- Prints messages to the Textadept message buffer.
--- Opens a new buffer (if one hasn't already been opened) for printing messages.
--- @param ... Message strings.
-function print(...) end
-
----
--- Displays a dialog with a list of buffers to switch to and switches to the
--- selected one, if any.
-function switch_buffer() end
-
----
--- Displays a CocoaDialog of a specified type with the given string arguments.
--- Each argument is like a string in Lua's 'arg' table.
--- @return string CocoaDialog result.
-function dialog(kind, ...) end
-
----
--- Calls 'dofile' on the given filename in the user's Textadept directory.
--- This is typically used for loading user files like key commands or snippets.
--- Errors are printed to the Textadept message buffer.
--- @param filename The name of the file (not path).
--- @return true if successful; false otherwise.
-function user_dofile(filename) end