API [HippoEDIT Wiki]

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== API ======

===== Enumerations =====

^Name ^ Description^
|[[scripting:api:e3state|e3State]]| Three state|
|[[scripting:api:access-type|eAccessType]]| Access type|
|[[scripting:api:action|eAction]]| Types of the Undo Actions|
|[[scripting:api:alignment|eAlignment]]| Text alignment style|
|[[scripting:api:box-style|eBoxStyle]]| Text box style (used in [[:scripting:api:style:start|IStyle]])|
|[[scripting:api:category|eCategory]]| Bundle category type|
|[[scripting:api:check-state|eCheckState]]| Check States enumeration|
|[[scripting:api:cms|eCMS]]| Context Menu style style|
|[[scripting:api:crlfstyle|eCRLFStyle]]| Line Break types|
|[[scripting:api:dialog-result|eDialogResult]]| Registered dialog result codes|
|[[scripting:api:file-handler-flag|eFileHandlerFlag]]| File Handler Preference flags (can be combined)|
|[[scripting:api:file-operation|eFileOperation]]| File operations|
|[[scripting:api:file-system-event|eFileSystemEvent]]| File system event type|
|[[scripting:api:find|eFind]]| Search modes; can be combined (used in [[:scripting:api:text-document:find|ITextDocument::Find]])|
|[[scripting:api:find-ex|eFindEx]]| Extended modes, used for multi file search in [[:scripting:api:application:find-in-files|IApplication::FindInFiles]]; can be combined|
|[[scripting:api:item-pos|eItemPos]]| Menu item relative position|
|[[scripting:api:keyboard-event-flag|eKeyboardEventFlag]]| Keyboard event flag|
|[[scripting:api:label-context|eLabelContext]]| Label context types|
|[[scripting:api:marker|eMarker]]| Marker types|
|[[scripting:api:message-type|eMessageType]]| Status message types|
|[[scripting:api:mouse-event|eMouseEvent]]| Mouse events|
|[[scripting:api:pane-layout|ePaneLayout]]| Pane layout style|
|[[scripting:api:scope-kind|eScopeKind]]| Scope kind for retrieval (used in [[:scripting:api:text-document:find-scope|ITextDocument::FindScope]])|
|[[scripting:api:search-action|eSearchAction]]| Possible search actions|
|[[scripting:api:search-result-type|eSearchResultType]]| Registered search result types|
|[[scripting:api:search-type|eSearchType]]| Registered search types|
|[[scripting:api:storage-type|eStorageType]]| Storage location type|
|[[scripting:api:tab-modes|eTabModes]]| Defines Pretty Print Mode for inserted Tabs and Spaces|
|[[scripting:api:tool-auto-execute|eToolAutoExecute]]| Define actions which auto execute the tool|
|[[scripting:api:tool-button-style|eToolButtonStyle]]| Toolbar button style|
|[[scripting:api:tool-state|eToolState]]| Tool States|
|[[scripting:api:underline-style|eUnderlineStyle]]| Text underlining style (used in [[:scripting:api:style:start|IStyle]])|
|[[scripting:api:word-wrap-modes|eWordWrapModes]]| Defines Word Wrap modes for editor|
===== Scriptable Objects =====

^Name ^ Description^
|[[scripting:api:application:start|IApplication]]| Application Object Interface|
|[[scripting:api:base-document:start|IBaseDocument]]| Base document interface|
|[[scripting:api:base-documents:start|IBaseDocuments]]| Collection of [[:scripting:api:base-document:start|IBaseDocument]] objects|
|[[scripting:api:base-tool-bar:start|IBaseToolBar]]| Base ToolBar object|
|[[scripting:api:base-view:start|IBaseView]]| Document View interface|
|[[scripting:api:base-views:start|IBaseViews]]| Collection of [[:scripting:api:base-view:start|IBaseView]] objects|
|[[scripting:api:bookmark:start|IBookmark]]| Bookmark object|
|[[scripting:api:bundle:start|IBundle]]| Bundle object, representing online installation package|
|[[scripting:api:bundles:start|IBundles]]| Collection of [[:scripting:api:bundle:start|IBundle]] objects|
|[[scripting:api:clipboard:start|IClipboard]]| Clipboard object|
|[[scripting:api:clipboard-item:start|IClipboardItem]]| Clipboard Item object|
|[[scripting:api:code-template-handler:start|ICodeTemplateHandler]]| Code Template Handler object|
|[[scripting:api:command-handler:start|ICommandHandler]]| Command object|
|[[scripting:api:command-handler-listener:start|ICommandHandlerListener]]| Command Listener object|
|[[scripting:api:completion-item:start|ICompletionItem]]| Completion List Item object|
|[[scripting:api:completion-set:start|ICompletionSet]]| Collection of [[:scripting:api:completion-item:start|ICompletionItem]] objects|
|[[scripting:api:dialog:start|IDialog]]| Base interface for a dialog|
|[[scripting:api:dialog-control:start|IDialogControl]]| Base interface for all dialog controls|
|[[scripting:api:external-document:start|IExternalDocument]]| External document interface to be implemented (optionally) by File Handler plugins|
|[[scripting:api:file-filter:start|IFileFilter]]| File Filter interface to use in [[:scripting:api:file-handler:filters|IFileHandler::Filters]]|
|[[scripting:api:file-system-listener:start|IFileSystemListener]]| File system event listener|
|[[scripting:api:file-system-manager:start|IFileSystemManager]]| File system manager|
|[[scripting:api:folder-favorites:start|IFolderFavorites]]| Folder Favorites manager|
|[[scripting:api:label:start|ILabel]]| Label object|
|[[scripting:api:label-info:start|ILabelInfo]]| Label Info object|
|[[scripting:api:list-item:start|IListItem]]| List Item object|
|[[scripting:api:list-pane:start|IListPane]]| Generic List Pane Interface|
|[[scripting:api:marker:start|IMarker]]| Marker object|
|[[scripting:api:menu-location:start|IMenuLocation]]| Menu location object|
|[[scripting:api:menu-object:start|IMenuObject]]| Menu object|
|[[scripting:api:output-pane:start|IOutputPane]]| Output Pane object|
|[[scripting:api:pane:start|IPane]]| Pane object|
|[[scripting:api:plugin:start|IPlugin]]| Base Plugin|
|[[scripting:api:point:start|IPoint]]| Point (screen position) object|
|[[scripting:api:position:start|IPosition]]| Text Position object|
|[[scripting:api:project:start|IProject]]| Project object|
|[[scripting:api:project-manager:start|IProjectManager]]| Project Manager Interface|
|[[scripting:api:range:overview|IRange]]| Range object|
|[[scripting:api:repository:start|IRepository]]| Online Repository access object|
|[[scripting:api:scope:start|IScope]]| Scope object|
|[[scripting:api:scope-info:start|IScopeInfo]]| Scope Info object|
|[[scripting:api:scope-tag-info:start|IScopeTagInfo]]| Scope Tag Info object|
|[[scripting:api:script:start|IScript]]| Script object|
|[[scripting:api:script-application:start|IScriptApplication]]| Script Application Object|
|[[scripting:api:script-code-template-handler:start|IScriptCodeTemplateHandler]]| Script Code Template Handler interface|
|[[scripting:api:script-command-handler:start|IScriptCommandHandler]]| Script Command interface|
|[[scripting:api:script-command-handler-listener:start|IScriptCommandHandlerListener]]| Script Command Listener|
|[[scripting:api:script-completion-item:start|IScriptCompletionItem]]| Script Completion Item object|
|[[scripting:api:script-completion-provider:start|IScriptCompletionProvider]]| Script Completion Provider|
|[[scripting:api:script-list-pane:start|IScriptListPane]]| Scripting List Pane Interface Extension|
|[[scripting:api:script-output-pane:start|IScriptOutputPane]]| Scripting Output Pane Interface Extension|
|[[scripting:api:script-short-key-handler:start|IScriptShortKeyHandler]]| Script ShortKey Handler interface|
|[[scripting:api:script-variable-handler:start|IScriptVariableHandler]]| Script External Variable Handler object|
|[[scripting:api:search-file:start|ISearchFile]]| Search Job File Match, as collection of [[:scripting:api:search-match:start|ISearchMatch]] objects|
|[[scripting:api:search-job:start|ISearchJob]]| Search Job object, as a collection of [[:scripting:api:search-file:start|ISearchFile]] objects|
|[[scripting:api:search-match:start|ISearchMatch]]| Search Job Text Match|
|[[scripting:api:search-options:start|ISearchOptions]]| Search Options dialog|
|[[scripting:api:search-results-pane:start|ISearchResultsPane]]| Search Results Pane object|
|[[scripting:api:selection:start|ISelection]]| Selection object (extension of [[:scripting:api:range:overview|IRange]])|
|[[scripting:api:settings:start|ISettings]]| Global Settings Object|
|[[scripting:api:settings-storage:start|ISettingsStorage]]| Service object for data/settings storage|
|[[scripting:api:shell:start|IShell]]| Shell Object|
|[[scripting:api:short-key-handler:start|IShortKeyHandler]]| ShortKey Handler object|
|[[scripting:api:status-bar:start|IStatusBar]]| Status Bar object|
|[[scripting:api:style:start|IStyle]]| Style object|
|[[scripting:api:style-collector:start|IStyleCollector]]| Collector for [[:scripting:api:style:start|IStyle]] objects|
|[[scripting:api:style-informer:start|IStyleInformer]]| Document Style informer plugin interface|
|[[scripting:api:style-range:start|IStyleRange]]| Style Range object|
|[[scripting:api:syntax:start|ISyntax]]| Syntax object|
|[[scripting:api:text-document:start|ITextDocument]]| HippoEDIT Text Document object|
|[[scripting:api:text-view:start|ITextView]]| Document View interface|
|[[scripting:api:tool-bar:start|IToolBar]]| ToolBar object|
|[[scripting:api:tool-bar-manager:start|IToolBarManager]]| ToolBar Manager|
|[[scripting:api:tool-handler:start|IToolHandler]]| Tool Item object|
|[[scripting:api:undo-items:start|IUndoItems]]| Collection of Undo Item positions|
|[[scripting:api:url-handler:start|IUrlHandler]]| Url Item Object|
|[[scripting:api:variable-handler:start|IVariableHandler]]| External Variable Handler object|
|[[scripting:api:wscript:start|IWScript]]| WScript Emulation Object|
|[[scripting:api:wsh-arguments:start|IWshArguments]]| Rich collection of WshArgument objects|
|[[scripting:api:wsh-text-stream:start|IWshTextStream]]| WScript ITextStream Emulation object|
===== Native (not scriptable) Objects =====

^Name ^ Description^
|[[scripting:api:completion-provider:start|ICompletionProvider]]| Code Completion Provider used for building extended completion routines|
|[[scripting:api:context-menu-handler:start|IContextMenuHandler]]| Context Menu Handler, shall be implemented by binary plugin, that wants to add own context menu handlers|
|[[scripting:api:document-base-events:start|IDocumentBaseEvents]]| Base Document event interface|
|[[scripting:api:document-iterator:start|IDocumentIterator]]| Collection of files with iterator|
|[[scripting:api:external-document-view:start|IExternalDocumentView]]| External Document View interface to be implemented (optionally) by File Handler plugins|
|[[scripting:api:file-handler:start|IFileHandler]]| File Handler, shall implemented by binary plugin which wants to do custom file loading|
|[[scripting:api:frame-events:start|IFrameEvents]]| Frame event interface|
|[[scripting:api:list-pane-events:start|IListPaneEvents]]| LisPane UI Event interface|
|[[scripting:api:main-menu-handler:start|IMainMenuHandler]]| Main Menu Handler, shall implemented by binary plugin which wants to change main menu|
|[[scripting:api:options-creator:start|IOptionsCreator]]| Factory class for creating of plugin [[:scripting:api:options-page:start|IOptionsPage]] objects, shall be implemented by binary plug-in want to add own Option Pages|
|[[scripting:api:options-page:start|IOptionsPage]]| Options Page object|
|[[scripting:api:options-page-collector:start|IOptionsPageCollector]]| Collector of [[:scripting:api:options-page:start|IOptionsPage]] objects|
|[[scripting:api:output-pane-events:start|IOutputPaneEvents]]| Output Pane UI Event interface|
|[[scripting:api:pane-collector:start|IPaneCollector]]| Collector for [[:scripting:api:pane:start|IPane]] objects|
|[[scripting:api:pane-creator:start|IPaneCreator]]| Factory class for creating tool panes, shall be implemented by binary plugin adding own panes|
|[[scripting:api:plugin-factory:start|IPluginFactory]]| Plugin Factory|
|[[scripting:api:project-events:start|IProjectEvents]]| Project Event interface|
|[[scripting:api:search-provider:start|ISearchProvider]]| Search Provider Handler, shall be implemented by binary plug-in exposing own search type|
|[[scripting:api:sequential-stream:start|ISequentialStream]]| |
|[[scripting:api:status-bar-handler:start|IStatusBarHandler]]| StatusBar Creation Handler, shall implemented by binary plugin which wants to add own indicators to the status bar|
|[[scripting:api:stream:start|IStream]]| |
|[[scripting:api:style-informer-creator:start|IStyleInformerCreator]]| Factory class for style informers, shall be implemented by binary plug-in adding own styles for documents|
|[[scripting:api:tool-bar-handler:start|IToolBarHandler]]| ToolBar Creation Handler, shall be implemented by binary plug-in which wants to add own toolbar|
|[[scripting:api:uievents:start|IUIEvents]]| UI Event interface|
|[[scripting:api:version-checker:start|IVersionChecker]]| Checker interface to support factory versioning|