NAME
  DynamicHelp - Tk 部品やBWidgetに説明文を提供する Provide help to Tk widget or BWidget

COMMAND
  DynamicHelp::add widget ?option value ...?
  DynamicHelp::configure ?option? ?value option value ...?
  DynamicHelp::delete widget
  DynamicHelp::include class type
  DynamicHelp::register path type ?arg...?
  DynamicHelp::sethelp path subpath ?force?

DESCRIPTION

説明文 Description text

命令 COMMAND

DynamicHelp::add ?option value ...?

  この命令は与えられた部品に動的説明文を追加する｡ This command adds dynamic help to the given widget.

  -command
    もし指定されると､展示すべき説明文を得る事を遂行する命令を参照する｡命令は展示すべき文字列を返さねばならない｡もし空文字列を返すと､説明文は展示されない｡ If specified, refers to a command to execute to get the help text to display. The command must return a string to display. If the command returns an empty string, no help is displayed.
  -index
    指定されると､部品の代りに説明文に束縛すべき目録の番号を参照する｡もし-type が目録でない場合､この指示項目は無視される｡ If specified, refers to a menu index to bind the help to instead of a widget. If -type is not menu, this option is ignored.
  -item
    指定されると､部品の代りに､画布部品上の品目か貼札､若しくは､説明文に束縛すべき文書内の貼札､を参照する｡ If specified, refers to an item or tag on a canvas widget or to a tag in a text widget to bind the help to instead of to a widget.
  -type
    説明文の様式を指定する｡可能なものは:風船 か 変数 か 目録｡既定は風船である｡ Specifies the type of help. Can be: balloon, variable or menu. Default is balloon.
  -text
    説明文として展示されるべき文書｡ The text to be displayed as help.
  -variable
    そこに説明文文字列が書かれるべき変数の名前を指定する｡幾つかの他の部品(譬えば 状態帯)がこの変数の展示に対応する｡ Specifies a variable name to which the help string will be written. Some other widget (e.g., a status bar) is responsible for displaying this variable.

  目録について動的説明文の生成は二段階の課程である｡目録自身は最初に加えられねばならず､且つそれぞれの目録の見出しは別々に加えられねばならない｡これが簡単な例である｡ Creating dynamic help for a menu is a two-step process. The menu itself must first be added and then each menu entry must be added separately. Here is a brief example.

          # 目録作成   create menu
          menu .m -type menubar
          # DynamicHelp::register が目録分身の名前と共に働かせる前に
          # 目録帯を頂上水準に結合する
          # associate menubar to toplevel BEFORE DynamicHelp::register
          # to make it works with menu clone name
          . configure -menu .m
          .m add cascade -label "File" -menu .m.file
          menu .m.file
          .m.file add command -label "Open..."
          .m.file add command -label "Quit"
          # 変数varinfoを使って説明文の札を生成する
          # create label for help, using variable varinfo
          label .l -textvariable varinfo
          # 目録 .m.file の全見出しを変数 varinfo に結合する
          # associate all entries of menu .m.file to variable varinfo
          DynamicHelp::add .m.file -type menu -variable varinfo
          # 次に .m.file の見出しを宣言する
          # then declare entries of .m.file
          DynamicHelp::add .m.file -type menu -index 0 -text "Detach menu"
          DynamicHelp::add .m.file -type menu -index 1 -text "Open a file"
          DynamicHelp::add .m.file -type menu -index 2 -text "Exit demo"

DynamicHelp::configure ?option? ?value option value ...?
  この命令は風船説明文を構成設定する｡ This command configure the ballon help.

  -borderwidth
    風船の周囲の黒い縁の巾｡ Width of the black border around the balloon.
  -delay
    風船を展示する前の千分の一秒単位のマウスの働かない遅延を定める｡ Define the delay in millisecond of mouse inactivity before displaying the balloon.
  -state
    説明文風船に関する二つの状態の一つを指定する:normal か disabled のどちらか｡ Specifies one of two states for help balloons: normal and disabled.
    状態が disabled であると､説明文風船はどの登録部品についても展示されない｡ If state is disabled, help balloons will not be displayed for any registered widget.
  -topbackground
    風船の為に生成される頂上水準の窓の背景の色｡ The background color of the toplevel window created for a balloon.
  その他の標準の指示項目は: Other standard options are:

  -background or -bg | -font
  -foreground or -fg | -justify
  -padx | -pady

DynamicHelp::delete widget
  与えられた widgetについて全ての動的説明文を削除する｡ Delete all dynamic help for the given widget.

DynamicHelp::include class type
  説明文 Description text

DynamicHelp::register path type ?arg...?

  この使用は推奨されない｡代りに DynamicHelp::add を使われたい｡ Its use is deprecated. Use DynamicHelp::add instead.

  説明文を部品の経路に登録する｡type は説明文の様式又は部品の様式を定める｡ type に従って他の指示項目が提供されねばならない｡ Register a help text to the widget path. type determines the type of the help or the type of the widget. Depending on type, other options must be provided.

  type | options
  balloon | ?tagOrItem? text
  variable | ?tagOrItem? varName text
  menu | varName
  menuentry | index text

  もし指示項目の一つが欠落するか空であると､この部品についての説明文は除去される｡ If one of the option is missing or is empty, help is removed for this widget.

  tagOrItem が指定されていると経路は画布か文書である｡画布の場合 tagOrItem はそこに説明文が束縛される画布上の貼札か品目である｡文書の場合 tagOrItem はそこに説明文が束縛される文書上の貼札である｡ If tagOrItem is specified, then path is a canvas or a text. In case of a canvas, tagOrItem is the name of a tag or item on the canvas to which the help will be bound. In case of a text, tagOrItem is the name of a tag on the text to which the help will be bound.

  balloonと varName 以外の様式は典型的には札に連鎖された変数である｡ 目録については､風船様式の説明文は利用できない｡目録に関する説明文を宣言するには使用者は最初に目録を宣言し次いでこの目録の見出しを続ける｡譬えば: For type other than balloon, varName is typically a variable linked to a label.
  For menu, balloon type help is not available. To declare a help for menu, you first declare the menu, and then entries of this menu.
  For example:

           # create menu
      menu .m -type menubar
      # associate menubar to toplevel BEFORE DynamicHelp::register
      # to make it works with menu clone name
      . configure -menu .m
      .m add cascade -label "File" -menu .m.file
      menu .m.file
      .m.file add command -label "Open..."
      .m.file add command -label "Quit"
      # create label for help, using variable varinfo
      label .l -textvariable varinfo
      # associate all entries of menu .m.file to variable varinfo
      DynamicHelp::register .m.file menu varinfo
      # then declare entries of .m.file
      DynamicHelp::register .m.file menuentry 0 "Detach menu"
      DynamicHelp::register .m.file menuentry 1 "Open a file"
      DynamicHelp::register .m.file menuentry 2 "Exit demo"

  註意すべきはもし跳び出し目録が目録帯に所有されていると､使用者は最初に目録帯をその頂上水準に結合せねばならない｡この場合､使用者が跳び出し目録を生成する時その分身の窓も生成され､ DynamicHelp::register は分身窓の存在を検知し行事をそれに対応付けする｡ Notice that if popup menu is owned by a menubar, you must associate first the menubar to its toplevel. In this case, when you create a menu popup, its clone window is also created, and DynamicHelp::register detects the exitence of the clone window and maps events to it.

DynamicHelp::sethelp path subpath ?force?
  Description text