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

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

@@ -21,32 +21,32 @@ module Wx
   
     # @overload initialize()
     #   Default constructor.
-    #   @return [DragImage]
+    #   @return [Wx::DragImage]
     # @overload initialize(image, cursor=Wx::NULL_CURSOR)
     #   Constructs a drag image from a bitmap and optional cursor.
     #   @param image [Wx::Bitmap]  Bitmap to be used as the drag image. The bitmap can have a mask.
     #   @param cursor [Wx::Cursor]  Optional cursor to combine with the image.
-    #   @return [DragImage]
+    #   @return [Wx::DragImage]
     # @overload initialize(image, cursor=Wx::NULL_CURSOR)
     #   Constructs a drag image from an icon and optional cursor.
     #   @param image [Wx::Icon]  Icon to be used as the drag image.
     #   @param cursor [Wx::Cursor]  Optional cursor to combine with the image.
-    #   @return [DragImage]
+    #   @return [Wx::DragImage]
     # @overload initialize(text, cursor=Wx::NULL_CURSOR)
     #   Constructs a drag image from a text string and optional cursor.
     #   @param text [String]  Text used to construct a drag image.
     #   @param cursor [Wx::Cursor]  Optional cursor to combine with the image.
-    #   @return [DragImage]
+    #   @return [Wx::DragImage]
     # @overload initialize(treeCtrl, id)
     #   Constructs a drag image from the text in the given tree control item, and optional cursor.
     #   @param treeCtrl [Wx::TreeCtrl]  Tree control for constructing a tree drag image.
     #   @param id [Wx::TreeItemId]  Tree control item id.
-    #   @return [DragImage]
+    #   @return [Wx::DragImage]
     # @overload initialize(listCtrl, id)
     #   Constructs a drag image from the text in the given list control item, and optional cursor.
     #   @param listCtrl [Wx::ListCtrl]  List control for constructing a list drag image.
     #   @param id [Integer]  List control item id.
-    #   @return [DragImage]
+    #   @return [Wx::DragImage]
     def initialize(*args) end
     
     # @overload begin_drag(hotspot, window, fullScreen=false, rect=nil)
@@ -55,9 +55,9 @@ module Wx
     #   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.
     #   @param window [Wx::Window]  The window that captures the mouse, and within which the dragging is limited unless fullScreen is true.
-    #   @param fullScreen [true,false]  If true, specifies that the drag will be visible over the full screen, or over as much of the screen as is specified by rect. Note that the mouse will still be captured in window.
+    #   @param fullScreen [Boolean]  If true, specifies that the drag will be visible over the full screen, or over as much of the screen as is specified by rect. Note that the mouse will still be captured in window.
     #   @param rect [Wx::Rect]  If non-NULL, specifies the rectangle (in screen coordinates) that bounds the dragging operation. Specifying this can make the operation more efficient by cutting down on the area under consideration, and it can also make a visual difference since the drag is clipped to this area.
-    #   @return [true,false]
+    #   @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.
@@ -66,31 +66,17 @@ module Wx
     #   @param hotspot [Array(Integer, Integer), Wx::Point]  The location of the drag position relative to the upper-left corner of the image.
     #   @param window [Wx::Window]  The window that captures the mouse, and within which the dragging is limited.
     #   @param boundingWindow [Wx::Window]  Specifies the area within which the drag occurs.
-    #   @return [true,false]
+    #   @return [Boolean]
     def begin_drag(*args) end
     
-    # Draws the image on the device context with top-left corner at the given position.
-    # This function is only available with {Wx::GenericDragImage}, to allow applications to draw their own image instead of using an actual bitmap. If you override this function, you must also override {Wx::DragImage#get_image_rect}.
-    # @param dc [Wx::DC] 
-    # @param pos [Array(Integer, Integer), Wx::Point] 
-    # @return [true,false]
-    def do_draw_image(dc, pos) end
-    
     # Call this when the drag has finished.
     # This function automatically releases mouse capture.
-    # @return [true,false]
+    # @return [Boolean]
     def end_drag; end
     
-    # Returns the rectangle enclosing the image, assuming that the image is drawn with its top-left corner at the given point.
-    # This function is available in {Wx::GenericDragImage} only, and may be overridden (together with {Wx::DragImage#do_draw_image}) to provide a virtual drawing capability.
-    # @param pos [Array(Integer, Integer), Wx::Point] 
-    # @return [Wx::Rect]
-    def get_image_rect(pos) end
-    alias_method :image_rect, :get_image_rect
-    
     # 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 [true,false]
+    # @return [Boolean]
     def hide; end
     
     # Call this to move the image to a new position.
@@ -98,25 +84,14 @@ module Wx
     # 
     # 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.
     # @param pt [Array(Integer, Integer), Wx::Point]  The position in client coordinates (relative to the window specified in {Wx::DragImage#begin_drag}).
-    # @return [true,false]
+    # @return [Boolean]
     def move(pt) end
     
     # Shows the image.
     # Call this at least once when dragging.
-    # @return [true,false]
+    # @return [Boolean]
     def show; end
     
-    # Override this if you wish to draw the window contents to the backing bitmap yourself.
-    # This can be desirable if you wish to avoid flicker by not having to redraw the updated window itself just before dragging, which can cause a flicker just as the drag starts. Instead, paint the drag image's backing bitmap to show the appropriate graphic minus the objects to be dragged, and leave the window itself to be updated by the drag image. This can provide eerily smooth, flicker-free drag behaviour.
-    # The default implementation copies the window contents to the backing bitmap. A new implementation will normally copy information from another source, such as from its own backing bitmap if it has one, or directly from internal data structures.
-    # This function is available in {Wx::GenericDragImage} only.
-    # @param windowDC [Wx::DC] 
-    # @param destDC [Wx::MemoryDC] 
-    # @param sourceRect [Wx::Rect] 
-    # @param destRect [Wx::Rect] 
-    # @return [true,false]
-    def update_backing_from_window(windowDC, destDC, sourceRect, destRect) end
-    
   end # DragImage
   
 

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

@@ -25,11 +25,15 @@ module Wx
   # === Styles
   # 
   # This class supports the following styles:
-  #  
+  # 
   # - {Wx::EL_ALLOW_NEW}: Allows the user to enter new strings. 
+  # 
   # - {Wx::EL_ALLOW_EDIT}: Allows the user to edit existing strings. 
+  # 
   # - {Wx::EL_ALLOW_DELETE}: Allows the user to delete existing strings. 
+  # 
   # - {Wx::EL_NO_REORDER}: Does not allow the user to reorder the strings. 
+  # 
   # - {Wx::EL_DEFAULT_STYLE}: Default style: {Wx::EL_ALLOW_NEW}|{Wx::EL_ALLOW_EDIT}|{Wx::EL_ALLOW_DELETE}. 
   # 
   # The control uses a {Wx::ListCtrl} internally and emit its events.
@@ -44,7 +48,7 @@ module Wx
   
     # @overload initialize()
     #   Default ctor.
-    #   @return [EditableListBox]
+    #   @return [Wx::EditableListBox]
     # @overload initialize(parent, id, label, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::EL_DEFAULT_STYLE, name=Wx::EditableListBoxNameStr)
     #   Constructor, creating and showing a list box.
     #   
@@ -56,11 +60,11 @@ module Wx
     #   @param size [Array(Integer, Integer), Wx::Size]  Window size. If {Wx::DEFAULT_SIZE} is specified then the window is sized appropriately.
     #   @param style [Integer]  Window style. See {Wx::EditableListBox}.
     #   @param name [String]  Window name.
-    #   @return [EditableListBox]
+    #   @return [Wx::EditableListBox]
     def initialize(*args) end
     
     # Creates the editable listbox for two-step construction.
-    # See {Wx::EditableListBox#editable_list_box} for further details.
+    # See {Wx::EditableListBox#initialize} for further details.
     # @param parent [Wx::Window] 
     # @param id [Integer] 
     # @param label [String] 
@@ -68,7 +72,7 @@ module Wx
     # @param size [Array(Integer, Integer), Wx::Size] 
     # @param style [Integer] 
     # @param name [String] 
-    # @return [true,false]
+    # @return [Boolean]
     def create(parent, id, label, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::EL_DEFAULT_STYLE, name=Wx::EditableListBoxNameStr) end
     
     # Replaces current contents with given strings.

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

@@ -358,6 +358,10 @@ module Wx
   # 
   EVT_KEY_UP = 10248
   
+  # 
+  # 
+  EVT_HOTKEY = 10249
+  
   # 
   # 
   EVT_SET_CURSOR = 10250
@@ -518,14 +522,6 @@ module Wx
   # 
   EVT_FULLSCREEN = 10291
   
-  # 
-  # 
-  EVT_MOUSE_CAPTURE_CHANGED = 10292
-  
-  # 
-  # 
-  EVT_MOUSE_CAPTURE_LOST = 10293
-  
   # 
   # 
   EVT_PAINT = 10294
@@ -558,10 +554,6 @@ module Wx
   # 
   EVT_SYS_COLOUR_CHANGED = 10301
   
-  # 
-  # 
-  EVT_DISPLAY_CHANGED = 10302
-  
   # 
   # 
   EVT_DPI_CHANGED = 10303
@@ -684,7 +676,7 @@ module Wx
   
   # Generates a new unique event type.
   # Usually this function is only used by {define_event} and not called directly.
-  # @return [Integer]
+  # @return [Wx::CommandLinkButton::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}.
@@ -713,14 +705,14 @@ module Wx
     alias_method :event_object, :get_event_object
     
     # Returns the identifier of the given event type, such as {Wx::EVT_BUTTON}.
-    # @return [Integer]
+    # @return [Wx::CommandLinkButton::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 [EventCategory]
+    # @return [Wx::EventCategory]
     def get_event_category; end
     alias_method :event_category, :get_event_category
     
@@ -730,7 +722,7 @@ module Wx
     alias_method :id, :get_id
     
     # Returns true if the event handler should be skipped, false otherwise.
-    # @return [true,false]
+    # @return [Boolean]
     def get_skipped; end
     alias_method :skipped, :get_skipped
     
@@ -743,7 +735,7 @@ module Wx
     
     # Returns true if the event is or is derived from {Wx::CommandEvent} else it returns false.
     # exists only for optimization purposes.
-    # @return [true,false]
+    # @return [Boolean]
     def is_command_event; end
     alias_method :command_event?, :is_command_event
     
@@ -759,7 +751,7 @@ module Wx
     alias_method :event_object=, :set_event_object
     
     # Sets the event type.
-    # @param type [Integer] 
+    # @param type [Wx::CommandLinkButton::EventType] 
     # @return [void]
     def set_event_type(type) end
     alias_method :event_type=, :set_event_type
@@ -777,13 +769,13 @@ module Wx
     alias_method :timestamp=, :set_timestamp
     
     # Test if this event should be propagated or not, i.e. if the propagation level is currently greater than 0.
-    # @return [true,false]
+    # @return [Boolean]
     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 [true,false] 
+    # @param skip [Boolean] 
     # @return [void]
     def skip(skip=true) end
     
@@ -801,36 +793,67 @@ module Wx
   # 
   # The following event-handler methods redirect the events to member method or handler blocks for {Wx::CommandEvent} events.
   # Event handler methods:
+  # 
   # - {Wx::EvtHandler#evt_command}(id,  event, meth = nil, &block): Process a command, supplying the window identifier, command event identifier, and member function. 
+  # 
   # - {Wx::EvtHandler#evt_command_range}(id1,  id2,  event, meth = nil, &block): Process a command for a range of window identifiers, supplying the minimum and maximum window identifiers, command event identifier, and member function. 
+  # 
   # - {Wx::EvtHandler#evt_button}(id, meth = nil, &block): Process a {Wx::EVT_BUTTON} command, which is generated by a {Wx::Button} control. 
+  # 
   # - {Wx::EvtHandler#evt_checkbox}(id, meth = nil, &block): Process a {Wx::EVT_CHECKBOX} command, which is generated by a {Wx::CheckBox} control. 
+  # 
   # - {Wx::EvtHandler#evt_choice}(id, meth = nil, &block): Process a {Wx::EVT_CHOICE} command, which is generated by a {Wx::Choice} control. 
+  # 
   # - {Wx::EvtHandler#evt_combobox}(id, meth = nil, &block): Process a {Wx::EVT_COMBOBOX} command, which is generated by a {Wx::ComboBox} control. 
+  # 
   # - {Wx::EvtHandler#evt_listbox}(id, meth = nil, &block): Process a {Wx::EVT_LISTBOX} command, which is generated by a {Wx::ListBox} control. 
+  # 
   # - {Wx::EvtHandler#evt_listbox_dclick}(id, meth = nil, &block): Process a {Wx::EVT_LISTBOX_DCLICK} command, which is generated by a {Wx::ListBox} control. 
+  # 
   # - {Wx::EvtHandler#evt_checklistbox}(id, meth = nil, &block): Process a {Wx::EVT_CHECKLISTBOX} command, which is generated by a {Wx::CheckListBox} control. 
+  # 
   # - {Wx::EvtHandler#evt_menu}(id, meth = nil, &block): Process a {Wx::EVT_MENU} command, which is generated by a menu item. 
+  # 
   # - {Wx::EvtHandler#evt_menu_range}(id1,  id2, meth = nil, &block): Process a {Wx::EVT_MENU} command, which is generated by a range of menu items. 
+  # 
   # - {Wx::EvtHandler#evt_context_menu}(meth = nil, &block): Process the event generated when the user has requested a popup menu to appear by pressing a special keyboard key (under Windows) or by right clicking the mouse. 
+  # 
   # - {Wx::EvtHandler#evt_radiobox}(id, meth = nil, &block): Process a {Wx::EVT_RADIOBOX} command, which is generated by a {Wx::RadioBox} control. 
+  # 
   # - {Wx::EvtHandler#evt_radiobutton}(id, meth = nil, &block): Process a {Wx::EVT_RADIOBUTTON} command, which is generated by a {Wx::RadioButton} control. 
+  # 
   # - {Wx::EvtHandler#evt_scrollbar}(id, meth = nil, &block): Process a {Wx::EVT_SCROLLBAR} command, which is generated by a {Wx::ScrollBar} control. This is provided for compatibility only; more specific scrollbar event macros should be used instead (see {Wx::ScrollEvent}). 
+  # 
   # - {Wx::EvtHandler#evt_slider}(id, meth = nil, &block): Process a {Wx::EVT_SLIDER} command, which is generated by a {Wx::Slider} control. 
+  # 
   # - {Wx::EvtHandler#evt_text}(id, meth = nil, &block): Process a {Wx::EVT_TEXT} command, which is generated by a {Wx::TextCtrl} control. 
+  # 
   # - {Wx::EvtHandler#evt_text_enter}(id, meth = nil, &block): Process a {Wx::EVT_TEXT_ENTER} command, which is generated by a {Wx::TextCtrl} control. Note that you must use {Wx::TE_PROCESS_ENTER} flag when creating the control if you want it to generate such events. 
+  # 
   # - {Wx::EvtHandler#evt_text_maxlen}(id, meth = nil, &block): Process a {Wx::EVT_TEXT_MAXLEN} command, which is generated by a {Wx::TextCtrl} control when the user tries to enter more characters into it than the limit previously set with SetMaxLength(). 
+  # 
   # - {Wx::EvtHandler#evt_togglebutton}(id, meth = nil, &block): Process a {Wx::EVT_TOGGLEBUTTON} event. 
+  # 
   # - {Wx::EvtHandler#evt_tool}(id, meth = nil, &block): Process a {Wx::EVT_TOOL} event (a synonym for {Wx::EVT_MENU}). Pass the id of the tool. 
+  # 
   # - {Wx::EvtHandler#evt_tool_range}(id1,  id2, meth = nil, &block): Process a {Wx::EVT_TOOL} event for a range of identifiers. Pass the ids of the tools. 
-  # - {Wx::EvtHandler#evt_tool_rclicked}(id, meth = nil, &block): Process a {Wx::EVT_TOOL_RCLICKED} event. Pass the id of the tool. (Not available on {Wx::OSX}.) 
-  # - {Wx::EvtHandler#evt_tool_rclicked_range}(id1,  id2, meth = nil, &block): Process a {Wx::EVT_TOOL_RCLICKED} event for a range of ids. Pass the ids of the tools. (Not available on {Wx::OSX}.) 
-  # - {Wx::EvtHandler#evt_tool_enter}(id, meth = nil, &block): Process a {Wx::EVT_TOOL_ENTER} event. Pass the id of the toolbar itself. The value of {Wx::CommandEvent#get_selection} is the tool id, or -1 if the mouse cursor has moved off a tool. (Not available on {Wx::OSX}.) 
-  # - {Wx::EvtHandler#evt_command_left_click}(id, meth = nil, &block): Process a {Wx::EVT_COMMAND_LEFT_CLICK} command, which is generated by a control ({Wx::MSW} only). 
-  # - {Wx::EvtHandler#evt_command_left_dclick}(id, meth = nil, &block): Process a {Wx::EVT_COMMAND_LEFT_DCLICK} command, which is generated by a control ({Wx::MSW} only). 
-  # - {Wx::EvtHandler#evt_command_right_click}(id, meth = nil, &block): Process a {Wx::EVT_COMMAND_RIGHT_CLICK} command, which is generated by a control ({Wx::MSW} only). 
-  # - {Wx::EvtHandler#evt_command_set_focus}(id, meth = nil, &block): Process a {Wx::EVT_COMMAND_SET_FOCUS} command, which is generated by a control ({Wx::MSW} only). 
-  # - {Wx::EvtHandler#evt_command_kill_focus}(id, meth = nil, &block): Process a {Wx::EVT_COMMAND_KILL_FOCUS} command, which is generated by a control ({Wx::MSW} only). 
+  # 
+  # - {Wx::EvtHandler#evt_tool_rclicked}(id, meth = nil, &block): Process a {Wx::EVT_TOOL_RCLICKED} event. Pass the id of the tool. (Not available on wxOSX.) 
+  # 
+  # - {Wx::EvtHandler#evt_tool_rclicked_range}(id1,  id2, meth = nil, &block): Process a {Wx::EVT_TOOL_RCLICKED} event for a range of ids. Pass the ids of the tools. (Not available on wxOSX.) 
+  # 
+  # - {Wx::EvtHandler#evt_tool_enter}(id, meth = nil, &block): Process a {Wx::EVT_TOOL_ENTER} event. Pass the id of the toolbar itself. The value of {Wx::CommandEvent#get_selection} is the tool id, or -1 if the mouse cursor has moved off a tool. (Not available on wxOSX.) 
+  # 
+  # - {Wx::EvtHandler#evt_command_left_click}(id, meth = nil, &block): Process a {Wx::EVT_COMMAND_LEFT_CLICK} command, which is generated by a control (wxMSW only). 
+  # 
+  # - {Wx::EvtHandler#evt_command_left_dclick}(id, meth = nil, &block): Process a {Wx::EVT_COMMAND_LEFT_DCLICK} command, which is generated by a control (wxMSW only). 
+  # 
+  # - {Wx::EvtHandler#evt_command_right_click}(id, meth = nil, &block): Process a {Wx::EVT_COMMAND_RIGHT_CLICK} command, which is generated by a control (wxMSW only). 
+  # 
+  # - {Wx::EvtHandler#evt_command_set_focus}(id, meth = nil, &block): Process a {Wx::EVT_COMMAND_SET_FOCUS} command, which is generated by a control (wxMSW only). 
+  # 
+  # - {Wx::EvtHandler#evt_command_kill_focus}(id, meth = nil, &block): Process a {Wx::EVT_COMMAND_KILL_FOCUS} command, which is generated by a control (wxMSW only). 
+  # 
   # - {Wx::EvtHandler#evt_command_enter}(id, meth = nil, &block): Process a {Wx::EVT_COMMAND_ENTER} command, which is generated by a control. 
   # 
   # === 
@@ -840,9 +863,9 @@ module Wx
   class CommandEvent < Event
   
     # Constructor.
-    # @param commandEventType [Integer] 
+    # @param commandEventType [Wx::CommandLinkButton::EventType] 
     # @param id [Integer] 
-    # @return [CommandEvent]
+    # @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).
@@ -870,13 +893,13 @@ module Wx
     # 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 [true,false]
+    # @return [Boolean]
     def is_checked; end
     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 [true,false]
+    # @return [Boolean]
     def is_selection; end
     alias_method :selection?, :is_selection
     

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

@@ -41,7 +41,7 @@ module Wx
   class EventBlocker < EvtHandler
   
     # Adds to the list of event types which should be blocked the given eventType.
-    # @param eventType [Integer] 
+    # @param eventType [Wx::CommandLinkButton::EventType] 
     # @return [void]
     def block(eventType) end
     

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

@@ -71,13 +71,16 @@ module Wx
     # 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 [EventFilter]
+    # @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:
-    # - Event_Skip to continue processing the event normally (this should be used in most cases).- Event_Ignore to not process this event at all (this can be used to suppress some events).- Event_Processed to not process this event normally but indicate that it was already processed by the event filter and so no default processing should take place either (this should only be used if the filter really did process the event).
+    # 
+    # - Event_Skip to continue processing the event normally (this should be used in most cases).
+    # - Event_Ignore to not process this event at all (this can be used to suppress some events).
+    # - Event_Processed to not process this event normally but indicate that it was already processed by the event filter and so no default processing should take place either (this should only be used if the filter really did process the event).
     # @param event [Wx::Event] 
     # @return [Integer]
     def filter_event(event) end