wxruby3 0.9.2-x64-mingw-ucrt → 0.9.3-x64-mingw-ucrt

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

@@ -31,6 +31,7 @@ module Wx
   IMAGE_LIST_STATE = 2
   
   # A {Wx::ImageList} contains a list of images, which are stored in an unspecified form.
+  # 
   # Images can use alpha channel or masks for transparent drawing, and can be made from a variety of sources including bitmaps and icons.
   # {Wx::ImageList} is used principally in conjunction with {Wx::TreeCtrl} and {Wx::ListCtrl} classes.
   # Use of this class is not recommended in the new code as it doesn't support showing DPI-dependent bitmaps. Please use {Wx::WithImages#set_images} instead of {Wx::WithImages#set_image_list}.
@@ -48,6 +49,7 @@ module Wx
     #   @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.
     #   @see Wx::ImageList#create 
     #   @param width [Integer]  Width of the images in the list.
@@ -59,6 +61,7 @@ module Wx
     
     # @overload add(bitmap, mask=Wx::NULL_BITMAP)
     #   Adds a new image or images using a bitmap and optional mask bitmap.
+    #   
     #   The logical size of the bitmap should be the same as the size specified when constructing {Wx::ImageList}. If the logical width of the bitmap is greater than the image list width, bitmap is split into smaller images of the required width.
     #   
     #   The new zero-based image index.
@@ -67,6 +70,7 @@ module Wx
     #   @return [Integer]
     # @overload add(bitmap, maskColour)
     #   Adds a new image or images using a bitmap and mask colour.
+    #   
     #   The logical size of the bitmap should be the same as the size specified when constructing {Wx::ImageList}. If the logical width of the bitmap is greater than the image list width, bitmap is split into smaller images of the required width.
     #   
     #   The new zero-based image index.
@@ -75,6 +79,7 @@ module Wx
     #   @return [Integer]
     # @overload add(icon)
     #   Adds a new image using an icon.
+    #   
     #   The logical size of the icon should be the same as the size specified when constructing {Wx::ImageList}.
     #   
     #   The new zero-based image index.
@@ -85,6 +90,7 @@ module Wx
     def add(*args) end
     
     # Initializes the list.
+    # 
     # See {Wx::ImageList#initialize} for details.
     # This function can be called only once after creating the object using its default ctor or after calling {Wx::ImageList#destroy}.
     # @param width [Integer] 
@@ -95,6 +101,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 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]
@@ -133,6 +140,7 @@ module Wx
     alias_method :image_count, :get_image_count
     
     # Retrieves the size of the image list as passed to {Wx::ImageList#create}.
+    # 
     # the size of the image list, which may be zero if the image list was not yet initialised.
     # @return [Wx::Size]
     def get_size; end
@@ -149,26 +157,28 @@ module Wx
     
     # @overload replace(index, bitmap, mask=Wx::NULL_BITMAP)
     #   Replaces the existing image with the new image.
+    #   
     #   true if the replacement was successful, false otherwise.
     #   
     #   <div class="wxrb-remark">
     #   <b>Remark:</b>
     #   <p>The original bitmap or icon is not affected by the {Wx::ImageList#replace} operation, and can be deleted afterwards. 
     #   </p>
-    #   </div>>
+    #   </div>
     #   @param index [Integer]  The index of the bitmap to be replaced.
     #   @param bitmap [Wx::Bitmap]  Bitmap representing the opaque areas of the image.
     #   @param mask [Wx::Bitmap]  Monochrome mask bitmap, representing the transparent areas of the image.
     #   @return [Boolean]
     # @overload replace(index, icon)
     #   Replaces the existing image with the new image.
+    #   
     #   true if the replacement was successful, false otherwise.
     #   
     #   <div class="wxrb-remark">
     #   <b>Remark:</b>
     #   <p>The original bitmap or icon is not affected by the {Wx::ImageList#replace} operation, and can be deleted afterwards.
     #   </p>
-    #   </div>>
+    #   </div>
     #   
     #   Availability:  only available for the WXMSW, WXOSX/Cocoa ports.
     #   @param index [Integer]  The index of the bitmap to be replaced.

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

@@ -7,6 +7,7 @@
 module Wx
 
   # An info bar is a transient window shown at top or bottom of its parent window to display non-critical information to the user.
+  # 
   # This class provides another way to show messages to the user, intermediate between message boxes and status bar messages. The message boxes are modal and thus interrupt the users work flow and should be used sparingly for this reason. However status bar messages are often too easy not to notice at all. An info bar provides a way to present the messages which has a much higher chance to be noticed by the user but without being annoying.
   # Info bar may show an icon (on the left), text message and, optionally, buttons allowing the user to react to the information presented. Unless a custom button was added to the info bar, it also has a close button at the right allowing the user to dismiss it so it isn't necessary to provide a button just to close it.
   # {Wx::InfoBar} calls its parent {Wx::Window#layout} method and assumes that it will change the parent layout appropriately depending on whether the info bar itself is shown or hidden. Usually this is achieved by simply using a sizer for the parent window layout and adding {Wx::InfoBar} to this sizer as one of the items. Considering the usual placement of the info bars, normally this sizer should be a vertical {Wx::BoxSizer} and the bar its first or last element so the simplest possible example of using this class would be: 
@@ -47,6 +48,7 @@ module Wx
   class InfoBar < Control
   
     # Set the effects to use when showing and hiding the bar.
+    # 
     # Either or both of the parameters can be set to {Wx::ShowEffect::SHOW_EFFECT_NONE} to disable using effects entirely.
     # By default, the info bar uses {Wx::ShowEffect::SHOW_EFFECT_SLIDE_TO_BOTTOM} effect for showing itself and {Wx::ShowEffect::SHOW_EFFECT_SLIDE_TO_TOP} for hiding if it is the first element of the containing sizer and reverse effects if it's the last one. If it is neither the first nor the last element, no effect is used to avoid the use of an inappropriate one and this function must be called if an effect is desired.
     # @param showEffect [Wx::ShowEffect]  The effect to use when showing the bar.
@@ -65,6 +67,7 @@ module Wx
     alias_method :hide_effect, :get_hide_effect
     
     # Set the duration of the animation used when showing or hiding the bar.
+    # 
     # By default, 500ms duration is used.
     # @param duration [Integer]  Duration of the animation, in milliseconds.
     # @return [void]
@@ -78,11 +81,13 @@ module Wx
     
     # @overload initialize()
     #   Default constructor.
+    #   
     #   Use {Wx::InfoBar#create} for the objects created using this constructor.
     #   @return [Wx::InfoBar]
     # @overload initialize(parent, winid=Wx::StandardID::ID_ANY)
     #   Constructor creating the info bar window.
     #   
+    #   
     #   @see Wx::InfoBar#create 
     #   @param parent [Wx::Window] 
     #   @param winid [Integer] 
@@ -90,6 +95,7 @@ module Wx
     def initialize(*args) end
     
     # Create the info bar window.
+    # 
     # Notice that unlike most of the other {Wx::Window}-derived classes, {Wx::InfoBar} is created hidden and is only shown when {Wx::InfoBar#show_message} is called. This is more convenient as usually the info bar is created to be shown at some later time and not immediately and so creating it hidden avoids the need to call {Wx::InfoBar#hide} explicitly from the code using it.
     # This should be only called if the object was created using its default constructor.
     # @param parent [Wx::Window]  A valid parent window pointer.
@@ -98,6 +104,7 @@ module Wx
     def create(parent, winid=Wx::StandardID::ID_ANY) end
     
     # Add a button to be shown in the info bar.
+    # 
     # The button added by this method will be shown to the right of the text (in LTR layout), with each successive button being added to the right of the previous one. If any buttons are added to the info bar using this method, the default "Close" button is not shown as it is assumed that the extra buttons already allow the user to close it.
     # Clicking the button will generate a normal EVT_COMMAND_BUTTON_CLICKED event which can be handled as usual. The default handler in {Wx::InfoBar} itself closes the window whenever a button in it is clicked so if you wish the info bar to be hidden when the button is clicked, simply call <code>event.Skip()</code> in the button handler to let the base class handler do it (calling {Wx::InfoBar#dismiss} explicitly works too, of course). On the other hand, if you don't skip the event, the info bar will remain opened so make sure to do it for at least some buttons to allow the user to close it.
     # Notice that the generic {Wx::InfoBar} implementation handles the button events itself and so they are not propagated to the info bar parent and you need to either inherit from {Wx::InfoBar} and handle them in your derived class or use {Wx::EvtHandler#bind}, as is done in the dialogs sample, to handle the button events in the parent frame.
@@ -107,6 +114,7 @@ module Wx
     def add_button(btnid, label=(())) end
     
     # Hide the info bar window.
+    # 
     # This method hides the window and lays out the parent window to account for its disappearance (unlike a simple {Wx::InfoBar#hide}).
     # @return [void]
     def dismiss; end
@@ -117,6 +125,7 @@ module Wx
     def remove_button(btnid) end
     
     # Show a message in the bar.
+    # 
     # If the bar is currently hidden, it will be shown. Otherwise its message will be updated in place.
     # @param msg [String]  The text of the message.
     # @param flags [Integer]  One of {Wx::ICON_NONE}, {Wx::ICON_INFORMATION} (default), {Wx::ICON_QUESTION}, {Wx::ICON_WARNING} or {Wx::ICON_ERROR} values. These flags have the same meaning as in {Wx::MessageDialog} for the generic version, i.e. show (or not, in case of {Wx::ICON_NONE}) the corresponding icon in the bar but can be interpreted by the native versions. For example, the GTK+ native implementation doesn't show icons at all but uses this parameter to select the appropriate background colour for the notification.
@@ -124,6 +133,7 @@ module Wx
     def show_message(msg, flags=Wx::ICON_INFORMATION) end
     
     # Returns the number of currently shown buttons.
+    # 
     # This is simply the number of calls to {Wx::InfoBar#add_button} minus the number of calls to {Wx::InfoBar#remove_button} so far.
     # The number of currently shown buttons, possibly 0.
     # @return [Integer]
@@ -131,6 +141,7 @@ module Wx
     alias_method :button_count, :get_button_count
     
     # Returns the ID of the button at the given position.
+    # 
     # The positions of the buttons are counted in order of their addition.
     # 
     # The ID of the button at the given position or {Wx::StandardID::ID_NONE} if it is out of range (this also results in an assertion failure).
@@ -140,6 +151,7 @@ module Wx
     alias_method :button_id, :get_button_id
     
     # Returns whether a button with the given ID is currently shown.
+    # 
     # true if the button with this ID is currently shown.
     # @param btnid [Integer]  ID of the button to check for.
     # @return [Boolean]

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

@@ -7,6 +7,7 @@
 module Wx
 
   # Provides methods for testing the state of the keyboard modifier keys.
+  # 
   # This class is used as a base class of {Wx::KeyEvent} and {Wx::MouseState} and, hence, indirectly, of {Wx::MouseEvent}, so its methods may be used to get information about the modifier keys which were pressed when the event occurred.
   # This class is implemented entirely inline in <{Wx::/kbdstate.h}> and thus has no linking requirements.
   # 
@@ -20,6 +21,7 @@ module Wx
   class KeyboardState < ::Object
   
     # Constructor initializes the modifier key settings.
+    # 
     # By default, no modifiers are active.
     # @param controlDown [Boolean] 
     # @param shiftDown [Boolean] 
@@ -29,6 +31,7 @@ module Wx
     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:
     # 
@@ -50,6 +53,7 @@ module Wx
     alias_method :modifiers, :get_modifiers
     
     # Returns true if any modifiers at all are pressed.
+    # 
     # This is equivalent to <code>Wx::KeyboardState#get_modifiers</code> <code>!=</code> {Wx::KeyModifier::MOD_NONE}.
     # Notice that this is different from {Wx::KeyboardState#has_modifiers} method which doesn't take e.g. Shift modifier into account. This method is most suitable for mouse events when any modifier, including Shift, can change the interpretation of the event.
     # @return [Boolean]
@@ -57,6 +61,7 @@ module Wx
     alias_method :has_any_modifiers?, :has_any_modifiers
     
     # Returns true if Control or Alt are pressed.
+    # 
     # Checks if Control, Alt or, under macOS only, Command key are pressed (notice that the real Control key is still taken into account under OS X too).
     # This method returns false if only Shift is pressed for compatibility reasons and also because pressing Shift usually doesn't change the interpretation of key events, see {Wx::KeyboardState#has_any_modifiers} if you want to take Shift into account as well.
     # @return [Boolean]
@@ -64,35 +69,41 @@ module Wx
     alias_method :has_modifiers?, :has_modifiers
     
     # Returns true if the Control key or Apple/Command key under macOS is pressed.
+    # 
     # This function doesn't distinguish between right and left control keys.
     # Notice that {Wx::KeyboardState#get_modifiers} should usually be used instead of this one.
     # @return [Boolean]
     def control_down; end
     
     # Returns true if the Control key (also under macOS).
+    # 
     # This function doesn't distinguish between right and left control keys.
     # Notice that {Wx::KeyboardState#get_modifiers} should usually be used instead of this one.
     # @return [Boolean]
     def raw_control_down; end
     
     # Returns true if the Shift key is pressed.
+    # 
     # This function doesn't distinguish between right and left shift keys.
     # Notice that {Wx::KeyboardState#get_modifiers} should usually be used instead of this one.
     # @return [Boolean]
     def shift_down; end
     
     # Returns true if the Meta/Windows/Apple key is pressed.
+    # 
     # This function tests the state of the key traditionally called Meta under Unix systems, Windows keys under MSW Notice that {Wx::KeyboardState#get_modifiers} should usually be used instead of this one.
     # @see Wx::KeyboardState#cmd_down 
     # @return [Boolean]
     def meta_down; end
     
     # Returns true if the Alt key is pressed.
+    # 
     # Notice that {Wx::KeyboardState#get_modifiers} should usually be used instead of this one.
     # @return [Boolean]
     def alt_down; end
     
     # Returns true if the key used for command accelerators is pressed.
+    # 
     # Same as {Wx::KeyboardState#control_down}. Deprecated.
     # Notice that {Wx::KeyboardState#get_modifiers} should usually be used instead of this one.
     # @return [Boolean]

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

@@ -7,6 +7,7 @@
 module Wx
 
   # A listbox is used to select one or more of a list of strings.
+  # 
   # The strings are displayed in a scrolling box, with the selected string(s) marked in reverse video. A listbox can be single selection (if an item is selected, the previous selection is removed) or multiple selection (clicking an item toggles the item on or off independently of other selections).
   # List box elements are numbered from zero and while the maximal number of elements is unlimited, it is usually better to use a virtual control, not requiring to add all the items to it at once, such as {Wx::DataViewCtrl} or {Wx::ListCtrl} with {Wx::LC_VIRTUAL} style, once more than a few hundreds items need to be displayed because this control is not optimized, neither from performance nor from user interface point of view, for large number of items.
   # Notice that the list box doesn't support control characters other than TAB.
@@ -56,6 +57,7 @@ module Wx
   
     # @overload create(parent, id, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, choices=nil, style=0, validator=Wx::DEFAULT_VALIDATOR, name=Wx::LIST_BOX_NAME_STR)
     #   Creates the listbox for two-step construction.
+    #   
     #   See {Wx::ListBox#initialize} for further details.
     #   @param parent [Wx::Window] 
     #   @param id [Integer] 
@@ -68,6 +70,7 @@ module Wx
     #   @return [Boolean]
     # @overload create(parent, id, pos, size, choices, style=0, validator=Wx::DEFAULT_VALIDATOR, name=Wx::LIST_BOX_NAME_STR)
     #   Creates the listbox for two-step construction.
+    #   
     #   See {Wx::ListBox#initialize} for further details.
     #   @param parent [Wx::Window] 
     #   @param id [Integer] 
@@ -96,6 +99,7 @@ module Wx
     #   @return [Wx::ListBox]
     # @overload initialize(parent, id, pos, size, choices, style=0, validator=Wx::DEFAULT_VALIDATOR, name=Wx::LIST_BOX_NAME_STR)
     #   Constructor, creating and showing a list box.
+    #   
     #   See the other {Wx::ListBox#initialize} constructor; the only difference is that this overload takes a {Wx::ArrayString} instead of a pointer to an array of {Wx::String}.
     #   @param parent [Wx::Window] 
     #   @param id [Integer] 
@@ -109,16 +113,18 @@ module Wx
     def initialize(*args) end
     
     # Deselects an item in the list box.
+    # 
     # <div class="wxrb-remark">
     # <b>Remark:</b>
     # <p>This applies to multiple selection listboxes only. 
     # </p>
-    # </div>>
+    # </div>
     # @param n [Integer]  The zero-based item to deselect.
     # @return [void]
     def deselect(n) end
     
     # Sets the selection to the given item n or removes the selection entirely if n == {Wx::NOT_FOUND}.
+    # 
     # Note that this does not cause any command events to be emitted nor does it deselect any other items in the controls which support multiple selections.
     # @see Wx::ListBox#set_string
     # @see  Wx::ListBox#set_string_selection 
@@ -128,13 +134,14 @@ module Wx
     alias_method :selection=, :set_selection
     
     # Returns the index of the selected item or {Wx::NOT_FOUND} if no item is selected.
+    # 
     # The position of the current selection.
     # 
     # <div class="wxrb-remark">
     # <b>Remark:</b>
     # <p>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.
     # </p>
-    # </div>>
+    # </div>
     # @see Wx::ListBox#set_selection
     # @see  Wx::ListBox#get_string_selection 
     # @return [Integer]
@@ -152,13 +159,14 @@ module Wx
     alias_method :string_selection=, :set_string_selection
     
     # Fill an array of ints with the positions of the currently selected items.
+    # 
     # The number of selections.
     # 
     # <div class="wxrb-remark">
     # <b>Remark:</b>
     # <p>Use this with a multiple selection listbox.
     # </p>
-    # </div>>
+    # </div>
     # @see Wx::ControlWithItems::GetSelection
     # @see  Wx::ControlWithItems::GetStringSelection
     # @see  Wx::ControlWithItems::SetSelection 
@@ -168,6 +176,7 @@ module Wx
     
     # @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 WXMSW, WXOSX and WXGTK2 ports.
     #   
     #   Item located at point, or {Wx::NOT_FOUND} if unimplemented or the item does not exist.
@@ -187,6 +196,7 @@ module Wx
     def insert_items(items, pos) end
     
     # Determines whether an item is selected.
+    # 
     # true if the given item is selected, false otherwise.
     # @param n [Integer]  The zero-based item index.
     # @return [Boolean]
@@ -205,24 +215,28 @@ module Wx
     alias_method :first_item=, :set_first_item
     
     # Ensure that the item with the given index is currently shown.
+    # 
     # This method scrolls the listbox only if necessary and doesn't do anything if this item is already shown, unlike {Wx::ListBox#set_first_item}.
     # @param n [Integer] 
     # @return [void]
     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 WXGTK this method can only determine the number of items per page if there is at least one item in the listbox.
     # @return [Integer]
     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 [Integer]
     def get_top_item; end
     alias_method :top_item, :get_top_item
     
     # MSW-specific function for setting custom tab stop distances.
+    # 
     # Tab stops are expressed in dialog unit widths, i.e. "quarters of the
     # average character width for the font that is selected into the list
     # box".
@@ -237,12 +251,14 @@ module Wx
     
     # Returns the number of items in the control.
     # 
+    # 
     # @see Wx::ListBox#is_empty 
     # @return [Integer]
     def get_count; end
     alias_method :count, :get_count
     
     # Returns the label of the item with the given index.
+    # 
     # The index must be valid, i.e. less than the value returned by {Wx::ListBox#get_count}, otherwise an assert is triggered. Notably, this function can't be called if the control is empty.
     # 
     # The label of the item.
@@ -258,6 +274,7 @@ module Wx
     def set_string(n, string) end
     
     # Finds an item whose label matches the given string.
+    # 
     # 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 [Boolean]  Whether search is case sensitive (default is not).