/Source Code/Plugins/PluginSupport/PluginContextBase.vb

Imports System.Windows.Forms



Public MustInherit Class PluginContextBase



    ''' <summary>

    ''' Names of items present in the main menu of the primary form.

    ''' </summary>

    Public Enum EMainMenuItem

        File = 0

        Projection = 1

        PlayList = 2

        Tools = 3

        Help = 4

    End Enum



    ''' <summary>

    ''' Adds an item to the main menu.

    ''' </summary>

    ''' <param name="text">The text of the item added to the menu.</param>

    ''' <param name="onClick">An event handler which handles users clicking the menu item.</param>

    ''' <returns>The menu item added to the interface.</returns>

    Public MustOverride Function AddMainMenuItem(ByVal text As String, ByVal onClick As EventHandler) As ToolStripItem



    ''' <summary>

    ''' Adds an item to the specified sub menu.

    ''' </summary>

    ''' <param name="mainMenuItem">The main menu item to add the item to.</param>

    ''' <param name="text">The text of the item added to the specified menu.</param>

    ''' <param name="onClick">An event handler which handles users clicking the menu item.</param>

    ''' <returns>The menu item added to the interface.</returns>

    Public MustOverride Function AddSubMenuItem(ByVal mainMenuItem As EMainMenuItem, ByVal text As String, ByVal onClick As EventHandler) As ToolStripItem



    ''' <summary>

    ''' Returns a Boolean value indicating whether or not a database is loaded.

    ''' </summary>

    ''' <returns>True if a database is loaded.</returns>

    Public MustOverride Function IsDatabaseLoaded() As Boolean



    ''' <summary>

    ''' Returns the version of the database.

    ''' </summary>

    ''' <returns>The version of the database.</returns>

    Public MustOverride Function GetDatabaseVersion() As String



End Class