Methods

Files

Wx::HelpControllerHelpProvider

Public Class Methods

new(help_controller) click to toggle source

(Not documented)

# File wx/classes/helpcontrollerhelpprovider.rb, line 5
  def initialize(help_controller)
    super()
    @hc = help_controller
  end

Public Instance Methods

show_help(win) click to toggle source

Show help for win; if the help text for win is a string with a single integer only, treats that as a section id for help and shows that, otherwise shows a popup (native-style on Windows) of the text.

# File wx/classes/helpcontrollerhelpprovider.rb, line 13
  def show_help(win)
    help_text = get_help(win)
    return false if help_text.empty?
    if help_text =~ /\A\d+\z/
      @hc.display_context_popup(help_text.to_i)
    else
      @hc.display_text_popup(help_text, Wx::get_mouse_position)
    end
    true
  end

Disabled; run with $DEBUG to generate this.

[Validate]

Generated with the Darkfish Rdoc Generator 1.1.6.