# :stopdoc:
# This file is automatically generated by the WXRuby3 documentation 
# generator. Do not alter this file.
# :startdoc:


module Wx

  # {Wx::HelpProvider} is an abstract class used by a program implementing context-sensitive help to show the help text for the given window.
  # The current help provider must be explicitly set by the application using {Wx::HelpProvider.set}.
  # === 
  # 
  # Category:  {Wx::HELP}
  # @see Wx::ContextHelp
  # @see  Wx::ContextHelpButton
  # @see  Wx::SimpleHelpProvider
  # @see  Wx::HelpControllerHelpProvider
  # @see  Wx::Window#set_help_text
  # @see  Wx::Window#get_help_text_at_point 
  # 
  # 
  class HelpProvider < ::Object
  
    # @overload add_help(window, text)
    #   Associates the text with the given window.
    #   Although all help providers have these functions to allow making {Wx::Window#set_help_text} work, not all of them implement the functions.
    #   @param window [Wx::Window] 
    #   @param text [String] 
    #   @return [void]
    # @overload add_help(id, text)
    #   Associates the text with the given ID.
    #   This help text will be shown for all windows with ID id, unless they have more specific help text associated using the other {Wx::HelpProvider#add_help} prototype. May be used to set the same help string for all Cancel buttons in the application, for example.
    #   Although all help providers have these functions to allow making {Wx::Window#set_help_text} work, not all of them implement the functions.
    #   @param id [Integer] 
    #   @param text [String] 
    #   @return [void]
    def add_help(*args) end
    
    # This version associates the given text with all windows with this id.
    # May be used to set the same help string for all Cancel buttons in the application, for example.
    # @param window [Wx::Window] 
    # @return [String]
    def get_help(window) end
    alias_method :help, :get_help
    
    # Removes the association between the window pointer and the help text.
    # This is called by the {Wx::Window} destructor. Without this, the table of help strings will fill up and when window pointers are reused, the wrong help string will be found.
    # @param window [Wx::Window] 
    # @return [void]
    def remove_help(window) end
    
    # Shows help for the given window.
    # Override this function if the help doesn't depend on the exact position inside the window, otherwise you need to override {Wx::HelpProvider#show_help_at_point}. Returns true if help was shown, or false if no help was available for this window.
    # @param window [Wx::Window] 
    # @return [Boolean]
    def show_help(window) end
    
    # This function may be overridden to show help for the window when it should depend on the position inside the window, By default this method forwards to {Wx::HelpProvider#show_help}, so it is enough to only implement the latter if the help doesn't depend on the position.
    # true if help was shown, or false if no help was available for this window.
    # @param window [Wx::Window]  Window to show help text for.
    # @param point [Array(Integer, Integer), Wx::Point]  Coordinates of the mouse at the moment of help event emission.
    # @param origin [Wx::wxHelpEvent::Origin]  Help event origin, see {Wx::HelpEvent#get_origin}.
    # @return [Boolean]
    def show_help_at_point(window, point, origin) end
    
    # Returns pointer to help provider instance.
    # Unlike some other classes, the help provider is not created on demand. This must be explicitly done by the application using {Wx::HelpProvider.set}.
    # @return [Wx::HelpProvider]
    def self.get; end
    
    # Set the current, application-wide help provider.
    # Pointer to previous help provider or NULL if there wasn't any.
    # @param helpProvider [Wx::HelpProvider] 
    # @return [Wx::HelpProvider]
    def self.set(helpProvider) end
    
  end # HelpProvider
  

end