Package sidekick

Generalized framework for code browsing, folding, and completion.

See:
          Description

Interface Summary
IAsset A block of code within a file.
 

Class Summary
Asset A block of code within a file.
ModeOptionsDialog {{{ ModeOptionsDialog class A customized OptionDialog for SideKick, which includes a shared ComboBox for the current edit mode.
ModeOptionsPane A specialized OptionPane which has mode-overridable properties.
ParserOptionPane An option pane to configure the mode - parsers associations.
ParserSwitchAction An action to switch the current SideKick parser.
SideKickActions  
SideKickActions.SideKickAction  
SideKickActions.ToggleParser An action which will always activate the SideKick parser, alternately selecting the default parser, and then the selected one, allowing you to toggle between say, Outline and Java parsers, XML and HTML, or Python and Jython parsers.
SideKickCompletion A code completion instance.
SideKickCompletionPopup  
SideKickFoldHandler Provides a FoldHandler based on the Assets parsed from the buffer.
SideKickMenuProvider  
SideKickModeOptionsPane Mode-Specific options for SideKick - a custom ModeOptionsPane which includes 3 questions for the user, and provides an example of how to extend ModeOptionsPane and set/reset the mode options.
SideKickOptionPane  
SideKickParsedData Stores a buffer structure tree.
SideKickParser An abstract base class for plugin-provided parser implementations.
SideKickPlugin SideKick plugin core which tracks registered parsers.
SideKickTree The Structure Browser dockable.
SideKickUpdate  
 

Package sidekick Description

Generalized framework for code browsing, folding, and completion. Other plugins provide implementations of SideKickParser which parse specific languages.

By implementing a SideKickParser, a plugin can take advantage of SideKick's structure browser and its folding mode.

Plugins can also provide a SideKickCompletion implementation to take advantage of SideKick's completion popup.