Contents

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


module Wx

  # This class is a special event handler which allows discarding any event (or a set of event types) directed to a specific window.
  # Example:
  # 
  # ```ruby
  #   class MyWindow
  # 
  #     ...
  # 
  #     def do_something
  #       # block all events directed to this window
  #       Wx::EventBlocker.blocked_for(self) do
  #         # while we do 1000 function_that_sends_events calls 
  #         1000.times { |i| function_that_sends_events(i) }
  #       end
  #       # old event handler restored; generated event(s) from next call will be processed
  #       function_that_sends_events(0)
  #     end
  # 
  #     ... 
  # 
  #   end
  # ```
  # 
  # === 
  # 
  # Category:  {Wx::Events}
  # @see How Events are Processed
  # @see  Wx::EvtHandler 
  # 
  # 
  # 
  # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
  class EventBlocker < EvtHandler
  
    # Adds to the list of event types which should be blocked the given eventType.
    # @param eventType [Wx::CommandLinkButton::EventType] 
    # @return [void]
    def block(eventType) end
    
  end # EventBlocker
  

end

Version data entries

2 entries across 2 versions & 1 rubygems

Version	Path
wxruby3-0.9.1-x64-mingw-ucrt	lib/wx/doc/gen/event_blocker.rb
wxruby3-0.9.0-x64-mingw-ucrt	lib/wx/doc/gen/event_blocker.rb