wxruby3 1.6.1 → 1.7.0

data/lib/wx/doc/gen/text_validator.rb

@@ -0,0 +1,245 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # Styles used by {Wx::TextValidator}.
+  # 
+  # Notice that {Wx::FILTER_EXCLUDE}[_CHAR]_LIST pair can be used to document the purpose of the validator only and are not enforced in the implementation of the {Wx::TextValidator}. Therefore, calling the corresponding member functions: {Wx::TextValidator}::{SetExcludes,SetCharExcludes}(), is enough to create the desired validator.
+  # 
+  # @wxrb_require USE_VALIDATORS
+  class TextValidatorStyle < Wx::Enum
+  
+    # No filtering takes place.
+    # 
+    FILTER_NONE = Wx::TextValidatorStyle.new(0)
+    
+    # Empty strings are filtered out.
+    # 
+    FILTER_EMPTY = Wx::TextValidatorStyle.new(1)
+    
+    # Non-ASCII characters are filtered out. See Wx::String::IsAscii.
+    # 
+    FILTER_ASCII = Wx::TextValidatorStyle.new(2)
+    
+    # Non-alpha characters are filtered out.
+    # 
+    FILTER_ALPHA = Wx::TextValidatorStyle.new(4)
+    
+    # Non-alphanumeric characters are filtered out.
+    # 
+    FILTER_ALPHANUMERIC = Wx::TextValidatorStyle.new(8)
+    
+    # Non-digit characters are filtered out.
+    # 
+    FILTER_DIGITS = Wx::TextValidatorStyle.new(16)
+    
+    # Non-numeric characters are filtered out.
+    # 
+    FILTER_NUMERIC = Wx::TextValidatorStyle.new(32)
+    
+    # Use an include list.
+    # 
+    FILTER_INCLUDE_LIST = Wx::TextValidatorStyle.new(64)
+    
+    # Use an include char list.
+    # 
+    FILTER_INCLUDE_CHAR_LIST = Wx::TextValidatorStyle.new(128)
+    
+    # Use an exclude list.
+    # 
+    FILTER_EXCLUDE_LIST = Wx::TextValidatorStyle.new(256)
+    
+    # Use an exclude char list.
+    # 
+    FILTER_EXCLUDE_CHAR_LIST = Wx::TextValidatorStyle.new(512)
+    
+    # Non-hexadecimal characters are filtered out.
+    # 
+    FILTER_XDIGITS = Wx::TextValidatorStyle.new(1024)
+    
+    # A convenience flag for use with the other flags.
+    # 
+    FILTER_SPACE = Wx::TextValidatorStyle.new(2048)
+    
+  end # TextValidatorStyle
+  
+  # {Wx::TextValidator} validates text controls, providing a variety of filtering behaviours.
+  # 
+  # For more information, please see wxValidator Overview.
+  # 
+  # Category:  {Wx::Validators}
+  # @see wxValidator Overview
+  # @see  Wx::Validator
+  # @see  Wx::GenericValidator
+  # @see  Wx::IntegerValidator
+  # @see  Wx::FloatingPointValidator 
+  # 
+  # 
+  # @wxrb_require USE_VALIDATORS
+  class TextValidator < Validator
+  
+    # Copy constructor.
+    # @param validator [Wx::TextValidator] 
+    # @return [Wx::TextValidator]
+    def initialize(validator) end
+    
+    # Clones the text validator using the copy constructor.
+    # @return [Wx::TextValidator]
+    def clone; end
+    
+    # Returns a copy of the exclude char list (the list of invalid characters).
+    # @return [String]
+    def get_char_excludes; end
+    alias_method :char_excludes, :get_char_excludes
+    
+    # Returns a copy of the include char list (the list of additional valid characters).
+    # @return [String]
+    def get_char_includes; end
+    alias_method :char_includes, :get_char_includes
+    
+    # Returns a const reference to the exclude list (the list of invalid values).
+    # @return [Wx::ArrayString]
+    def get_excludes; end
+    alias_method :excludes, :get_excludes
+    
+    # Returns a const reference to the include list (the list of valid values).
+    # @return [Wx::ArrayString]
+    def get_includes; end
+    alias_method :includes, :get_includes
+    
+    # Returns the validator style.
+    # 
+    # 
+    # @see Wx::TextValidator#has_flag 
+    # @return [Integer]
+    def get_style; end
+    alias_method :style, :get_style
+    
+    # Returns true if the given style bit is set in the current style.
+    # @param style [Wx::TextValidatorStyle] 
+    # @return [Boolean]
+    def has_flag(style) end
+    alias_method :has_flag?, :has_flag
+    
+    # Sets the exclude list (invalid values for the user input).
+    # 
+    # <div class="wxrb-note">
+    # <b>Note:</b>
+    # <p>Beware that exclusion takes priority over inclusion. 
+    # </p>
+    # </div>
+    # @param stringList [Array<String>] 
+    # @return [void]
+    def set_excludes(stringList) end
+    alias_method :excludes=, :set_excludes
+    
+    # Sets the exclude char list (invalid characters for the user input).
+    # 
+    # <div class="wxrb-note">
+    # <b>Note:</b>
+    # <p>Beware that exclusion takes priority over inclusion. 
+    # </p>
+    # </div>
+    # 
+    # <div class="wxrb-note">
+    # <b>Note:</b>
+    # <p>This function may cancel the effect of {Wx::TextValidatorStyle::FILTER_SPACE} if the passed in string chars contains the <b>space</b> character. 
+    # </p>
+    # </div>
+    # @param chars [String] 
+    # @return [void]
+    def set_char_excludes(chars) end
+    alias_method :char_excludes=, :set_char_excludes
+    
+    # Sets the include list (valid values for the user input).
+    # 
+    # 
+    # @see Wx::TextValidator#is_included 
+    # @param stringList [Array<String>] 
+    # @return [void]
+    def set_includes(stringList) end
+    alias_method :includes=, :set_includes
+    
+    # Sets the include char list (additional valid values for the user input).
+    # 
+    # <div class="wxrb-note">
+    # <b>Note:</b>
+    # <p>Any explicitly excluded characters will still be excluded even if they're part of chars. 
+    # </p>
+    # </div>
+    # @param chars [String] 
+    # @return [void]
+    def set_char_includes(chars) end
+    alias_method :char_includes=, :set_char_includes
+    
+    # Adds exclude to the list of excluded values.
+    # 
+    # <div class="wxrb-note">
+    # <b>Note:</b>
+    # <p>Beware that exclusion takes priority over inclusion.
+    # </p>
+    # </div>
+    # @param exclude [String] 
+    # @return [void]
+    def add_exclude(exclude) end
+    
+    # Adds include to the list of included values.
+    # 
+    # <div class="wxrb-note">
+    # <b>Note:</b>
+    # <p>Any explicitly excluded characters will still be excluded.
+    # </p>
+    # </div>
+    # @param include [String] 
+    # @return [void]
+    def add_include(include) end
+    
+    # Adds chars to the list of excluded characters.
+    # 
+    # <div class="wxrb-note">
+    # <b>Note:</b>
+    # <p>Beware that exclusion takes priority over inclusion.
+    # </p>
+    # </div>
+    # @param chars [String] 
+    # @return [void]
+    def add_char_excludes(chars) end
+    
+    # Adds chars to the list of included characters.
+    # 
+    # <div class="wxrb-note">
+    # <b>Note:</b>
+    # <p>Any explicitly excluded characters will still be excluded even if they're part of chars.
+    # </p>
+    # </div>
+    # @param chars [String] 
+    # @return [void]
+    def add_char_includes(chars) end
+    
+    # Sets the validator style which must be a combination of one or more of the {Wx::TextValidatorStyle} values.
+    # 
+    # Note that not all possible combinations make sense! Also, some combinations have shorter and more idiomatic alternative, e.g. {Wx::TextValidatorStyle::FILTER_ALPHANUMERIC} can be used instead of <code>wxFILTER_ALPHA|wxFILTER_DIGITS</code>.
+    # @param style [Integer] 
+    # @return [void]
+    def set_style(style) end
+    alias_method :style=, :set_style
+    
+    # Validates the window contents against the include or exclude lists, depending on the validator style.
+    # @param parent [Wx::Window] 
+    # @return [Boolean]
+    def validate(parent) end
+    
+    # Returns the error message if the contents of val are invalid or the empty string if val is valid.
+    # @param val [String] 
+    # @return [String]
+    def is_valid(val) end
+    alias_method :valid?, :is_valid
+    
+  end # TextValidator
+  
+
+end

data/lib/wx/doc/gen/time_picker_ctrl.rb

@@ -0,0 +1,128 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # 
+  # 
+  TP_DEFAULT = 0
+  
+  # This control allows the user to enter time.
+  # 
+  # It is similar to {Wx::DatePickerCtrl} but is used for time, and not date, selection. While {Wx::TimePickerCtrl#get_value} and {Wx::TimePickerCtrl#set_value} still work with values of type {Wx::DateTime} (because wxWidgets doesn't provide a time-only class), their date part is ignored by this control.
+  # It is only available if {Wx::Setup::USE_TIMEPICKCTRL} is set to 1.
+  # This control currently doesn't have any specific flags.
+  # 
+  # <div class="wxrb-note">
+  # <b>Note:</b>
+  # <p>In WXMSW this control uses default user date format even if Wx::UILocale#use_default hasn't been called, while under the other platforms it only does it if the default UI locale has been set. For applications targeting international users, it is strongly recommended to call Wx::UILocale#use_default to ensure that the behaviour is consistent across all platforms.
+  # </p>
+  # </div>
+  # 
+  # ### Events emitted by this class
+  # 
+  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::DateEvent} events.
+  # Event handler methods for events emitted by this class:
+  # 
+  # - {Wx::EvtHandler#evt_time_changed}(id, meth = nil, &block): Process a {Wx::EVT_TIME_CHANGED} event, which fires when the user changes the current selection in the control. 
+  # 
+  # Category:  Picker Controls  <div class='appearance'><span class='appearance'>Appearance:</span><table><tr><td> WXMSW Appearance
+  #   </td><td> WXGTK Appearance
+  #   </td><td> WXOSX Appearance
+  #   </td></tr></table></div>
+  # @see Wx::DatePickerCtrl
+  # @see  Wx::CalendarCtrl
+  # @see  Wx::DateEvent
+  # 
+  # 
+  # @wxrb_require USE_TIMEPICKCTRL
+  class TimePickerCtrl < Control
+  
+    # @overload initialize()
+    #   Default constructor.
+    #   @return [Wx::TimePickerCtrl]
+    # @overload initialize(parent, id, dt=Wx::DEFAULT_DATE_TIME, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::TP_DEFAULT, validator=Wx::DEFAULT_VALIDATOR, name=Wx::TIME_PICKER_CTRL_NAME_STR)
+    #   Initializes the object and calls {Wx::TimePickerCtrl#create} with all the parameters.
+    #   @param parent [Wx::Window] 
+    #   @param id [Integer] 
+    #   @param dt [Time,Date,DateTime] 
+    #   @param pos [Array(Integer, Integer), Wx::Point] 
+    #   @param size [Array(Integer, Integer), Wx::Size] 
+    #   @param style [Integer] 
+    #   @param validator [Wx::Validator] 
+    #   @param name [String] 
+    #   @return [Wx::TimePickerCtrl]
+    # @overload initialize(parent, id, dt=Wx::DEFAULT_DATE_TIME, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::TP_DEFAULT, validator=Wx::DEFAULT_VALIDATOR, name=Wx::TIME_PICKER_CTRL_NAME_STR, &block)
+    #   Initializes the object and calls {Wx::TimePickerCtrl#create} with all the parameters.
+    #   @param parent [Wx::Window] 
+    #   @param id [Integer] 
+    #   @param dt [Time,Date,DateTime] 
+    #   @param pos [Array(Integer, Integer), Wx::Point] 
+    #   @param size [Array(Integer, Integer), Wx::Size] 
+    #   @param style [Integer] 
+    #   @param validator [Wx::Validator] 
+    #   @param name [String] 
+    #   @yieldparam [Wx::TimePickerCtrl] win new instance
+    #   @return [Wx::TimePickerCtrl]
+    def initialize(*args) end
+    
+    # Create the control window.
+    # 
+    # This method should only be used for objects created using default constructor.
+    # 
+    # true if the control was successfully created or false if creation failed.
+    # @param parent [Wx::Window]  Parent window, must not be non-null.
+    # @param id [Integer]  The identifier for the control.
+    # @param dt [Time,Date,DateTime]  The initial value of the control, if an invalid date (such as the default value) is used, the control is set to current time.
+    # @param pos [Array(Integer, Integer), Wx::Point]  Initial position.
+    # @param size [Array(Integer, Integer), Wx::Size]  Initial size. If left at default value, the control chooses its own best size by using the height approximately equal to a text control and width large enough to show the time fully.
+    # @param style [Integer]  The window style, should be left at 0 as there are no special styles for this control in this version.
+    # @param validator [Wx::Validator]  Validator which can be used for additional checks.
+    # @param name [String]  Control name.
+    # @return [Boolean]
+    def create(parent, id, dt=Wx::DEFAULT_DATE_TIME, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::TP_DEFAULT, validator=Wx::DEFAULT_VALIDATOR, name=Wx::TIME_PICKER_CTRL_NAME_STR) end
+    
+    # Returns the currently entered time as hours, minutes and seconds.
+    # 
+    # All the arguments must be non-null, false is returned otherwise and none of them is modified.
+    # @see Wx::TimePickerCtrl#set_time
+    # @return [Array(Boolean,Integer,Integer,Integer)]
+    def get_time; end
+    alias_method :time, :get_time
+    
+    # Returns the currently entered time.
+    # 
+    # The date part of the returned {Wx::DateTime} object is always set to today and should be ignored, only the time part is relevant.
+    # @return [Time,Date,DateTime]
+    def get_value; end
+    alias_method :value, :get_value
+    
+    # Changes the current time of the control.
+    # 
+    # Calling this method does not result in a time change event.
+    # 
+    # true if the time was changed or false on failure, e.g. if the time components were invalid.
+    # @see Wx::TimePickerCtrl#get_time
+    # @param hour [Integer]  The new hour value in 0..23 interval.
+    # @param min [Integer]  The new minute value in 0..59 interval.
+    # @param sec [Integer]  The new second value in 0..59 interval.
+    # @return [Boolean]
+    def set_time(hour, min, sec) end
+    
+    # Changes the current value of the control.
+    # 
+    # The date part of dt is ignored, only the time part is displayed in the control. The dt object must however be valid.
+    # In particular, notice that it is a bad idea to use default {Wx::DateTime} constructor from hour, minute and second values as it uses the today date for the date part, which means that some values can be invalid if today happens to be the day of DST change. For example, when switching to summer time, the time 2:00 typically doesn't exist as the clocks jump directly to 3:00. To avoid this problem, use a fixed date on which DST is known not to change (e.g. Jan 1, 2012) for the date part of the argument or use {Wx::TimePickerCtrl#set_time}.
+    # Calling this method does not result in a time change event.
+    # @param dt [Time,Date,DateTime] 
+    # @return [void]
+    def set_value(dt) end
+    alias_method :value=, :set_value
+    
+  end # TimePickerCtrl
+  
+
+end

data/lib/wx/doc/gen/timer.rb

@@ -0,0 +1,119 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # The {Wx::Timer} class allows you to execute code at specified intervals.
+  # 
+  # Its precision is platform-dependent, but in general will not be better than 1ms nor worse than 1s.
+  # There are three different ways to use this class:
+  # 
+  # - You may derive a new class from {Wx::Timer} and override the {Wx::Timer#notify} member to perform the required action.
+  # - You may redirect the notifications to any {Wx::EvtHandler} derived object by using the non-default constructor or {Wx::Timer#set_owner}. Then {Wx::Timer#bind} {Wx::EVT_TIMER} (or use the EVT_TIMER macro) to connect it to the event handler which will receive {Wx::TimerEvent} notifications.
+  # - You may use a derived class and {Wx::Timer#bind} {Wx::EVT_TIMER} to connect it to an event handler defined in the derived class. If the default constructor is used, the timer object will be its own owner object, since it is derived from {Wx::EvtHandler}.
+  # 
+  # In any case, you must start the timer with {Wx::Timer#start} after constructing it before it actually starts sending notifications. It can be stopped later with {Wx::Timer#stop}.
+  # 
+  # <div class="wxrb-note">
+  # <b>Note:</b>
+  # <p>A timer can only be used from the main thread.
+  # </p>
+  # </div>
+  # 
+  # Category:  {Wx::Miscellaneous}
+  # @see Wx::StopWatch 
+  # 
+  # 
+  # @wxrb_require USE_TIMER
+  class Timer < EvtHandler
+  
+    # @overload initialize()
+    #   Default constructor.
+    #   
+    #   If you use it to construct the object and don't call {Wx::Timer#set_owner} later, you must override {Wx::Timer#notify} method to process the notifications.
+    #   @return [Wx::Timer]
+    # @overload initialize(owner, id=-1)
+    #   Creates a timer and associates it with owner.
+    #   
+    #   Please see {Wx::Timer#set_owner} for the description of parameters.
+    #   @param owner [Wx::EvtHandler] 
+    #   @param id [Integer] 
+    #   @return [Wx::Timer]
+    def initialize(*args) end
+    
+    # Returns the ID of the events generated by this timer.
+    # @return [Integer]
+    def get_id; end
+    alias_method :id, :get_id
+    
+    # Returns the current interval for the timer (in milliseconds).
+    # @return [Integer]
+    def get_interval; end
+    alias_method :interval, :get_interval
+    
+    # Returns the current owner of the timer.
+    # 
+    # If non-null this is the event handler which will receive the timer events (see {Wx::TimerEvent}) when the timer is running.
+    # @return [Wx::EvtHandler]
+    def get_owner; end
+    alias_method :owner, :get_owner
+    
+    # Returns true if the timer is one shot, i.e. if it will stop after firing the first notification automatically.
+    # @return [Boolean]
+    def is_one_shot; end
+    alias_method :one_shot?, :is_one_shot
+    
+    # Returns true if the timer is running, false if it is stopped.
+    # @return [Boolean]
+    def is_running; end
+    alias_method :running?, :is_running
+    
+    # This member should be overridden by the user if the default constructor was used and {Wx::Timer#set_owner} wasn't called.
+    # 
+    # Perform whatever action which is to be taken periodically here.
+    # Notice that throwing exceptions from this method is currently not supported, use event-based timer handling approach if an exception can be thrown while handling timer notifications.
+    # @return [void]
+    def notify; end
+    
+    # Associates the timer with the given owner object.
+    # 
+    # When the timer is running, the owner will receive timer events (see {Wx::TimerEvent}) with id equal to id specified here.
+    # @param owner [Wx::EvtHandler] 
+    # @param id [Integer] 
+    # @return [void]
+    def set_owner(owner, id=-1) end
+    alias_method :owner=, :set_owner
+    
+    # (Re)starts the timer.
+    # 
+    # If milliseconds parameter is -1 (value by default), the previous value is used. Returns false if the timer could not be started, true otherwise (in MS Windows timers are a limited resource).
+    # If oneShot is false (the default), the {Wx::Timer#notify} function will be called repeatedly until the timer is stopped. If true, it will be called only once and the timer will stop automatically.
+    # To make your code more readable you may also use the following symbolic constants:
+    # 
+    # - {Wx::TIMER_CONTINUOUS}: Start a normal, continuously running, timer
+    # - {Wx::TIMER_ONE_SHOT}: Start a one shot timer. Alternatively, and preferably, call {Wx::Timer#start_once} instead of this function.
+    # 
+    # If the timer was already running, it will be stopped by this method before restarting it.
+    # @param milliseconds [Integer] 
+    # @param oneShot [Boolean] 
+    # @return [Boolean]
+    def start(milliseconds=-1, oneShot=Wx::TIMER_CONTINUOUS) end
+    
+    # Starts the timer for a once-only notification.
+    # 
+    # This is a simple wrapper for {Wx::Timer#start} with {Wx::TIMER_ONE_SHOT} parameter.
+    # @param milliseconds [Integer] 
+    # @return [Boolean]
+    def start_once(milliseconds=-1) end
+    
+    # Stops the timer.
+    # @return [void]
+    def stop; end
+    
+  end # Timer
+  
+
+end

data/lib/wx/doc/gen/timer_event.rb

@@ -0,0 +1,68 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # 
+  TIMER_CONTINUOUS = 0
+  
+  # 
+  TIMER_ONE_SHOT = 1
+  
+  # 
+  # 
+  EVT_TIMER = 10001
+  
+  # {Wx::TimerEvent} object is passed to the event handler of timer events (see {Wx::Timer#set_owner}).
+  # 
+  # For example:
+  # 
+  # ```ruby
+  #   class MyFrame < Wx::Frame
+  # 
+  #     def initialize
+  #       super(nil)
+  #       @timer = Wx::Timer.new(self, TIMER_ID)
+  # 
+  #       evt_timer(TIMER_ID, :on_timer)
+  # 
+  #       @timer.start(1000)    # 1 second interval
+  #     end
+  #      
+  #     ...
+  #      
+  #     def on_timer(event)
+  #       # do whatever you want to do every second here
+  #     end
+  #   
+  #   end
+  # ```
+  # 
+  # Category:  {Wx::Events}
+  # @see Wx::Timer 
+  # 
+  # 
+  # @wxrb_require USE_TIMER
+  class TimerEvent < Event
+  
+    # @param timer [Wx::Timer] 
+    # @return [Wx::TimerEvent]
+    def initialize(timer) end
+    
+    # Returns the interval of the timer which generated this event.
+    # @return [Integer]
+    def get_interval; end
+    alias_method :interval, :get_interval
+    
+    # Returns the timer object which generated this event.
+    # @return [Wx::Timer]
+    def get_timer; end
+    alias_method :timer, :get_timer
+    
+  end # TimerEvent
+  
+
+end

data/lib/wx/doc/gen/tip_provider.rb

@@ -0,0 +1,63 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # This function creates a {Wx::TipProvider} which may be used with {show_tip}.
+  # 
+  # 
+  # @see wxTipProvider Overview
+  # @param filename [String]  The name of the file containing the tips, one per line.
+  # @param currentTip [Integer]  The index of the first tip to show. Normally this index is remembered between the 2 program runs.
+  # @return [Wx::TipProvider]
+  def self.create_file_tip_provider(filename, currentTip) end
+  
+  # This function shows a "startup tip" to the user.
+  # 
+  # The return value is the state of the "Show tips at startup" checkbox.
+  # @see wxTipProvider Overview
+  # @param parent [Wx::Window]  The parent window for the modal dialog.
+  # @param tipProvider [Wx::TipProvider]  An object which is used to get the text of the tips. It may be created with the {create_file_tip_provider} function.
+  # @param showAtStartup [Boolean]  Should be true if startup tips are shown, false otherwise. This is used as the initial value for "Show tips at startup" checkbox which is shown in the tips dialog.
+  # @return [Boolean]
+  def self.show_tip(parent, tipProvider, showAtStartup=true) end
+  
+  # This is the class used together with {show_tip} function.
+  # 
+  # It must implement {Wx::TipProvider#get_tip} function and return the current tip from it (different tip each time it is called).
+  # You will never use this class yourself, but you need it to show startup tips with {show_tip}. Also, if you want to get the tips text from elsewhere than a simple text file, you will want to derive a new class from {Wx::TipProvider} and use it instead of the one returned by {create_file_tip_provider}.
+  # 
+  # Category:  {Wx::Miscellaneous}
+  # @see wxTipProvider Overview
+  # @see  show_tip 
+  # 
+  # 
+  # @wxrb_require USE_STARTUP_TIPS
+  class TipProvider < ::Object
+  
+    # Constructor.
+    # @param currentTip [Integer]  The starting tip index.
+    # @return [Wx::TipProvider]
+    def initialize(currentTip) end
+    
+    # Returns the index of the current tip (i.e. the one which would be returned by {Wx::TipProvider#get_tip}).
+    # 
+    # The program usually remembers the value returned by this function after calling {show_tip}. Note that it is not the same as the value which was passed to {show_tip} + 1 because the user might have pressed the "Next" button in the tip dialog.
+    # @return [Integer]
+    def get_current_tip; end
+    alias_method :current_tip, :get_current_tip
+    
+    # Return the text of the current tip and pass to the next one.
+    # 
+    # This function is pure virtual, it should be implemented in the derived classes.
+    # @return [String]
+    def get_tip; end
+    alias_method :tip, :get_tip
+    
+  end # TipProvider
+  
+
+end

data/lib/wx/doc/gen/tip_window.rb

@@ -0,0 +1,51 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # Shows simple text in a popup tip window on creation.
+  # 
+  # This is used by {Wx::SimpleHelpProvider} to show popup help. The window automatically destroys itself when the user clicks on it or it loses the focus.
+  # You may also use this class to emulate the tooltips when you need finer control over them than what the standard tooltips provide.
+  # 
+  # Category:  Managed Windows
+  # @see Wx::ToolTip 
+  # 
+  # 
+  # @wxrb_require USE_TIPWINDOW
+  class TipWindow < Window
+  
+    # Replace the deprecated single-step constructor.
+    # 
+    # See {Wx::TipWindow#create} for parameters
+    # @see Wx::TipWindow#create
+    # @param parent [Wx::Window] 
+    # @param text [String] 
+    # @param maxLength [Integer] 
+    # @param rectBound [Wx::Rect] 
+    # @return [Wx::TipWindow::Ref]
+    def self.new_tip(parent, text, maxLength=100, rectBound=nil) end
+    
+    # By default, the tip window disappears when the user clicks the mouse or presses a keyboard key or if it loses focus in any other way - for example because the user switched to another application window.
+    # 
+    # Additionally, if a non-empty rectBound is provided, the tip window will also automatically close if the mouse leaves this area. This is useful to dismiss the tip mouse when the mouse leaves the object it is associated with.
+    # @param rectBound [Wx::Rect]  The bounding rectangle for the mouse in the screen coordinates
+    # @return [void]
+    def set_bounding_rect(rectBound) end
+    alias_method :bounding_rect=, :set_bounding_rect
+    
+    # Constructs a new TipWindow object which is immediately shown.
+    # Returns a {Wx::TipWindow::Ref}.
+    # @param parent [Wx::Window] parent window (not nil).
+    # @param text [String] The text to show, may contain the new line characters.
+    # @param maxLength [Integer] The length of each line, in pixels. Set to a very large value to avoid wrapping lines.
+    # @param rectBounds [Wx::Rect] If given, passed to {Wx::TipWindow#set_bounding_rect}, please see its documentation for the description of this parameter.
+    # @return [Wx::TipWindow::Ref] weak tip window reference
+    def self.new_tip(parent, text, maxLength = 100, rectBounds = nil) end
+  end # TipWindow
+  
+
+end