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

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

@@ -45,7 +45,7 @@ module Wx
   
     # @overload initialize()
     #   Default ctor.
-    #   @return [ImageList]
+    #   @return [Wx::ImageList]
     # @overload initialize(width, height, mask=true, initialCount=1)
     #   Constructor specifying the image size, whether image masks should be created, and the initial size of the list.
     #   Note that the size is specified in logical pixels.
@@ -54,7 +54,7 @@ module Wx
     #   @param height [Integer]  Height of the images in the list.
     #   @param mask [true,false]  If true, all images will have masks, with the mask being created from the light grey pixels if not specified otherwise, i.e. if the image doesn't have neither alpha channel nor mask and no mask is explicitly specified when adding it. Note that if an image does have alpha channel or mask, it will always be used, whether this parameter is true or false.
     #   @param initialCount [Integer]  The initial size of the list.
-    #   @return [ImageList]
+    #   @return [Wx::ImageList]
     def initialize(*args) end
     
     # @overload add(bitmap, mask=Wx::NULL_BITMAP)
@@ -79,7 +79,7 @@ module Wx
     #   
     #   The new zero-based image index.
     #   
-    #   Availability:  only available for the {Wx::MSW}, {Wx::OSX/Cocoa} ports.  {Wx::msw},{Wx::osx}
+    #   Availability:  only available for the wxMSW, wxOSX/Cocoa ports.  {Wx::msw},{Wx::osx}
     #   @param icon [Wx::Icon]  Icon to use as the image.
     #   @return [Integer]
     def add(*args) end
@@ -95,7 +95,7 @@ module Wx
     def create(width, height, mask=true, initialCount=1) end
     
     # Destroys the current list.
-    # This function resets the object to its initial state and does more than just {Wx::ImageList#remove_all} in the native {Wx::MSW} version.
+    # This function resets the object to its initial state and does more than just {Wx::ImageList#remove_all} in the native wxMSW version.
     # After calling it, {Wx::ImageList#create} may be called again to recreate the image list, e.g. using a different size.
     # @return [void]
     def destroy; end
@@ -106,7 +106,11 @@ module Wx
     # @param x [Integer]  X position on the device context.
     # @param y [Integer]  Y position on the device context.
     # @param flags [Integer]  How to draw the image. A bitlist of a selection of the following:
-    #   - {Wx::IMAGELIST_DRAW_NORMAL}: Draw the image normally.- {Wx::IMAGELIST_DRAW_TRANSPARENT}: Draw the image with transparency.- {Wx::IMAGELIST_DRAW_SELECTED}: Draw the image in selected state.- {Wx::IMAGELIST_DRAW_FOCUSED}: Draw the image in a focused state.
+    #   
+    #   - {Wx::IMAGELIST_DRAW_NORMAL}: Draw the image normally.
+    #   - {Wx::IMAGELIST_DRAW_TRANSPARENT}: Draw the image with transparency.
+    #   - {Wx::IMAGELIST_DRAW_SELECTED}: Draw the image in selected state.
+    #   - {Wx::IMAGELIST_DRAW_FOCUSED}: Draw the image in a focused state.
     # @param solidBackground [true,false]  For optimisation - drawing can be faster if the function is told that the background is solid.
     # @return [true,false]
     def draw(index, dc, x, y, flags=Wx::IMAGELIST_DRAW_NORMAL, solidBackground=false) end
@@ -168,7 +172,7 @@ module Wx
     #   
     #   The original bitmap or icon is not affected by the {Wx::ImageList#replace} operation, and can be deleted afterwards.
     #   
-    #   Availability:  only available for the {Wx::MSW}, {Wx::OSX/Cocoa} ports.  {Wx::msw},{Wx::osx}
+    #   Availability:  only available for the wxMSW, wxOSX/Cocoa ports.  {Wx::msw},{Wx::osx}
     #   @param index [Integer]  The index of the bitmap to be replaced.
     #   @param icon [Wx::Icon]  Icon to use as the image.
     #   @return [true,false]

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

@@ -26,23 +26,23 @@ module Wx
     # @param shiftDown [true,false] 
     # @param altDown [true,false] 
     # @param metaDown [true,false] 
-    # @return [KeyboardState]
+    # @return [Wx::KeyboardState]
     def initialize(controlDown=false, shiftDown=false, altDown=false, metaDown=false) end
     
     # Return the bit mask of all pressed modifier keys.
     # The return value is a combination of {Wx::KeyModifier::MOD_ALT}, {Wx::KeyModifier::MOD_CONTROL}, {Wx::KeyModifier::MOD_SHIFT} and {Wx::KeyModifier::MOD_META} bit masks. Additionally, {Wx::KeyModifier::MOD_NONE} is defined as 0, i.e. corresponds to no modifiers (see {Wx::KeyboardState#has_any_modifiers}) and {Wx::KeyModifier::MOD_CMD} is either {Wx::KeyModifier::MOD_CONTROL} (MSW and Unix) or {Wx::KeyModifier::MOD_META} (Mac), see {Wx::KeyboardState#cmd_down}. See {Wx::KeyModifier} for the full list of modifiers.
     # Notice that this function is easier to use correctly than, for example, {Wx::KeyboardState#control_down} because when using the latter you also have to remember to test that none of the other modifiers is pressed:
     # 
-    # ```
-    #   if ( ControlDown() && !AltDown() && !ShiftDown() && !MetaDown() )
-    #       ... handle Ctrl-XXX ...
+    # ```ruby
+    #   if control_down && !alt_down && !shift_down && !meta_down
+    #     ... handle Ctrl-XXX ...
     # ```
     # 
     # and forgetting to do it can result in serious program bugs (e.g. program not working with European keyboard layout where AltGr key which is seen by the program as combination of CTRL and ALT is used). On the other hand, you can simply write:
     # 
-    # ```
-    #   if ( GetModifiers() == wxMOD_CONTROL )
-    #       ... handle Ctrl-XXX ...
+    # ```ruby
+    #   if get_modifiers == Wx::MOD_CONTROL
+    #     ... handle Ctrl-XXX ...
     # ```
     # 
     # with this function.

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

@@ -13,14 +13,21 @@ module Wx
   # === Styles
   # 
   # This class supports the following styles:
-  #  
+  # 
   # - {Wx::LB_SINGLE}: Single-selection list. 
-  # - {Wx::LB_MULTIPLE}: Multiple-selection list: the user can toggle multiple items on and off. This is the same as {Wx::LB_EXTENDED} in {Wx::GTK2} port. 
+  # 
+  # - {Wx::LB_MULTIPLE}: Multiple-selection list: the user can toggle multiple items on and off. This is the same as {Wx::LB_EXTENDED} in wxGTK2 port. 
+  # 
   # - {Wx::LB_EXTENDED}: Extended-selection list: the user can extend the selection by using SHIFT or CTRL keys together with the cursor movement keys or the mouse. 
+  # 
   # - {Wx::LB_HSCROLL}: Create horizontal scrollbar if contents are too wide (Windows only). 
+  # 
   # - {Wx::LB_ALWAYS_SB}: Always show a vertical scrollbar. 
+  # 
   # - {Wx::LB_NEEDED_SB}: Only create a vertical scrollbar if needed. 
-  # - {Wx::LB_NO_SB}: Don't create vertical scrollbar ({Wx::MSW} and {Wx::GTK} only). 
+  # 
+  # - {Wx::LB_NO_SB}: Don't create vertical scrollbar (wxMSW and wxGTK only). 
+  # 
   # - {Wx::LB_SORT}: The listbox contents are sorted in alphabetical order. 
   # 
   # Note that {Wx::LB_SINGLE}, {Wx::LB_MULTIPLE} and {Wx::LB_EXTENDED} styles are mutually exclusive and you can specify at most one of them (single selection is the default). See also Window Styles.
@@ -28,14 +35,16 @@ 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_listbox}(id, meth = nil, &block): Process a {Wx::EVT_LISTBOX} event, when an item on the list is selected or the selection changes. 
-  # - {Wx::EvtHandler#evt_listbox_dclick}(id, meth = nil, &block): Process a {Wx::EVT_LISTBOX_DCLICK} event, when the listbox is double-clicked. On some platforms (notably {Wx::GTK2}) pressing the enter key is handled as an equivalent of a double-click. 
+  # 
+  # - {Wx::EvtHandler#evt_listbox_dclick}(id, meth = nil, &block): Process a {Wx::EVT_LISTBOX_DCLICK} event, when the listbox is double-clicked. On some platforms (notably wxGTK2) pressing the enter key is handled as an equivalent of a double-click. 
   # 
   # === 
   # 
-  # 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::EditableListBox
   # @see  Wx::Choice
@@ -74,7 +83,7 @@ module Wx
     
     # @overload initialize()
     #   Default constructor.
-    #   @return [ListBox]
+    #   @return [Wx::ListBox]
     # @overload initialize(parent, id, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, choices=nil, style=0, validator=Wx::DEFAULT_VALIDATOR, name=Wx::ListBoxNameStr)
     #   Constructor, creating and showing a list box.
     #   @param parent [Wx::Window]  The parent window.
@@ -85,7 +94,7 @@ module Wx
     #   @param style [Integer]  Window style. See {Wx::ListBox}.
     #   @param validator [Wx::Validator]  The validator for this control.
     #   @param name [String]  The name of this class.
-    #   @return [ListBox]
+    #   @return [Wx::ListBox]
     # @overload initialize(parent, id, pos, size, choices, style=0, validator=Wx::DEFAULT_VALIDATOR, name=Wx::ListBoxNameStr)
     #   Constructor, creating and showing a list box.
     #   See the other {Wx::ListBox#list_box} constructor; the only difference is that this overload takes a {Wx::ArrayString} instead of a pointer to an array of {Wx::String}.
@@ -97,7 +106,7 @@ module Wx
     #   @param style [Integer] 
     #   @param validator [Wx::Validator] 
     #   @param name [String] 
-    #   @return [ListBox]
+    #   @return [Wx::ListBox]
     def initialize(*args) end
     
     # Deselects an item in the list box.
@@ -121,7 +130,7 @@ module Wx
     # This method can be used with single selection list boxes only, you must use {Wx::ListBox#get_selections} for the list boxes with {Wx::LB_MULTIPLE} style.
     # @see Wx::ListBox#set_selection
     # @see  Wx::ListBox#get_string_selection 
-    # @return [void]
+    # @return []
     def get_selection; end
     alias_method :selection, :get_selection
     
@@ -142,22 +151,22 @@ module Wx
     # @see Wx::ControlWithItems::GetSelection
     # @see  Wx::ControlWithItems::GetStringSelection
     # @see  Wx::ControlWithItems::SetSelection 
-    # @return [Array<Integer>]
+    # @return [Array(,Array<Integer>)]
     def get_selections; end
     alias_method :selections, :get_selections
     
     # @overload hit_test(point)
     #   Returns the item located at point, or {Wx::NOT_FOUND} if there is no item located at point.
-    #   It is currently implemented for {Wx::MSW}, {Wx::Mac} and {Wx::GTK2} ports.
+    #   It is currently implemented for wxMSW, {Wx::Mac} and wxGTK2 ports.
     #   
     #   Item located at point, or {Wx::NOT_FOUND} if unimplemented or the item does not exist.
     #   @param point [Array(Integer, Integer), Wx::Point]  Point of item (in client coordinates) to obtain
-    #   @return [void]
+    #   @return []
     # @overload hit_test(x, y)
     #   This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
     #   @param x [Integer] 
     #   @param y [Integer] 
-    #   @return [void]
+    #   @return []
     def hit_test(*args) end
     
     # Insert the given number of strings before the specified position.
@@ -191,14 +200,14 @@ module Wx
     def ensure_visible(n) end
     
     # Return the number of items that can fit vertically in the visible area of the listbox.
-    # Returns -1 if the number of items per page couldn't be determined. On {Wx::GTK} this method can only determine the number of items per page if there is at least one item in the listbox.
-    # @return [void]
+    # Returns -1 if the number of items per page couldn't be determined. On wxGTK this method can only determine the number of items per page if there is at least one item in the listbox.
+    # @return []
     def get_count_per_page; end
     alias_method :count_per_page, :get_count_per_page
     
     # Return the index of the topmost visible item.
     # Returns {Wx::NOT_FOUND} if the method is not implemented for the current platform.
-    # @return [void]
+    # @return []
     def get_top_item; end
     alias_method :top_item, :get_top_item
     
@@ -209,7 +218,7 @@ module Wx
     # 
     # true if all specified tabs are set, false otherwise
     # 
-    # Availability:  only available for the {Wx::MSW} port.  {Wx::msw}
+    # Availability:  only available for the wxMSW port.  {Wx::msw}
     # @param tabStops [Wx::Vector< int >]  If this argument is empty, tab stops are reset to their default value (every 32 dialog units). If it contains a single element, tab stops are set at each multiple of the given value. Otherwise tab stops are set at every element of the array, which must be in ascending order.
     # @return [true,false]
     def msw_set_tab_stops(tabStops) end
@@ -217,7 +226,7 @@ module Wx
     # Returns the number of items in the control.
     # 
     # @see Wx::ListBox#is_empty 
-    # @return [void]
+    # @return []
     def get_count; end
     alias_method :count, :get_count
     
@@ -240,7 +249,7 @@ module Wx
     # The zero-based position of the item, or {Wx::NOT_FOUND} if the string was not found.
     # @param string [String]  String to find.
     # @param caseSensitive [true,false]  Whether search is case sensitive (default is not).
-    # @return [void]
+    # @return []
     def find_string(string, caseSensitive=false) end
     
   end # ListBox