Editra 0.7.00
Editra API Documentation
Class List
Here are the classes, structs, unions and interfaces with brief descriptions:
_AdvFindDlgInternalEvent
_SegmentButtonClass for managing segment button data
_TagLoaderTag generator loader and manager class
_WorkerThreadWorker thread class to be used by the ThreadPool
AdaHandlerFileTypeHandler for Ada
AdvancedPanelCreates a panel for holding advanced configuration options
AppearancePanelCreates a panel with controls for Editra's appearance settings
AuiPaneNavigatorNavigate through Aui Panes
AutoCompExtensionPlugin that Extends the autocomp feature
AutoCompIThe Autocompletion interface
AutoCompServiceInterface to retrieve and provide autocompletion and calltip information to an stc control
BaseCompleterBase Autocomp provider class
BashHandlerFileTypeHandler for Bash scripts
BatchHandlerFileTypeHandler for Dos batch files
BitmapProviderPlugin that fetches requested icons from the current active theme
BooHandlerFileTypeHandler for Boo
BookmarkClass to store bookmark data
BookmarkListListCtrl for displaying the bookmarks in
BookmarkWindowShelf window for managing bookmarks
BreakpointMarker object to represent a breakpoint in the EditraBaseStc
BreakpointDisabledMarker object to represent a disabled breakpoint in the EditraBaseStc
BreakpointStepMarker object to represent debugger step breakpoint in the EditraBaseStc
CallLockClass to lock a context around a function call
CamlHandlerFileTypeHandler for Caml
CBConfigObjectPlugin configuration object for CodeBrowser Provides configuration panel for plugin dialog
CBConfigPanelConfiguration panel for plugin manager dialog
CHandlerFileTypeHandler for C Files
ChoiceDialogDialog with a wx.Choice control for showing a list of choices
ChoicePanelGeneric Choice dialog panel
ClassClass for representing a python class object for the parser
ClassClass Object Representation
ClipboardMultiple clipboards as named registers (as per vim)
ClipboardExceptionThrown for errors in the Clipboard class
CodeCode representation objects base class all code elements should inherit from this class
CodeBrowserAdds a CodeBrowser to the view menu
CodeBrowserTree
ColorSetterControl for setting a hex color value or selecting it from a Color Dialog
ColorSetterEventEvent to signal that text needs updating
Command
CommandBarBaseBase class for control bars
CommandEntryBarCommandbar for editor command entry and execution
CommandEntryBaseBase single line text control with key event handling callbacks
CommandExecuterPart of the Vi emulation, opens a minibuffer to execute EX commands
CommandList
CommandListCtrlAuto-width adjusting list for showing editing the commands
CompleterPython Code completion provider
CompleterCSS Code completion provider
CompleterGeneric word completer provider
CompleterHTML/XML Code completion provider
CompleterFactoryFactory for creating composite completer objects
ConfigDialogConfiguration dialog for configuring what executables are available for a filetype and what the preferred one is
ConfigNotebookNotebook for holding config pages
ConfigPanelConfiguration panel that holds the controls for configuration
ConfigPanelCreates a panel for configuring plugins
ContextMenuManagerClass for registering and managing context menu callbacks
ControlBarToolbar like control container for use with a ControlBox
ControlBarEventControlBar Button Event
ControlBoxSimple managed panel helper class that allows for adding and managing the position of a small toolbar like panel
CppFormatterDo a little preprocessing, and pass list of tokens and lines to CppSemantics class
CPPHandlerFileTypeHandler for C++ Files
CppSemanticsA simplified BNF that will just look for the structures we are interested in
CSHHandlerFileTypeHandler for C-Shell
CssItemConverts an Editra StyleItem to a Css item for use in generating html
CSSTagCSSTag object for representing css elements
CycleCacheA simple circular cache
DHandlerFileTypeHandler for D
DirectoryBasic directory data structure
DirectoryMonitorObject to manage monitoring file system changes
DocCodePanelPanel used for programming settings
DocGenPanelPanel used for general document settings in the DocumentPanel's notebook
DocPositionMgrObject for managing the saving and setting of a collection of documents positions between sessions
DocStructCode Document Representation Object Captures the structure of the code in a document, this structure can then be easily used to represent the document in a number of differen't formats
DocSyntaxPanelDocument syntax config panel
DocumentPanelCreates a panel with controls for Editra's editing settings
DownloadPanelCreates a panel with controls for downloading plugins
DropTargetFTDrop target capable of accepting dropped files and text
EBaseListCtrlBase listctrl class that provides automatic row highlighting
ECBaseDlgEditra Control Library Base Dialog Class
ECheckListCtrlListCtrl with CheckBoxes in the first column
EdBaseBookBase notebook control
EdBaseCtrlBar
EdBaseCtrlBoxControlBox base class to be used by all common components
EdBaseDialogEditra Dialog Base Class
EdBaseFrameEditra Frame Base Class
EdBookmarksShelf interface implementation for the bookmark manager
EdClipboardLocal clipboard object
EdEditorViewTab editor view for main notebook control
EdErrorDialogError reporter dialog
EdFileWrapper for representing a file object that stores data about the file encoding and path
EdFileInfoDlgFile information dialog
EdFindResultsShelf interface implementation for the find results
EdFormatEOLDlgDialog for selecting EOL format
EdFrameManagerFrame manager for external components to abstract underlying manager
EdIpcServerCreate an instance of IPC server for Editra
EditraThe Editra Application Object
EditraArtEditras Art Provider
EditraBaseStcBase StyledTextCtrl that provides all the base code editing functionality
EditraCommanderProxy object that sends commands to the editor
EditraStcDefines a styled text control for editing text
EditraXmlBase class for all Editra syntax xml objects
EdLogFileTransient log file object
EdLogViewerShelf interface implementation for the log viewer
EdMenuCustom wxMenu class that makes it easier to customize and access items
EdMenuBarCustom menubar to allow for easier access and updating of menu components
EdPagesEditra's editor buffer notebook
EdPrinterPrinter Class for the editor
EdSearchCtrlCreates a simple search control for use in the toolbar or a statusbar and the such
EdSearchEngineText searching engine
EdSessionBarCommand bar for managing editing sessions
EdSessionMgrEditra specific session manager implementation
EdShelfBook
EdShelfDelegateDelegate class to mediate between the plugin singleton object and the UI implementation
EdStatBarCustom status bar that handles dynamic field width adjustment and automatic expiration of status messages
EdTabBaseBase class for all tab views to derive from, this class just defines the abstract interface and some common basic methods
EdThreadPoolSingleton ThreadPool
EdToolBarToolbar wrapper class
EdXmlXML base class
EEditListCtrlListCtrl with Editable cells
EFileHistoryFileHistory Menu Manager
ELexerA wrapper to add peeking and line counting to pygments lexer
EncodingDialogDialog for choosing an file encoding from the list of available encodings on the system
EnumEnum Object
ErrorDialogDialog for showing errors and and notifying Editra.org should the user choose so
ErrorMarkerMarker object to indicate an error line in the EditraBaseStc
ErrorPanelError Reporter panel
ErrorPattern
ErrorReporterCrash/Error Reporter Service
EToggleEditListCtrlListCtrl with Editable cells and images that can be toggled in the the first column
EToken
exposeExpose a panels method to a to a specified class The specified class must have a GetPanel method
ExtensionPointDeclares what Interface a plugin is extending
ExtensionRegisterA data storage class for managing mappings of file types to file extensions
FactoryMixinFactory implementation
FeatureFeature Object
FeatureListContainer for all other misc syntax features
FeriteHandlerFileTypeHandler for Ferite
FileBasic file data structure
FileBackupMgrFile backup creator and manager
FileInfoDlgDialog for displaying information about a file
FileList
FileLoadEventEvent to signal that a chunk of text haes been read
FileMgrDialog
FileMgrPanel
FileObjectImplFile Object Interface implementation base class
FileReadJobJob for running an async file read in a background thread
FileTreeSimple base control for displaying directories and files in a hierarchical view
FileTypeCheckerFile type checker and recognizer
FileTypeHandlerBase default Output handler all output handlers should derive from this class
FilterDialogDialog that allows adding and removing items from a filter list
FilterPanelFilter dialog panel
FindBoxContainer box that allows for switching the FindPanel's mode through the ui
FindEventEvent sent by the FindReplaceDialog that contains all options of the FindReplaceData and requested action of the find dialog
FindPanelFind controls panel
FindReplaceDlgAdvanced Find Replace Dialog this version of the dialog uses a standard dialog window
FindReplaceDlgBaseDelegate mixin base class for deriving FindReplaceDialogs, delegates calls to the widgets and containers that make up the dialog
FoldMarkerMarker object class for managing the code folding markers
FontChangeEventGeneral notification event
FreezerContext manager for freezing window redraws
FunctionGeneral Function Object, to create a function like object with a differen't type identifier, change the obj parameter to set the element type property
FunctionCreate a function object for representing a python function definition in the parser
GeneralFilePanelConfiguration panel for general file settings
GeneralPanelCreates a panel with controls for Editra's general settings
GeneralStartupPanelGeneral Startup Settings
GeneratorPlugin Interface Extension Point for Generator type plugin objects
GeneratorIPlugins that are to be used for generating code/document need to implement this interface
GotoLineBarCommandbar for Goto Line function
GtkTabArtSimple tab art with no gradients
Handler
HandlerMetaMetaclass for manipulating a handler classes metadata converts all user defined 'meta' classes to a Meta class with all unset attributes initialized to the default setting
HaskellHandlerFileTypeHandler for Haskell
HaxeHandlerFileTypeHandler for haXe
HexValidatorValidate Hex strings for the color setter
HistoryCacheData management cache
HotspotPattern
HtmlTransforms the text from a given Editra stc to a fully styled html page
HTMLHandlerFileTypeHandler for HTML
InfoBarInformation popup panel
InnoSetupHandlerFileTypeHandler for Inno Setup Scripts
InstallPanelCreates a panel for installing plugins
InterfaceBase class for defining interfaces
IntValidatorA Generic integer validator
IPCArgXml object for holding the list of args
IPCCommandIPC XML Command
IPCFileXml object for holding the list of files
IpcServerEventEvent to signal the server has recieved some commands
KeyBinderClass for managing keybinding configurations
KeyHandlerKeyHandler base class
KeywordListContainer object for all keyword sets
KornHandlerFileTypeHandler for Korn Shell scripts
LangListComboCombines a langlist and a BitmapComboBox
LaTeXCreates a LaTeX document object from the contents of the supplied document reference
LatexHandlerFileTypeHandler for LaTex
LaunchScript Launcher and output viewer
LaunchConfigObjectPlugin configuration object
LaunchWindowControl window for showing and running scripts
LaunchXml
LineCtrlA custom int control for providing a go To line control for the Command Bar
LintMarkerMarker object to represent a marker for coding issue in the EditraBaseStc
LintMarkerErrorMarker object to represent a marker for a high severity coding issue in the EditraBaseStc
LintMarkerWarningMarker object to represent a marker for moderate severity coding issue in the EditraBaseStc
ListRowHighlighterThis mixin can be used to add automatic highlighting of alternate rows in a list control
LiteralLiteral Object
LogBufferBuffer for displaying log messages that are sent on Editra's log channel
LogFileLog file class
LogMsgLogMsg is a container class for representing log messages
LogViewerLogViewer is a control for displaying and working with output from Editra's log
LuaHandlerFileTypeHandler for Lua
MacroMacro Object
MainPanelMain panel view
MainWindowEditras Main Window
MainWindowAddOnPlugin that Extends the MainWindowI
MainWindowExitEventEvent to signal that the main window is exiting
MainWindowIThe MainWindow Interface is intended as a simple general purpose interface for adding functionality to the main window
MarkerMarker Base class
InnoSetupHandler.meta
IPCFile.meta
IPCArg.meta
IPCCommand.meta
MetaMetadata namespace, acts as a container object for meta attributes for classes using the FactoryMeta metaclass
DHandler.meta
CamlHandler.meta
EdSessionBar.meta
PikeHandler.meta
AdaHandler.meta
BashHandler.meta
BatchHandler.meta
CHandler.meta
CPPHandler.meta
CSHHandler.meta
HaskellHandler.meta
KornHandler.meta
STATAHandler.meta
LuaHandler.meta
HaxeHandler.meta
NewLispHandler.meta
NSISHandler.meta
PhpHandler.meta
HotspotPattern.meta
PerlHandler.meta
PostScriptHandler.meta
PythonHandler.meta
RHandler.meta
RubyHandler.meta
ErrorPattern.meta
TCLHandler.meta
VBScriptHandler.meta
HTMLHandler.meta
Handler.meta
LaunchXml.meta
Command.meta
MetaMetadata namespace, acts as a container object for all FileTypeHandler meta attributes
BooHandler.meta
FeriteHandler.meta
SearchBar.meta
CommandList.meta
CommandEntryBar.meta
GotoLineBar.meta
LatexHandler.meta
MetaCompleterMeta class for creating custom completer classes at runtime
MetaDataMetaclass for applying meta data to a class
MethodMethod Object
MiniFindReplaceDlgAdvanced Find Replace Dialog this version of the dialog uses a MiniFrame that will float on top of its parent
MiscPanelMisc settings panel
ModuleModule Object
NamespaceNamespace Representation
NetConfigPageConfiguration page for network and proxy settings
NetworkPanelNetwork related configration options
NewLispHandlerFileTypeHandler for newLisp
NodeTagNode Code Object
NONMEMLexerNonmem lexer based on statefull RegexLexer from pygments library
NotificationEventGeneral notification event
NSISHandlerFileTypeHandler for NSIS scripts
NullValueNull value to signify that a callback method should be skipped or that no callback could answer the request
OutputBufferOutputBuffer is a general purpose output display for showing text
OutputBufferEventEvent for data transfer and signaling actions in the OutputBuffer
OutputDisplayMain output buffer display
OutputPanelOutput buffer settings panel
PackagePackage Method object
PanelBoxScrolled container window for managing and displaying PanelBox items
PanelBoxEventEventPanel Box Event Object
PanelBoxItemPanelBox Item that has an icon, main label text and sub label +-------------------------+ | | | ICON label | | sub item | +-------------------------+
PanelBoxItemBaseBase PanelBox Item
ParserRuleParserRule Object
PBDownloadItemPanelBox Item to display download information about a plugin
PBPluginItemPanelBox Item to display configuration information about a plugin
PerlFormatter
PerlHandlerFileTypeHandler for Perl scripts
PerspectiveManagerCreates a perspective manager for the given aui managed window
PhpHandlerFileTypeHandler for Php
PikeHandlerFileTypeHandler for Pike
PlateButtonPlateButton is a custom type of flat button with support for displaying bitmaps and having an attached dropdown menu
PluginBase class for all plugin type objects
PluginConfigObjectPlugin configuration object
PluginDataA storage class for representing data about a Plugin
PluginDataPlugin Metadata storage class used to store data about plugins and where to download them from
PluginDialogDefines a Plugin manager Dialog that can be used to download plugins from a defined repository, offers services to install plugins that where downloaded with or without the dialog, as well as configure already installed plugins
PluginErrorItemPanelBox Item to display configuration information about a plugin
PluginManagerThe PluginManger keeps track of the active plugins
PluginMetaActs as the registration point for plugin entrypoint objects
PopupListPopup window with a listbox in it
PopupListBaseCommon functionality between Popuplist GTK and Mac
PopupWinListPopuplist for Windows/GTK
PostScriptHandlerFileTypeHandler for Post/GhostScript
PreferencesDialogPreference dialog for configuring the editor
PreferencesPanelBaseBase mixin class for preference panels
PrefToolsMain sections of the configuration pages
PreviewPanelPanel to hold the preview window and selector
ProcedureProcedure object
ProcessBufferMixinMixin class for OutputBuffer to handle events generated by a ProcessThread
ProcessThreadRun a subprocess in a separate thread
ProcessThreadBaseBase Process Thread Override DoPopen in subclasses
ProfileClass for managing profile data
ProgramProgram Code Object
ProgressStatusBarCustom StatusBar with a built-in progress bar
PropertyListContainer class for the syntax properties
ProtocolProtocol Code Object
PyCompleterPython code completion provider
PyFontPickerA slightly enhanced wx.FontPickerCtrl that displays the choosen font in the label text using the choosen font as well as the font's size using nicer formatting
PyFormatter
PyParserPython parsing class
PythonHandlerFileTypeHandler for Python
RbFormatterRuby code formatter
ReadErrorError happened while trying to read the file
RHandlerFileTypeHandler for R
RtfGenerates a fully styled RTF document from the given text controls contents
RtfColorTblA storage class to help with generating the color table for the Rtf Generator Class
RubyHandlerFileTypeHandler for Ruby scripts
ScopeBase class for representing code objects
ScopeScope object base class used for creating container code types
SearchBarCommandbar for searching text in the current buffer
SearchControllerControls the interface to the text search engine
SearchEngineText Search Engine All Search* methods are iterable generators All Find* methods do a complete search and return the match collection
SearchResultListOutputbuffer for listing matching lines from the search results that a ebmlib.SearchEngine dispatches
SearchResultScreenScreen for displaying search results and navigating to them
SectionSection Representation
SegmentBarSimple toolbar like control that displays bitmaps and optionally labels below each bitmap
SegmentBarEventSegmentBar Button Event
SegmentBookNotebook Class
SegmentBookEventSegmentBook event
SessionManagerSimple editing session manager helper class
SettingsPanelPanel holding all settings controls for changing the font, colors, styles, ect
ShelfPlugin that creates a notebook for holding the various Shelf items implemented by ShelfI
ShelfIInterface into the Shelf
ShelfWrapper
SingletonSingleton metaclass for creating singleton classes
SOAP12MessageClass for creating and sending a message using the SOAP protocol
StackStack is a simple wrapper for a list with push and pop exposed
StackMarkerMarker object to mark a line in a callstack in the EditraBaseStc
STATAHandlerFileTypeHandler for Stata
StaticCallLockProvides a static lock around a function call
StatusEventEvent for posting status events
StructStruct object
StyleEditorThis class creates the window that contains the controls for editing/configuring the syntax highlighting styles it acts as a graphical way to interact with the ed_style.StyleMgr
StyleEditorBoxStyleEditor main Panel
StyleEditorPanelMain panel for the editor portion of the StyleEditor
StyleItemA storage class for holding styling information
StyleMgrManages style definitions and provides them on request
StyleTagStyle Tag Code Object
SymbolDefines a symbol as parsed by the autocompleter
SynExtensionDelegateDelegate SyntaxData class for SynXml Extension class instances
SyntaxSyntax definition for initializing a Scintilla Lexer
SyntaxDataSyntaxData object for many OOC
SyntaxDataSyntaxData object for XText
SyntaxDataSyntaxData object for LOUT
SyntaxDataSyntaxData object for Gui4Cli
SyntaxDataSyntaxData object for Assembly files
SyntaxDataSyntaxData object for Properties files
SyntaxDataSyntaxData object for Pascal
SyntaxDataSyntaxData object for Perl
SyntaxDataSyntaxData object for XML
SyntaxDataSyntaxData object for Cobra
SyntaxDataSyntaxData object for many C like languages
SyntaxDataSyntaxData object for various shell scripting languages
SyntaxDataSyntaxData object for Editra Style Sheets
SyntaxDataSyntaxData object for Eiffel
SyntaxDataSyntaxData object for Java
SyntaxDataSyntaxData object for Ferite
SyntaxDataActionScript SyntaxData
SyntaxDataSyntaxData object for Mako
SyntaxDataSyntaxData object for Apache Conf files
SyntaxDataSyntaxData object for Python
SyntaxDataSyntaxData object for TCL/Tk
SyntaxDataSyntaxData object for Smalltalk
SyntaxDataSyntaxData object for MatLab and Octave
SyntaxDataSyntaxData object for Caml
SyntaxDataSyntaxData object for VisualBasic
SyntaxDataSyntaxData object for Html and related languages
SyntaxDataSyntaxData object for STATA
SyntaxDataSyntaxData object for Verilog and SysVerilog
SyntaxData
SyntaxDataSyntaxData object for Makefiles
SyntaxDataSyntaxData object for Batch files
SyntaxDataSyntaxData object for Haskell
SyntaxDataSyntaxData object for PostScript
SyntaxDataSyntaxData object for Squirrel
SyntaxDataSyntaxData object for Inno Setup Scripts
SyntaxDataSyntaxData object for YAML
SyntaxDataSyntaxData object for CSS
SyntaxDataSyntaxData object for D
SyntaxDataSyntaxData object for Progress 4GL
SyntaxDataSyntaxData object for Kix
SyntaxDataSyntaxData object for IssueLists This class is primarily intended as an example to creating a custom lexer
SyntaxDataSyntaxData object for DOT
SyntaxDataSyntaxData object for Php
SyntaxDataSyntaxData object for Lua
SyntaxDataSyntaxData object for JavaScript
SyntaxDataSyntaxData object for Diff files
SyntaxDataSyntaxData object for Ada
SyntaxDataSyntaxData object for R and S
SyntaxDataSyntaxData object for NASM
SyntaxDataSyntaxData object for List/newLisp/Scheme
SyntaxDataSyntaxData object for MASM
SyntaxDataSyntaxData object for Erlang
SyntaxDataSyntaxData object for Edje
SyntaxDataSyntaxData object for Ruby
SyntaxDataSyntaxData object for many C like languages
SyntaxDataSyntaxData object for NSIS
SyntaxDataSyntaxData object for 68k assembly files
SyntaxDataSyntaxData object for Flagship
SyntaxDataSyntaxData object for Django
SyntaxDataSyntaxData object for Pike
SyntaxDataSyntaxData object for Fortran 77/95
SyntaxDataSyntaxData object for Forth
SyntaxDataSyntaxData object for LaTeX/TeX
SyntaxDataSyntaxData object for VHDL
SyntaxDataSyntaxData object for HaXe
SyntaxDataSyntaxData object for MS SQL
SyntaxDataSyntaxData object for Boo
SyntaxDataSyntaxData object for IssueLists This class is primarly intended as an example to creating a custom lexer
SyntaxDataSyntaxData object for VbScript
SyntaxDataSyntaxData object for PL/SQL
SyntaxDataBaseSyntax data container object base class
SyntaxMgrClass Object for managing loaded syntax data
SyntaxModeHandlerMain Xml interface to extending filetype handling support
SyntaxSpecListContainer element for holding the syntax specification elements
TagGenEventEvent to signal when a tag generation job is complete
TagGenJobThread for running tag parser on and returning the results for display in the tree
TangoThemeRepresents the Tango Icon theme for Editra
TaskObjectRun a task in its own thread
TaskThreadRun a task in its own thread
TCLHandlerFileTypeHandler for TCL/TK
TerminalTerminal Object
ThemeIInterface for defining an icon theme in Editra When a icon theme is active Editra's ArtProvider will ask the active theme that implements this interface to give it a bitmap
ThreadPoolObject for managing a collection of threads and dispatching jobs to them
TokenNotFoundParsing exception
TrashDirectoryError
TrashError
TrashMoveError
TrashPermissionsError
UpdatePageCreates a panel with controls for updating Editra
UpdateTextEventEvent to signal that text needs updating
VariableVariable object
VBScriptHandlerFileTypeHandler for VBScript
ViKeyHandlerDefines a key handler for Vi emulation
WatcherThreadBackground thread to monitor a directory
WriteErrorError happened while trying to write the file
XmlTagsBuilder
XTextLexerXtext lexer based on statefull RegexLexer from pygments library
 All Classes Namespaces Functions Variables Properties