wxruby3 0.9.0.pre.rc.2-x64-mingw-ucrt → 0.9.0-x64-mingw-ucrt

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

@@ -24,7 +24,7 @@ module Wx
   # @param parent [Wx::Window] 
   # @param x [Integer] 
   # @param y [Integer] 
-  # @param centre [true,false] 
+  # @param centre [Boolean] 
   # @return [String]
   def self.get_text_from_user(message, caption=Wx::GET_TEXT_FROM_USER_PROMPT_STR, default_value=(''), parent=nil, x=Wx::DEFAULT_COORD, y=Wx::DEFAULT_COORD, centre=true) end
   
@@ -36,7 +36,7 @@ module Wx
   # @param parent [Wx::Window] 
   # @param x [Integer] 
   # @param y [Integer] 
-  # @param centre [true,false] 
+  # @param centre [Boolean] 
   # @return [String]
   def self.get_password_from_user(message, caption=Wx::GET_PASSWORD_FROM_USER_PROMPT_STR, default_value=(''), parent=nil, x=Wx::DEFAULT_COORD, y=Wx::DEFAULT_COORD, centre=true) end
   
@@ -53,14 +53,14 @@ module Wx
     # @overload set_text_validator(validator)
     #   Associate a validator with the text control used by the dialog.
     #   These methods can be used to limit the user entry to only some characters, e.g. 
-    #   ```
-    #     wxTextEntryDialog dlg(this, ...);
-    #     dlg.SetTextValidator(wxFILTER_ALPHA);
-    #     if ( dlg.ShowModal() == wxID_OK )
-    #     {
-    #         // We can be certain that this string contains letters only.
-    #         wxString value = dlg.GetValue();
-    #     }
+    #   ```ruby
+    #     Wx::TextEntryDialog(self, ...) do |dlg|
+    #       dlg.set_text_validator(Wx::FILTER_ALPHA)
+    #       if dlg.show_modal == Wx::ID_OK
+    #          # We can be certain that this string contains letters only.
+    #          value = dlg.get_value
+    #       end
+    #     end
     #   ```
     #   
     #   The first overload uses the provided validator which can be of a custom class derived from {Wx::TextValidator} while the second one creates a {Wx::TextValidator} with the specified style.
@@ -69,18 +69,18 @@ module Wx
     # @overload set_text_validator(style=Wx::TextValidatorStyle::FILTER_NONE)
     #   Associate a validator with the text control used by the dialog.
     #   These methods can be used to limit the user entry to only some characters, e.g. 
-    #   ```
-    #     wxTextEntryDialog dlg(this, ...);
-    #     dlg.SetTextValidator(wxFILTER_ALPHA);
-    #     if ( dlg.ShowModal() == wxID_OK )
-    #     {
-    #         // We can be certain that this string contains letters only.
-    #         wxString value = dlg.GetValue();
-    #     }
+    #   ```ruby
+    #     Wx::TextEntryDialog(self, ...) do |dlg|
+    #       dlg.set_text_validator(Wx::FILTER_ALPHA)
+    #       if dlg.show_modal == Wx::ID_OK
+    #          # We can be certain that this string contains letters only.
+    #          value = dlg.get_value
+    #       end
+    #     end
     #   ```
     #   
     #   The first overload uses the provided validator which can be of a custom class derived from {Wx::TextValidator} while the second one creates a {Wx::TextValidator} with the specified style.
-    #   @param style [TextValidatorStyle] 
+    #   @param style [Wx::TextValidatorStyle] 
     #   @return [void]
     def set_text_validator(*args) end
     alias_method :text_validator=, :set_text_validator
@@ -88,7 +88,7 @@ module Wx
     # @overload initialize()
     #   Default constructor.
     #   Call {Wx::TextEntryDialog#create} to really create the dialog later.
-    #   @return [TextEntryDialog]
+    #   @return [Wx::TextEntryDialog]
     # @overload initialize(parent, message, caption=Wx::GET_TEXT_FROM_USER_PROMPT_STR, value=(''), style=Wx::TextEntryDialogStyle, pos=Wx::DEFAULT_POSITION)
     #   Constructor.
     #   Use {Wx::TextEntryDialog#show_modal} to show the dialog.
@@ -99,7 +99,7 @@ module Wx
     #   @param value [String] 
     #   @param style [Integer] 
     #   @param pos [Array(Integer, Integer), Wx::Point] 
-    #   @return [TextEntryDialog]
+    #   @return [Wx::TextEntryDialog]
     def initialize(*args) end
     
     # @param parent [Wx::Window]  Parent window.
@@ -108,7 +108,7 @@ module Wx
     # @param value [String]  The default value, which may be the empty string.
     # @param style [Integer]  A dialog style, specifying the buttons ({Wx::OK}, {Wx::CANCEL}) and an optional {Wx::GeometryCentre::CENTRE} style. Additionally, most {Wx::TextCtrl} styles (such as {Wx::TE_PASSWORD} or {Wx::TE_MULTILINE}) may be specified here, but {Wx::TE_READONLY} may not be used, as it doesn't make sense for this dialog, used for text input.
     # @param pos [Array(Integer, Integer), Wx::Point]  Dialog position.
-    # @return [true,false]
+    # @return [Boolean]
     def create(parent, message, caption=Wx::GET_TEXT_FROM_USER_PROMPT_STR, value=(''), style=Wx::TextEntryDialogStyle, pos=Wx::DEFAULT_POSITION) end
     
     # Returns the text that the user has entered if the user has pressed OK, or the original value if the user has pressed Cancel.
@@ -161,7 +161,7 @@ module Wx
     # @param defaultValue [String]  The default value, which may be the empty string.
     # @param style [Integer]  A dialog style, specifying the buttons ({Wx::OK}, {Wx::CANCEL}) and an optional {Wx::GeometryCentre::CENTRE} style. You do not need to specify the {Wx::TE_PASSWORD} style, it is always applied.
     # @param pos [Array(Integer, Integer), Wx::Point]  Dialog position.
-    # @return [PasswordEntryDialog]
+    # @return [Wx::PasswordEntryDialog]
     def initialize(parent, message, caption=Wx::GET_PASSWORD_FROM_USER_PROMPT_STR, defaultValue=(''), style=Wx::TextEntryDialogStyle, pos=Wx::DEFAULT_POSITION) end
     
   end # PasswordEntryDialog

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

@@ -80,17 +80,6 @@ module Wx
   # 
   class TextValidator < Validator
   
-    # @overload initialize(validator)
-    #   Copy constructor.
-    #   @param validator [Wx::TextValidator] 
-    #   @return [TextValidator]
-    # @overload initialize(style=Wx::TextValidatorStyle::FILTER_NONE, valPtr=nil)
-    #   Constructor taking a style and optional pointer to a {Wx::String} variable.
-    #   @param style [Integer]  One or more of the {Wx::TextValidatorStyle} styles. See {Wx::TextValidator#set_style}.
-    #   @param valPtr [String]  A pointer to a {Wx::String} variable that contains the value. This variable should have a lifetime equal to or longer than the validator lifetime (which is usually determined by the lifetime of the window).
-    #   @return [TextValidator]
-    def initialize(*args) end
-    
     # Clones the text validator using the copy constructor.
     # @return [Wx::TextValidator]
     def clone; end
@@ -123,16 +112,11 @@ module Wx
     alias_method :style, :get_style
     
     # Returns true if the given style bit is set in the current style.
-    # @param style [TextValidatorStyle] 
-    # @return [true,false]
+    # @param style [Wx::TextValidatorStyle] 
+    # @return [Boolean]
     def has_flag(style) end
     alias_method :has_flag?, :has_flag
     
-    # Receives character input from the window and filters it according to the current validator style.
-    # @param event [Wx::KeyEvent] 
-    # @return [void]
-    def on_char(event) end
-    
     # Sets the exclude list (invalid values for the user input).
     # Beware that exclusion takes priority over inclusion.
     # @param stringList [Array<String>] 
@@ -197,7 +181,7 @@ module Wx
     
     # Validates the window contents against the include or exclude lists, depending on the validator style.
     # @param parent [Wx::Window] 
-    # @return [true,false]
+    # @return [Boolean]
     def validate(parent) end
     
     # Returns the error message if the contents of val are invalid or the empty string if val is valid.

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

@@ -18,13 +18,14 @@ module Wx
   # 
   # The following event-handler methods redirect the events to member method or handler blocks for {Wx::DateEvent} events.
   # Event handler methods for events emitted by this class:
+  # 
   # - {Wx::EvtHandler#evt_time_changed}(id, meth = nil, &block): Process a {Wx::EVT_TIME_CHANGED} event, which fires when the user changes the current selection in the control. 
   # 
   # === 
   # 
-  # Category:  Picker 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
+  # Category:  Picker Controls  <div class='appearance'><span class='appearance'>Appearance:</span><table><tr><td> wxMSW Appearance
+  #   </td><td> wxGTK Appearance
+  #   </td><td> wxOSX Appearance
   #   </td></tr></table></div>
   # @see Wx::DatePickerCtrl
   # @see  Wx::CalendarCtrl
@@ -35,8 +36,8 @@ module Wx
   
     # @overload initialize()
     #   Default constructor.
-    #   @return [TimePickerCtrl]
-    # @overload initialize(parent, id, dt=Wx::DefaultDateTime, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::TP_DEFAULT, validator=Wx::DEFAULT_VALIDATOR, name=Wx::TimePickerCtrlNameStr)
+    #   @return [Wx::TimePickerCtrl]
+    # @overload initialize(parent, id, dt=Wx::DEFAULT_DATE_TIME, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::TP_DEFAULT, validator=Wx::DEFAULT_VALIDATOR, name=Wx::TimePickerCtrlNameStr)
     #   Initializes the object and calls {Wx::TimePickerCtrl#create} with all the parameters.
     #   @param parent [Wx::Window] 
     #   @param id [Integer] 
@@ -46,7 +47,7 @@ module Wx
     #   @param style [Integer] 
     #   @param validator [Wx::Validator] 
     #   @param name [String] 
-    #   @return [TimePickerCtrl]
+    #   @return [Wx::TimePickerCtrl]
     def initialize(*args) end
     
     # Create the control window.
@@ -61,13 +62,13 @@ module Wx
     # @param style [Integer]  The window style, should be left at 0 as there are no special styles for this control in this version.
     # @param validator [Wx::Validator]  Validator which can be used for additional checks.
     # @param name [String]  Control name.
-    # @return [true,false]
-    def create(parent, id, dt=Wx::DefaultDateTime, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::TP_DEFAULT, validator=Wx::DEFAULT_VALIDATOR, name=Wx::TimePickerCtrlNameStr) end
+    # @return [Boolean]
+    def create(parent, id, dt=Wx::DEFAULT_DATE_TIME, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::TP_DEFAULT, validator=Wx::DEFAULT_VALIDATOR, name=Wx::TimePickerCtrlNameStr) end
     
     # Returns the currently entered time as hours, minutes and seconds.
     # All the arguments must be non-NULL, false is returned otherwise and none of them is modified.
     # @see Wx::TimePickerCtrl#set_time
-    # @return [Array(true,false,Integer,Integer,Integer)]
+    # @return [Array(Boolean,Integer,Integer,Integer)]
     def get_time; end
     alias_method :time, :get_time
     
@@ -85,7 +86,7 @@ module Wx
     # @param hour [Integer]  The new hour value in 0..23 interval.
     # @param min [Integer]  The new minute value in 0..59 interval.
     # @param sec [Integer]  The new second value in 0..59 interval.
-    # @return [true,false]
+    # @return [Boolean]
     def set_time(hour, min, sec) end
     
     # Changes the current value of the control.

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

@@ -10,7 +10,9 @@ module Wx
   # Its precision is platform-dependent, but in general will not be better than 1ms nor worse than 1s.
   # There are three different ways to use this class:
   # 
-  # - You may derive a new class from {Wx::Timer} and override the {Wx::Timer#notify} member to perform the required action.- You may redirect the notifications to any {Wx::EvtHandler} derived object by using the non-default constructor or {Wx::Timer#set_owner}. Then use the EVT_TIMER macro to connect it to the event handler which will receive {Wx::TimerEvent} notifications.- You may use a derived class and the EVT_TIMER macro to connect it to an event handler defined in the derived class. If the default constructor is used, the timer object will be its own owner object, since it is derived from {Wx::EvtHandler}.
+  # - You may derive a new class from {Wx::Timer} and override the {Wx::Timer#notify} member to perform the required action.
+  # - You may redirect the notifications to any {Wx::EvtHandler} derived object by using the non-default constructor or {Wx::Timer#set_owner}. Then use the EVT_TIMER macro to connect it to the event handler which will receive {Wx::TimerEvent} notifications.
+  # - You may use a derived class and the EVT_TIMER macro to connect it to an event handler defined in the derived class. If the default constructor is used, the timer object will be its own owner object, since it is derived from {Wx::EvtHandler}.
   # 
   # In any case, you must start the timer with {Wx::Timer#start} after constructing it before it actually starts sending notifications. It can be stopped later with {Wx::Timer#stop}.
   # A timer can only be used from the main thread.
@@ -26,13 +28,13 @@ module Wx
     # @overload initialize()
     #   Default constructor.
     #   If you use it to construct the object and don't call {Wx::Timer#set_owner} later, you must override {Wx::Timer#notify} method to process the notifications.
-    #   @return [Timer]
+    #   @return [Wx::Timer]
     # @overload initialize(owner, id=-1)
     #   Creates a timer and associates it with owner.
     #   Please see {Wx::Timer#set_owner} for the description of parameters.
     #   @param owner [Wx::EvtHandler] 
     #   @param id [Integer] 
-    #   @return [Timer]
+    #   @return [Wx::Timer]
     def initialize(*args) end
     
     # Returns the ID of the events generated by this timer.
@@ -52,12 +54,12 @@ module Wx
     alias_method :owner, :get_owner
     
     # Returns true if the timer is one shot, i.e. if it will stop after firing the first notification automatically.
-    # @return [true,false]
+    # @return [Boolean]
     def is_one_shot; end
     alias_method :one_shot?, :is_one_shot
     
     # Returns true if the timer is running, false if it is stopped.
-    # @return [true,false]
+    # @return [Boolean]
     def is_running; end
     alias_method :running?, :is_running
     
@@ -79,18 +81,20 @@ module Wx
     # If milliseconds parameter is -1 (value by default), the previous value is used. Returns false if the timer could not be started, true otherwise (in MS Windows timers are a limited resource).
     # If oneShot is false (the default), the {Wx::Timer#notify} function will be called repeatedly until the timer is stopped. If true, it will be called only once and the timer will stop automatically.
     # To make your code more readable you may also use the following symbolic constants:
-    # - {Wx::TIMER_CONTINUOUS}: Start a normal, continuously running, timer- {Wx::TIMER_ONE_SHOT}: Start a one shot timer Alternatively, use {Wx::Timer#start_once}.
+    # 
+    # - {Wx::TIMER_CONTINUOUS}: Start a normal, continuously running, timer
+    # - {Wx::TIMER_ONE_SHOT}: Start a one shot timer Alternatively, use {Wx::Timer#start_once}.
     # 
     # If the timer was already running, it will be stopped by this method before restarting it.
     # @param milliseconds [Integer] 
-    # @param oneShot [true,false] 
-    # @return [true,false]
+    # @param oneShot [Boolean] 
+    # @return [Boolean]
     def start(milliseconds=-1, oneShot=Wx::TIMER_CONTINUOUS) end
     
     # Starts the timer for a once-only notification.
     # This is a simple wrapper for {Wx::Timer#start} with {Wx::TIMER_ONE_SHOT} parameter.
     # @param milliseconds [Integer] 
-    # @return [true,false]
+    # @return [Boolean]
     def start_once(milliseconds=-1) end
     
     # Stops the timer.

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

@@ -19,32 +19,25 @@ module Wx
   # {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
-  #   }
+  # ```ruby
+  #   class MyFrame < Wx::Frame
+  # 
+  #     def initialize
+  #       super(nil)
+  #       @timer = Wx::Timer.new(self, TIMER_ID)
+  # 
+  #       evt_timer(TIMER_ID, :on_timer)
+  # 
+  #       @timer.start(1000)    # 1 second interval
+  #     end
+  #      
+  #     ...
+  #      
+  #     def on_timer(event)
+  #       # do whatever you want to do every second here
+  #     end
   #   
-  #   void MyFrame::OnTimer(wxTimerEvent& event)
-  #   {
-  #       // do whatever you want to do every second here
-  #   }
+  #   end
   # ```
   # 
   # === 
@@ -56,7 +49,7 @@ module Wx
   class TimerEvent < Event
   
     # @param timer [Wx::Timer] 
-    # @return [TimerEvent]
+    # @return [Wx::TimerEvent]
     def initialize(timer) end
     
     # Returns the interval of the timer which generated this event.

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

@@ -19,8 +19,8 @@ module Wx
   # @see wxTipProvider Overview
   # @param parent [Wx::Window]  The parent window for the modal dialog.
   # @param tipProvider [Wx::TipProvider]  An object which is used to get the text of the tips. It may be created with the {create_file_tip_provider} function.
-  # @param showAtStartup [true,false]  Should be true if startup tips are shown, false otherwise. This is used as the initial value for "Show tips at startup" checkbox which is shown in the tips dialog.
-  # @return [true,false]
+  # @param showAtStartup [Boolean]  Should be true if startup tips are shown, false otherwise. This is used as the initial value for "Show tips at startup" checkbox which is shown in the tips dialog.
+  # @return [Boolean]
   def self.show_tip(parent, tipProvider, showAtStartup=true) end
   
   # This is the class used together with {show_tip} function.
@@ -37,7 +37,7 @@ module Wx
   
     # Constructor.
     # @param currentTip [Integer]  The starting tip index.
-    # @return [TipProvider]
+    # @return [Wx::TipProvider]
     def initialize(currentTip) end
     
     # Returns the index of the current tip (i.e. the one which would be returned by {Wx::TipProvider#get_tip}).

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

@@ -18,13 +18,14 @@ module Wx
   # 
   # The following event-handler methods redirect the events to member method or handler blocks for {Wx::CommandEvent} events.
   # Event handler methods for events emitted by this class:
+  # 
   # - {Wx::EvtHandler#evt_togglebutton}(id, meth = nil, &block): Handles a {Wx::EVT_TOGGLEBUTTON} event. 
   # 
   # === 
   # 
-  # 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
+  # Category:  {Wx::Controls}  <div class='appearance'><span class='appearance'>Appearance:</span><table><tr><td> wxMSW Appearance
+  #   </td><td> wxGTK Appearance
+  #   </td><td> wxOSX Appearance
   #   </td></tr></table></div>
   # @see Wx::CheckBox
   # @see  Wx::Button
@@ -35,7 +36,7 @@ module Wx
   
     # @overload initialize()
     #   Default constructor.
-    #   @return [ToggleButton]
+    #   @return [Wx::ToggleButton]
     # @overload initialize(parent, id, label, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, val=Wx::DEFAULT_VALIDATOR, name=Wx::CheckBoxNameStr)
     #   Constructor, creating and showing a toggle button.
     #   
@@ -49,11 +50,11 @@ module Wx
     #   @param style [Integer]  Window style. See {Wx::ToggleButton}.
     #   @param val [Wx::Validator]  Window validator.
     #   @param name [String]  Window name.
-    #   @return [ToggleButton]
+    #   @return [Wx::ToggleButton]
     def initialize(*args) end
     
     # Creates the toggle button for two-step construction.
-    # See {Wx::ToggleButton#toggle_button} for details.
+    # See {Wx::ToggleButton#initialize} for details.
     # @param parent [Wx::Window] 
     # @param id [Integer] 
     # @param label [String] 
@@ -62,18 +63,18 @@ module Wx
     # @param style [Integer] 
     # @param val [Wx::Validator] 
     # @param name [String] 
-    # @return [true,false]
+    # @return [Boolean]
     def create(parent, id, label, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, val=Wx::DEFAULT_VALIDATOR, name=Wx::CheckBoxNameStr) end
     
     # Gets the state of the toggle button.
     # Returns true if it is pressed, false otherwise.
-    # @return [true,false]
+    # @return [Boolean]
     def get_value; end
     alias_method :value, :get_value
     
     # Sets the toggle button to the given state.
     # This does not cause a EVT_TOGGLEBUTTON event to be emitted.
-    # @param state [true,false]  If true, the button is pressed.
+    # @param state [Boolean]  If true, the button is pressed.
     # @return [void]
     def set_value(state) end
     alias_method :value=, :set_value