aboutsummaryrefslogtreecommitdiff
path: root/core/.pm.lua
diff options
context:
space:
mode:
Diffstat (limited to 'core/.pm.lua')
-rw-r--r--core/.pm.lua105
1 files changed, 0 insertions, 105 deletions
diff --git a/core/.pm.lua b/core/.pm.lua
deleted file mode 100644
index 4bca6730..00000000
--- a/core/.pm.lua
+++ /dev/null
@@ -1,105 +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.pm table.
-
----
--- Textadept's project manager.
-module('textadept.pm')
-
--- Markdown:
--- ## Fields
---
--- * `entry_text`: The text in the entry.
--- * `width`: The width of the project manager.
--- * `cursor`: The cursor in the project manager (string representation of
--- current `GtkTreePath`).
---
--- ## Overview
---
--- The PM uses different [browsers][browsers] to display heirarchical data.
---
--- [browsers]: ../modules/textadept.pm.browser.html
---
--- ## Interactive Search
---
--- Typing text into the project manager view begins the interactive search.
--- If the text matches ANY part of an item in the view (case sensitively), the
--- item is highlighted and subsequent matches can be navigated to using the
--- up/down arrow keys.
---
--- ## Customizing Look and Feel
---
--- There is no way to theme the dialog from within Textadept. Instead you can
--- use [GTK Resource files][gtkrc]. The pm entry and view have widget names of
--- `textadept-pm-entry` and `textadept-pm-view` respectively.
---
--- [gtkrc]: http://library.gnome.org/devel/gtk/unstable/gtk-Resource-Files.html.
---
--- My RC file looks something like this:
---
--- pixmap_path "/usr/share/icons/Tango/:/home/mitchell/.icons/prog/"
--- style "textadept-pm-display-style" {
--- fg[NORMAL] = "#AAAAAA" # treeview arrows foreground
--- fg[PRELIGHT] = "#AAAAAA" # treeview arrows hover foreground
--- bg[NORMAL] = "#333333" # entry border background
--- base[NORMAL] = "#333333" # entry, treeview background
--- base[ACTIVE] = "#444444" # treeview unfocused selection background
--- base[SELECTED] = "#444444" # entry, treeview selection background
--- text[NORMAL] = "#AAAAAA" # entry, treeview text foreground
--- text[ACTIVE] = "#AAAAAA" # treeview unfocused selection text
--- text[SELECTED] = "#DDDDDD" # entry, treeview selection text foreground
--- stock["gtk-directory"] = {{ "16x16/places/stock_folder.png", LTR }}
--- stock["gtk-folder-new"] = {{ "16x16/actions/folder_new.png", LTR }}
--- stock["prog-class"] = {{ "class.png", LTR }}
--- stock["prog-enum"] = {{ "enum.png", LTR }}
--- stock["prog-field"] = {{ "field.png", LTR }}
--- stock["prog-interface"] = {{ "interface.png", LTR }}
--- stock["prog-literal"] = {{ "literal.png", LTR }}
--- stock["prog-method"] = {{ "method.png", LTR }}
--- stock["prog-namespace"] = {{ "namespace.png", LTR }}
--- stock["prog-reference"] = {{ "reference.png", LTR }}
--- stock["prog-struct"] = {{ "struct.png", LTR }}
--- }
--- widget "*textadept-pm-entry" style "textadept-pm-display-style"
--- widget "*textadept-pm-view" style "textadept-pm-display-style"
-
---- Requests the project manager to get its contents based on its entry text.
-function activate() end
-
----
--- Adds a browser prefix to the list of browsers available in the project
--- manager entry combo box.
--- @param prefix The text to add.
-function add_browser(prefix) end
-
---- Clears the project manager contents.
-function clear() end
-
----
--- Adds contents to the Project Manager view.
--- @param contents Table of tables to for display in the treeview (single
--- level). Each key in the return table is the treeview item's ID. The table
--- value has the following recognized fields:
--- * parent - boolean value indicating if this entry can contain children.
--- If true, an expanding arrow is displayed next to the entry.
--- * pixbuf - a string representing a GTK stock-id whose icon is displayed
--- next to an entry.
--- * text - the entry's Pango marked-up display text.
--- Note that only a SINGLE level of data needs to be returned. When parents
--- are expanded, this function is called again to get that level of data.
--- @param parent String representation of parent GtkTreePath to add the child
--- contents to.
-function fill(contents, parent)
-
---- Focuses the project manager entry.
-function focus() end
-
----
--- Shows a context menu.
--- @param menu Table of menu items. It consists of an ordered list of strings
--- to be used to construct a context menu. The strings are 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.
--- @param event The GDK event associated with the context menu request.
-function show_context_menu(menu, event) end