Advanced Plug-in Development Tips & Tricks

   1    VirtualKeyboard keyboard = (VirtualKeyboard)GUIWindowManager.GetWindow((int)GUIWindow.Window.WINDOW_VIRTUAL_KEYBOARD);
   2     if (null == keyboard)
   3         return;
   4 
   5     keyboard.Reset();
   6     keyboard.Text = strLine;
   7     keyboard.DoModal(GetID);
   8     if (keyboard.IsConfirmed)
   9     {
  10         // Do something here. The typed value is stored in "keyboard.Text"
  11     }

   1   DialogWebKeyboard keyboard = (DialogWebKeyboard)GUIWindowManager.GetWindow((int)GUIWindow.Window.WINDOW_VIRTUAL_WEB_KEYBOARD);
   2   ...

   1    //Activate new window
   2    GUIWindowManager.ActivateWindow(YOUR_TO_BE_ACTIVATED_WINDOW_ID);
   3 
   4    ...
   5 
   6    //Show the previous window (go back)
   7    GUIWindowManager.ShowPreviousWindow();

   1   Log.Info("My plugin: started");

   1   // Read configuration settings
   2   using (Settings reader = new Settings(Config.GetFile(Config.Dir.Config, "mediaportal.xml")))
   3   {
   4      setting = reader.GetValue("section_name", "setting_name");
   5   }

   1   // Save a property
   2   GUIPropertyManager.SetProperty("#status", "Ready");
   3 
   4   // Read a property value
   5   string strUrl = GUIPropertyManager.GetProperty("#urltonavigate");

   1    /// <summary>
   2    /// Shows the Error Dialog
   3    /// </summary>
   4    private void ShowErrorDialog(string messsage)
   5    {
   6       GUIDialogOK dlgOK = (GUIDialogOK)GUIWindowManager.GetWindow((int)GUIWindow.Window.WINDOW_DIALOG_OK);
   7       if (dlgOK != null)
   8       {
   9          dlgOK.SetHeading("Error" /* or Message */);
  10          dlgOK.SetLine(1, messsage);
  11          dlgOK.SetLine(2, "");
  12          dlgOK.DoModal(PARENT_WINDOW_ID);
  13       }
  14    }

   1    private int ShowContextMenu()
   2    {
   3       GUIDialogMenu dlgMenu = (GUIDialogMenu)GUIWindowManager.GetWindow((int)GUIWindow.Window.WINDOW_DIALOG_MENU);
   4       if (dlgMenu != null)
   5       {
   6          dlgMenu.Reset();
   7          dlgMenu.SetHeading("Header");
   8          dlgMenu.Add("line 1");
   9          dlgMenu.Add("line 2");
  10          ...
  11          dlgMenu.DoModal(PARENT_WINDOW_ID);
  12 
  13          if (dlgMenu.SelectedLabel == -1) // Nothing was selected
  14             return EventAction.Nothing;
  15 
  16          return dlgMenu.SelectedLabel;
  17       }
  18    }

   1 namespace MediaPortal.GUI.Library
   2 {
   3         public interface IPlugin
   4         {
   5              void Start();
   6              void Stop();
   7         }
   8 }