ko
Classes
Constructor
Class variables
args - args
func - func
instance - instance
interval - window.setInterval()
running - Boolean
timeout - window.setTimeout()
timer - Number
Class functions
ko.abbrev
Functions
Expands the abbreviation, if any, at the current cursor position.
abbrev - String
Optional. The abbreviation to expand. If not given, then the current selection or word before the cursor is used.
lang - String
The language name to scope the search. Optional.
sublang - String
The sub-language name top scope the search. Optional.
Returns - Boolean
Find a snippet for the given abbreviation name. Abbreviations used for snippets are looked for in "Abbreviations" groups in these places: 1. the current project (if any) 2. the toolbox 3. the shared toolbox (if any) And for these languages: A. the current buffer sub-lang (for multi-lang files) B. the current buffer lang (if different than A) C. the "General" lang (i.e. not language-specific)
abbrev - String
The abbreviation name.
lang - String
The language name to scope the search. Optional. If not given, then the language of the current view is used. Specify "General" to *not* search for a lang-specific abbreviation.
sublang - String
The sub-language name top scope the search. This can be relevant for multi-language files (e.g. HTML can have HTML and JavaScript and CSS). Optional. If not given, then the sub-lang of the current cursor position in the current view is used. Specify "General" to *not* search for a sub-lang-specific abbreviation.
Returns - Components.interfaces.koIPart_snippet
Insert an abbreviation snippet into a buffer.
snippet - Components.interfaces.koIPart_snippet
The snippet part to insert. You can use `ko.abbrev.findAbbrevSnippet()` to get one.
view - Components.interfaces.koIView
The buffer view in which to insert the snippet. Optional. If not specified then the current view is used.
ko.browse
Functions
show our about dialog XXX DEPRECATE, this should be dialog.about or ko.about
show mailing list archives on ASPN that are related to the topic
topic - String
browse to a predefined url on activestate.com see tag2uri in ko.browse
show the url defined in "localHelpFile" in an instance of koIAppInfoEx
app - String
the app identifier from the CID of a koIAppInfoEx implementation (eg. @activestate.com/koAppInfoEx?app=Perl)
open the given url or complain appropriately
url - String
browser - String
optional, retreived from prefs if not used
show a list of command id's in the browser
show a list of keybindings in the browser
Hide or show the local help entries in the Help->Languages popup depending on whether an actual help file to launch can be found.
show the url defined in "webHelpURL" in an instance of koIAppInfoEx
app - String
the app identifier from the CID of a koIAppInfoEx implementation (eg. @activestate.com/koAppInfoEx?app=Perl)
ko.commands
Functions
Returns - rc
event - Event
Returns - Boolean
node - top.document.getElementById()
controller - _getControllerForCommand()
Returns - found
ko.dialogs
Variables
alert - parent.opener.ko.dialogs.alert
yesNo - parent.opener.ko.dialogs.yesNo
yesNo()
Functions
options - String
Returns - ko.dialogs.authenticate2()
Returns - Object
style - String
Returns - obj.response
mruName - String
interpolateValues - Boolean
Returns - obj.response
mode - String
Returns - Object
is_cancellable - Boolean
modal - Boolean
selectionCondition - String
yesNoCancel - Boolean
Returns - obj.response
response - String
style - String
Returns - obj.response
ko.dragDrop
Functions
ko.dragDrop.dragObserver
Variables
canHandleMultipleItems - Boolean
Functions
event - Event
Returns - Boolean
event - Event
event - Event
Returns - flavours
event - Event
Returns - Boolean
event - Event
ko.eggs
Functions
ko.filepicker
Functions
A dialog to pick a directory, and put the directory path into a XUL textbox.
textbox - Element
A dialog to pick a remote directory and put the path into a XUL textbox.
textbox - Element
Pick a directory/folder.
Returns - String
Pick an executable file for open.
defaultDirectory - ko.uriparse.dirName()
title - String
Returns - String
Pick a file for open.
defaultDirectory - ko.uriparse.dirName()
title - String
Returns - String
Pick multiple files for open.
defaultDirectory - ko.uriparse.dirName()
title - String
Returns - Array
Open remote file(s) Same parameters meanings as "filepicker_remoteFileBrowser" (above) Returns nothing. Note: The files will be opened through this function call
Browse for remote file(s)
defaultUrl - _lastRemoteLocation
defaultFilename - String
mode - Components.interfaces.nsIFilePicker.modeOpen
title - String
defaultFilterName - Array
filterNames - Array
helpTag - String
Returns - Object
Choose remote filename to save as Same parameters meanings as "filepicker_remoteFileBrowser" (above) Returns the remote url of the selected file, or null if the dialog is cancelled.
Pick a file for save.
defaultDirectory - ko.uriparse.dirName()
title - String
Returns - String
ko.fileutils
Functions
fname1 - fname1.replace()
fname2 - fname2.replace()
ko.help
Functions
alternate uses the alternate help preference
getTag old help open method, DEPRECATED
Returns - tag
openTag old help open method, DEPRECATED
language open language specific help for the current buffer.
open open Komodo help window
page - String
a page tag as defined in toc.xml
tutorialProject used by the help system to open KPF files associated with a tutorial
tutorial - String
name of tutorial to open
tutorials Open the Tutorial in the help browser "tutorial" can optionally be used to specify a particular tutorial to start with. Currently valid values are "perl", "python", "php", "xslt", and null (to go to Tutorial home page).
tutorial - String
name of tutorial to open
ko.inputBuffer
Input buffering When you need to capture user input while a slow XUL window is loading you can use the input buffer. Usage: - in some JS code: ko.inputBuffer.start() // open XUL window - in slow XUL window onload handler: var contents = ko.inputBuffer.finish(); // use the contents somehow
Variables
id - String
Functions
Returns - contents
event - Event
ko.interpolate
Utility methods to easily use the KoIInterpolationService from JavaScript. Basically you can use the ko.interpolate.interpolate() method to iterpolation special '%'-escape codes in a given list of strings. See koInterpolationService.py (or play around with "run commands") for an authoritative description of available escape codes. How to interpolate a couple of strings (mystringa, mystringb). You can do as many strings as you want. var imystringa = null; var imystringb = null; try { var istrings = ko.interpolate.interpolate( <ref-to-komodo.xul>, [mystringa, mystringb], // codes are not bracketed [mystringc, mystringd], // codes are bracketed <optional-query-title>); imystringaForUse = istrings[0]; imystringaForDisplay = istrings[1]; imystringbForUse = istrings[2]; imystringbForDisplay = istrings[3]; imystringcForUse = istrings[4]; imystringcForDisplay = istrings[5]; imystringdForUse = istrings[6]; imystringcForDisplay = istrings[7]; } catch (ex) { var errno = lastErrorSvc.getLastErrorCode(); if (errno == Components.results.NS_ERROR_ABORT) { // Command was cancelled. } else if (errno == Components.results.NS_ERROR_INVALID_ARG) { var errmsg = lastErrorSvc.getLastErrorMessage(); alert("Could not interpolate:" + errmsg); } else { log.error(ex); alert("There was an unexpected error: " + ex); } }
Functions
Returns - projectFile
Returns - String
Returns - projectFile
Return a list of start and end offsets of interpolation code blocks into the given strings "s".
Returns - offsets
A utility function to retrieving specific view data required by Interpolate_interpolate(). "editor" is a reference to the komodo.xul window. "viewData" (optional) is a object possibly containing overriding values for some of the view data.
viewData - Object
Returns - viewData
Return the current word from the current scimoz character position.
scimoz - Components.interfaces.ISciMoz
(Optional) The scimoz editor to retireive the word from.
Returns - String
Interpolate '%'-escape codes in the given list(s) of strings. "editor" is a reference the komodo.xul window. "strings" is a list of raw strings to interpolate. "bracketedStrings" is a list of raw strings to interpolate, using the bracketed form "queryTitle" (optional) is a title for the possible query dialog raised during interpolation. "viewData" (optional) allows one to override specific view data used for interpolation. By default view data is retrieved from the current view. This may not always be appropriate. It may be an object with one or more of the following attributes: "fileName" is the filename of the current file (null, if N/A); "lineNum" is the current line number (0, if N/A); "word" is the current word under cursor (null if none); "selection" is the current selection (null if none). On success, this function returns a *double* list of interpolated strings: For each string in "strings" and "bracketedStrings" two strings are returned. The first is the interpolated string for use and the second for *display*. In most cases these are the same but they may differ, for example, if a password query response was interpolated into the string which should not be displayed in the Komodo UI. Otherwise an exception is raised and an error set on the last error service: koILastError errno reason ----------------------- ----------------------------------------- NS_ERROR_ABORT User cancelled the query dialog. NS_ERROR_INVALID_ARG A normal interpolation failure because of invalid interp code usage.
viewData - ko.interpolate.getViewData()
Returns - istrings
bracketed - Boolean
queryTitle - String
Returns - istring
ko.isearch
Variables
controller - ISController
ko.keybindings
Variables
keylabel2keysequence - keylabel2keysequence
keysequence2keylabel - keysequence2keylabel
Functions
Classes
Constructor
Class variables
_commandParams - Object
_configDirty - Boolean
_configKeyTree - cloneObject()
_configUnsaved - Boolean
_keyPressCaptureWindow - window
_knownconfigs - Array
activeCommands - Object
command2key - Object
commanditems - Array
commandnames - Array
constructor
currentConfiguration - gPrefSvc.prefs.getStringPref()
currentPrefixMap - this.keyTree
currentPrefixString - String
currentScheme - this.keybindingSchemeService.getScheme()
data - lines.join()
document - document
inPrefixCapture - Boolean
key2command - Object
keybindingSchemeService
keyDownLabels
keynames - Array
keyTree - Object
lastcategory - String
prefset - gPrefSvc.prefs
rownum - Number
Class functions
desc - desc.replace()
Returns - String
Returns - Boolean
Returns - root
root - commandMatch
Returns - keysequence2keylabel()
Returns - seqs
Returns - commanddesc
Returns - String
Returns - commanddesc
Returns - commanddesc
Returns - scheme.writeable
event - Event
Returns - Boolean
event - Event
useShift - Boolean
Returns - data.join()
event - Event
Returns - possible
Returns - this._knownconfigs
keyname - keyname.slice()
event - Event
forceReload - Boolean
Returns - String
Returns - String
Returns - newconfigname
forceReload - Boolean
Parse the keybinding configuration file data into commands. Acitivate the keybinding commands.
forceReload - Boolean
Returns - key
Returns - Boolean
Returns - usedbys
ko.launch
Functions
Opens the update manager and checks for updates to the application. From http://plow/source/xref/mozilla/1.8/browser/base/content/utilityOverlay.js#452
diff open the diff dialog, you must provide the diff
diff - String
title - String
message - String
Returns - ko.windowManager.openDialog()
Open the Find dialog.
pattern - String
The pattern to search for.
Returns - ko.windowManager.openDialog()
Open the find dialog for searching in a "collection" find context.
collection - koICollectionFindContext
defines in what to search.
pattern - String
is the pattern to search for. Optional.
Returns - ko.windowManager.openDialog()
Open Find dialog to search in the current project.
pattern - String
Returns - ko.windowManager.openDialog()
Open Find dialog to search in files.
pattern - String
dirs - String
includes - Array
excludes - Array
Returns - ko.windowManager.openDialog()
httpInspector open the HTTPInspector window
Returns - ko.windowManager.openOrFocusDialog()
openAddonsMgr open the extension/add ons manager window
Returns - ko.windowManager.openOrFocusDialog()
Open the Find/Replace dialog.
pattern - String
The pattern to search for.
repl - String
The replacement pattern.
Returns - ko.windowManager.openDialog()
Open the find dialog to find & replace in a "collection" of files.
collection - koICollectionFindContext
defines in what to search.
pattern - String
The pattern to search for.
repl - String
The replacement pattern.
Returns - ko.windowManager.openDialog()
Open Find dialog to find & replace in the current project.
pattern - String
The pattern to search for.
repl - String
The replacement pattern.
Returns - ko.windowManager.openDialog()
Open Find dialog to make replacements in files.
pattern - String
repl - String
dirs - String
includes - Array
excludes - Array
Returns - ko.windowManager.openDialog()
runCommand open the run command dialog
Returns - window.openDialog()
Open the rx toolkit.
mode - String
One of "match", "match-all", "split", "replace", "replace-all" or null for the default (match-all).
regex - String
The regular expression pattern, or null for the default (the last regex).
replacement - String
searchText - String
matchCase - Boolean
Whether to set the "I" match option.
isModal - Boolean
Whether to open the Rx dialog modally (default is false.
flagMultiline - Boolean
Whether to set the "M" match option.
Returns - args
watchLocalFile prompt for a file to watch, then open a new watch window
ko.launch.find2_dialog_args
Variables
collection - collection
cwd - cwd
dirs - dirs
excludes - excludes
includes - includes
mode - String
pattern - pattern
repl - repl
ko.lint
Functions
event - Event
Classes
Constructor
Class variables
_lastRequestId - Number
_lintTimer - objectTimer
constructor
errorString - request.errorString
lintingEnabled - this.view.prefs.getBooleanPref()
lintResults - request.results
view - view
Class functions
Returns - this
reason - String
ko.logging
Variables
dumpDOM - dumpDOM
getObjectTree - getObjectTree
getStack - getStack
loggingSvc - Components.interfaces.koILoggingService
Functions
Returns - res
event - Event
Returns - this.getLoggingMgr().getLogger()
Returns - _gLoggingMgr
name - String
Returns - s
Classes
Constructor
Class variables
_logger - logger
_logger_name - logger_name
constructor
Class functions
message - String
Returns - this._logger.getEffectiveLevel()
ko.logging.LoggerMap
ko.macros
Variables
current - _partSvc.runningMacro
eventHandler - MacroEventHandler
recorder - MacroRecorder
Functions
Returns - Boolean
ko.main
Variables
log - _log
Functions
addCanQuitHandler observer for watching the quit-application-requested notification, and easily handling a response to it.
addUnloadHandler Register a routine to be called on Komodo shutdown. To register a simple routine do this: ko.main.addUnloadHandler(<routine>) To register an object method do this: ko.main.addUnloadHandler(this.<method>, this);
addWillQuitHandler simple observer for watching the quit-application-granted notification
ko.main.window
Functions
Returns - Boolean
ko.markers
Variables
MARKERS_MASK_SYMBOLS - Number
MARKNUM_BOOKMARK - Number
MARKNUM_BREAKPOINT_DISABLED - Number
MARKNUM_BREAKPOINT_ENABLED - Number
MARKNUM_CURRENT_LINE_BACKGROUND - Number
MARKNUM_DEBUG_CURRENT_LINE - Number
MARKNUM_INTERACTIVE_PROMPT - Number
MARKNUM_INTERACTIVE_PROMPT_MORE - Number
MARKNUM_SPAWNPOINT_DISABLED - Number
MARKNUM_SPAWNPOINT_ENABLED - Number
MARKNUM_STDERR - Number
MARKNUM_STDIN_PROMPT - Number
MARKNUM_STDOUT - Number
MARKNUM_TRANSIENTMARK - Number
Functions
Read a file from disk, cache and return the contents.
uri - String
file uri
force - Boolean
force read from file Note: The file contents are cached by URI. This is used to load pixmaps for scintilla markers.
Returns - content_cache[uri]
Setup the standard Komodo markers in the given SciMoz instance and return an appropriate mask for ISciMoz.setMarginMaskN(<n>, <mask>).
scimoz - iSciMoz
scimoz plugin instsance
Returns - ko.markers.MARKERS_MASK_SYMBOLS
ko.mozhacks
Functions
pluginContextMenu Verified still necessary with moz 1.8 branch - SMC For some reason popups over the plugin are messed up until the first context menu over mozilla is activated. It is apparently due to popupNode not being initialized, so we do that here. See: http://www.xulplanet.com/references/elemref/ref_popup.html
ko.mru
Functions
notify - Boolean
index - Number
Returns - retval
maxLength - Math.max()
Returns - retval
Returns - maxEntries
ko.open
The open namespace contains functionality to open buffers in komodo
Functions
Open the given path in Komodo.