wxruby3 0.9.2-x64-mingw-ucrt → 0.9.4-x64-mingw-ucrt

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

@@ -7,6 +7,7 @@
 module Wx
 
   # This class is used when you wish to drag an object on the screen, and a simple cursor is not enough.
+  # 
   # On Windows, the Win32 API is used to achieve smooth dragging. On other platforms, {Wx::GenericDragImage} is used. Applications may also prefer to use {Wx::GenericDragImage} on Windows, too.
   # To use this class, when you wish to start dragging an image, create a {Wx::DragImage} object and store it somewhere you can access it as the drag progresses. Call {Wx::DragImage#begin_drag} to start, and {Wx::DragImage#end_drag} to stop the drag. To move the image, initially call {Wx::DragImage#show} and then {Wx::DragImage#move}. If you wish to update the screen contents during the drag (for example, highlight an item as in the dragimag sample), first call {Wx::DragImage#hide}, update the screen, call {Wx::DragImage#move}, and then call {Wx::DragImage#show}.
   # You can drag within one window, or you can use full-screen dragging either across the whole screen, or just restricted to one area of the screen to save resources. If you want the user to drag between two windows, then you will need to use full-screen dragging.
@@ -51,6 +52,7 @@ module Wx
     
     # @overload begin_drag(hotspot, window, fullScreen=false, rect=nil)
     #   Start dragging the image, in a window or full screen.
+    #   
     #   You need to then call {Wx::DragImage#show} and {Wx::DragImage#move} to show the image on the screen. Call {Wx::DragImage#end_drag} when the drag has finished.
     #   Note that this call automatically calls CaptureMouse().
     #   @param hotspot [Array(Integer, Integer), Wx::Point]  The location of the drag position relative to the upper-left corner of the image.
@@ -60,6 +62,7 @@ module Wx
     #   @return [Boolean]
     # @overload begin_drag(hotspot, window, boundingWindow)
     #   Start dragging the image, using the first window to capture the mouse and the second to specify the bounding area.
+    #   
     #   This form is equivalent to using the first form, but more convenient than working out the bounding rectangle explicitly.
     #   You need to then call {Wx::DragImage#show} and {Wx::DragImage#move} to show the image on the screen. Call {Wx::DragImage#end_drag} when the drag has finished.
     #   Note that this call automatically calls CaptureMouse().
@@ -70,6 +73,7 @@ module Wx
     def begin_drag(*args) end
     
     # Call this when the drag has finished.
+    # 
     # <div class="wxrb-note">
     # <b>Note:</b>
     # <p>This function automatically releases mouse capture. 
@@ -79,11 +83,13 @@ module Wx
     def end_drag; end
     
     # Hides the image.
+    # 
     # You may wish to call this before updating the window contents (perhaps highlighting an item). Then call {Wx::DragImage#move} and {Wx::DragImage#show}.
     # @return [Boolean]
     def hide; end
     
     # Call this to move the image to a new position.
+    # 
     # The image will only be shown if {Wx::DragImage#show} has been called previously (for example at the start of the drag).
     # 
     # You can move the image either when the image is hidden or shown, but in general dragging will be smoother if you move the image when it is shown.
@@ -92,6 +98,7 @@ module Wx
     def move(pt) end
     
     # Shows the image.
+    # 
     # Call this at least once when dragging.
     # @return [Boolean]
     def show; end

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

@@ -22,6 +22,7 @@ module Wx
   EL_DEFAULT_STYLE = 1792
   
   # An editable listbox is composite control that lets the user easily enter, delete and reorder a list of strings.
+  # 
   # ### Styles
   # 
   # This class supports the following styles:
@@ -52,6 +53,7 @@ module Wx
     # @overload initialize(parent, id, label, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::EL_DEFAULT_STYLE, name=Wx::EDITABLE_LIST_BOX_NAME_STR)
     #   Constructor, creating and showing a list box.
     #   
+    #   
     #   @see Wx::EditableListBox#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.
@@ -64,6 +66,7 @@ module Wx
     def initialize(*args) end
     
     # Creates the editable listbox for two-step construction.
+    # 
     # See {Wx::EditableListBox#initialize} for further details.
     # @param parent [Wx::Window] 
     # @param id [Integer] 
@@ -82,9 +85,8 @@ module Wx
     alias_method :strings=, :set_strings
     
     # Returns in the given array the current contents of the control (the array will be erased before control's contents are appended).
-    # @param strings [Array<String>] 
-    # @return [void]
-    def get_strings(strings) end
+    # @return [Array<String>]
+    def get_strings; end
     alias_method :strings, :get_strings
     
   end # EditableListBox

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

@@ -697,11 +697,13 @@ module Wx
   EVT_NC_PAINT = 10296
   
   # Generates a new unique event type.
+  # 
   # Usually this function is only used by {define_event} and not called directly.
-  # @return [Wx::Slider::EventType]
+  # @return [Wx::Notebook::EventType]
   def self.new_event_type; end
   
   # In a GUI application, this function posts event to the specified dest object using {Wx::EvtHandler#add_pending_event}.
+  # 
   # Otherwise, it dispatches event immediately using {Wx::EvtHandler#process_event}. See the respective documentation for details (and caveats). Because of limitation of {Wx::EvtHandler#add_pending_event} this function is not thread-safe for event objects having {Wx::String} fields, use {queue_event} instead.
   # @param dest [Wx::EvtHandler] 
   # @param event [Wx::Event] 
@@ -709,6 +711,7 @@ module Wx
   def self.post_event(dest, event) end
   
   # An event is a structure holding information about an event passed to a callback or member function.
+  # 
   # {Wx::Event} used to be a multipurpose event object, and is an abstract base class for other event classes (see below).
   # For more information about events, see the Events and Event Handling overview.
   # 
@@ -725,11 +728,12 @@ module Wx
     alias_method :event_object, :get_event_object
     
     # Returns the identifier of the given event type, such as {Wx::EVT_BUTTON}.
-    # @return [Wx::Slider::EventType]
+    # @return [Wx::Notebook::EventType]
     def get_event_type; end
     alias_method :event_type, :get_event_type
     
     # Returns a generic category for this event.
+    # 
     # {Wx::Event} implementation returns {Wx::EventCategory::EVT_CATEGORY_UI} by default.
     # This function is used to selectively process events in Wx::EventLoopBase::YieldFor.
     # @return [Wx::EventCategory]
@@ -747,6 +751,7 @@ module Wx
     alias_method :skipped, :get_skipped
     
     # Gets the timestamp for the event.
+    # 
     # The timestamp is the time in milliseconds since some fixed moment (not necessarily the standard Unix Epoch, so only differences between the timestamps and not their absolute values usually make sense).
     # wxWidgets returns a non-NULL timestamp only for mouse and key events (see {Wx::MouseEvent} and {Wx::KeyEvent}).
     # @return [Integer]
@@ -754,6 +759,7 @@ module Wx
     alias_method :timestamp, :get_timestamp
     
     # Returns true if the event is or is derived from {Wx::CommandEvent} else it returns false.
+    # 
     # <div class="wxrb-note">
     # <b>Note:</b>
     # <p>exists only for optimization purposes. 
@@ -775,7 +781,7 @@ module Wx
     alias_method :event_object=, :set_event_object
     
     # Sets the event type.
-    # @param type [Wx::Slider::EventType] 
+    # @param type [Wx::Notebook::EventType] 
     # @return [void]
     def set_event_type(type) end
     alias_method :event_type=, :set_event_type
@@ -797,6 +803,7 @@ module Wx
     def should_propagate; end
     
     # This method can be used inside an event handler to control whether further event handlers bound to this event will be called after the current one returns.
+    # 
     # Without {Wx::Event#skip} (or equivalently if Skip(false) is used), the event will not be processed any more. If Skip(true) is called, the event processing system continues searching for a further handler function for this event, even though it has been processed already in the current handler.
     # In general, it is recommended to skip all non-command events to allow the default handling to take place. The command events are, however, normally not skipped as usually a single command such as a button click or menu item selection must only be processed by one handler.
     # @param skip [Boolean] 
@@ -804,6 +811,7 @@ module Wx
     def skip(skip=true) end
     
     # Stop the event from propagating to its parent window.
+    # 
     # Returns the old propagation level value which may be later passed to {Wx::Event#resume_propagation} to allow propagating the event again.
     # @return [Integer]
     def stop_propagation; end
@@ -811,6 +819,7 @@ module Wx
   end # Event
   
   # This event class contains information about command events, which originate from a variety of simple controls.
+  # 
   # Note that {Wx::CommandEvents} and {Wx::CommandEvent}-derived event classes by default and unlike other {Wx::Event}-derived classes propagate upward from the source window (the window which emits the event) up to the first parent which processes the event. Be sure to read How Events Propagate Upwards.
   # More complex controls, such as {Wx::TreeCtrl}, have separate command event classes.
   # ### Events using this class
@@ -885,17 +894,18 @@ module Wx
   class CommandEvent < Event
   
     # Constructor.
-    # @param commandEventType [Wx::Slider::EventType] 
+    # @param commandEventType [Wx::Notebook::EventType] 
     # @param id [Integer] 
     # @return [Wx::CommandEvent]
     def initialize(commandEventType=Wx::EVT_NULL, id=0) end
     
-    # Returns client data pointer for a listbox or choice selection event (not valid for a deselection).
+    # Returns client object pointer for a listbox or choice selection event (not valid for a deselection).
     # @return [Object]
-    def get_client_data; end
-    alias_method :client_data, :get_client_data
+    def get_client_object; end
+    alias_method :client_object, :get_client_object
     
     # Returns the integer identifier corresponding to a listbox, choice or radiobox selection (only if the event was a selection, not a deselection), or a boolean value representing the value of a checkbox.
+    # 
     # For a menu item, this method returns -1 if the item is not checkable or a boolean value (true or false) for checkable items indicating the new state of the item.
     # @return [Integer]
     def get_int; end
@@ -907,12 +917,14 @@ module Wx
     alias_method :selection, :get_selection
     
     # Returns item string for a listbox or choice selection event.
+    # 
     # If one or several items have been deselected, returns the index of the first deselected item. If some items have been selected and others deselected at the same time, it will return the index of the first selected item.
     # @return [String]
     def get_string; end
     alias_method :string, :get_string
     
     # This method can be used with checkbox and menu events: for the checkboxes, the method returns true for a selection event and false for a deselection one.
+    # 
     # For the menu events, this method indicates if the menu item just has become checked or unchecked (and thus only makes sense for checkable menu items).
     # Notice that this method cannot be used with {Wx::CheckListBox} currently.
     # @return [Boolean]
@@ -920,16 +932,19 @@ module Wx
     alias_method :checked?, :is_checked
     
     # For a listbox or similar event, returns true if it is a selection, false if it is a deselection.
+    # 
     # If some items have been selected and others deselected at the same time, it will return true.
     # @return [Boolean]
     def is_selection; end
     alias_method :selection?, :is_selection
     
-    # Sets the client data for this event.
-    # @param clientData [Object] 
+    # Sets the client object for this event.
+    # 
+    # The client object is not owned by the event object and the event object will not delete the client object in its destructor.
+    # The client object must be owned and deleted by another object (e.g. a control) that has longer life time than the event object.
+    # @param clientObject [Object] 
     # @return [void]
-    def set_client_data(clientData) end
-    alias_method :client_data=, :set_client_data
+    def set_client_object(clientObject) end
     
     # Sets the <b>m_extraLong</b> member.
     # @param extraLong [Integer] 

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

@@ -7,6 +7,7 @@
 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
@@ -39,7 +40,7 @@ module Wx
   class EventBlocker < EvtHandler
   
     # Adds to the list of event types which should be blocked the given eventType.
-    # @param eventType [Wx::Slider::EventType] 
+    # @param eventType [Wx::Notebook::EventType] 
     # @return [void]
     def block(eventType) end
     

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

@@ -7,6 +7,7 @@
 module Wx
 
   # A global event filter for pre-processing all the events generated in the program.
+  # 
   # This is a very simple class which just provides {Wx::EventFilter#filter_event} virtual method to be called by {Wx::EvtHandler} before starting process of any event. Thus, inheriting from this class and overriding {Wx::EventFilter#filter_event} allows capturing and possibly handling or ignoring all the events happening in the program. Of course, having event filters adds additional overhead to every event processing and so should not be used lightly and your {Wx::EventFilter#filter_event} code should try to return as quickly as possible, especially for the events it is not interested in.
   # An example of using this class: 
   # ```ruby
@@ -52,8 +53,6 @@ module Wx
   # Notice that {Wx::App} derives from {Wx::EventFilter} and is registered as an event filter during its creation so you may also override {Wx::EventFilter#filter_event} method in your {Wx::App}-derived class and, in fact, this is often the most convenient way to do it. However creating a new class deriving directly from {Wx::EventFilter} allows isolating the event filtering code in its own separate class and also having several independent filters, if necessary.
   # Category:  {Wx::Events}
   # 
-  # 
-  # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
   class EventFilter < ::Object
   
     # Process event as usual.
@@ -69,12 +68,14 @@ module Wx
     Event_Processed = 1
     
     # Default constructor.
+    # 
     # Constructor does not register this filter using {Wx::EvtHandler.add_filter}, it's your responsibility to do it when necessary.
     # Notice that the objects of this class can't be copied.
     # @return [Wx::EventFilter]
     def initialize; end
     
     # Override this method to implement event pre-processing.
+    # 
     # This method allows filtering all the events processed by the program, so you should try to return quickly from it to avoid slowing down the program to a crawl.
     # Although the return type of this method is int, this is only due to backwards compatibility concerns and the actual return value must be one of the Event_XXX constants defined above:
     # 

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

@@ -1334,13 +1334,13 @@ module Wx
     # A connection with the network was established. 
     # Processes a {Wx::EVT_DIALUP_CONNECTED} event.
     # @param [String,Symbol,Method,Proc] meth (name of) method or handler proc
-    # @yieldparam [Wx::App] event the event to handle
+    # @yieldparam [Wx::DialUpEvent] event the event to handle
     def evt_dialup_connected(meth = nil, &block) end
     
     # The connection with the network was lost. 
     # Processes a {Wx::EVT_DIALUP_DISCONNECTED} event.
     # @param [String,Symbol,Method,Proc] meth (name of) method or handler proc
-    # @yieldparam [Wx::App] event the event to handle
+    # @yieldparam [Wx::DialUpEvent] event the event to handle
     def evt_dialup_disconnected(meth = nil, &block) end
     
     # A mouse event occurred over an URL in the text control. 
@@ -1648,14 +1648,14 @@ module Wx
     # Selected directory has changed. Processes a {Wx::EVT_DIRCTRL_SELECTIONCHANGED} event type. Notice that this event is generated even for the changes done by the program itself and not only those done by the user. Available since wxWidgets 2.9.5. 
     # @param [Integer,Wx::Enum,Wx::Window,Wx::MenuItem,Wx::ToolBarTool,Wx::Timer] id window/control id
     # @param [String,Symbol,Method,Proc] meth (name of) method or handler proc
-    # @yieldparam [Wx::GenericDirCtrl] event the event to handle
+    # @yieldparam [Wx::TreeEvent] event the event to handle
     def evt_dirctrl_selectionchanged(id, meth = nil, &block) end
     
     # The user activated a file by double-clicking or pressing Enter. Available since wxWidgets 2.9.5.  
     # Processes a {Wx::EVT_DIRCTRL_FILEACTIVATED} event.
     # @param [Integer,Wx::Enum,Wx::Window,Wx::MenuItem,Wx::ToolBarTool,Wx::Timer] id window/control id
     # @param [String,Symbol,Method,Proc] meth (name of) method or handler proc
-    # @yieldparam [Wx::GenericDirCtrl] event the event to handle
+    # @yieldparam [Wx::TreeEvent] event the event to handle
     def evt_dirctrl_fileactivated(id, meth = nil, &block) end
     
     # @!endgroup