Public Member Functions | Package Functions

BinNavi.API.plugins.IPlugin Interface Reference

Base interface of all plugins. More...

Inheritance diagram for BinNavi.API.plugins.IPlugin:
BinNavi.API.plugins.IAddressSpaceMenuPlugin BinNavi.API.plugins.IBatchPlugin BinNavi.API.plugins.ICriteriaSelectionPlugin BinNavi.API.plugins.IDatabaseMenuPlugin BinNavi.API.plugins.IGraphMenuPlugin BinNavi.API.plugins.IMainWindowMenuPlugin BinNavi.API.plugins.IModuleMenuPlugin BinNavi.API.plugins.IProjectFolderMenuPlugin BinNavi.API.plugins.IProjectMenuPlugin

List of all members.

Public Member Functions

long getGuid ()
 The GUID of the plugin.
String getName ()
 The name of the plugin.
void init (PluginInterface pluginInterface)
 Initializes the plugin.
void unload ()
 Unloads the plugin.

Package Functions

String getDescription ()
 The description of the plugin.

Detailed Description

All plugins have to implement this interface.

Member Function Documentation

String BinNavi.API.plugins.IPlugin.getDescription (  )  [package]

Returns a description of the plugin. This description is used in the plugin configuration dialog to let the user know what the plugin does.

Returns:
The description of the plugin.
long BinNavi.API.plugins.IPlugin.getGuid (  ) 

Returns a unique GUID that identifies the plugin. Plugins with duplicate GUIDs will not be loaded.

Returns:
The GUID that identifies the plugin.
String BinNavi.API.plugins.IPlugin.getName (  ) 

Returns the name of the plugin. This name is used in the plugin configuration dialog to let the user select what plugin to configure.

Note that plugins that return null from this function will not be loaded.

Returns:
The name of the plugin.
void BinNavi.API.plugins.IPlugin.init ( PluginInterface  pluginInterface  ) 

The plugin manager calls this function for each plugin right after loading a plugin for the first time.

Note that this function should be used to initialize the plugin. Do not use the constructor of the plugin to initialize plugin.

Further note that all plugins must have a standard constructor that does not take any arguments. Only this constructor is used to load a plugin.

Parameters:
pluginInterface The plugin interface that gives a plugin access to BinNavi.
void BinNavi.API.plugins.IPlugin.unload (  ) 

This function is called when the plugin is unloaded. Plugins that actively changed the appearance of BinNavi (for example by adding menus or showing dialogs) must remove all changes in this function.

Generated on Wed Aug 3 2011 10:19:30 for zynamicsBinNavi by  doxygen 1.7.1