wxruby3 1.6.0 → 1.7.0

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

@@ -0,0 +1,51 @@
+# :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 
+  # 
+  # 
+  # @wxrb_require USE_SPINBTN|USE_SPINCTRL
+  class SpinEvent < NotifyEvent
+  
+    # The constructor is not normally used by the user code.
+    # @param commandType [Wx::TipWindow::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

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

@@ -0,0 +1,113 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # 
+  SPLASH_CENTRE_ON_PARENT = 1
+  
+  # 
+  SPLASH_CENTRE_ON_SCREEN = 2
+  
+  # 
+  SPLASH_NO_CENTRE = 0
+  
+  # 
+  SPLASH_TIMEOUT = 4
+  
+  # 
+  SPLASH_NO_TIMEOUT = 0
+  
+  # {Wx::SplashScreen} shows a window with a thin border, displaying a bitmap describing your application.
+  # 
+  # Show it in application initialisation, and then either explicitly destroy it or let it time-out.
+  # Example usage:
+  # 
+  # ```ruby
+  #   bitmap Wx::Bitmap.new 
+  #   if bitmap.load_file("splash16.png", Wx::BITMAP_TYPE_PNG))
+  #      splash = Wx::SplashScreen.new(bitmap,
+  #          Wx::SPLASH_CENTRE_ON_SCREEN|Wx::SPLASH_TIMEOUT,
+  #          6000, nil, -1, Wx::DEFAULT_POSITION, Wx::DEFAULT_SIZE,
+  #          Wx::BORDER_SIMPLE|Wx::STAY_ON_TOP)
+  #   end
+  #   Wx.get_app.yield
+  # ```
+  # 
+  # Category:  Managed Windows
+  # 
+  # @wxrb_require USE_SPLASH
+  class SplashScreen < Frame
+  
+    # @overload initialize(bitmap, splashStyle, milliseconds, parent, id, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=(Wx::Border::BORDER_SIMPLE|Wx::FRAME_NO_TASKBAR|Wx::STAY_ON_TOP))
+    #   Construct the splash screen passing a bitmap, a style, a timeout, a window id, optional position and size, and a window style.
+    #   
+    #   splashStyle is a bitlist of some of the following:
+    #   
+    #   - {Wx::SPLASH_CENTRE_ON_PARENT}
+    #   - {Wx::SPLASH_CENTRE_ON_SCREEN}
+    #   - {Wx::SPLASH_NO_CENTRE}
+    #   - {Wx::SPLASH_TIMEOUT}
+    #   - {Wx::SPLASH_NO_TIMEOUT}
+    #   
+    #   milliseconds is the timeout in milliseconds.
+    #   @param bitmap [Wx::Bitmap] 
+    #   @param splashStyle [Integer] 
+    #   @param milliseconds [Integer] 
+    #   @param parent [Wx::Window] 
+    #   @param id [Integer] 
+    #   @param pos [Array(Integer, Integer), Wx::Point] 
+    #   @param size [Array(Integer, Integer), Wx::Size] 
+    #   @param style [Integer] 
+    #   @return [Wx::SplashScreen]
+    # @overload initialize(bitmap, splashStyle, milliseconds, parent, id, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=(Wx::Border::BORDER_SIMPLE|Wx::FRAME_NO_TASKBAR|Wx::STAY_ON_TOP), &block)
+    #   Construct the splash screen passing a bitmap, a style, a timeout, a window id, optional position and size, and a window style.
+    #   
+    #   splashStyle is a bitlist of some of the following:
+    #   
+    #   - {Wx::SPLASH_CENTRE_ON_PARENT}
+    #   - {Wx::SPLASH_CENTRE_ON_SCREEN}
+    #   - {Wx::SPLASH_NO_CENTRE}
+    #   - {Wx::SPLASH_TIMEOUT}
+    #   - {Wx::SPLASH_NO_TIMEOUT}
+    #   
+    #   milliseconds is the timeout in milliseconds.
+    #   @param bitmap [Wx::Bitmap] 
+    #   @param splashStyle [Integer] 
+    #   @param milliseconds [Integer] 
+    #   @param parent [Wx::Window] 
+    #   @param id [Integer] 
+    #   @param pos [Array(Integer, Integer), Wx::Point] 
+    #   @param size [Array(Integer, Integer), Wx::Size] 
+    #   @param style [Integer] 
+    #   @yieldparam [Wx::SplashScreen] win new instance
+    #   @return [Wx::SplashScreen]
+    def initialize(*args) end
+    
+    # Returns the splash style (see {Wx::SplashScreen#initialize} for details).
+    # @return [Integer]
+    def get_splash_style; end
+    alias_method :splash_style, :get_splash_style
+    
+    # Returns the window used to display the bitmap.
+    # @return [Wx::Window]
+    def get_splash_window; end
+    alias_method :splash_window, :get_splash_window
+    
+    # Returns the timeout in milliseconds.
+    # @return [Integer]
+    def get_timeout; end
+    alias_method :timeout, :get_timeout
+    
+    # Reimplement this event handler if you want to set an application variable on window destruction, for example.
+    # @param event [Wx::CloseEvent] 
+    # @return [void]
+    def on_close_window(event) end
+    
+  end # SplashScreen
+  
+
+end

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

@@ -0,0 +1,99 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # This class represents the events generated by a splitter control.
+  # 
+  # Also there is only one event class, the data associated to the different events is not the same and so not all accessor functions may be called for each event. The documentation mentions the kind of event(s) for which the given accessor function makes sense: calling it for other types of events will result in assert failure (in debug mode) and will return meaningless results.
+  # ### Events using this class
+  # 
+  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::SplitterEvent} events.
+  # Event handler methods:
+  # 
+  # - {Wx::EvtHandler#evt_splitter_sash_pos_changing}(id, meth = nil, &block): The sash position is in the process of being changed. May be used to modify the position of the tracking bar to properly reflect the position that would be set if the drag were to be completed at this point. Processes a {Wx::EVT_SPLITTER_SASH_POS_CHANGING} event. 
+  # 
+  # - {Wx::EvtHandler#evt_splitter_sash_pos_changed}(id, meth = nil, &block): The sash position was changed. May be used to modify the sash position before it is set, or to prevent the change from taking place. Processes a {Wx::EVT_SPLITTER_SASH_POS_CHANGED} event. 
+  # 
+  # - {Wx::EvtHandler#evt_splitter_unsplit}(id, meth = nil, &block): The splitter has been just unsplit. Processes a {Wx::EVT_SPLITTER_UNSPLIT} event. 
+  # 
+  # - {Wx::EvtHandler#evt_splitter_dclick}(id, meth = nil, &block): The sash was double clicked. The default behaviour is to unsplit the window when this happens (unless the minimum pane size has been set to a value greater than zero). Processes a {Wx::EVT_SPLITTER_DOUBLECLICKED} event. 
+  # 
+  # Category:  {Wx::Events}
+  # @see Wx::SplitterWindow
+  # @see  Events and Event Handling 
+  # 
+  # 
+  # @wxrb_require USE_SPLITTER
+  class SplitterEvent < NotifyEvent
+  
+    # Constructor.
+    # 
+    # Used internally by wxWidgets only.
+    # @param eventType [Wx::TipWindow::EventType] 
+    # @param splitter [Wx::SplitterWindow] 
+    # @return [Wx::SplitterEvent]
+    def initialize(eventType=Wx::EVT_NULL, splitter=nil) end
+    
+    # Returns the new sash position.
+    # 
+    # May only be called while processing {Wx::EVT_SPLITTER_SASH_POS_CHANGING}, {Wx::EVT_SPLITTER_SASH_POS_RESIZE} and {Wx::EVT_SPLITTER_SASH_POS_CHANGED} events.
+    # @return [Integer]
+    def get_sash_position; end
+    alias_method :sash_position, :get_sash_position
+    
+    # Returns a pointer to the window being removed when a splitter window is unsplit.
+    # 
+    # May only be called while processing {Wx::EVT_SPLITTER_UNSPLIT} events.
+    # @return [Wx::Window]
+    def get_window_being_removed; end
+    alias_method :window_being_removed, :get_window_being_removed
+    
+    # Returns the x coordinate of the double-click point.
+    # 
+    # May only be called while processing {Wx::EVT_SPLITTER_DOUBLECLICKED} events.
+    # @return [Integer]
+    def get_x; end
+    alias_method :x, :get_x
+    
+    # Returns the y coordinate of the double-click point.
+    # 
+    # May only be called while processing {Wx::EVT_SPLITTER_DOUBLECLICKED} events.
+    # @return [Integer]
+    def get_y; end
+    alias_method :y, :get_y
+    
+    # In the case of {Wx::EVT_SPLITTER_SASH_POS_CHANGED} events, sets the new sash position.
+    # 
+    # In the case of {Wx::EVT_SPLITTER_SASH_POS_CHANGING} events, sets the new tracking bar position so visual feedback during dragging will represent that change that will actually take place. Set to -1 from the event handler code to prevent repositioning.
+    # May only be called while processing {Wx::EVT_SPLITTER_SASH_POS_CHANGING}, {Wx::EVT_SPLITTER_SASH_POS_RESIZE} and {Wx::EVT_SPLITTER_SASH_POS_CHANGED} events.
+    # @param pos [Integer]  New sash position.
+    # @return [void]
+    def set_sash_position(pos) end
+    alias_method :sash_position=, :set_sash_position
+    
+    # Sets the size values of the window size.
+    # 
+    # This size is adjusted to the sash orientation. For a vertical sash it should be the width and for a horizontal sash it's the height.
+    # May only be called while processing {Wx::EVT_SPLITTER_SASH_POS_CHANGING}, {Wx::EVT_SPLITTER_SASH_POS_RESIZE} and {Wx::EVT_SPLITTER_SASH_POS_CHANGED} events.
+    # @param oldSize [Integer] 
+    # @param newSize [Integer] 
+    # @return [void]
+    def set_size(oldSize, newSize) end
+    
+    # Returns the old size before the update.
+    # 
+    # The size value is already adjusted to the orientation of the sash. So for a vertical sash it's the width and for a horizontal sash it's the height.
+    # May only be called while processing {Wx::EVT_SPLITTER_SASH_POS_CHANGING}, {Wx::EVT_SPLITTER_SASH_POS_RESIZE} and {Wx::EVT_SPLITTER_SASH_POS_CHANGED} events. 
+    # May only be called while processing {Wx::EVT_SPLITTER_SASH_POS_CHANGING}, {Wx::EVT_SPLITTER_SASH_POS_RESIZE} and {Wx::EVT_SPLITTER_SASH_POS_CHANGED} events.
+    # @return [Integer]
+    def get_old_size; end
+    alias_method :old_size, :get_old_size
+    
+  end # SplitterEvent
+  
+
+end