Contents

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


module Wx

  # This event class is used for the events generated by {Wx::SpinButton} and {Wx::SpinCtrl}.
  # === Events using this class
  # 
  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::SpinEvent} events.
  # Event handler methods:
  # 
  # - {Wx::EvtHandler#evt_spin}(id, meth = nil, &block): Generated whenever an arrow is pressed. 
  # 
  # - {Wx::EvtHandler#evt_spin_up}(id, meth = nil, &block): Generated when left/up arrow is pressed. 
  # 
  # - {Wx::EvtHandler#evt_spin_down}(id, meth = nil, &block): Generated when right/down arrow is pressed. 
  # 
  # Note that if you handle both SPIN and UP or DOWN events, you will be notified about each of them twice: first the UP/DOWN event will be received and then, if it wasn't vetoed, the SPIN event will be sent.
  # === 
  # 
  # Category:  {Wx::Events}
  # @see Wx::SpinButton and Wx::SpinCtrl 
  # 
  # 
  class SpinEvent < NotifyEvent
  
    # The constructor is not normally used by the user code.
    # @param commandType [Wx::CommandLinkButton::EventType] 
    # @param id [Integer] 
    # @return [Wx::SpinEvent]
    def initialize(commandType=Wx::EVT_NULL, id=0) end
    
    # Retrieve the current spin button or control value.
    # @return [Integer]
    def get_position; end
    alias_method :position, :get_position
    
    # Set the value associated with the event.
    # @param pos [Integer] 
    # @return [void]
    def set_position(pos) end
    alias_method :position=, :set_position
    
  end # SpinEvent
  

end

Version data entries

2 entries across 2 versions & 1 rubygems

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