wxruby3 0.9.0.pre.beta.8-x64-mingw-ucrt

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

@@ -0,0 +1,170 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # 
+  # 
+  EVT_SPINCTRL = 10131
+  
+  # 
+  # 
+  EVT_SPINCTRLDOUBLE = 10132
+  
+  # {Wx::SpinCtrl} combines {Wx::TextCtrl} and {Wx::SpinButton} in one control.
+  # === Styles
+  # 
+  # This class supports the following styles:
+  #  
+  # - {Wx::SP_ARROW_KEYS}: The user can use arrow keys to change the value. 
+  # - {Wx::SP_WRAP}: The value wraps at the minimum and maximum. 
+  # - {Wx::TE_PROCESS_ENTER}: Indicates that the control should generate {Wx::EVT_TEXT_ENTER} events. Using this style will prevent the user from using the Enter key for dialog navigation (e.g. activating the default button in the dialog) under MSW. 
+  # - {Wx::Alignment::ALIGN_LEFT}: Same as {Wx::TE_LEFT} for {Wx::TextCtrl}: the text is left aligned (this is the default). 
+  # - {Wx::Alignment::ALIGN_CENTRE_HORIZONTAL}: Same as {Wx::TE_CENTRE} for {Wx::TextCtrl}: the text is centered. 
+  # - {Wx::Alignment::ALIGN_RIGHT}: Same as {Wx::TE_RIGHT} for {Wx::TextCtrl}: the text is right aligned. 
+  # 
+  # === Events emitted by this class
+  # 
+  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::SpinEvent} events.
+  # Event handler methods for events emitted by this class:
+  # - {Wx::EvtHandler#evt_spinctrl}(id, meth = nil, &block): Process a {Wx::EVT_SPINCTRL} event, which is generated whenever the numeric value of the spin control is updated. 
+  # 
+  # You may also use the {Wx::SpinButton} event macros, however the corresponding events will not be generated under all platforms. Finally, if the user modifies the text in the edit part of the spin control directly, the EVT_TEXT is generated, like for the {Wx::TextCtrl}. When the use enters text into the text area, the text is not validated until the control loses focus (e.g. by using the TAB key). The value is then adjusted to the range and a {Wx::SpinEvent} sent then if the value is different from the last value sent.
+  # === 
+  # 
+  # Category:  {Wx::Controls}  <div class='appearance'><span class='appearance'>Appearance:</span><table><tr><td> {Wx::MSW} Appearance
+  #   </td><td> {Wx::GTK} Appearance
+  #   </td><td> {Wx::OSX} Appearance
+  #   </td></tr></table></div>
+  # @see Wx::SpinButton
+  # @see  Wx::SpinCtrlDouble
+  # @see  Wx::Control 
+  # 
+  # 
+  class SpinCtrl < Control
+  
+    # @overload initialize()
+    #   Default constructor.
+    #   @return [SpinCtrl]
+    # @overload initialize(parent, id=Wx::ID_ANY, value=Wx::EMPTY_STRING, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::SP_ARROW_KEYS, min=0, max=100, initial=0, name=("Wx::SPIN_CTRL"))
+    #   Constructor, creating and showing a spin control.
+    #   If value is non-empty, it will be shown in the text entry part of the control and if it has numeric value, the initial numeric value of the control, as returned by {Wx::SpinCtrl#get_value} will also be determined by it instead of by initial. Hence, it only makes sense to specify initial if value is an empty string or is not convertible to a number, otherwise initial is simply ignored and the number specified by value is used.
+    #   @see Wx::SpinCtrl#create 
+    #   @param parent [Wx::Window]  Parent window. Must not be NULL.
+    #   @param id [Integer]  Window identifier. The value {Wx::StandardID::ID_ANY} indicates a default value.
+    #   @param value [String]  Default value (as text).
+    #   @param pos [Array(Integer, Integer), Wx::Point]  Window position. If {Wx::DEFAULT_POSITION} is specified then a default position is chosen.
+    #   @param size [Array(Integer, Integer), Wx::Size]  Window size. If {Wx::DEFAULT_SIZE} is specified then a default size is chosen.
+    #   @param style [Integer]  Window style. See {Wx::SpinButton}.
+    #   @param min [Integer]  Minimal value.
+    #   @param max [Integer]  Maximal value.
+    #   @param initial [Integer]  Initial value.
+    #   @param name [String]  Window name.
+    #   @return [SpinCtrl]
+    def initialize(*args) end
+    
+    # Creation function called by the spin control constructor.
+    # See {Wx::SpinCtrl#spin_ctrl} for details.
+    # @param parent [Wx::Window] 
+    # @param id [Integer] 
+    # @param value [String] 
+    # @param pos [Array(Integer, Integer), Wx::Point] 
+    # @param size [Array(Integer, Integer), Wx::Size] 
+    # @param style [Integer] 
+    # @param min [Integer] 
+    # @param max [Integer] 
+    # @param initial [Integer] 
+    # @param name [String] 
+    # @return [true,false]
+    def create(parent, id=Wx::ID_ANY, value=Wx::EMPTY_STRING, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::SP_ARROW_KEYS, min=0, max=100, initial=0, name=("Wx::SPIN_CTRL")) end
+    
+    # Returns the numerical base being currently used, 10 by default.
+    # 
+    # @see Wx::SpinCtrl#set_base
+    # @return [Integer]
+    def get_base; end
+    alias_method :base, :get_base
+    
+    # Gets maximal allowable value.
+    # @return [Integer]
+    def get_max; end
+    alias_method :max, :get_max
+    
+    # Gets minimal allowable value.
+    # @return [Integer]
+    def get_min; end
+    alias_method :min, :get_min
+    
+    # Returns the text in the text entry part of the control.
+    # @return [String]
+    def get_text_value; end
+    alias_method :text_value, :get_text_value
+    
+    # Gets the value of the spin control.
+    # @return [Integer]
+    def get_value; end
+    alias_method :value, :get_value
+    
+    # Get the value for increment for a spin control.
+    # The default value is 1 but it can be changed using {Wx::SpinCtrl#set_increment}.
+    # @return [Integer]
+    def get_increment; end
+    alias_method :increment, :get_increment
+    
+    # Sets the base to use for the numbers in this control.
+    # Currently the only supported values are 10 (which is the default) and 16.
+    # Changing the base allows the user to enter the numbers in the specified base, e.g. with "0x" prefix for hexadecimal numbers, and also displays the numbers in the specified base when they are changed using the spin control arrows.
+    # Setting a base to 16 is allowed only if current range does not include negative values.
+    # 
+    # true if the base was successfully changed or false if it failed, usually meaning that either the base is not 10 or 16 or that the base is not supported for values in the current range.
+    # @param base [Integer]  Numeric base, currently only 10 and 16 are supported.
+    # @return [true,false]
+    def set_base(base) end
+    alias_method :base=, :set_base
+    
+    # Sets range of allowable values.
+    # Notice that calling this method may change the value of the control if it's not inside the new valid range, e.g. it will become minVal if it is less than it now. However no {Wx::EVT_SPINCTRL} event is generated, even if it the value does change.
+    # Setting a range including negative values is silently ignored if current base is set to 16.
+    # @param minVal [Integer] 
+    # @param maxVal [Integer] 
+    # @return [void]
+    def set_range(minVal, maxVal) end
+    
+    # Select the text in the text part of the control between positions from (inclusive) and to (exclusive).
+    # This is similar to {Wx::TextCtrl#set_selection}.
+    # this is currently only implemented for Windows and generic versions of the control.
+    # @param from [Integer] 
+    # @param to [Integer] 
+    # @return [void]
+    def set_selection(from, to) end
+    
+    # @overload set_value(text)
+    #   Sets the value of the spin control.
+    #   It is recommended to use the overload taking an integer value instead. If text doesn't represent a valid number, it may not be shown in the text part of the control at all (only empty string is guaranteed to be supported under all platforms) and the numeric value will be changed to {Wx::SpinCtrl#get_min}.
+    #   Notice that, unlike {Wx::TextCtrl#set_value}, but like most of the other setter methods in wxWidgets, calling this method does not generate any events as events are only generated for the user actions.
+    #   @param text [String] 
+    #   @return [void]
+    # @overload set_value(value)
+    #   Sets the value of the spin control.
+    #   Calling this method doesn't generate any {Wx::EVT_SPINCTRL} events.
+    #   @param value [Integer] 
+    #   @return [void]
+    def set_value(*args) end
+    alias_method :value=, :set_value
+    
+    # Sets the increment for the control.
+    # The increment is the number by which the value changes when the up or down arrow is used.
+    # The default is 1, but it can be useful to set it to a higher value when using the control for bigger numbers.
+    # Note that it is still possible to enter any value (in the valid range) into the control manually, whatever is the value of the increment.
+    # @param value [Integer] 
+    # @return [void]
+    def set_increment(value) end
+    alias_method :increment=, :set_increment
+    
+  end # SpinCtrl
+  
+
+end

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

@@ -0,0 +1,47 @@
+# :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 [Integer] 
+    # @param id [Integer] 
+    # @return [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,83 @@
+# :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:
+  # 
+  #   wxBitmap bitmap;
+  #   if (bitmap.LoadFile("splash16.png", wxBITMAP_TYPE_PNG))
+  #   {
+  #       wxSplashScreen* splash = new wxSplashScreen(bitmap,
+  #           wxSPLASH_CENTRE_ON_SCREEN|wxSPLASH_TIMEOUT,
+  #           6000, NULL, -1, wxDefaultPosition, wxDefaultSize,
+  #           wxBORDER_SIMPLE|wxSTAY_ON_TOP);
+  #   }
+  #   wxYield();
+  # 
+  # === 
+  # 
+  # Category:  Managed Windows
+  # 
+  class SplashScreen < Frame
+  
+    # 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 [SplashScreen]
+    def initialize(bitmap, splashStyle, milliseconds, parent, id, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=(Wx::BORDER_SIMPLE|Wx::FRAME_NO_TASKBAR|Wx::STAY_ON_TOP)) end
+    
+    # Returns the splash style (see {splash_screen} 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,87 @@
+# :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 
+  # 
+  # 
+  class SplitterEvent < NotifyEvent
+  
+    # Constructor.
+    # Used internally by wxWidgets only.
+    # @param eventType [Integer] 
+    # @param splitter [Wx::SplitterWindow] 
+    # @return [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