Sha256: 27810b74221e6e77e8a98a00a3d40fefb7bfa24a65df21ada6e04eac1412f356

Contents?: true

Size: 1.55 KB

Versions: 8

Compression:

Stored size: 1.55 KB

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:
  # 
  #   class MyFrame : public wxFrame
  #   {
  #   public:
  #       ...
  #       void OnTimer(wxTimerEvent& event);
  #   
  #   private:
  #       wxTimer m_timer;
  #       wxDECLARE_EVENT_TABLE();
  #   };
  #   
  #   wxBEGIN_EVENT_TABLE(MyFrame, wxFrame)
  #       EVT_TIMER(TIMER_ID, MyFrame::OnTimer)
  #   wxEND_EVENT_TABLE()
  #   
  #   MyFrame::MyFrame()
  #          : m_timer(this, TIMER_ID)
  #   {
  #       m_timer.Start(1000);    // 1 second interval
  #   }
  #   
  #   void MyFrame::OnTimer(wxTimerEvent& event)
  #   {
  #       // do whatever you want to do every second here
  #   }
  # 
  # === 
  # 
  # Category:  {Wx::Events}
  # @see Wx::Timer 
  # 
  # 
  class TimerEvent < Event
  
    # @param timer [Wx::Timer] 
    # @return [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

8 entries across 8 versions & 1 rubygems

Version Path
wxruby3-0.9.0.pre.beta.14-x64-mingw-ucrt lib/wx/doc/gen/timer_event.rb
wxruby3-0.9.0.pre.beta.13-x64-mingw-ucrt lib/wx/doc/gen/timer_event.rb
wxruby3-0.9.0.pre.beta.11-x64-mingw-ucrt lib/wx/doc/gen/timer_event.rb
wxruby3-0.9.0.pre.beta.10-x64-mingw-ucrt lib/wx/doc/gen/timer_event.rb
wxruby3-0.9.0.pre.beta.9-x64-mingw-ucrt lib/wx/doc/gen/timer_event.rb
wxruby3-0.9.0.pre.beta.8-x64-mingw-ucrt lib/wx/doc/gen/timer_event.rb
wxruby3-0.9.0.pre.beta.2-x64-mingw-ucrt-3.2-3.2.2 lib/wx/doc/gen/timer_event.rb
wxruby3-0.9.0.pre.beta.1-x64-mingw-ucrt-3.2 lib/wx/doc/gen/timer_event.rb