args - args
func - func
instance - instance
interval - window.setInterval()
running - Boolean
timeout - window.setTimeout()
timer - Number
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.
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)
Returns - rc
event - Event
Returns - Boolean
node - top.document.getElementById()
controller - _getControllerForCommand()
Returns - found
bpManager
controller - DebuggerItemsController
listener - _listener
manager
tabManager
event - Event
Returns - Boolean
Returns - String
Returns - languageService.getLanguageService().executablePath
bpManager - BreakpointsTabManager
manager - DBG_Manager
manager
Returns - Boolean
Returns - Boolean
manager - Components.interfaces.koIDBGPBreakpointManager
_ishellStartSafeTabIdRe
_ishellStartSafeTabIds - Array
_log - ko.logging.getLogger()
INVOKE_BUILD - Components.interfaces.koIInvocation.INVOKE_BUILD
INVOKE_DEBUG - Components.interfaces.koIInvocation.INVOKE_DEBUG
INVOKE_INTERACTIVE - Components.interfaces.koIInvocation.INVOKE_INTERACTIVE
INVOKE_RUN - Components.interfaces.koIInvocation.INVOKE_RUN
log
Returns - rc
invoke_type - ko.dbg.invocation.INVOKE_DEBUG
session - ko.dbg.manager.newSession()
Returns - this.showInvocationDialog()
session - ko.dbg.manager.newSession()
Returns - this.showInvocationDialog()
Returns - Array
language - gPrefs.getStringPref()
event - Event
Returns - ret
Returns - Array
Returns - invocation
Returns - this.doStart()
invocation - resp.invocation
Returns - invocation
Returns - Boolean
alert - parent.opener.ko.dialogs.alert
yesNo - parent.opener.ko.dialogs.yesNo
yesNo()
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
canHandleMultipleItems - Boolean
event - Event
Returns - Boolean
event - Event
event - Event
Returns - flavours
event - Event
Returns - Boolean
event - Event
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 - currentView.document.file.URI
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
fname1 - fname1.replace()
fname2 - fname2.replace()
Format this view. If there is a selection in this view or the formatSelection argument is true, then the formatter will work upon the view's selection, else the formatter works on the complete document. The targetted text will be replaced if the formatting is successful.
view - Components.interfaces.koIScintillaView
(Optional) The view to format. Defaults to the currentview.
formatSelection - Boolean
(Optional) Force the formater to work on a selection of the view.
Format the current view with the formatter configuration that has the provided UUID. This is required for the formatter menu(item)'s.
uuid - String
The unique identifier of the configuration prefset.
Format the given view (defaults to the current view when not supplied) with the formatter configuration provided. If there is a selection in this view then the formatter will work upon the view's selection, else the formatter works on the complete document. The targetted text will be replaced if the formatting is successful.
view - Components.interfaces.koIScintillaView
The view to format. Defaults to the current view if null.
config - Components.interfaces.koIPreferenceSet
The formatter configuration prefset to use for formatting.
formatSelection - Boolean
(Optional) Force the formater to work on a selection of the view.
Format the given view (defaults to the currentView when not supplied) with the formatter configuration that has the supplied config name. If there is a selection in this view then the formatter will work upon the view's selection, else the formatter works on the complete document. The targetted text will be replaced if the formatting is successful.
view - Components.interfaces.koIScintillaView
The view to format. Defaults to the current view if null.
configName - String
The name of the formatter configuration to use for formatting.
Return a list of all formatter configuration preferences.
Returns - Array
Return a list of formatter configuration preferences that are setup for the given language.
Returns - Array
Return a list of formatter configuration preferences that are setup for the current view's language and prefset.
view - ko.views.manager.currentView
Returns - Array
Populate the provided menupopup element with the available formatters for the current view.
event - Event
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
event - Event
explicit - Boolean
Returns - _curr_session_name
event - Event
Note the current location.
view - view
An optional view in which to get the current location. If not given the current view is used.
check_section_change - Boolean
Returns - koILocation
func - jump_fn
indic_color - indic_color
indic_style - indic_style
lang_names - lang_names
name - name
Add a handler to the list of known hyperlink handlers.
handler - ko.hyperlinks.BaseHandler
- The handler to add.
Return a copy of the available hyperlink handlers.
Returns - Array
Get the available hyperlink handlers for the given language name, or all hyperlink handlers when lang is not set.
Returns - Array
Return the handler with this name from the list of known hyperlink handlers.
name - String
- The handler name to find.
Returns - ko.hyperlinks.BaseHandler
Remove this handler from the list of known hyperlink handlers.
handler - ko.hyperlinks.BaseHandler
- The handler to remove.
Show any available hyperlink at the position in the view.
Returns - ko.hyperlinks.BaseHandler
The base hyperlink handler class. Handlers are responsible for checking to see if an editor position is a hyperlink and then highlighting the hyperlink within the editor.
name - String
A unique name of the hyperlink handler.
jump_fn - Function
Will be called when the user clicks on the jump point. The matching (or replaced) hyperlink value is the only argument passed to this function.
lang_names - {array
Optional - If set, the handler will only show hyperlinks when the editor language is one of these language names.
indic_style - Number
Optional - Indicator style, see scimoz.INDIC_*
indic_color - Number
Optional - Indicator color (BGR), i.e. 0xFFCC33
Activate this hyperlink instance.
view - Components.interfaces.koIScintillaView
The view instance.
hyperlink - ko.hyperlinks.Hyperlink
The hyperlink instance.
Remove this hyperlink instance.
view - Components.interfaces.koIScintillaView
The view instance.
hyperlink - ko.hyperlinks.Hyperlink
The hyperlink instance.
Set a hyperlink at this position.
view - Components.interfaces.koIScintillaView
View to mark.
startPos - Number
Scimoz position for the start of the hyperlink.
endPos - Number
Scimoz position for the end of the hyperlink.
args - Array
Optional - Array of args to pass to the function.
Returns - ko.hyperlinks.Hyperlink
Try and show a hyperlink at the current position in the view.
view - Components.interfaces.koIScintillaView
View to check.
scimoz - Components.interfaces.ISciMoz
Scimoz for the view.
position - Number
Position in the scimoz editor.
line - String
The current line from the editor.
lineStartPos - Number
Scimoz position for the start of the line.
lineEndPos - Number
Scimoz position for the end of the line.
Returns - Boolean
named_css_colors - Array
Returns - color_hex
Activate this hyperlink instance.
view - Components.interfaces.koIScintillaView
The view instance.
hyperlink - ko.hyperlinks.Hyperlink
The hyperlink instance.
Remove this hyperlink instance.
view - Components.interfaces.koIScintillaView
The view instance.
hyperlink - ko.hyperlinks.Hyperlink
The hyperlink instance.
event - Event
Returns - match.join()
Try and show a hyperlink at the current position in the view.
view - Components.interfaces.koIScintillaView
View to check.
scimoz - Components.interfaces.ISciMoz
Scimoz for the view.
line - String
The current line from the editor.
lineStartPos - Number
Scimoz position for the start of the line.
lineEndPos - Number
Scimoz position for the end of the line.
Returns - ko.hyperlinks.Hyperlink
Try and show a hyperlink at the current position in the view.
view - Components.interfaces.koIScintillaView
View to check.
scimoz - Components.interfaces.ISciMoz
Scimoz for the view.
line - String
The current line from the editor.
lineStartPos - Number
Scimoz position for the start of the line.
lineEndPos - Number
Scimoz position for the end of the line.
Returns - ko.hyperlinks.Hyperlink
A hyperlink instance created by a handler and set on the view.
handler - ko.hyperlinks.BaseHandler
- Handler that made it.
startPos - Number
Scimoz position for the start of the hyperlink.
endPos - Number
Scimoz position for the end of the hyperlink.
args - Array
Optional - Array of args to pass to the function.
args - args
endPos - endPos
handler - handler
startPos - startPos
Activate this hyperlink.
view - Components.interfaces.koIScintillaView
The view instance.
Remove this hyperlink.
name - String
A unique name of the hyperlink handler.
findRegex - RegExp
Regular expression used to find the hyperlink.
fn - Function
Will be called when the user clicks on the jump point. The matching (or replaced) hyperlink value is the only argument passed to this function.
replace_str - {string
Optional - If set, will be used to change the matching text into a different value, similar to str.replace(findRegex, replace_str), so you can use the JavaScript regular expression positions: $1, $2, etc... in the string.
lang_names - {array
Optional - If set, the handler will only show hyperlinks when the editor language is one of these language names.
indic_style - Number
Optional - Indicator style, see scimoz.INDIC_*
indic_color - Number
Optional - Indicator color (BGR), i.e. 0xFFCC33
findRegex - findRegex
replace_str - replace_str
Try and show a hyperlink at the current position in the view.
view - Components.interfaces.koIScintillaView
View to check.
scimoz - Components.interfaces.ISciMoz
Scimoz for the view.
position - Number
Position in the scimoz editor.
line - String
The current line from the editor.
lineStartPos - Number
Scimoz position for the start of the line.
lineEndPos - Number
Scimoz position for the end of the line.
Returns - ko.hyperlinks.Hyperlink
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
id - String
Returns - contents
event - Event
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); } }
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
controller - ISController
keylabel2keysequence - keylabel2keysequence
keysequence2keylabel - keysequence2keylabel
_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()
document - document
inPrefixCapture - Boolean
key2command - Object
keybindingSchemeService
keyDownLabels
keynames - Array
keyTree - Object
lastcategory - String
prefset - gPrefSvc.prefs
rownum - Number
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
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
collection - collection
cwd - cwd
dirs - dirs
excludes - excludes
includes - includes
mode - String
pattern - pattern
repl - repl
_lintDisplayer - Components.interfaces.koILintDisplayer
_lintSvc - Components.interfaces.koILintService
event - Event
_lastRequestId - Number
_lintTimer - objectTimer
constructor
errorString - request.errorString
lintingEnabled - this.view.prefs.getBooleanPref()
lintResults - request.results
view - view
Returns - this
reason - String
dumpDOM - dumpDOM
getObjectTree - getObjectTree
getStack - getStack
loggingSvc - Components.interfaces.koILoggingService
Returns - res
event - Event
Returns - this.getLoggingMgr().getLogger()
Returns - _gLoggingMgr
name - String
Returns - s
_logger - logger
_logger_name - logger_name
constructor
Log a deprecation warning message. This will also log the stack trace to show where the deprecated code was being called from. Note: This is not a core Python logging function, it's just used from JavaScript code to warn about Komodo JavaScript API deprecations.
message - String
The deprecation warning message.
message - String
Returns - this._logger.getEffectiveLevel()
current - _partSvc.runningMacro
eventHandler - MacroEventHandler
recorder - MacroRecorder
view - ko.views.manager.currentView
Returns - Boolean
Window "close" event handler to close the Komodo window and, if it is the last one, quit. This is called when the application's "x" close button is pressed. It is NOT called when quitting Komodo via "File -> Exit", "Cmd+Q", or equivalent.
event - Event
Window "DOMWindowClose" event sent when the window is about to be closed by `window.close()`. For Komodo shutdown this is called when a window is closed via toolkit's `goQuitApplication()`, but NOT when closed via the application window's "x" close button. http://developer.mozilla.org/en/docs/Gecko-Specific_DOM_Events#DOMWindowClose http://mxr.mozilla.org/mozilla1.8/source/dom/src/base/nsGlobalWindow.cpp#4737 ... DispatchCustomEvent("DOMWindowClose") ...
event - Event
addWillCloseHandler Register a routine to be called when a Komodo window is closed. To register a simple routine do this: ko.main.addWillCloseHandler(<routine>) To register an object method do this: ko.main.addWillCloseHandler(this.<method>, this);
Returns - Boolean
_koNum
event - Event
Returns - res
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_HISTORYLOC - 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
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
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
notify - Boolean
index - Number
Returns - retval
maxLength - Math.max()
Returns - retval
Returns - maxEntries
The open namespace contains functionality to open buffers in komodo
Open the given path in Komodo. If you need the view for the file that is opened from this call, pass in a callback function argument and then this function will be called after the view is opened (or re-focused if it was already open).
displayPath - String
identifies the path to open. Display path may be the display path of an already open (and possibly untitled) document.
viewType - String
optional default "editor", the type of view to create for the openned path. It is ignored if the displayPath indicates an already open view.
callback - Function
optional, to be called when the asynchronous load is complete. This will only be called if this opens or switches to an editor view, e.g. this won't be called for a kpf file. The view will be passed as an argument to the function.
open a file picker, and open the files that the user selects
viewType - String
urls - urls.concat()
Open Komodo's Start Page - the view will be opened synchronously.
open a file picker, and open the templates that the user selects. This allows editing the templates, it is not for creating new files from templates.
viewType - String
Asynchronously open the URI in a new Komodo tab, if the file is already open then this existing tab becomes the currently focused tab. If you need the view for the file that is opened from this call, pass in a callback function argument and then this function will be called after the view is opened (or re-focused if it was already open).
uri - String
the path or URI to open
viewType - String
optional default "editor" type of view component to use. Values can be [ "editor", "browser", "diff" ].
skipRecentOpenFeature - Boolean
optional default false, can be used when the URI to open is a project file to specify that the feature to open files in that project should not be offered.
callback - Function
optional, to be called when the asynchronous load is complete. This will only be called if this opens or switches to an editor view, e.g. this won't be called for a kpf file. The view will be passed as an argument to the function.
tofile - Boolean
selectionOnly - Boolean
Returns - Boolean
active - _activeView
The active view is the last project view to have received focus. It does not mean that the view currently has focus.
BaseManager - BaseManager
extensionManager - projectExtensionManager
manager - projectManager
managers - Array
Returns - s_new
Returns - fixedLines.join()
item - ko.projects.active.getSelectedItem()
parent - ko.projects.active.manager.getCurrentProject()
Returns - Boolean
parent - ko.projects.active.getSelectedItem()
Returns - this.addSimplePart()
Returns - Boolean
Returns - ko.projects.addItem()
parent - ko.projects.active.getSelectedItem()
parent - ko.projects.active.manager.getCurrentProject()
Returns - snippet
parent - ko.projects.active.getSelectedItem()
parent - ko.projects.active.manager.getCurrentProject()
async - part.getBooleanAttribute()
Returns - Boolean
Returns - Boolean
view - ko.views.manager.getViewForURI()
folder - Boolean
Returns - Boolean
Returns - items
findPart find a part in the toolboxes and/or a specifid part's project
type - String
name - String
where - String
one of "container", "toolbox", "shared toolbox", "toolboxes" or "*" where "*" means "current part project, toolbox, shared toolbox"
part - koIPart
defaults to the running macro if available
Returns - koIPart
Given a ID, look in the projects and toolboxes until you find the first part with that id (the id allocation scheme guarantees there will be at most one) and return it. Return null on failure to find such a part.
Returns - gPartSvc.getPartById()
Returns - parts
parent - parent.parent
does the active view have real focus, if so, return it, otherwise null.
Returns - ko.projects.active.manager
Returns - Boolean
Returns - Boolean
filename - ko.filepicker.openFile()
Given a koIPart, invoke it (do it's "double-click" action) through whatever code path is appropriate for that part -- i.e. snippets get inserted, commands get run, etc.
Given the ID of a part, find it and invoke it.
Returns - Boolean
skipRecentOpenFeature - Boolean
part - part.parent
Returns - Boolean
items - pview.getSelectedItems()
Returns - Boolean
Recursively removes virtual files and folders, but does not remove any folders that have been added manually or parts that are not files or folders (i.e. snippets, macros, etc...). This function will also remove any manually added files, that were not added as part of the import process, because there is not way to tell manually added files and imported files apart.
Returns - items
Returns - Boolean
view - ko.views.manager.currentView
Returns - enteredUndoableTabstop
Prepare to close Komodo. Return false if cannot yet close Komodo. If there are processes still running then must wait for or kill them.
Returns - Boolean
Keep a list of processes spawned by the RunCommand system. This is necessary to ensure that there are no hangs when Komodo closes because some process is still running. Before closing Komodo all process must be terminated.
Run the given command.
parseOutput - Boolean
parseRegex - String
showParsedOutputList - Boolean
clearOutputWindow - Boolean
saveInMRU - Boolean
saveInMacro - Boolean
Returns - Boolean
Run an "encoded" command. An encoded command is a string that describes the command and possibly a number of optional arguments. The encoding is defined by koIRunService.Decode().
Returns - Boolean
Remove any processes that have terminated from the list.
The interface for using the run output window (where run command output goes to, in the bottom pane of the Komodo workspace). Expected usage: - Someone calls ko.run.output.initialize() at startup and ko.run.output.finalize() at shutdown. - When a command is to be run in the output window do this: * announce intention to start session ko.run.output.startSession(...); *... setup and start running the actual command calling * ko.run.output.getTerminal() and ko.run.output.show() as needed ko.run.output.setProcessHandle(p); * to allow user to kill process *... setup ko.run.output.endSession() to be run when the process * terminates.
Complete a terminal session. The command exited with the given value.
Returns - _gTerminalHandler
Kill the process currently running in the output window's terminal, if any.
event - Event
Pass a koIRunProcess reference to the output window so it can manipulate the process that is being run in its terminal, if necessary.
Show the command output window. "editor" is the XUL window holding the command output window. "showParseOutputList" is a boolean indicating whether to show the tree parsed output list.
Start a terminal session in the output window with the given command. This raises an exception if the run output window is currently busy. "command" is the command being run (note that this is the command string *for display* which might be slight different -- passwords obscured -- than the actual command) "parseOutput" is a boolean indicating whether to parse output lines "parseRegex" is the regular expression to use to parse output lines "cwd" is the directory in which the command is being run (note: ditto *for display* subtlety withh "command") "filename" is the current editor filename (if any) "clearContent" is a boolean indicating whether to clear the output window content (by default "true", i.e. the window _is_ cleared).
clearContent - Boolean
event - Event
event - Event
Returns - Boolean
Add the supplied urls to SCC.
sccSvc - Components.interfaces.koISCC
SCC service instance.
urls - Array
The list of urls to be added.
postCallback - Function
Function to be called on completion.
Checkout a SCC repository.
checkoutFolder - String
(optional) Initial checkout directory.
Commit the changes for the supplied urls into SCC.
sccSvc - Components.interfaces.koISCC
SCC service instance.
urls - Array
The list of urls to be commited.
message - String
The checkin message.
postCallback - Function
Function to be called on completion.
Perform a diff revisions, and display the results.
sccSvc - Components.interfaces.koISCC
SCC service instance.
urls - Array
The list of urls used.
additionalOptions - String
Additional diff command options.
postCallback - Function
Function to be called on completion.
Perform a diff revisions, and display the results.
sccSvc - Components.interfaces.koISCC
SCC service instance.
uri1 - String
The second file uri to diff against.
version1 - String
Version of the first file to use.
version2 - String
Version of the second file to use.
filepath - String
Local path of the file used to diff.
additionalOptions - String
Additional diff command options.
postCallback - Function
Function to be called on completion.
Edit the supplied urls under SCC.
sccSvc - Components.interfaces.koISCC
SCC service instance.
urls - Array
The list of urls to be edited.
postCallback - Function
Function to be called on completion.
Get the available scc names and components.
Returns - Array
Return the SCC services that can handles the supplied koIFile. If Komodo has not yet checked the supplied file for SCC support then it is possible this function will return with no matching service even though the file may be under a SCC system. XXX - How to avoid this, force the fileStatusService to check the file?
koIFile - Components.interfaces.koIFileEx
File needing SCC support.
Returns - Components.interfaces.koISCC
Return the SCC services that can handles the supplied koIFile. If Komodo has not yet checked the supplied url/file for SCC support then it is possible this function will return with no matching service even though the file may be under a SCC system. XXX - How to avoid this, force the fileStatusService to check the file?
url - wstring
Url to get the handling SCC services for.
Returns - Components.interfaces.koISCC
Load the SCC history dialog for the given urls.
sccSvc - Components.interfaces.koISCC
SCC service instance.
urls - Array
The list of urls.
localRevisions - Array
The matching list of current scc file versions, must be one for every url.
Remove the supplied urls from SCC.
sccSvc - Components.interfaces.koISCC
SCC service instance.
urls - Array
The list of urls to be removed.
postCallback - Function
Function to be called on completion.
Revert (undo changes for) the supplied urls in SCC.
sccSvc - Components.interfaces.koISCC
SCC service instance.
urls - Array
The list of urls to be added.
postCallback - Function
Function to be called on completion.
Update the supplied urls for latest SCC contents.
sccSvc - Components.interfaces.koISCC
SCC service instance.
urls - Array
The list of urls.
postCallback - Function
Function to be called on completion.
Warn the user about enabling CVS and SVN SSH integration.
Adds text to the SCC output panel.
text - String
The output text to be added.
Clear all the text in the SCC output panel.
One off initialization of the SCC output panel text.
Add the description and text to the SCC output panel.
actiondescription - String
Title description of text.
actiontext - String
The text to add to the SCC output panel.
Report the SCC command results in the main Komodo SCC output panel.
sccSvc - Components.interfaces.koISCC
SCC service instance.
cmdName - String
The name of the scc command.
urls - Array
The list of urls used.
text - String
The command output text.
Show the main Komodo SCC output panel, will ask if the user wants to see it.
manager - Sleuth
tabManager - SleuthResultsTabManager
Returns - Boolean
Returns - Boolean
Returns - Boolean
Returns - Boolean
Returns - Boolean
Returns - Boolean
Returns - Boolean
Returns - Boolean
Returns - Boolean
Returns - Boolean
Returns - Boolean
Returns - Boolean
Returns - this
_sectionActive - Boolean
_sectionHaveDoneFirstSearch - Boolean
_sectionSelectedIndex - Number
AddMessage Post a message to the status bar message area. "msg" is the message string. An empty string or null indicates that the message (of the given category) should be cleared. "category" is the message group to which the message belongs. It is an arbitrary string (it must be at least one character). "timeout" is the amount of time, in milliseconds, that the message should appear. A value of 0 indicates that the message does not timeout. "highlight" is a boolean indicating whether the message should be highlighted on the status bar. "interactive" is a boolean indicating whether the message corresponds to an interactive prompt (such as interactive search). These have higher 'priority' over non-interactive messages in case of conflict. A structure similar to a stack of status messages is maintained. The latest message is always shown. When/if it timesout then the previous message is the stack is displayed. There can only be one message per category, so reusing a category allows for removal of status messages that are no longer appropriate. To add a message that does not timeout: ko.statusBar.addMessage("hello there", "my_category", 0, false) To remove that message: ko.statusBar.addMessage(null, "my_category", 0, false) To add a highlighted message for three seconds: ko.statusBar.addMessage("hello there", "my_category", 3000, true)
Clear clear all statusbar elements
ClearCheck clear the syntax checking status
dump dump the current message stack to stdout
event - Event
Returns - _sysUtils.byteLength()
Returns - _sysUtils.charIndexFromPosition()
text - text.replace()
Returns - String
value - part.slice().replace().replace()
Return a copy of s with the leading and trailing whitespace removed.
Returns - String
Returns - newtext
Returns - newValue
backrefNum - backrefNum
backrefNumber - backrefNumber
indicator - indicator
isBackref - isBackref
isBackrefAnchor - isBackrefAnchor
message - msg
snippet - snippet
text - String
Returns - indicatorEnd
Returns - Boolean
isBackref - Boolean
Are we the first string to be added in a linked tabstop?
Remove linked tabstops from the document.
view - ko.views.manager.currentView
Remove all traces of tabstops from the view and document.
Returns - Array
This method creates non-empty tabstops where only a zero-width indicator link was found. It's necessary because the indicator might be detected when 'a' is typed like so: a<*> but by the time it's processed, the user has typed 'sd', leading to this situation: asd<*> In this case, only the 'd' is found to be next to a zero-width indicator, so the 'a' and 's' don't appear in the other tabstops. This function fixes that.
Watches for backspace at the start of a tabstop. Further comments in the code.
Similar to handleBackspace, but watches for delete actions at the right of the indicator. This routine is simpler: if we're about to step on the TSCZW indicator at the end of a linked tabstop, it's time to unlink them.
If we're removing a full TSC, but not the trailing TSCZW, remove the linked items anyway. Otherwise we end up in a state where modifying the parent text doesn't affect the linked tabstops, but if we append at this point, the other tabstops get the update. It's asymmetrical, so we'll unlink.
Returns - finalLen
When the user presses the tab key, this method first determines if there is a current set of linked tabstops to unlink, and then finds the next tabstop to visit. If that tabstop is the head of a set of tabstops linked by the same backref, it colors each tabstop with the TSC indicator ("Tabstop Current"), and also places an invisible TSCZW indicator to the right of each one, to allow the user to delete TSC-indicated text.
Returns - Boolean
Parse a stream of pieces of text and tabstop.
Returns - Object
Returns - tabstop_re.test()
When the user makes a modification in a document with tabstops, this routine handles the change. It handles two main events: 1. The first linked tabstop has changed. All other linked tabstops are updated with the new value. 2. Text containing indicators is about to be deleted. This routine removes the appropriate entries from the view's tabstopIndicatorTable.
availIndicators - Array
endingIndicatorsInUse - Array
idx - Number
lastIndicatorInUse - indicator
lim - liveText.length
nestedIndicatorsInUse - Array
subjectText - liveText
Returns - retStrParts.join()
Returns - this.subjectText.substr()
Returns - Node
isInner - Boolean
Returns - ko.tabstops.LiveTextPlain
Exception object. The message field gives a specific message.
constructor - Error.constructor
Inserts the contents of parsed liveText into the buffer
Returns - Number
Returns - indent
Returns - ko.stringutils.bytelength()
Returns - indent
Returns - insertLiveTextPartHelper()
Returns - indent
Returns - insertLiveTextPartHelper()
Returns - indent
Returns - ko.tabstops.insertEmptyIndicator()
Returns - parts.join()
Returns - len
Returns - indent
Returns - insertLiveTextPartHelper()
isBackref - Boolean
Returns - s
scc - changelistManager
toolboxBaseManager - toolboxBaseManager
user - toolboxManager
name - command
In a discussion btwn DavidA and TrentM it was decided that the shared toolbox behaviour should be the following (in light of the possibility that the current Komodo user might not have permissions to write to the shared toolbox location): - If the useSharedToolbox pref is false, then shared toolbox support is off. - Else if the shared toolbox file exists then shared toolbox support is on. - Else if the user DOES have access to write to the shared toolbox file location then a blank one is created (as for the normal Toolbox) and shared toolbox support is on. - Else (useSharedToolbox is true, the shared toolbox file does not exist and the user does NOT have write access) shared toolbox support is turned off. Update the shared toolbox state (i.e. enable or disable it).
Returns - _tracer
constructor
myPerfTimer - Object
perfLog - Number
timelineService - Components.interfaces.nsITimelineService
reset - Boolean
focusToo - Boolean
event - Event
Returns - _buttonTextShowing
Returns - Boolean
Returns - Boolean
prefs - gPrefs
prefs - gPrefs
force - Boolean
collapseIfFocused - Boolean
buttonTextShowing - broadcaster.hasAttribute()
Functions to convert/parse strings representing URLs, files, etc. This is basically a loose shim around class URIParser in URIlib.py (somewhat obtusely via koIFileEx). Routines: ko.uriparse.localPathToURI(<localPath>) ko.uriparse.pathToURI(<URI or localPath>) ko.uriparse.URIToLocalPath(<URI or localPath>) ko.uriparse.displayPath(<localPath or URI>) ko.uriparse.baseName(<localPath or URI>) ko.uriparse.dirName(<localPath or URI>) ko.uriparse.ext(<localPath or URI>) Dev Notes: - This module caches a single koIFileEx instance to, presumably, speed things up.
Show the dialog for creating a new mapped URI with the supplied uri and path arguments.
uri - String
The URI to add a mapping for.
path - String
The path the URI will be mapped to.
Returns - Boolean
Get the basename (a.k.a. leafName) of the given file. "file" can be a local filename or URI. Examples: file:///D:/trentm/foo.txt -> foo.txt D:\trentm\foo.txt -> foo.txt ftp://ftp.activestate.com/ActivePython -> ActivePython
Returns - koFileEx.baseName
Return the common URI prefix of the given list of URIs.
uris - Array
Returns - commonprefix
Get the dirname of the given file. "file" can be a local filename or URI referring to a local file. Examples: file:///D:/trentm/foo.txt -> D:\trentm D:\trentm\foo.txt -> D:\trentm ftp://ftp.activestate.com/ActivePython -> throws exception
Returns - koFileEx.dirName
Get an appropriate representation of the given URI for display to the user. "uri", typically, is a URI, though it can be a local filename as well. Examples: file:///D:/trentm/foo.txt -> D:\trentm\foo.txt D:\trentm\foo.txt -> D:\trentm\foo.txt ftp://ftp.activestate.com/ActivePython -> ftp://ftp.activestate.com/ActivePython
Returns - koFileEx.displayPath
Get the extension of the given file. "file" can be a local filename or URI
Returns - koFileEx.ext
DEPRECATED: Was once used to ensure URI's were properly formatted.
Returns - uri
This is a reverse of getMappedURI. Return a unmapped URI if there is a pref setup to match the given path, else return whatever was passed in. Note: If a mapping existed, the return result is *always* a URI.
path - String
The path or URI to check for uri mappings.
prefs - Components.interfaces.koIPreferenceSet
Optional. The preference set to check against.
Returns - String
Uses the supplied URI to check if there are any special mappings setup in order to change this URI into another location. If there is a match, return the new URI, else return the original URI.
uri - String
The URI to check.
prefs - Components.interfaces.koIPreferenceSet
Optional. The preference set to check against.
Returns - String
Get the URI representation of the given local file path. "localPath" must be a local file path. Returns the URI for the given path or raises an exception if "localPath" is not a local path. Returned URIs are normalized ("x/./y" => "x/y", etc.) Examples: D:\trentm\foo.txt -> file:///D:/trentm/foo.txt \\planer\d\trentm\tmp\foo.txt -> file://planer/d/trentm/tmp/foo.txt file:///D:/trentm/foo.txt -> throws exception ftp://ftp.activestate.com/ActivePython -> throws exception
Returns - _normalizedPathToURI()
Get the URI representation of the given local file path or URI "path" must be a local file path or a URI Returns the URI for the given path or the URI if one was passed in. Returned URIs are normalized ("x/./y" => "x/y", etc.) Examples: D:\trentm\foo.txt -> file:///D:/trentm/foo.txt file:///D:/trentm/foo.txt -> file:///D:/trentm/foo.txt ftp://ftp.activestate.com/ActivePython -> ftp://ftp.activestate.com/ActivePython
Returns - _normalizedPathToURI()
Get the local file path for the given URI. "uri" may be a URI for a local file or a local path. Returns the local file path or raises an exception if there is no local file representation for that URI. Note: I would rather this explicitly raised if "uri" were a local path, but koIFileEx does not work that way. Examples: D:\trentm\foo.txt -> D:\trentm\foo.txt file:///D:/trentm/foo.txt -> D:\trentm\foo.txt ftp://ftp.activestate.com/ActivePython -> throws exception
Returns - koFileEx.path
manager - ko.views.viewManager
Get the view manager.
viewManager - viewManager
Shared code that returns a label and tooltip based on the path info, and other pertinent info on the state of the document/view object.
baseName - String
dirName - String
lineNo - Number
- one-based line number
tabId - String
- Komodo tab id
viewType - String
- editor/browser/startpage/...
sectionTitle - String
showDirty - Boolean
Returns - String
Shared code that returns a label and tooltip based on the supplied view, suitable for a menuitem.
view - Object(koIScintillaView)
lineNo - Number
- one-based line number
showDirty - Boolean
- put a "*" in the label if the view's document is dirty
sectionTitle - String
- optional string that describes a location.
Returns - Array
Returns - Boolean
pos - scimoz.positionAfter()
Returns - pos
view history controller Recently-visited views: The viewhistory object maintains a stack of recently visited lists. This information can be used to switch to recent views. The semantics of the following methods are as follows: - .getNextMostRecentView() and .getNextLeastRecentView() are used by the buffer switching commands to know which views to switch to. - .enterBufferSwitchingSession() and .exitBufferSwitchingSession() are called by the buffer swiching commands to help .setMostRecentView() know how to behave (the "recent views" stack is NOT updated during such a session). Note that .enter...() may be called multiple times for one .exit...() call. - .setMostRecentView() is called by the view manager's .selectView() and can be called directly by the buffer switching commands for proper session handling. NOTE: THIS BEHAVIOR IS TURNED OFF BY SETTING "handlestctrltab" to false on the tabbed view.
_currentView
_keylistener
_observingCtrlKeyUp - Boolean
_recentViews - Array
_timeout - objectTimer
constructor
inBufferSwitchingSession - Boolean
log - ko.logging.getLogger()
Returns - currIndex
event - Event
event - Event
Returns - view
Returns - view
Returns - state
event - Event
event - Event
event - Event
event - Event
Returns - menuitem
view_checkDiskFiles is only called from the window's focus handler, located in komodo.xul. it handles checking if any files have changed.
event - Event
Returns - Boolean
does scintilla have focus? Return the scintilla widget
Returns - Element
does any view widget have focus? return which one does or null
Returns - Element
get the current working directory for the window, which is the directory of the current buffer, or the home directory of the user
Returns - String
Close all open windows (or just children of a given parent window). The normal goQuitApplication function in toolkit does this, but we want to prevent quitting if one of the dialogs prevents shutdown by not closing.
parent - Window
An optional argument to only close windows that are children of this window.
Returns - Boolean
Close children of the current main Komodo window.
Returns - this.closeAll()
Returns - args
Return a "fixed-up" version of the "features" argument for window.openDialog(). This tweaks the string on Mac OS X to ensure the dialog is *not* opened as a sheet.
features - String
The features string to fixup. Pass in null to get a reasonable default.
Returns - features
return a reference to the main Komodo window
Returns - wm.getMostRecentWindow()
Returns an array of all Komodo windows that are currently open.
Returns - Array
return true if this is the only Komodo window open
An alternative version of window.openDialog() that does some fixups that Komodo wants in general.
Returns - window.openDialog.apply()
Open a window if no windows of windowType exist. Otherwise, bring the window of windowType to the front. Parameters for this function are identical to window.openDialog()
Returns - window.openDialog.apply()
Returns - Boolean
Returns - _restoreInProgress
restore all workspace preferences and state, open files and projects
currentWindow - ko.windowManager.getMainWindow()
idx - parseInt()
save all workspace preferences and state
importNS import one namespace into another
to - from[i]
include include an xtk namespace
load load a JavaScript file into the global namespace or a defined namespace
uri - String
uri to a JavaScript File
obj - Object
object to load the JavaScript into, if undefined loads into global namespace
debug - Number
mSelection - s
mSelectionCallback - f
mSingleSelect - Boolean
mSortType - Number
mTotalRows - Number
mTree - tree
rowCount
selection
selectionCallback
singleSelect
Returns - Boolean
Returns - String
Returns - Number
Returns - Number
Returns - Boolean
Returns - Boolean
Returns - Boolean
Returns - Boolean
Returns - Number
Returns - this
Returns - result
event - Event
Returns - result
_debug - Number
_rows - Array
_sortCaseInsensitive - Boolean
_sortColumn - column
_sortDirection - Number
rowCount
rows
SORT_ASCENDING - Number
SORT_DESCENDING - Number
tree - out
Returns - String
Returns - Number
Returns - Boolean
Returns - Boolean
Returns - Boolean
Returns - Boolean
Returns - Boolean
Returns - Boolean
Returns - this
col - this.tree.columns.getFirstColumn().element
sortDirection - xtk.dataTreeView.SORT_ASCENDING
Useful clipboard functions.
Returns - supportCString
Returns - String
Add a text flavor (eg html or plain text) to a transferable object, if passed transferable is null or not defined a new one is created. Returns the tranferable object.
flavor - String
The mime-type flavor (eg "text/html").
text - String
The text to add.
transferable - Components.interfaces.nsITransferable
(Optional) The tranferable to use, if null a new object is created.
Returns - Components.interfaces.nsITransferable
Check if clipboard contains at least one of passed formats (ie flavor). Returns true if clipboard contains one of passed flavor, false otherwise.
flavors - Array
Mime-type strings (eg ["text/html", "text/unicode"])
Returns - Boolean
Check if clipboard contains text in HTML format. Returns true if clipboard contains HTML text, false otherwise.
Returns - Boolean
Copy to clipboard using a tranferable object, this allows to copy text in multiple format for example the same text as HTML and plain text.
transferable - Components.interfaces.nsITransferable
The tranferable object
Create a transferable object useful to copy multiple formats to clipboard and return with it.
Returns - Components.interfaces.nsITransferable
Get HTML source code from clipboard.
Returns - String
Get plain text from clipboard.
Returns - String
Set the clipboard to contain the plain text provided.
text - String
The text to copy to clipboard.
black - this.RGB()
blue - this.RGB()
brightness - Number
gamma - Number
green - this.RGB()
red - this.RGB()
topScale - Number
white - this.RGB()
yellow - this.RGB()
hexToLong Converts a color of the form #ffaabb to a long
hexstring - String
Returns - Number
RGB covert rgb value into a long int
Returns - Number
Returns - Math.floor()
Returns - r
Returns - this.NanometerToRGB()
__END__
is this element or an ancestor focused?
Returns - Boolean
is the focused element, or it's ancestor a element with a matching localName?
localName - String
Returns - Element
Returns - _handlers[tooltipName]
LOG_CRITICAL - Number
LOG_DEBUG - Number
LOG_ERROR - Number
LOG_INFO - Number
LOG_NOTSET - Number
LOG_WARN - Number
name - name
Returns - _logs[name]
recurse - Number
compress - Boolean
level - Number
Returns - s
constructor - xtk.logging.Logger
lastErrorMsg - str
level - Number
str - str