editor - editor_controller_instance
prefs - Components.interfaces.koIPreferenceSet
Komodo global preferences object.
skin - ko.skin
version - String
args - args
func - func
instance - instance
interval - window.setInterval()
running - Boolean
timeout - window.setTimeout()
timer - Number
_loadCustomSkinQueue - Array
_loadCustomSkinTimer - setTimeout()
_virtualStyles - Object
gtk - Object
GTK specific functionality
PREF_CUSTOM_ICONS - PREF_CUSTOM_ICONS
PREF_CUSTOM_SKIN - PREF_CUSTOM_SKIN
PREF_EDITOR_SCHEME - PREF_EDITOR_SCHEME
PREF_SCHEME_SKINNING - PREF_SCHEME_SKINNING
PREF_USE_GTK_DETECT - PREF_USE_GTK_DETECT
shouldFlushCaches - Boolean
Returns - Boolean
Returns - loadIntoWindow()
Constructor Offloads the loading of a custom skin to gtk if available, otherwise calls it manually using the skin preference
Load a custom skin
uri - String
Load the skin the user has stored as his preference (if any)
Load the skin the user has stored as his preference (if any)
Preference Observer
subject - Object
topic - String
data - String
Unload a custom skin
uri - String
_allowedStylesNameSets - Array
_cachedAllowedStylesForLanguage - allowedStyles
_isWordChar_re
_textLikeLanguages - Array
log - ko.logging.getLogger()
Returns - this._cachedAllowedStylesForLanguage[languageName]
Returns - scimoz.getStyleAt()
Returns - Boolean
Returns - snippet
languageObj - Components.interfaces.koILanguageRegistryService.getLanguage()
Returns - Array
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 to scope the search. Optional.
Returns - Boolean
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.koITool
Returns - firstPos
Insert an abbreviation snippet into a buffer.
snippet - Components.interfaces.koITool
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.
exObj - Object
-- if it exists and trying to insert a snippet throws an exception, set exObj.value to the exception.
Returns - Boolean
event - Event
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)
cmdId - cmdId.getAttribute()
Returns - rc
event - Event
Returns - Boolean
node - top.document.getElementById()
controller - top.document.commandDispatcher.getControllerForCommand()
Returns - found
yesNo()
options - String
Returns - ko.dialogs.authenticate2()
Returns - Object
style - String
Returns - obj.response
mruName - String
interpolateValues - Boolean
Returns - obj.response
Pick a HTML preview File/URL for the given file.
url - String
Indicate the file to preview.
language - String
The language of the current file. If this is not specified it will be automaticxally determined from the URL.
mode - String
One of "previewing" or "setting". The UI is slightly different depending on whether the preview file/URL is being sought to immediately _use_ it or to just set it. The default is "previewing".
browserType - String
The browser type to preview with. Must be one of "default", "komodo", "firefox", "safari", "chrome", "opera", "ie". If the dialog is cancelled it returns null. Otherwise it returns an object with the following attributes: .preview The file or URL to use to preview the given URL. Note that this may be the given URL itself. .browserType When a browser choice was made, the value of that choice. .remember A boolean indicating if the current setting should be remembered so this picker need not be called again.
Returns - Object
is_cancellable - Boolean
modal - Boolean
Returns - newName
selectionCondition - String
yesNoCancel - Boolean
Returns - obj.response
response - String
style - String
Returns - obj.response
genericSupportedFlavours - Array
KoDropData - KomodoDropData
Class instance to hold dropped Komodo data.
windowSupportedFlavours - this.genericSupportedFlavours.concat()
event - Event
Returns - Boolean
Convert the Komodo dropped data - this may involve: o viewing the source of HTTP urls o converting mapped urls o treating dropped URLs as text
koDropDataList - Array
- Array of KomodoDropData items.
Returns - Array
Returns - Boolean
event - Event
Returns - Boolean
event - Event
Returns - Boolean
Open all Komodo dropped files or URLs and then return the unhandled list of koDropData items.
koDropDataList - Array
- Array of KomodoDropData items.
Returns - Array
Unpack the dropped data into a Komodo specific data structure.
dataTransfer - Ci.nsIDOMDataTransfer
- The data.
acceptedFlavours - Array
- Optional - list of supported data types.
Returns - Array
A dialog to pick a directory, and put the directory path into a XUL textbox.
textbox - Element
Pick an executable file for open.
title - String
Returns - String
Browse for a file.
Returns - String
Pick multiple files.
defaultDirectory - local.osPathSvc.dirname()
title - String
Returns - Array
A dialog to pick a remote directory and put the path into a XUL textbox.
textbox - Element
path - local.osPathSvc.dirname()
Returns - local.osPathSvc.exists()
Pick a directory/folder.
defaultDirectory - _get_defaultDirectory()
Returns - String
Use the prefs system to track default dirs for particular calls to the various file-pickers. Goal: avoid defaulting to the last dir used by a different file-picker client.
label - String
dir - String
Returns - String
DEPRECATED: Same as ko.filepicker.browseForExeFile.
Returns - ko.filepicker.browseForFile.apply()
DEPRECATED: Same as ko.filepicker.browseForFile.
Returns - ko.filepicker.browseForFile.apply()
DEPRECATED: Same as ko.filepicker.browseForFiles.
Returns - ko.filepicker.browseForFiles.apply()
Open remote file(s) Same parameters meanings as "ko.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 - Ci.nsIFilePicker.modeOpen
title - local.bundle.GetStringFromName()
defaultFilterName - Array
filterNames - Array
helpTag - String
Returns - Object
Choose remote filename to save as Same parameters meanings as "ko.filepicker.remoteFileBrowser" (above) Returns the remote url of the selected file, or null if the dialog is cancelled.
Pick a file for save.
defaultDirectory - local.osPathSvc.dirname()
title - String
Returns - String
Use the prefs system to track default dirs for particular calls to the various file-pickers. Goal: avoid defaulting to the last dir used by a different file-picker client.
label - String
path - String
Returns - String
fname1 - fname1.replace()
fname2 - fname2.replace()
classes - Cc
interfaces - Ci
utils - Cu
Make the view for this find result current if necessary. XXX Note that we are presuming that Komodo does not yet allow multiple views per document, which it eventually will. When this is possibly we must switch to storing unique view IDs in the find session. XXX We are currently using view.koDoc.displayPath as the view's "unique id". The view system does not currently provide a way to getViewFromDisplayPath() so we roll our own.
Find all instances of "pattern" with "replacement" in the current view context. Note: koIFindSession.StartFind() is skipped because we don't need to use this state mechanism to know when to terminate the session. Session termination is handled via .NoteUrl() and .HaveSearchedThisUrlAlready(). No return value. XXX: This internal method is required by the TODO addon.
Return the view after this one appropriate for searching. If there is no such view (e.g. only one view), then return null. Dev Note: This in very inefficient for a lot of open files. XXX: Once all view types have viewIds we can do this more properly. I.e. don't default to 'editor' view 0 as the "next" view for any non-'editor' view. XXX: This internal method is required by the TODO addon.
Returns - searchableViews[nextIndex]
Return the view before this one appropriate for searching. If there is no such view (e.g. only one view), then return null.
Returns - searchableViews[prevIndex]
Returns - scimoz
Mark all instances of "pattern" with "replacement" in the current view context. Note: koIFindSession.StartFind() is skipped because we don't need to use this state mechanism to know when to terminate the session. Session termination is handled via .NoteUrl() and .HaveSearchedThisUrlAlready(). Returns true if hits were found in the view, false otherwise.
Returns - foundSome
Mark all the given find results.
Replace all instances of "pattern" with "replacement" in the current view context. Note: koIFindSession.StartReplace() is skipped because we don't need to use this state mechanism to know when to terminate the session. Session termination is handled via .NoteUrl() and .HaveSearchedThisUrlAlready(). Returns the number of replacements made.
Returns - numReplacements
Replace the last find result in the current find session, if there is one and if it is genuine and current. No return value.
Setup (i.e. do all the right things for find-session maintenance) and find the next occurrence of "pattern".
editor - {DOMWindow
the main Komodo window in which to work, or the view to work with
context - koIFindContext
defines the scope in which to search, e.g., in a selection, just the current doc, all open docs. (if editor is a view, context.type cannot be FCT_ALL_OPEN_DOCS)
pattern - String
the pattern to search for.
mode - String
either 'find' or 'replace'. The maintenance of a find session needs to know if a find-next operation is in the context of finding or replacing.
check_selection_only - Boolean
can be set true to have only consider the current selection in the document. This is used to handle the special case of priming a find-session for "Replace" when the current selection *is* the first hit. By default this is false.
Returns - koIFindResult
Report the completion of a find session to the user.
context - DOMWindow
is the koIFindContext for the find session.
msgHandler - callback
is a callback for displaying a message to the user. See ko.find.findNext documentation for details.
Report an error in the find service to the user.
context - String
A short string giving context for the error, e.g. "find", "find all", "replace", ...
exc - exception
is an optional exception, if the error was trapped via try/catch. May be null.
msgHandler - callback
is a callback for displaying a message to the user. See ko.find.findNext documentation for details. The actual error message is pulled from the koILastErrorService.
Find all occurrences of the given pattern.
editor - window
- a reference to the komodo.xul main window
context - Components.interfaces.koIFindContext
- a koIFindContext
pattern - String
- the pattern being sought
patternAlias - String
- shortened version of the pattern in use
msgHandler
highlightMatches - Boolean
(optional) when set, will highlight *all* matches in the context using a scintilla indicator.
Returns - Boolean
Find all hits in files.
editor - DOMWindow
the main Komodo window in which to work
context - Components.interfaces.koIFindContext
pattern - String
the pattern to search for.
patternAlias - String
a name for the pattern (for display to user)
msgHandler - callback
is an optional callback for displaying a message to the user. See ko.find.findNext documentation for details.
Returns - Boolean
Called by macros -- only difference with ko.find.findAll is that contexttype is a constant, the context needs to be created, and options need to be set (and unset). XXX the APIs should be factored out so that these "inmacro" versions aren't necessary.
Find (and move to) the next occurrence of the given pattern.
editor - {window
- a reference to the komodo.xul main window, or a scintilla view in which to search
context - Components.interfaces.koIFindContext
- a koIFindContext
pattern - String
- the pattern being sought
mode - String
(optional) is either "find" (the default) or "replace", indicating if this is in the context of a replace UI.
quiet - Boolean
(optional) is a boolean indicating if UI (e.g. dialogs) may be used for presenting info, e.g. wrapped the document. Interactive search typically sets this to true. Default is false.
useMRU - Boolean
(optional) is a boolean indicating if the pattern should be loaded into the find MRU. Default is true.
msgHandler
highlightMatches - Boolean
(optional) when set, will highlight *all* matches in the context using a scintilla indicator.
highlightTimeout - Number
(optional) the maximum number of milliseconds to spend highlighting before giving up; defaults to using the user-specified preference value.
displayResultCallback - ko.find._displayFindResult
Returns - Boolean
Called by macros -- only difference with ko.find.findNext is that contexttype is a constant, and the context needs to be created. XXX the APIs should be factored out so that these "inmacro" versions aren't necessary.
Return a callback appropriate for the 'msgHandler' callbacks that will put a message on the status bar.
Highlight all additional find matches.
pattern - String
- the pattern being sought
timeout - Number
- [optional] number of milliseconds before timing out
Returns - Boolean
Clear all of the current find and replace highlights.
scimoz - Components.interfaces.ISciMoz
- The scimoz instance.
Clear any find highlights in the edited region.
scimoz - Components.interfaces.ISciMoz
- Scintilla instance.
position - Number
- The scimoz position (byte position)
length - Number
- The number of affected bytes at this position.
Check to see if find highlighting is enabled.
Returns - Boolean
Bookmark all occurrences of the given pattern.
editor - window
- a reference to the komodo.xul main window
context - Components.interfaces.koIFindContext
- a koIFindContext
pattern - String
- the pattern being sought
patternAlias - String
a name for the pattern (for display to user)
msgHandler
Returns - Boolean
Called by macros -- only difference with ko.find.markAll is that contexttype is a constant, and the context needs to be created. XXX the APIs should be factored out so that these "inmacro" versions aren't necessary.
Returns - original.replace().replace().replace()
Replace one occurrence of the given pattern.
editor - window
- a reference to the komodo.xul main window
context - Components.interfaces.koIFindContext
- a koIFindContext
pattern - String
- the pattern being sought
replacement - String
- the pattern to replace with
msgHandler
Returns - Boolean
Replace all occurrences of the given pattern.
editor - window
- a reference to the komodo.xul main window
context - Components.interfaces.koIFindContext
- a koIFindContext
pattern - String
- the pattern being sought
replacement - String
- the pattern to replace with
showReplaceResults - Boolean
- whether to show the results tab
firstOnLine - Boolean
A boolean indicating, if true, that only the first hit on a line should be replaced. Default is false. (This is to support Vi's replace with the 'g' flag.)
msgHandler
highlightReplacements - Boolean
To highlight the replacements made.
Returns - Boolean
Replace all hits in files.
editor - DOMWindow
the main Komodo window in which to work
context - Components.interfaces.koIFindContext
defines the scope in which to search, e.g., in a selection, just the current doc, all open docs.
pattern - String
the pattern to search for.
repl - String
the replacement string.
confirm - Boolean
Whether to confirm replacements. Optional, true by default.
msgHandler - callback
is an optional callback for displaying a message to the user. See ko.find.findNext documentation for details.
Returns - Boolean
Called by macros -- only difference with ko.find.replace is that contexttype is a constant, and the context needs to be created. XXX the APIs should be factored out so that these "inmacro" versions aren't necessary. FCT_CURRENT_DOC = 0, FCT_SELECTION, FCT_ALL_OPEN_DOCS, FCT_IN_FILES, FCT_IN_COLLECTION FOT_SIMPLE = 0, FOT_WILDCARD, FOT_REGEX_PYTHON FOC_INSENSITIVE = 0, FOC_SENSITIVE, FOC_SMART
editor - Object
-- global window object
contexttype - Number
-- one of the following koIFindContext values:
pattern - String
replacement - String
quiet - Boolean
patternType - Number
- one of the following koIFindOptions values:
caseSensitivity - Number
- one of the following koIFindOptions values:
searchBackward - Boolean
matchWord - Boolean
Called by macros -- only difference with ko.find.replace is that contexttype is a constant, and the context needs to be created. XXX the APIs should be factored out so that these "inmacro" versions aren't necessary.
FindController - FindController
managers - manager
Returns - manager
Returns - this.managers[id]
preferredId - Number
_idprefix - String
_journalId - journalId
_opSupportsUndo - opSupportsUndo
_options - options
_pattern - pattern
_patternAlias - patternAlias
_repl - repl
_searchInProgress - Boolean
constructor
context_ - context
doc - widget.contentDocument
id - id
is_locked - Boolean
view - Components.interfaces.koIFindResultsView
Returns - baseDesc
Configure the find results tab with information about the find/replace operation.
pattern - String
the pattern searched for
patternAlias - String
A more user-friendly name for the pattern. Optional, null if no alias.
repl - String
the replacement pattern. Null if this is just a find operation.
context - Components.interfaces.koIFindContext
The search context for this op. (Dev Note: this is reference to a context that can change, so this isn't reliable for 'redo' operations)
options - Components.interfaces.koIFindOptions
Holds the find options. (Dev Note: this is reference to a context that can change, so this isn't reliable for 'redo' operations)
opSupportsUndo - Boolean
Indicates in this find/replace operation supports undo. Optional, default false.
Returns - this._searchInProgress
event - Event
event - Event
Returns - Boolean
Returns - this
Called to indicated that the search operation has completed.
success - Boolean
Indicates if the find/replace was successful.
numResults - Number
The number of find/replace hits. Optional, typically only provided for a successful completion.
numFiles - Number
The number of paths in which there were hits. Optional, typically only provided for a successful completion.
numFilesSearched - Number
The number of paths searched. Optional, typically only provided for a successful completion.
journalId - String
The identifier for the journal for a "Replace All in Files" operation. This is used to support undo. Null if not applicable.
important - Boolean
focus - Boolean
event - Event
event - Event
event - Event
event - Event
Launches the alternate help command.
Opens language specific help for the current buffer.
searchTerm - String
Open language help for this search term.
Open the Komodo memory usage report.
Open the Komodo help window.
page - String
A page tag as defined in toc.xml
Open the Komodo error log for viewing.
_recently_did_history - Boolean
classes - Cc
interfaces - Ci
utils - Cu
event - Event
Common function for moving forward or back
delta - Number
# of hops to make; negative numbers means going back, positive numbers go forward.
explicit - Boolean
if true, the user pressed the "Recent Locations" button. Otherwise they hit the go_back or go_forward command.
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
Note the current location from functions like view.history.setMostRecentView
view - view
An optional view in which to get the current location. If not given the current view is used.
Returns - koILocation
Returns - Number
args - args
enabled - prefs.getBooleanPref()
enabledPrefName - String
endPos - endPos
func - jump_fn
handler - handler
indic_color - indic_color
indic_style - indic_style
lang_names - lang_names
name - name
startPos - startPos
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.
view - Components.interfaces.koIScintillaView
View to check.
position - Number
Position in the scimoz editor.
reason - String
What the triggering event reason was, can be one of "keypress" or "mousemove".
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
Called when the mouse dwells on this hyperlink.
view - Components.interfaces.koIScintillaView
The view instance.
hyperlink - ko.hyperlinks.Hyperlink
The hyperlink instance.
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.
reason - String
What the triggering event reason was, can be one of "keyup", "mousemove", "mouseup" or "blur".
Returns - Boolean
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.
reason - String
What the triggering event reason was, can be one of "keypress" or "mousemove".
Returns - Boolean
named_css_colors - Array
Convert a CSS rgb() color string to an array of [r, g, b, a]
rgb_color - String
The rgb() / rgba() string
Returns - Array
Convert a CSS color specification to hexidecimal representation
color - String
Any CSS color value
Returns - String
Convert a CSS color specification to rgb() representation
color - String
Any CSS color value
Returns - String
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.
reason - String
What the triggering event reason was, can be one of "keyup", "mousemove", "mouseup" or "blur".
Returns - Boolean
Convert a CSS rgb() color string to hex "#nnnnnn"
rgb_color - String
The rgb() string
Returns - String
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.
reason - String
What the triggering event reason was, can be one of "keypress" or "mousemove".
Returns - ko.hyperlinks.Hyperlink
A goto definition hyperlink handler.
constructor
enabled - prefSet.getBooleanPref()
Called when the mouse dwells on this hyperlink.
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.
reason - String
What the triggering event reason was, can be one of "keyup", "mousemove", "mouseup" or "blur".
Returns - Boolean
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.
reason - String
What the triggering event reason was, can be one of "keypress" or "mousemove".
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.
Called when the mouse dwells on this hyperlink.
view - Components.interfaces.koIScintillaView
The view instance.
Activate this hyperlink.
view - Components.interfaces.koIScintillaView
The view instance.
Remove this hyperlink.
view - Components.interfaces.koIScintillaView
The view instance.
reason - String
What the triggering event reason was, can be one of "keyup", "mousemove", "mouseup" or "blur".
Returns - Boolean
Called when the mouse dwells on this hyperlink.
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.
reason - String
What the triggering event reason was, can be one of "keyup", "mousemove", "mouseup" or "blur".
Returns - Boolean
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
limit_to_styles - styleNumbers
regex_match - match
replace_str - replace_str
When checking for a hgyperlink match, the style at the cursor position must match one one of these values.
styleNumbers - Array
- List of style numbers.
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.
reason - String
What the triggering event reason was, can be one of "keypress" or "mousemove".
Returns - ko.hyperlinks.Hyperlink
activestateBugHandler - ko.hyperlinks.RegexHandler
chromePreviewHandler - ko.hyperlinks.ImagePreviewHandler
colorPreviewHandler - ko.hyperlinks.ColorPickerHandler
djangoExtendsHandler - ko.hyperlinks.RegexHandler
djangoRenderViewHandler - ko.hyperlinks.RegexHandler
fileHandler - ko.hyperlinks.RegexHandler
A generic file handler - to help in opening files. Examples: file:///foo/bar.txt /foo/bar.txt C:\foo\bar.txt \\foo\bar.txt Note: This must be the last added file hyperlink handler, so it has a lower priority than the other more specific file handlers - bug 101505.
gotoDefinitionHandler - ko.hyperlinks.GotoDefinitionHandler
imagePreviewHandler - ko.hyperlinks.ImagePreviewHandler
ipAddressHandler - ko.hyperlinks.RegexHandler
jsGetElementByIdHandler - ko.hyperlinks.RegexHandler
networkURIHandler - ko.hyperlinks.RegexHandler
phpIncludeHandler - ko.hyperlinks.RegexHandler
srcHrefHandler - ko.hyperlinks.RegexHandler
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
Return the bounds of the current word from the given scimoz position, based on the type of characters to the left and right of the position.
scimoz - {Components.interfaces.ISciMoz}:
The scimoz editor to retrieve the bounds from.
Returns - Number
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
Return the current word from the current scimoz character position. New version of getWordUnderCursor: allows specification of a position, and also looks at the position's context: on an alnum word, on punctuation, on whitespace, or on a boundary between the two types. Currently not used.
scimoz - Components.interfaces.ISciMoz
(Optional) The scimoz editor to retrieve the word from.
pos - Number
(Optional) The position to get 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
Interpolate '%'-escape codes in the given string.
s - String
The string to interpolate.
bracketed - Boolean
(optional) Whether "s" uses the bracketed interpolate format
queryTitle - String
(optional) Title for any query dialogs raised during interpolation.
Returns - String
DEPRECATED: [DEPRECATED] Interpolate the given string.
Returns - ko.interpolate.interpolateString()
_knownconfigs - Array
commanditems
currentConfiguration - this.prefset.getStringPref()
currentPrefixString - String
currentScheme - this.keybindingSchemeService.getScheme()
document - document
inPrefixCapture - Boolean
keybindingSchemeService
keyDownLabels
keylabel2keysequence - keylabel2keysequence
keysequence2keylabel - keysequence2keylabel
manager - ko.keybindings.Manager
prefset - ko.prefs
_configDirty - Boolean
_configKeyTree - cloneObject()
_configUnsaved - Boolean
_keyPressCaptureWindow - window
_knownconfigs - schemes.value
activeCommands - cloneObject()
command2key - Object
commanditems - Array
commandnames - Array
constructor
currentConfiguration - configName
currentPrefixMap - this.keyTree
currentPrefixString - String
currentScheme - scheme
inPrefixCapture - Boolean
key2command - Object
keyDownLabels
keynames - Array
keyTree - Object
lastcategory - String
prefset - prefset
rownum - Number
desc - desc.replace()
Returns - String
Returns - Boolean
Returns - root
Returns - part
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
isKeyPressEvent - Boolean
Returns - data.join()
event - Event
isKeyPressEvent - Boolean
Returns - possible
event - Event
Returns - Array.isArray()
Returns - this._knownconfigs
keyname - keyname.slice()
event - Event
forceReload - Boolean
Returns - String
Returns - String
Returns - newconfigname
forceReload - Boolean
topic - topic.indexOf()
Parse the keybinding configuration file data into commands. Acitivate the keybinding commands.
forceReload - Boolean
Returns - key
Returns - Boolean
Returns - usedbys
Show Komodo's about dialog.
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
options - Object
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()
Returns - ko.windowManager.openDialog()
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()
watchLocalFile prompt for a file to watch, then open a new watch window
_lastRequestId - Number
_lastTimeoutId - Number
_lintClearOnTextChange - effectivePrefs.getBooleanPref()
classes - Cc
errorString
handleScroll
interfaces - Ci
languageInfo - languageInfo
languageSetup - languageSetup
lintDelay - effectivePrefs.getLongPref()
lintingEnabled - effectivePrefs.getBooleanPref()
lintResults
recalculatingResults - Boolean
utils - Cu
view - view
event - Event
prefset - ko.prefs
_lastRequestId - this._lastTimeoutId
_lastTimeoutId - setTimeout()
_lintClearOnTextChange - this.view.koDoc.getEffectivePrefs().getBooleanPref()
constructor
errorString - request.errorString
lintDelay - this.view.koDoc.getEffectivePrefs().getLongPref()
lintingEnabled - lintingEnabled
lintResults - request.results
recalculatingResults - Boolean
view
reason - String
Returns - _linterLanguageNames[languageName]
alwaysLint - Boolean
Returns - this
Returns - subLanguageList.map().filter().length
_in_display - Number
Returns - a[0]
Returns - newArray
Returns - res
__base_line_no
current - _partSvc.runningMacro
CURRENT_MACRO_VERSION - Number
eventHandler - MacroEventHandler
view - ko.views.manager.currentView
Returns - Boolean
The main toolboxes are loaded, go and initialize the macro triggers.
mode - String
__koNum - val
classes - Cc
interfaces - Ci
utils - Cu
windowIsClosing - Boolean
Is this window being closed?
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. However, this method will be called in procedures that cause Komodo to shut down, such as during updates. It's too late to check if we can quit, but we should still save the workspace and run the willCloseHandlers. See bug 67126 for more details. 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
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); *XXX Do we want to add an optional argument list to pass in?
Remove the given handler from the list of do-close handlers.
Returns - Boolean
MARKERS_MASK_SYMBOLS
MARKNUM_BOOKMARK - Number
MARKNUM_CURRENT_LINE_BACKGROUND - Number
MARKNUM_HISTORYLOC - Number
MARKNUM_INTERACTIVE_PROMPT - Number
MARKNUM_INTERACTIVE_PROMPT_MORE - Number
MARKNUM_STDERR - Number
MARKNUM_STDIN_PROMPT - Number
MARKNUM_STDOUT - Number
MARKNUM_TRANSIENTMARK - Number
MAX_MARKNUM - Number
Asynchronously load an image (e.g. png), cache the result and run the given callback with the image details.
uri - String
file uri Note: The file contents are cached by URI.
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 - Components.interfaces.ISciMoz
- A plugin instance.
isDarkBackground - Boolean
- whether scimoz is using a dark bg.
Returns - ko.markers.MARKERS_MASK_SYMBOLS
moreKomodo - moreKomodo
MoreKomodoCommon - MoreKomodoCommon
notify - Boolean
notify - Boolean
index - Number
Returns - retval
maxLength - Math.max()
Returns - retval
Returns - maxEntries
Remove the given "entry" (a string) from the given MRU if it exists.
prefName - String
The mru preference with which it is associated.
entry - String
The entry to remove from the mru.
caseSensitive - Boolean
How to match the entry.
Remove the given URL from the mru preference (if it exists).
prefName - String
The mru preference with which it is associated.
url - String
The URL to remove from the mru.
__XXZZ__
mruFileList - String
mruProjectList - String
mruTemplateList - String
The open namespace contains functionality to open buffers in komodo
_audioUrlREs - Array
_imageUrlREs - Array
accessKey - _viewsBundle.GetStringFromName()
label - _viewsBundle.GetStringFromName()
preNotificationSessionSchemeName - oldSchemeName
Display a notification box that lets the user revert the current color scheme from the one that was just imported to the previous one.
schemeService - nsIScintillaSchemeService
oldSchemeName - String
newSchemeName - String
Returns - undefined
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
Returns - Boolean
Returns - Boolean
urls - urls.concat()
isRecent - Boolean
viewType - String
skipRecentOpenFeature - Boolean
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.
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.
Returns - ko.open.URIAtLine()
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
lineno - Number
the line number to open the file at
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.
_toolboxParts - Array
active - this
BaseManager - BaseManager
classes - Cc
currentProject
extensionManager - projectExtensionManager
interfaces - Ci
log - safeGetFocusedPlacesView()
manager - projectManager
managers - Array
peMenu - peMenu
utils - Cu
Returns - s_new
Returns - defaultDir
Returns - fixedLines.join()
text - text.replace()
Returns - String
Returns - parts
Returns - this.addPartWithURLAndType()
Returns - part
part - parent.project.createPartFromType()
parent - ko.projects.active.getSelectedItem()
Returns - part
Returns - parts
Returns - part
parent - ko.projects.active.getSelectedItem()
snippet - ko.toolbox2.createPartFromType()
Returns - snippet
part - parent.project.createPartFromType()
parent - ko.toolbox2.getStandardToolbox()
Return a custom id that can be used for the part's menu or toolbar element.
part - Components.interfaces.koIPart
The toolbox part.
Returns - String
async - Boolean
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
Return null if there is no part with the given ID.
Returns - ko.toolbox2.findToolById()
Returns - parts
Returns - Boolean
Import a Komodo package (filename) into the given part.
viewMgr - Object
- The project view manager.
part - Components.interfaces.koIPart
- The part to import into.
uri - String
- The URI of the package to import.
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
ensureVisible - Boolean
Returns - Boolean
part - part.parent
Returns - Boolean
items - pview.manager.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
Returns - Boolean
Returns - enteredUndoableTabstop
classes - Cc
interfaces - Ci
utils - Cu
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
Run the given command.
command - String
- The command string to execute.
options - Object
- Optional object can contain the following: "cwd" {String} - the directory to start the process in. "env" {String} - an encoded string of environment changes to use for the process. Encoding scheme: "VAR1=value1\nVAR2=value2\n..." "runIn" {String} - identifies where the command should be run, one of: "command-output-window" - the Komodo output pane (the default) "new-console" - in a separate console window "no-console" - in a hidden external window "insertOutput" {Boolean} - specifies whether to insert the command's output into the current insertion point (default false). "operateOnSelection" {Boolean} - use the current selection as input to the command (default false). "openOutputWindow" {Boolean} specifies whether the Command Output pane should be opened (default true). "name" {String} - alias name for the command being run, shown to the user. "editor" {Window} - a top-level Komodo window object to run inside. "saveInMRU" {Boolean} - save the command in run command MRU list (false) "saveInMacro {Boolean} - save the command in macro recordings (true) "viewData" {Object} - custom view information (null) When runIn == "command-output-window", the following additional options are available: "parseRegex" {String} - a regex pattern to use to parse the output lines into the command output window tree. "showParsedOutputList" {Boolean} - show regex parsed output in a list view "clearOutputWindow" {Boolean} - Whether to clear the command output window when starting a new command (defaults to true). "terminationCallback" {Function} - called after the command terminates.
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.
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
Run the given command.
parseOutput - Boolean
parseRegex - String
showParsedOutputList - Boolean
clearOutputWindow - Boolean
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
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 - Object
The XUL window holding the command output window.
focusPane - Boolean
Whether focus is changed to the command output pane.
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
_alwaysDoSessionEndCallback - Boolean
_inUndoSession - Boolean
_onSessionEnd
_ranges - Array
_state - INACTIVE
classes - Cc
findOptions
interfaces - Ci
savedFindOptions
view - view
Returns - searchText
Returns - ko.interpolate.getBoundsForWordUnderCursor()
Returns - s.replace()
view - ko.views.manager.currentView
Returns - session
dormantSelStart - scimoz.selectionStart
dormantSelEnd - scimoz.selectionEnd
__END__
_alwaysDoSessionEndCallback - always
_inUndoSession - Boolean
_onSessionEnd - callback
_ranges - Array
_sessionEndingEventCommands - Array
_state - SETTING_CARETS
_textEventCommands - Array
additionalSelectionTyping - scimoz.additionalSelectionTyping
firstSelectionStartPos - startPos
isActive
isDormant
isGatheringCarets
event - Event
event - Event
endPos - startPos
event - Event
event - Event
Returns - Boolean
event - Event
Returns - Boolean
always - Boolean
_leadingKeywordRE
_leadingKeywordRE_invokedExplicitly
fileName - ex.fileName
invokedExplicitly - Boolean
lineNumber - ex.lineNumber
message - message
name - String
rightOfFirstRubyKeyword - this.rightOfFirstKeyword
stack - ex.stack
verifyAtRightOfFirstRubyKeyword - this.verifyAtRightOfFirstKeyword
delimiter - String
Returns - numReps
scimoz - ko.views.manager.currentView.scimoz
currentLine - scimoz.lineFromPosition()
Returns - scimoz.getTextRange()
Returns - scimoz.getStyleAt()
Returns - this.HTML_checkIsLessThanPresent()
Returns - Boolean
Returns - pieces.join()
ex - Error
Set the encoding menu for the current view.
Clear clear all statusbar elements
ClearCheck clear the syntax checking status
Set the encoding menu for the current view.
menupopup - DOMElement
Returns - _sysUtils.byteLength()
Returns - _sysUtils.charIndexFromPosition()
Use koIOs.expanduser to expand a leading "~". This contracts it.
path - String
Returns - one
text - text.replace()
Returns - String
value - value.substr().replace()
Return a string of length fieldSize, where the left side of the string is padded with enough instances of padChar to reach the target size. The returned size is the minimum size that exceeds fieldSize.
text - String
-- the text to right-align in a field
fieldSize - Number
-- minimum acceptable size of the final text
padChar - String
-- default is a space Returns text if fieldSize <= 0
Returns - String
Return a copy of s with the leading and trailing whitespace removed.
Returns - String
Returns - newtext
Returns - newValue
backrefNum - backrefNum
backrefNumber - backrefNumber
indicator - DECORATOR_SOFT_CHAR
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?
event - Event
event - Event
Returns - ko.tabstops.checkForObsoleteTabstops()
Remove linked tabstops from the document.
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 - this.subjectText.substr()
Returns - Node
isInner - Boolean
Returns - ko.tabstops.LiveTextSoftChars
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
*************** LiveTextPlain ***************
Returns - indent
Returns - ko.stringutils.bytelength()
*************** LiveTextSoftChars ***************
Returns - indent
Returns - len
*************** LiveTextTabstopBackrefDef ***************
Returns - indent
Returns - insertLiveTextPartHelper()
*************** LiveTextTabstopBackrefUse ***************
Returns - indent
Returns - insertLiveTextPartHelper()
*************** LiveTextTabstopEmpty ***************
Returns - indent
Returns - ko.tabstops.insertEmptyIndicator()
*************** LiveTextTabstopNested ***************
Returns - parts.join()
Returns - len
*************** LiveTextTabstopText ***************
Returns - indent
Returns - insertLiveTextPartHelper()
isBackref - Boolean
Returns - s
_arrowKeys - Array
_sortDirection - String
_webPackageURL - url
log - log
manager - Toolbox2Manager
multipleNodesSelected - Boolean
raggedMultipleSelection - Boolean
selectedIndices - this.getSelectedIndices()
Returns - uri
Returns - ko.uriparse.localPathToURI()
event - Event
Returns - row.value
Returns - String
Returns - cleanMacros
Returns - Array
Returns - tool
Returns - osPathSvc.join()
index - this.manager.view.getIndexByTool()
Returns - loadedSomething
Returns - uri
parent - this.getStandardToolbox()
selectItem - Boolean
event - Event
Returns - this.manager.toolsMgr.createToolFromType()
event - Event
event - Event
event - Event
Returns - Boolean
event - Event
Returns - Boolean
tool - this._getSelectedTool()
tool - this._getSelectedTool()
tool - this._getSelectedTool()
tool - this._getSelectedTool()
tool - this._getSelectedTool()
tool - this._getSelectedTool()
event - Event
Ensure the given tool is visible in the toolbox tree. Note: Does not ensure the toolbox pane is visible.
tool - koITool
The tool to make visible.
options - Object
Optional, "select" property means to select the item.
event - Event
Returns - this.manager.toolsMgr.getToolById()
isAutoAbbrev - Boolean
Returns - this.manager.toolsMgr.getAbbreviationSnippet()
Returns - index
index - this.manager.view.getParentIndex()
Returns - item
Returns - obj.value
Returns - obj.value
Returns - this.manager.toolbox2Svc.getExtensionToolbox()
Returns - this.manager.toolsMgr.getToolById()
Returns - item
rootsOnly - Boolean
Returns - ko.treeutils.getSelectedIndices()
Returns - this.manager.view.getTool()
Returns - this.manager.toolbox2Svc.getStandardToolbox()
Returns - paths
Returns - tools.value
Returns - obj.value
Returns - obj.value
event - Event
Returns - ko.toolbox2.onTreeKeyPress()
event - Event
event - Event
event - Event
event - Event
event - Event
event - Event
event - Event
event - Event
tool - this._getSelectedTool()
tool - this._getSelectedTool()
tool - this._getSelectedTool()
tool - this._getSelectedTool()
tool - this._getSelectedTool()
tool - this._getSelectedTool()
tool - this._getSelectedTool()
tool - this._getSelectedTool()
event - Event
checkMouseClick - Boolean
event - Event
event - Event
event - Event
event - Event
Returns - Boolean
event - Event
event - Event
event - Event
event - Event
event - Event
Returns - Array
event - Event
event - Event
Returns - this.manager.updateFilter()
ascending - Components.interfaces.koIToolbox2HTreeView.SORT_BY_NAME_ASCENDING
descending - Components.interfaces.koIToolbox2HTreeView.SORT_BY_NAME_DESCENDING
natural - Components.interfaces.koIToolbox2HTreeView.SORT_BY_NATURAL_ORDER
toolboxBaseManager - toolboxBaseManager
user - ko.toolbox2
name - command
Returns - a
Returns - selectedIndices
_customizeComplete
_updateToolbarSeparators
Show/hide toolbar separators in response to their surrounding elements being hidden
_updateToolbarViewStates
Update the toolbar classes to add first-child and last-child to the first/last toolbar items that are not hidden This is used to get the rounded corner effect
_windowInfoList - ko.workspace.getRecentClosedWindowList()
cloneUnifiedMenuItems
customize
Enter panes/widgets customization mode Eventually, toolbar customization should be moved here as well.
toggleWidget - this.toggleTab
Start toolbar customization
aToolbox - <toolbox>
[optional] The toolbox to customize
Returns - dialog
Makes the given pane closed/invisible in Komodo.
Makes the given pane open/visible in Komodo.
focusToo - Boolean
Toggle the full screen state of the window
event - Event
Returns - _buttonTextShowing
Returns - this.isTabShown()
Returns whether the given pane is currently opened/visible in Komodo.
pane - {object
| id} - The pane element, or the id of the pane element.
Returns - Boolean
Returns - Boolean
Restore generic window state, fullscreen, maximized and sidepane tab layout. Note: Must be called after the window is fully initialized (i.e. after the Mozilla window persist has done it's thing).
Update the top-level menu visibility. Note that even when the menubar is hidden, it can still be made visible using the Alt key.
menubarShowing - Boolean
Whether the menu is always showing.
Sets the user's tab pane layout to match the Komodo appearance preferences.
Toggle whether the toolbox should auto-hide in full screen mode
force - Boolean
collapseIfFocused - Boolean
Update the menubar menu item to reflect whether the window is in full screen mode
limit - Number
buttonTextShowing - broadcaster.hasAttribute()
Update the context menu for the toolbox
view - ko.views.manager.currentView
view - ko.views.manager.currentView
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.URIToPath(<URI or path>) 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 an array, holding the the common URI prefix as the first element of the array and an array of the relative paths as the second array entry.
uris - Array
Returns - Array
Return the common URI prefix of the given list of URIs.
uris - Array
Returns - String
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()
Return the relative path from 'fromPath' to 'toPath'.
fromPath - String
The local path to get to.
Returns - String
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
Get the file path for the given URI. "uri" may be a URI for a local or remote path. Returns the file path or raises an exception if there is no local file representation for that URI. Examples: D:\trentm\foo.txt -> D:\trentm\foo.txt file:///D:/trentm/foo.txt -> D:\trentm\foo.txt ftp://ftp.activestate.com/ActivePython -> /ActivePython
Returns - koFileEx.path
Require one or multiple files
prefix - String
Optional path prefix to use for all files
files - {string
file or files to be loaded. If this is null or not an array then prefix will become files.
Restart Komodo
confirmation - Boolean
Whether to show a confirmation (if necessary)
_currentView
_observingCtrlKeyUp - Boolean
_recentViews - Array
inBufferSwitchingSession - Boolean
log - ko.logging.getLogger()
manager - (anonymous 44)()
viewManager - viewManager
event - Event
event - Event
event - Event
event - Event
event - Event
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/...
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.positionBefore()
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.
_keylistener
_recentViews - newStack
constructor
inBufferSwitchingSession - Boolean
Returns - currIndex
event - Event
event - Event
Generate the view history views in order (current view first, then the next most recent view, ...).
Returns - view
Returns - view
Returns - state
_getIDForWidget
Given a <browser type="ko-widget">, return its id.
_panes - Dict
_persist_state - JSON.parse()
_strings - onMenuCommand()
_widgets - Dict
classes - Cc
getWidgetInfo
id - id
interfaces - Ci
modifyWidget
pane - pane.containerPane
panes - get()
results - Cr
utils - Cu
widgets - get()
Helper to get the widget data given a widget ID
Returns - Widget
Register a pane This should only be called by the <ko-pane> constructor
Register a widget from an existing element Called from the <ko-pane> constructor; note that the pain will be removed right after, so we don't hold references to anything but attributes
Returns - Boolean
Unregister a pane
This is set up from the <ko-pane>, and is called when a <browser type=ko-widget> has done loading (that is, a web progress state of window|stop).
Returns - menuitem
Returns - data.browser
event - Event
Returns - Boolean
Called by ko.main's window.onload
prefpath - prefpath
Returns - String
Returns - Boolean
collapsed - Boolean
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 - this.getHomeDirectory()
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
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
Change the focus to the next Komodo window.
Returns - <Window>
Change the focus to the previous Komodo window.
Returns - <Window>
Return the last opened window - of any window type.
Returns - <Window>
return a reference to the main Komodo window
Returns - <Window>
Returns an array of all Komodo windows that are currently open.
Returns - Array
return true if this is the only Komodo window open
Returns - <Window>
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>
Returns - Boolean
_calledInitializeEssentials - Boolean
Returns - windowWorkspace
Collect path to all open files
Returns - (Array)
Returns - mruList
Load *.komodospace file, convert to list of paths
filepath - this.pickSpaceFileToOpen()
Returns - JSON Array
Take a list of URIs and load the files into Komodo based on those paths.
Open a ko.filepicker to grab the workspace file the user wants to open
Returns - String
Open dialog to allow user to pick location to save workspace file
Returns - String
Restore all workspaces, panes and widgets from the last session.
Returns - _restoreInProgress
restore all workspace preferences and state, open files and projects
currentWindow - ko.windowManager.getMainWindow()
idx - parseInt()
Create file at user specified location with all currentView paths
filepath - this.pickSpaceSavePath()
Returns - _saveInProgress
save all workspace preferences and state
flatTreeView - xtk.dataTreeView
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
A flat tree implementation. Sample Usage: XUL: <tree id="sample_tree" flex="1"> <treecols> <treecol id="sample_treecol_name" flex="1" label="Name"/> <splitter class="tree-splitter"/> <treecol id="sample_treecol_value" flex="1" label="Name"/> </treecols> <!-- Tree children are dynamically generated, from our own custom tree view --> <treechildren/> </tree> JavaScript: function SampleTreeView(initial_rows) { if (!initial_rows) { // Default value then this._rows = []; } else { this._rows = initial_rows; // The following two lines ensure proper inheritance (see Flanagan, p. 144). SampleTreeView.prototype = new xtk.dataTreeView(); SampleTreeView.prototype.constructor = SampleTreeView; // Override getCellText method for assigning the celltext SampleTreeView.prototype.getCellText = function(row, column) { // forRow is an item of the _rows array var forRow = this._rows[row]; switch (column.id) { case 'sample_treecol_name': return forRow[0]; case 'sample_treecol_value': return forRow[1]; return "(Unknown column: " + column.id + ")"; // Load the tree view and assign it to a tree element var sampleTreeView = new SampleTreeView(); var sampleTree = document.getElementById("sample_tree"); sampleTree.treeBoxObject.view = sampleTreeView; // SORTING: // Sorting capabilitilies are automatically included (string sorting by // default). These are all of the sort specific attributes: // <treecol sortActive="true|false" /> - marks the default sort column // <treecol sortDirection="ascending|descending|natural" /> // <treecol sortType="string" /> - String sorting (default when not specified) // <treecol sortType="numeric" /> - Numerical sorting // <treecol sortType="function:func_name" /> - Custom sort function: // where "func_name" is a function in the SampleTreeView class. The // signature looks like: "func_name(compare1, compare2)". Each // compare argument is an object that contains these attributes: // compare1.data -> data (string) return by getCellText. // compare1.row -> the real underlying row object. // compare1.oldindex -> original row index before the sort. // See the "_doDataCompare" function below for an example.
_debug - Number
_rows - Array
_sortCaseInsensitive - Boolean
_sortColumn - column
_sortDirection - Number
_unfilteredRows - this._rows
enableSorting - Boolean
rowCount
rows
SORT_ASCENDING - Number
SORT_DESCENDING - Number
tree - out
text - text.toLowerCase()
Returns - String
Returns - Number
Returns - Boolean
Returns - Boolean
Returns - Boolean
Returns - Boolean
Returns - Boolean
Returns - Boolean
Returns - this
col - colElem
sortDirection - xtk.dataTreeView.SORT_ASCENDING
Controller that forwards everything to sub-controllers
aControllers - Array
_controllers - Array
aliases_textEntry - Object
Default set of aliases useful for normal text boxes; these are useful on <textbox>s so that we actually do the expected things instead of editing in some related <scintilla> widget. The keys are the Komodo command names, and the values are the Mozilla ones.
commandAliases - Object
wrappedJSObject - this
Get the controller for a given command
Returns - Two-element
Returns - command
Returns - command
A hierarchical tree implementation (where each row may contain child nodes). Each tree row must be an object that has the following properties: attribute isContainer {bool} - whether it can have child nodes attribute hasChildren {bool} - whether the container is empty or not method getChildren() {array} - retrieve the child row nodes (children must be objects that meet the same tree requirements) attribute state {int} - tree flags, such as whether opened/closed (managed by the tree), should be 0 by default attribute level {int} - the depth of the row (managed by the tree), should be 0 by default Custom treeview for showing hierachical tree data.
_rows - new_rows
_sortFunction
_sortPropertyName
contructor
STATE_CLOSED - Number
STATE_OPENED - Number
Returns - rows
Sort sibling rows. This should be overridden by implementations that wish to implement useful sorting.
sortPropertyName - String
The name of the property to sort by
sortFunction - Function
The function callback for sorting
sortDir - Number
The directory to sort in; may be either xtk.dataTreeView.SORT_DESCENDING or xtk.dataTreeView.SORT_ASCENDING
Returns - Array of rows
Returns - this.rows[row].level
Returns - row
row - afterIndex
Returns - Boolean
Returns - this.rows[row].isContainer
Returns - this.rows[row].state
Useful clipboard functions.
classes - Cc
interfaces - Ci
utils - Cu
Returns - supportCString
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
Returns - Array
Return whether this is a dark color.
hexstring - String
- Hexadecimal string of the color.
Returns - Boolean
Return whether this is a light color.
hexstring - String
- Hexadecimal string of the color.
Returns - Boolean
RGB convert rgb value into a long int WARNING: This actually returns a BGR value which works fine for Scintilla, but won't work for most other targets.
Returns - Number
Returns - Array
Returns - Math.floor()
Returns - r
Returns - this.NanometerToRGB()
__END__
event - Event
is this element a descendent (or same node!) of an ancestor?
ancestor - Element
The ancestor to check
element - Element
The element that might be a descendent
Returns - Boolean
is this element or a descendent focused?
Returns - Boolean
target - DOMElement
- The originating target.
eventName - String
- The name for the event.
data - Object
- (Optional) Additional data object.
Send out a window event with the given event name.
target - DOMElement
- The originating target.
eventName - String
- The name for the event.
Returns - xtk.domutils.getChildrenByAttribute()
Returns - xtk.domutils.getChildrenByProperty()
attrVal - Array
Returns - results
propVal - Array
Returns - results
is the focused element, or it's ancestor a element with a matching localName?
localName - String
Returns - Element
Helper method to easily create a new DOM element with a bunch of (optional) attributes set. names to values.
name - String
- The element name to create.
attributes - Object
- (Optional) A map object containing attributes
Returns - DOMNode
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
lastErrorMsg - str
level - Number
str - xtk.logging.getObjectTree()