Reply to thread

Message

A plugin can now have its own setup/configuration form(s)
I've setup a simple interface :
[code]
using System;

namespace MediaPortal.GUI.Library
{
/// <summary>
/// Interface for plugin setup configuration screens.
///
/// Plugins may have a configuration screen. By implementing this interface in your plugin
/// MediaPortal will add it to the tools->plugin menu where users can configure your plugin
/// Look at the home subproject for a sample
/// </summary>
public interface ISetupForm
{
string PluginName(); // Return the name which should b shown in the plugin menu
string Description(); // Return the description which should b shown in the plugin menu
string Author(); // Return the author which should b shown in the plugin menu
void ShowPlugin(); // show the setup dialog
bool CanEnable(); // Indicates whether plugin can be enabled/disabled
int GetWindowId(); // get ID of plugin window

/// <summary>
/// If the plugin should have its own button on the home screen then it
/// should return true to this method, otherwise if it should not be on home
/// it should return false
/// </summary>
/// <param name="strButtonText">text the button should have</param>
/// <param name="strButtonImage">image for the button, or empty for default</param>
/// <param name="strButtonImageFocus">image for the button, or empty for default</param>
/// <param name="strPictureImage">subpicture for the button or empty for none</param>
/// <returns>true : plugin needs its own button on home
/// false : plugin does not need its own button on home</returns>
bool GetHome(out string strButtonText, out string strButtonImage, out string strButtonImageFocus, out string strPictureImage);
}
}

[/code]

If your own plugin contains class(es) which implement this interface they will show up on the tools->plugin... menu
When a user wants to configure the plugin the ShowPlugIn() will be called

Frodo

<blockquote data-quote="Frodo" data-source="post: 663" data-attributes="member: 10277">A plugin can now have its own setup/configuration form(s)I've setup a simple interface :[code]using System;namespace MediaPortal.GUI.Library{&nbsp; /// &lt;summary&gt;&nbsp; /// Interface for plugin setup configuration screens. &nbsp; /// &nbsp; /// Plugins may have a configuration screen. By implementing this interface in your plugin&nbsp; /// MediaPortal will add it to the tools-&gt;plugin menu where users can configure your plugin&nbsp; /// Look at the home subproject for a sample &nbsp; /// &lt;/summary&gt;&nbsp; public interface ISetupForm&nbsp; {&nbsp; &nbsp; string PluginName();&nbsp; // Return the name which should b shown in the plugin menu&nbsp; &nbsp; string Description(); // Return the description which should b shown in the plugin menu&nbsp; &nbsp; string Author();&nbsp; &nbsp; &nbsp; // Return the author which should b shown in the plugin menu&nbsp; &nbsp; void&nbsp;&nbsp; ShowPlugin();&nbsp; // show the setup dialog&nbsp; &nbsp; bool&nbsp;&nbsp; CanEnable();&nbsp;&nbsp; // Indicates whether plugin can be enabled/disabled&nbsp; &nbsp; int&nbsp; &nbsp; GetWindowId(); // get ID of plugin window&nbsp; &nbsp; /// &lt;summary&gt;&nbsp; &nbsp; /// If the plugin should have its own button on the home screen then it&nbsp; &nbsp; /// should return true to this method, otherwise if it should not be on home&nbsp; &nbsp; /// it should return false&nbsp; &nbsp; /// &lt;/summary&gt;&nbsp; &nbsp; /// &lt;param name=&quot;strButtonText&quot;&gt;text the button should have&lt;/param&gt;&nbsp; &nbsp; /// &lt;param name=&quot;strButtonImage&quot;&gt;image for the button, or empty for default&lt;/param&gt;&nbsp; &nbsp; /// &lt;param name=&quot;strButtonImageFocus&quot;&gt;image for the button, or empty for default&lt;/param&gt;&nbsp; &nbsp; /// &lt;param name=&quot;strPictureImage&quot;&gt;subpicture for the button or empty for none&lt;/param&gt;&nbsp; &nbsp; /// &lt;returns&gt;true&nbsp; : plugin needs its own button on home&nbsp; &nbsp; ///&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; false : plugin does not need its own button on home&lt;/returns&gt;&nbsp; &nbsp; bool&nbsp;&nbsp; GetHome(out string strButtonText, out string strButtonImage, out string strButtonImageFocus, out string strPictureImage); &nbsp; }}[/code]If your own plugin contains class(es) which implement this interface they will show up on the tools-&gt;plugin... menu&nbsp; When a user wants to configure the plugin the ShowPlugIn() will be calledFrodo</blockquote>

[QUOTE="Frodo, post: 663, member: 10277"] A plugin can now have its own setup/configuration form(s) I've setup a simple interface : [code] using System; namespace MediaPortal.GUI.Library { /// <summary> /// Interface for plugin setup configuration screens. /// /// Plugins may have a configuration screen. By implementing this interface in your plugin /// MediaPortal will add it to the tools->plugin menu where users can configure your plugin /// Look at the home subproject for a sample /// </summary> public interface ISetupForm { string PluginName(); // Return the name which should b shown in the plugin menu string Description(); // Return the description which should b shown in the plugin menu string Author(); // Return the author which should b shown in the plugin menu void ShowPlugin(); // show the setup dialog bool CanEnable(); // Indicates whether plugin can be enabled/disabled int GetWindowId(); // get ID of plugin window /// <summary> /// If the plugin should have its own button on the home screen then it /// should return true to this method, otherwise if it should not be on home /// it should return false /// </summary> /// <param name="strButtonText">text the button should have</param> /// <param name="strButtonImage">image for the button, or empty for default</param> /// <param name="strButtonImageFocus">image for the button, or empty for default</param> /// <param name="strPictureImage">subpicture for the button or empty for none</param> /// <returns>true : plugin needs its own button on home /// false : plugin does not need its own button on home</returns> bool GetHome(out string strButtonText, out string strButtonImage, out string strButtonImageFocus, out string strPictureImage); } } [/code] If your own plugin contains class(es) which implement this interface they will show up on the tools->plugin... menu When a user wants to configure the plugin the ShowPlugIn() will be called Frodo [/QUOTE]