Contents

# :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 = 10005
  
  # {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

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
wxruby3-0.9.2-x64-mingw-ucrt	lib/wx/doc/gen/timer_event.rb