root/branches/greitmayr/extensions/referrals.py @ 28

# Example plugin for EditorFunctions type plugins
# The functionality was originally implemented by endura29 <endura29@gmail.com>
#
# The plugin allows to install new menu items and toolbar items and register a
# a function with each that is called. The function must accept one argument which
# is the instance of PersonalWikiFrame providing access to the editor and the data store.
# 
# To register a menu item implement the function describeMenuItem to return a
# tuple containing the callback function, the item string and an item tooltip.
#
# To register a toolbar item implement the function describeToolbarItem to return
# a tuple containing the callback function, item label, item icon and tooltip.
#
# both register functions must accept one argument which is again the 
# PersonalWikiFrame instance

# descriptor for EditorFunctions plugin type
WIKIDPAD_PLUGIN = (("EditorFunctions",1),)

def describeMenuItem(wiki):
    return (referrals, "Show Referring Wikis\tctrl-r", "Show Referring Wikis")

def describeToolbarItem(wiki):
    (index, icon) = wiki.iconLookup["rename"]
    return (referrals, "Referers", icon, "Show Referring Wikis")

def referrals(wiki):
    wiki.editor.AddText("\n------------------------\n")
    parents = wiki.wikiData.getParentRelationships(wiki.currentWikiWord)
    wiki.editor.AddText("*%s Wikis referring to*   %s\n" % (len(parents), wiki.currentWikiWord))
    for word in parents:
        wiki.editor.AddText("%s\n" % word) 
    wiki.editor.AddText("------------------------\n")
    children = wiki.wikiData.getChildRelationships(wiki.currentWikiWord)
    wiki.editor.AddText("*%s Wikis referred to by* %s\n" % (len(children), wiki.currentWikiWord))
    for word in children:
        wiki.editor.AddText("%s\n" % word)
    wiki.editor.AddText("------------------------\n")