mcs/class/Managed.Windows.Forms/System.Windows.Forms/Help.cs

   1 // Permission is hereby granted, free of charge, to any person obtaining
   2 // a copy of this software and associated documentation files (the
   3 // "Software"), to deal in the Software without restriction, including
   4 // without limitation the rights to use, copy, modify, merge, publish,
   5 // distribute, sublicense, and/or sell copies of the Software, and to
   6 // permit persons to whom the Software is furnished to do so, subject to
   7 // the following conditions:
   8 //
   9 // The above copyright notice and this permission notice shall be
  10 // included in all copies or substantial portions of the Software.
  11 //
  12 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  13 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  14 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  15 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  16 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  17 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  18 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  19 //
  20 // Copyright (c) 2005 Novell, Inc. (http://www.novell.com)
  21 //
  22 // Authors:
  23 //      Peter Bartok    (pbartok@novell.com)
  24 //
  25 //
  26
  27 // NOT COMPLETE
  28
  29 using System;
  30 using System.Drawing;
  31
  32 namespace System.Windows.Forms
  33 {
  34         public class Help
  35         {
  36                 #region Constructor
  37                 private Help ()
  38                 {
  39                 }
  40                 #endregion
  41
  42                 #region Public Static Methods
  43                 public static void ShowHelp (Control parent, string url)
  44                 {
  45                         ShowHelp(parent, url, HelpNavigator.TableOfContents, null);
  46                 }
  47
  48                 public static void ShowHelp (Control parent, string url, HelpNavigator navigator)
  49                 {
  50                         ShowHelp(parent, url, navigator, null);
  51                 }
  52
  53                 [MonoTODO("Create glue code to tie into libCHM")]
  54 #if NET_2_0
  55                 public static void ShowHelp (Control parent, string url, HelpNavigator command, object parameter)
  56                 {
  57                         object param = parameter;
  58 #else
  59                 public static void ShowHelp (Control parent, string url, HelpNavigator command, object param)
  60                 {
  61 #endif
  62                         MessageBox.Show(parent, Locale.GetText("Help (" + command +
  63                                         (param != null ? "(" + param + ")" : String.Empty) +
  64                                         ") not yet implemented"), Locale.GetText("Popup Help"),
  65                                         MessageBoxButtons.OK, MessageBoxIcon.Stop);
  66                 }
  67
  68                 public static void ShowHelp (Control parent, string url, string keyword)
  69                 {
  70                         if (keyword == null || keyword == String.Empty)
  71                                 ShowHelp (parent, url, HelpNavigator.TableOfContents, null);
  72                         ShowHelp (parent, url, HelpNavigator.Topic, keyword);
  73                 }
  74
  75                 public static void ShowHelpIndex (Control parent, string url)
  76                 {
  77                         ShowHelp (parent, url, HelpNavigator.Index, null);
  78                 }
  79
  80                 [MonoTODO("Create glue code to tie into libCHM")]
  81                 public static void ShowPopup (Control parent, string caption, Point location)
  82                 {
  83                         MessageBox.Show (parent, Locale.GetText ("Popup Help not yet implemented"),
  84                                 Locale.GetText ("Popup Help"), MessageBoxButtons.OK, MessageBoxIcon.Stop);
  85                 }
  86                 #endregion      // Public Static Methods
  87         }
  88 }