parent nodes: Plugins

AP Is

Contents:
AP Is
General
Selected functions of PersonalWikiFrame instance
The following documentation is outdated!*
wikidPad functions
wikidPad.variables*
wikiData - The wiki database interface*
wikiPage object*
tree control*
text control*

Back

General

The first argument to each hook function is the instance of the
PersonalWikiFrame object which is the main window of the application.
In scripts, this instance is automatically assigned to the variable
"pwiki".

If you are reading the source code of WikidPad, this instance is often
stored in member variable "pWiki", for some newer objects it has the
name "mainControl".

Back

Selected functions of PersonalWikiFrame instance

• newWiki(wikiName, wikiDir) • openWiki(wikiConfigFilename, wikiWordToOpen=None, ignoreWdhName=False) • saveCurrentWikiState() • openWikiPage(wikiWord) • findCurrentWordInTree() • viewParents(word) • viewChildren() • viewParentLess() • viewBookmarks() • viewHistory() • saveCurrentWikiPage() • stdDialog(dlgtype, title, message, additional=None) • displayErrorMessage(errorStr, exception) • getWikiData() • getActiveEditor() • getCurrentWikiWord() • getCurrentDocPage() Back

The following documentation is outdated!*

The first argument to each hook function is wikidPad itself. Here are
the available methods on the wikidPad object.

wikidPad functions

addToHistory(word) goInHistory(positionDelta) goBackInHistory() goForwardInHistory() showWikiWordOpenDialog()
showWikiWordRenameDialog()
showWikiWordRenameConfirmDialog()
showSearchDialog()
showSavedSearchesDialog()
showWikiWordDeleteDialog()
showFindReplaceDialog()

displayMessage(title, msg)

wikidPad.variables*

globalConfigDir globalConfigLoc globalConfig wikiAppDir wikiPadHelp config wikiName dataDir wikiData tree editor

wikiData - The wiki database interface*

getPage(wikiWord, itemsToLoad) getChildRelationships(wikiWord) getParentRelationships(wikiWord) getAllWords() getAllAliases() getAllRelations() getWikiWordsStartingWith(string)
getWikiWordsWith(string)
getWikiWordsModifiedWithin(days)
getParentLessWords()

renameWord(word, toWord) deleteWord(word) getWordsWithPropertyValue(key, value) findBestPathFromWordToWord(word, toWord) search(forPattern) getTodos()

wikiPage object*

wikiWord wikiFile parentRelations childRelations todos props getContent() save()

tree control*

collapse() buildTreeForWord(wikiword)

text control*

setWrap(onOrOffBoolean) SetText() snip() startIncrementalSearch(searchStr) endIncrementalSearch() executeSearch(searchStr, searchStartPos=-1) getWikiWordText(position) getWikiWordBeginEnd(position) isPositionInWikiWord(position) isPositionInLink(position) See the wxWindows/wxPython documentation for info about the wxTreeCtrl and wxStyledTextCtrl.

previous: Back
parents:  Plugins
[alias: ApiDocs], [camelCaseWordsEnabled: false]
[help.status: done]