wxruby3 0.9.1-x64-mingw-ucrt → 0.9.3-x64-mingw-ucrt

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

@@ -169,6 +169,7 @@ module Wx
   # 
   # 
   # 
+  # @wxrb_require USE_LISTCTRL
   class ListColumnFormat < Wx::Enum
   
     # 
@@ -314,18 +315,29 @@ module Wx
   EVT_LIST_ITEM_UNCHECKED = 10155
   
   # A list control presents lists in a number of formats: list view, report view, icon view and small icon view.
+  # 
   # In any case, elements are numbered from zero. For all these modes, the items are stored in the control and must be added to it using {Wx::ListCtrl#insert_item} method.
   # A special case of report view quite different from the other modes of the list control is a virtual control in which the items data (including text, images and attributes) is managed by the main program and is requested by the control itself only when needed which allows having controls with millions of items without consuming much memory. To use virtual list control you must use {Wx::ListCtrl#set_item_count} first and override at least {Wx::ListCtrl#on_get_item_text} (and optionally {Wx::ListCtrl#on_get_item_image} or {Wx::ListCtrl#on_get_item_column_image} and {Wx::ListCtrl#on_get_item_attr}) to return the information about the items when the control requests it.
   # Virtual list control can be used as a normal one except that no operations which can take time proportional to the number of items in the control happen  this is required to allow having a practically infinite number of items. For example, in a multiple selection virtual list control, the selections won't be sent when many items are selected at once because this could mean iterating over all the items.
   # Using many of {Wx::ListCtrl} features is shown in the corresponding sample.
   # To intercept events from a list control, use the event table macros described in {Wx::ListEvent}.
-  # The native wxOSX implementation for report mode that was added in wxWidgets 2.8 was removed in wxWidgets 3.1, meaning for wxWidgets 3.1+ wxOSX uses the generic implementation for all modes.
   # 
-  # == Column Ordering
+  # <div class="wxrb-note">
+  # <b>Note:</b>
+  # <p>The native WXOSX implementation for report mode that was added in wxWidgets 2.8 was removed in wxWidgets 3.1, meaning for wxWidgets 3.1+ WXOSX uses the generic implementation for all modes.
+  # </p>
+  # </div>
+  # 
+  # ## Column Ordering
   # 
   # By default, the columns of a list control appear on the screen in order of their indices, i.e. column 0 appears first, then column 1 next, and so on. However this can be changed by using the {Wx::ListCtrl#set_columns_order} function to arbitrarily reorder the columns visual order.
   # The user can also rearrange the columns interactively by dragging them. In this case, the index of the column is not the same as its order and the functions {Wx::ListCtrl#get_column_order} and {Wx::ListCtrl#get_column_index_from_order} should be used to translate between them.
-  # All the other functions still work with the column indices, i.e. the visual positioning of the columns on screen doesn't affect the code setting or getting their values for example.
+  # 
+  # <div class="wxrb-note">
+  # <b>Note:</b>
+  # <p>All the other functions still work with the column indices, i.e. the visual positioning of the columns on screen doesn't affect the code setting or getting their values for example.
+  # </p>
+  # </div>
   # 
   # Example of reordering columns: 
   # ```ruby
@@ -341,7 +353,7 @@ module Wx
   #   # 1 and 2 respectively
   # ```
   # 
-  # === Styles
+  # ### Styles
   # 
   # This class supports the following styles:
   # 
@@ -375,7 +387,7 @@ module Wx
   # 
   # - {Wx::LC_VRULES}: Draws light vertical rules between columns in report mode. 
   # 
-  # === Events emitted by this class
+  # ### Events emitted by this class
   # 
   # The following event-handler methods redirect the events to member method or handler blocks for {Wx::ListEvent} events.
   # Event handler methods for events emitted by this class:
@@ -424,13 +436,15 @@ module Wx
   # 
   # - {Wx::EvtHandler#evt_list_item_unchecked}(id, meth = nil, &block): The item has been unchecked. Processes a {Wx::EVT_LIST_ITEM_UNCHECKED} event type (new since wxWidgets 3.1.0). 
   # 
-  # Under wxMSW this control uses {Wx::SystemThemedControl} for an explorer style appearance by default since wxWidgets 3.1.0. If this is not desired, you can call Wx::SystemThemedControl::EnableSystemTheme with false argument to disable this.
-  # 
-  # === 
+  # <div class="wxrb-note">
+  # <b>Note:</b>
+  # <p>Under WXMSW this control uses {Wx::SystemThemedControl} for an explorer style appearance by default since wxWidgets 3.1.0. If this is not desired, you can call Wx::SystemThemedControl::EnableSystemTheme with false argument to disable this.
+  # </p>
+  # </div>
   # 
-  # Category:  {Wx::Controls}  <div class='appearance'><span class='appearance'>Appearance:</span><table><tr><td> wxMSW Appearance
-  #   </td><td> wxGTK Appearance
-  #   </td><td> wxOSX 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 wxListCtrl Overview
   # @see  Wx::ListView
@@ -442,6 +456,7 @@ module Wx
   # @see  Wx::EditableListBox 
   # 
   # 
+  # @wxrb_require USE_LISTCTRL
   class ListCtrl < Control
   
     # @overload initialize()
@@ -450,6 +465,7 @@ module Wx
     # @overload initialize(parent, id, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::LC_ICON, validator=Wx::DEFAULT_VALIDATOR, name=Wx::LIST_CTRL_NAME_STR)
     #   Constructor, creating and showing a list control.
     #   
+    #   
     #   @see Wx::ListCtrl#create
     #   @see  Wx::Validator 
     #   @param parent [Wx::Window]  Parent window. Must not be NULL.
@@ -463,6 +479,7 @@ module Wx
     def initialize(*args) end
     
     # Adds a new column to the list control in report view mode.
+    # 
     # This is just a convenient wrapper for {Wx::ListCtrl#insert_column} which adds the new column after all the existing ones without having to specify its position explicitly.
     # @param heading [String] 
     # @param format [Wx::ListColumnFormat] 
@@ -471,6 +488,7 @@ module Wx
     def append_column(heading, format=Wx::ListColumnFormat::LIST_FORMAT_LEFT, width=-1) end
     
     # Arranges the items in icon or small icon view.
+    # 
     # This only has effect on Win32. flag is one of:
     # 
     # - {Wx::LIST_ALIGN_DEFAULT}: Default alignment.
@@ -482,11 +500,17 @@ module Wx
     def arrange(flag=Wx::LIST_ALIGN_DEFAULT) end
     
     # Deletes all items and all columns.
-    # This sends an event of type {Wx::EVT_LIST_DELETE_ALL_ITEMS} under all platforms.
+    # 
+    # <div class="wxrb-note">
+    # <b>Note:</b>
+    # <p>This sends an event of type {Wx::EVT_LIST_DELETE_ALL_ITEMS} under all platforms. 
+    # </p>
+    # </div>
     # @return [void]
     def clear_all; end
     
     # Creates the list control.
+    # 
     # See {Wx::ListCtrl#initialize} for further details.
     # @param parent [Wx::Window] 
     # @param id [Integer] 
@@ -499,11 +523,13 @@ module Wx
     def create(parent, id, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::LC_ICON, validator=Wx::DEFAULT_VALIDATOR, name=Wx::LIST_CTRL_NAME_STR) end
     
     # Delete all columns in the list control.
+    # 
     # true if all columns were successfully deleted, false otherwise.
     # @return [Boolean]
     def delete_all_columns; end
     
     # Deletes all items in the list control.
+    # 
     # This function does not send the {Wx::EVT_LIST_DELETE_ITEM} event because deleting many items from the control would be too slow then (unlike {Wx::ListCtrl#delete_item}) but it does send the special {Wx::EVT_LIST_DELETE_ALL_ITEMS} event if the control was not empty. If it was already empty, nothing is done and no event is sent.
     # true if the items were successfully deleted or if the control was already empty, false if an error occurred while deleting the items.
     # @return [Boolean]
@@ -515,6 +541,7 @@ module Wx
     def delete_column(col) end
     
     # Deletes the specified item.
+    # 
     # This function sends the {Wx::EVT_LIST_DELETE_ITEM} event for the item being deleted.
     # @see Wx::ListCtrl#delete_all_items 
     # @param item [Integer] 
@@ -522,6 +549,7 @@ module Wx
     def delete_item(item) end
     
     # Enable alternating row background colours (also called zebra striping).
+    # 
     # This method can only be called for the control in virtual report mode, i.e. having {Wx::LC_REPORT} and {Wx::LC_VIRTUAL} styles.
     # When enabling alternating colours, the appropriate colour for the even rows is chosen automatically depending on the default foreground and background colours which are used for the odd rows.
     # @see Wx::ListCtrl#set_alternate_row_colour 
@@ -530,15 +558,17 @@ module Wx
     def enable_alternate_row_colours(enable=true) end
     
     # Enable or disable a beep if there is no match for the currently entered text when searching for the item from keyboard.
-    # The default is to not beep in this case except in wxMSW where the beep is always generated by the native control and cannot be disabled, i.e. calls to this function do nothing there.
+    # 
+    # The default is to not beep in this case except in WXMSW where the beep is always generated by the native control and cannot be disabled, i.e. calls to this function do nothing there.
     # @param on [Boolean] 
     # @return [void]
     def enable_bell_on_no_match(on=true) end
     
     # Finish editing the label.
+    # 
     # This method allows one to programmatically end editing a list control item in place. Usually it will only be called when editing is in progress, i.e. if {Wx::ListCtrl#get_edit_control} returns non-NULL. In particular, do not call it from EVT_LIST_BEGIN_LABEL_EDIT handler as the edit control is not yet fully created by then, just veto the event in this handler instead to prevent the editing from even starting.
     # Notice that calling this method will result in EVT_LIST_END_LABEL_EDIT event being generated.
-    # Currently only implemented in wxMSW.
+    # Currently only implemented in WXMSW.
     # 
     # true if item editing was finished or false if no item as being edited.
     # @param cancel [Boolean]  If true, discard the changes made by user, as if Escape key was pressed. Otherwise, accept the changes as if Return was pressed.
@@ -552,6 +582,7 @@ module Wx
     
     # @overload find_item(start, str, partial=false)
     #   Find an item whose label matches this string, starting from start or the beginning if start is <code>-1</code>.
+    #   
     #   The string comparison is case insensitive.
     #   If partial is true then this method will look for items which begin with str.
     #   The next matching item if any or <code>-1</code> ({Wx::NOT_FOUND}) otherwise.
@@ -561,12 +592,14 @@ module Wx
     #   @return [Integer]
     # @overload find_item(start, data)
     #   Find an item whose data matches this data, starting from start or the beginning if 'start' is <code>-1</code>.
+    #   
     #   The next matching item if any or <code>-1</code> ({Wx::NOT_FOUND}) otherwise.
     #   @param start [Integer] 
     #   @param data [Integer] 
     #   @return [Integer]
     # @overload find_item(start, pt, direction)
     #   Find an item nearest this position in the specified direction, starting from start or the beginning if start is -1.
+    #   
     #   The next matching item if any or <code>-1</code> ({Wx::NOT_FOUND}) otherwise.
     #   @param start [Integer] 
     #   @param pt [Array(Integer, Integer), Wx::Point] 
@@ -575,6 +608,7 @@ module Wx
     def find_item(*args) end
     
     # Gets information about this column.
+    # 
     # See {Wx::ListCtrl#set_item} for more information.
     # @param col [Integer] 
     # @param item [Wx::ListItem] 
@@ -583,6 +617,7 @@ module Wx
     alias_method :column, :get_column
     
     # Returns the number of columns.
+    # 
     # The control can have multiple columns only in {Wx::LC_REPORT} mode. In {Wx::LC_LIST} mode this function returns 1, as a list is still considered to have a (single) column. In {Wx::LC_SMALL_ICON} and {Wx::LC_ICON} modes, it returns 0 as there are no columns at all.
     # @return [Integer]
     def get_column_count; end
@@ -600,13 +635,20 @@ module Wx
     alias_method :count_per_page, :get_count_per_page
     
     # Returns the edit control being currently used to edit a label.
+    # 
     # Returns NULL if no label is being edited.
-    # It is currently only implemented for wxMSW and the generic version, not for the native macOS version.
+    # 
+    # <div class="wxrb-note">
+    # <b>Note:</b>
+    # <p>It is currently only implemented for WXMSW and the generic version, not for the native macOS version. 
+    # </p>
+    # </div>
     # @return [Wx::TextCtrl]
     def get_edit_control; end
     alias_method :edit_control, :get_edit_control
     
     # Returns the specified image list.
+    # 
     # which may be one of:
     # 
     # - {Wx::IMAGE_LIST_NORMAL}: The normal (large icon) image list.
@@ -618,6 +660,7 @@ module Wx
     alias_method :image_list, :get_image_list
     
     # Returns the colour for this item.
+    # 
     # If the item has no specific colour, returns an invalid colour (and not the default background colour of the control itself).
     # @see Wx::ListCtrl#get_item_text_colour 
     # @param item [Integer] 
@@ -644,6 +687,7 @@ module Wx
     alias_method :item_position, :get_item_position
     
     # Returns the rectangle representing the item's size and position, in physical coordinates.
+    # 
     # code is one of {Wx::LIST_RECT_BOUNDS}, {Wx::LIST_RECT_ICON}, {Wx::LIST_RECT_LABEL}.
     # @param item [Integer] 
     # @param code [Integer] 
@@ -657,6 +701,7 @@ module Wx
     alias_method :item_spacing, :get_item_spacing
     
     # Gets the item state.
+    # 
     # For a list of state flags, see {Wx::ListCtrl#set_item}. The stateMask indicates which state flags are of interest.
     # @param item [Integer] 
     # @param stateMask [Integer] 
@@ -672,6 +717,7 @@ module Wx
     alias_method :item_text, :get_item_text
     
     # Returns the colour for this item.
+    # 
     # If the item has no specific colour, returns an invalid colour (and not the default foreground colour of the control itself as this wouldn't allow distinguishing between items having the same colour as the current control foreground and items with default colour which, hence, have always the same colour as the control).
     # @param item [Integer] 
     # @return [Wx::Colour]
@@ -679,6 +725,7 @@ module Wx
     alias_method :item_text_colour, :get_item_text_colour
     
     # Searches for an item with the given geometry or state, starting from item but excluding the item itself.
+    # 
     # If item is -1, the first item that matches the specified flags will be returned. Returns the first item with given state following item or -1 if no such item found. This function may be used to find all selected items in the control like this:
     # 
     # ```ruby
@@ -702,7 +749,11 @@ module Wx
     # - {Wx::LIST_NEXT_LEFT}: Searches for an item to the left of the specified item.
     # - {Wx::LIST_NEXT_RIGHT}: Searches for an item to the right of the specified item.
     # 
-    # this parameter is only supported by wxMSW currently and ignored on other platforms.
+    # <div class="wxrb-note">
+    # <b>Note:</b>
+    # <p>this parameter is only supported by WXMSW currently and ignored on other platforms.
+    # </p>
+    # </div>
     # 
     # state can be a bitlist of the following:
     # 
@@ -724,6 +775,7 @@ module Wx
     alias_method :selected_item_count, :get_selected_item_count
     
     # Returns the rectangle representing the size and position, in physical coordinates, of the given subitem, i.e.
+    # 
     # the part of the row item in the column subItem.
     # This method is only meaningful when the {Wx::ListCtrl} is in the report mode. If subItem parameter is equal to the special value {Wx::LIST_GETSUBITEMRECT_WHOLEITEM} the return value is the same as for {Wx::ListCtrl#get_item_rect}.
     # code can be one of {Wx::LIST_RECT_BOUNDS}, {Wx::LIST_RECT_ICON} or {Wx::LIST_RECT_LABEL}.
@@ -746,6 +798,7 @@ module Wx
     alias_method :top_item, :get_top_item
     
     # Returns the rectangle taken by all items in the control.
+    # 
     # In other words, if the controls client size were equal to the size of this rectangle, no scrollbars would be needed and no free space would be left.
     # Note that this function only works in the icon and small icon views, not in list or report views (this is a limitation of the native Win32 control).
     # @return [Wx::Rect]
@@ -753,6 +806,7 @@ module Wx
     alias_method :view_rect, :get_view_rect
     
     # Set the alternative row background colour to a specific colour.
+    # 
     # It is recommended to call {Wx::ListCtrl#enable_alternate_row_colours} instead of using these methods as native implementations of this control might support alternating row colours but not setting the exact colour to be used for them.
     # As {Wx::ListCtrl#enable_alternate_row_colours}, this method can only be used with controls having {Wx::LC_REPORT} and {Wx::LC_VIRTUAL} styles.
     # @param colour [Wx::Colour,String,Symbol]  A valid alternative row background colour to enable alternating rows or invalid colour to disable them and use the same colour for all rows.
@@ -762,12 +816,14 @@ module Wx
     
     # Get the alternative row background colour.
     # 
+    # 
     # @see Wx::ListCtrl#set_alternate_row_colour 
     # @return [Wx::Colour]
     def get_alternate_row_colour; end
     alias_method :alternate_row_colour, :get_alternate_row_colour
     
     # Determines which item (if any) is at the specified point, giving details in flags.
+    # 
     # Returns index of the item or {Wx::NOT_FOUND} if no item is at the specified point.
     # flags will be a combination of the following flags:
     # 
@@ -781,7 +837,7 @@ module Wx
     # - {Wx::LIST_HITTEST_ONITEMSTATEICON}: Over the checkbox of an item.
     # - {Wx::LIST_HITTEST_ONITEM}: Combination of {Wx::LIST_HITTEST_ONITEMICON}, {Wx::LIST_HITTEST_ONITEMLABEL}, {Wx::LIST_HITTEST_ONITEMSTATEICON}.
     # 
-    # If ptrSubItem is not NULL and the {Wx::ListCtrl} is in the report mode the subitem (or column) number will also be provided. This feature is only available in version 2.7.0 or higher and is currently only implemented under wxMSW and requires at least comctl32.dll of version 4.70 on the host system or the value stored in ptrSubItem will be always -1. To compile this feature into wxWidgets library you need to have access to commctrl.h of version 4.70 that is provided by Microsoft.
+    # If ptrSubItem is not NULL and the {Wx::ListCtrl} is in the report mode the subitem (or column) number will also be provided. This feature is only available in version 2.7.0 or higher and is currently only implemented under WXMSW and requires at least comctl32.dll of version 4.70 on the host system or the value stored in ptrSubItem will be always -1. To compile this feature into wxWidgets library you need to have access to commctrl.h of version 4.70 that is provided by Microsoft.
     # @param point [Array(Integer, Integer), Wx::Point] 
     # @return [Array(Integer,Integer)]
     def hit_test(point) end
@@ -792,12 +848,14 @@ module Wx
     
     # @overload insert_column(col, info)
     #   For report view mode (only), inserts a column.
+    #   
     #   For more details, see {Wx::ListCtrl#set_item}. Also see InsertColumn(long, const wxString&, int, int) overload for a usually more convenient alternative to this method and the description of how the item width is interpreted by this method.
     #   @param col [Integer] 
     #   @param info [Wx::ListItem] 
     #   @return [Integer]
     # @overload insert_column(col, heading, format=Wx::ListColumnFormat::LIST_FORMAT_LEFT, width=Wx::LIST_AUTOSIZE)
     #   For report view mode (only), inserts a column.
+    #   
     #   Insert a new column in the list control in report view mode at the given position specifying its most common attributes.
     #   Notice that to set the image for the column you need to use InsertColumn(long, const wxListItem&) overload and specify {Wx::LIST_MASK_IMAGE} in the item mask.
     #   
@@ -832,6 +890,7 @@ module Wx
     def insert_item(*args) end
     
     # Returns true if the control doesn't currently contain any items.
+    # 
     # Note that the control with some columns is still considered to be empty if it has no rows.
     # @return [Boolean]
     def is_empty; end
@@ -843,6 +902,7 @@ module Wx
     alias_method :virtual?, :is_virtual
     
     # Redraws the given item.
+    # 
     # This is only useful for the virtual list controls as without calling this function the displayed value of the item doesn't change even when the underlying data does change.
     # @see Wx::ListCtrl#refresh_items 
     # @param item [Integer] 
@@ -850,6 +910,7 @@ module Wx
     def refresh_item(item) end
     
     # Redraws the items between itemFrom and itemTo.
+    # 
     # The starting item must be less than or equal to the ending one.
     # Just as {Wx::ListCtrl#refresh_item} this is only useful for virtual list controls.
     # @param itemFrom [Integer] 
@@ -858,22 +919,35 @@ module Wx
     def refresh_items(itemFrom, itemTo) end
     
     # Scrolls the list control.
+    # 
     # If in icon, small icon or report view mode, dx specifies the number of pixels to scroll. If in list view mode, dx specifies the number of columns to scroll. dy always specifies the number of pixels to scroll vertically.
-    # This method is currently only implemented in the Windows version.
+    # 
+    # <div class="wxrb-note">
+    # <b>Note:</b>
+    # <p>This method is currently only implemented in the Windows version. 
+    # </p>
+    # </div>
     # @param dx [Integer] 
     # @param dy [Integer] 
     # @return [Boolean]
     def scroll_list(dx, dy) end
     
     # Sets the background colour.
+    # 
     # Note that the {Wx::Window#get_background_colour} function of {Wx::Window} base class can be used to retrieve the current background colour.
-    # If alternate row colouring is enabled, then call {Wx::ListCtrl#enable_alternate_row_colours} again after changing the background colour. This will update the alternate row color to match the new background colour.
+    # 
+    # <div class="wxrb-note">
+    # <b>Note:</b>
+    # <p>If alternate row colouring is enabled, then call {Wx::ListCtrl#enable_alternate_row_colours} again after changing the background colour. This will update the alternate row color to match the new background colour. 
+    # </p>
+    # </div>
     # @param col [Wx::Colour,String,Symbol] 
     # @return [Boolean]
     def set_background_colour(col) end
     alias_method :background_colour=, :set_background_colour
     
     # Sets information about this column.
+    # 
     # See {Wx::ListCtrl#set_item} for more information.
     # @param col [Integer] 
     # @param item [Wx::ListItem] 
@@ -881,6 +955,7 @@ module Wx
     def set_column(col, item) end
     
     # Sets the column width.
+    # 
     # width can be a width in pixels or {Wx::LIST_AUTOSIZE} (-1) or {Wx::LIST_AUTOSIZE_USEHEADER} (-2).
     # {Wx::LIST_AUTOSIZE} will resize the column to the length of its longest item.
     # {Wx::LIST_AUTOSIZE_USEHEADER} will resize the column to the length of the header (Win32) or 80 pixels (other platforms).
@@ -891,8 +966,9 @@ module Wx
     def set_column_width(col, width) end
     
     # Change the font and the colours used for the list control header.
+    # 
     # This method can be used to change the appearance of the header shown by the control in report mode (unless {Wx::LC_NO_HEADER} style is used).
-    # Currently it is implemented only for wxMSW and does nothing in the other ports.
+    # Currently it is implemented only for WXMSW and does nothing in the other ports.
     # 
     # true if the attributes have been updated or false if this is not supported by the current platform.
     # @param attr [Wx::ItemAttr]  The object containing the font and text and background colours to use. It may be default, i.e. not specify any custom font nor colours, to reset any previously set custom attribute.
@@ -901,6 +977,7 @@ module Wx
     alias_method :header_attr=, :set_header_attr
     
     # Sets the image list associated with the control.
+    # 
     # Not that it is recommended to use {Wx::ListCtrl#set_normal_images} or {Wx::ListCtrl#set_small_images} instead of this function in the new code.
     # which must be one of {Wx::IMAGE_LIST_NORMAL}, {Wx::IMAGE_LIST_SMALL}, {Wx::IMAGE_LIST_STATE} (support for the last one is unimplemented).
     # This method does not take ownership of the image list, you have to delete it yourself.
@@ -912,6 +989,7 @@ module Wx
     def set_image_list(imageList, which) end
     
     # Sets the images to use when showing large, normal icons in this control.
+    # 
     # These images are used by the items when the list control is in {Wx::LC_ICON} mode, in all the other modes the images set by {Wx::ListCtrl#set_small_images} are used.
     # This function should be preferred to calling {Wx::ListCtrl#set_image_list} or {Wx::ListCtrl#assign_image_list} with {Wx::IMAGE_LIST_NORMAL} argument in the new code, as using {Wx::BitmapBundle} makes it possible to specify multiple versions of the icons, allowing the control to choose the right one for the current DPI scaling.
     # @param images [Array<Wx::ImageBundle>] 
@@ -920,6 +998,7 @@ module Wx
     alias_method :normal_images=, :set_normal_images
     
     # Sets the images to use when showing small icons in this control.
+    # 
     # These images are used by the items when the list control is in {Wx::LC_SMALL_ICON} or {Wx::LC_REPORT} mode, use {Wx::ListCtrl#set_normal_images} for the icons used in {Wx::LC_ICON} mode.
     # This function should be preferred to calling {Wx::ListCtrl#set_image_list} or {Wx::ListCtrl#assign_image_list} with {Wx::IMAGE_LIST_SMALL} argument in the new code, as using {Wx::BitmapBundle} makes it possible to specify multiple versions of the icons, allowing the control to choose the right one for the current DPI scaling.
     # @param images [Array<Wx::ImageBundle>] 
@@ -928,6 +1007,7 @@ module Wx
     alias_method :small_images=, :set_small_images
     
     # Check if the item is visible.
+    # 
     # An item is considered visible if at least one pixel of it is present on the screen.
     # @param item [Integer] 
     # @return [Boolean]
@@ -936,12 +1016,14 @@ module Wx
     
     # @overload set_item(info)
     #   Sets the data of an item.
+    #   
     #   Using the {Wx::ListItem}'s mask and state mask, you can change only selected attributes of a {Wx::ListCtrl} item.
     #   true if the item was successfully updated or false if the update failed for some reason (e.g. an invalid item index).
     #   @param info [Wx::ListItem] 
     #   @return [Boolean]
     # @overload set_item(index, column, label, imageId=-1)
     #   Sets an item string field at a particular column.
+    #   
     #   true if the item was successfully updated or false if the update failed for some reason (e.g. an invalid item index).
     #   @param index [Integer] 
     #   @param column [Integer] 
@@ -952,6 +1034,7 @@ module Wx
     alias_method :item=, :set_item
     
     # Sets the background colour for this item.
+    # 
     # This function only works in report view mode. The colour can be retrieved using {Wx::ListCtrl#get_item_background_colour}.
     # @param item [Integer] 
     # @param col [Wx::Colour,String,Symbol] 
@@ -959,6 +1042,7 @@ module Wx
     def set_item_background_colour(item, col) end
     
     # Sets the image associated with the item.
+    # 
     # In report view, you can specify the column. The image is an index into the image list associated with the list control.
     # @param item [Integer] 
     # @param column [Integer] 
@@ -967,6 +1051,7 @@ module Wx
     def set_item_column_image(item, column, image) end
     
     # This method can only be used with virtual list controls.
+    # 
     # It is used to indicate to the control the number of items it contains. After calling it, the main program should be ready to handle calls to various item callbacks (such as {Wx::ListCtrl#on_get_item_text}) for all items in the range from 0 to count.
     # Notice that the control is not necessarily redrawn after this call as it may be undesirable if an item which is not visible on the screen anyhow was added to or removed from a control displaying many items, if you do need to refresh the display you can just call {Wx::ListCtrl#refresh} manually.
     # @param count [Integer] 
@@ -981,6 +1066,7 @@ module Wx
     def set_item_font(item, font) end
     
     # Sets the unselected and selected images associated with the item.
+    # 
     # The images are indices into the image list associated with the list control.
     # @param item [Integer] 
     # @param image [Integer] 
@@ -989,6 +1075,7 @@ module Wx
     def set_item_image(item, image, selImage=-1) end
     
     # Sets the position of the item, in icon or small icon view.
+    # 
     # Windows only.
     # @param item [Integer] 
     # @param pos [Array(Integer, Integer), Wx::Point] 
@@ -996,6 +1083,7 @@ module Wx
     def set_item_position(item, pos) end
     
     # Sets the item state.
+    # 
     # The stateMask is a combination of {Wx::LIST_STATE_XXX} constants described in {Wx::ListItem} documentation. For each of the bits specified in stateMask, the corresponding state is set or cleared depending on whether state argument contains the same bit or not.
     # So to select an item you can use 
     # ```ruby
@@ -1021,6 +1109,7 @@ module Wx
     def set_item_text(item, text) end
     
     # Sets the colour for this item.
+    # 
     # This function only works in report view. The colour can be retrieved using {Wx::ListCtrl#get_item_text_colour}.
     # @param item [Integer] 
     # @param col [Wx::Colour,String,Symbol] 
@@ -1048,12 +1137,14 @@ module Wx
     
     # Returns true if checkboxes are enabled for list items.
     # 
+    # 
     # @see Wx::ListCtrl#enable_check_boxes
     # @return [Boolean]
     def has_check_boxes; end
     alias_method :has_check_boxes?, :has_check_boxes
     
     # Enable or disable checkboxes for list items.
+    # 
     # true if checkboxes are supported, false otherwise.
     # 
     # In a list control with {Wx::LC_VIRTUAL} style you have to keep track of the checkbox state. When a checkbox is clicked (EVT_LIST_ITEM_CHECKED or EVT_LIST_ITEM_UNCHECKED) you have to update the state and refresh the item yourself.
@@ -1063,6 +1154,7 @@ module Wx
     def enable_check_boxes(enable=true) end
     
     # Return true if the checkbox for the given {Wx::ListItem} is checked.
+    # 
     # Always returns false if checkboxes support hadn't been enabled.
     # For a control with {Wx::LC_VIRTUAL} style, this uses {Wx::ListCtrl#on_get_item_is_checked}.
     # @param item [Integer]  Item (zero-based) index.
@@ -1071,6 +1163,7 @@ module Wx
     alias_method :item_checked?, :is_item_checked
     
     # Check or uncheck a {Wx::ListItem} in a control using checkboxes.
+    # 
     # This method only works if checkboxes support had been successfully enabled using {Wx::ListCtrl#enable_check_boxes}.
     # For a control with {Wx::LC_VIRTUAL} style, this will only generate the EVT_LIST_ITEM_CHECKED and EVT_LIST_ITEM_UNCHECKED events. See {Wx::ListCtrl#on_get_item_is_checked} for information on how to update the checkbox state.
     # @param item [Integer]  Item (zero-based) index.
@@ -1079,6 +1172,7 @@ module Wx
     def check_item(item, check) end
     
     # Extend rules and alternate rows background to the entire client area.
+    # 
     # By default, the rules (when enabled with {Wx::LC_HRULES} and {Wx::LC_VRULES}) and alternate row background (when {Wx::ListCtrl#enable_alternate_row_colours} was called) are only shown in the part of the control occupied by the items, which can be smaller than the entire window if there are few items in the control.
     # Calling this function extends the display of the rules and alternate background rows to the entire client area.
     # Similarly to {Wx::ListCtrl#enable_alternate_row_colours}, this method can only be used with controls having {Wx::LC_REPORT} and {Wx::LC_VIRTUAL} styles.
@@ -1088,9 +1182,15 @@ module Wx
     def extend_rules_and_alternate_colour(extend=true) end
     
     # Show the sort indicator of a specific column in a specific direction.
-    # Sort indicators are only shown in report view and in the native wxMSW version override any column icon, i.e. if the sort indicator is shown for a column, no (other) icon is shown.
+    # 
+    # Sort indicators are only shown in report view and in the native WXMSW version override any column icon, i.e. if the sort indicator is shown for a column, no (other) icon is shown.
     # This function should typically be called from EVT_LIST_COL_CLICK handler.
-    # This does not actually sort the list, use {Wx::ListCtrl#sort_items} for this.
+    # 
+    # <div class="wxrb-note">
+    # <b>Note:</b>
+    # <p>This does not actually sort the list, use {Wx::ListCtrl#sort_items} for this.
+    # </p>
+    # </div>
     # @param col [Integer]  The column to set the sort indicator for. If <code>-1</code> is given, then the currently shown sort indicator will be removed.
     # @param ascending [Boolean]  If true or false show the sort indicator corresponding to ascending or descending sort order respectively.
     # @return [void]
@@ -1101,12 +1201,14 @@ module Wx
     def remove_sort_indicator; end
     
     # Returns the column that shows the sort indicator.
+    # 
     # Can return <code>-1</code> if there is no sort indicator currently shown.
     # @return [Integer]
     def get_sort_indicator; end
     alias_method :sort_indicator, :get_sort_indicator
     
     # Returns the new value to use for sort indicator after clicking a column.
+    # 
     # This helper function can be useful in the EVT_LIST_COL_CLICK handler when it updates the sort indicator after the user clicked on a column.
     # For example: 
     # ```ruby
@@ -1138,6 +1240,7 @@ module Wx
     protected
     
     # This function may be overridden in the derived class for a control with {Wx::LC_VIRTUAL} style.
+    # 
     # It should return the attribute for the specified item or NULL to use the default appearance parameters.
     # {Wx::ListCtrl} will not delete the pointer or keep a reference of it. You can return the same {Wx::ItemAttr} pointer for every {Wx::ListCtrl#on_get_item_attr} call.
     # The base class version always returns NULL.
@@ -1151,9 +1254,15 @@ module Wx
     def on_get_item_attr(item) end
     
     # This function may be overridden in the derived class for a control with {Wx::LC_VIRTUAL} style.
+    # 
     # It should return the attribute for the for the specified item and column or NULL to use the default appearance parameters.
     # The base class version returns <code>OnGetItemAttr(item)</code>.
-    # Currently this function is only called under wxMSW, the other ports only support {Wx::ListCtrl#on_get_item_attr}
+    # 
+    # <div class="wxrb-note">
+    # <b>Note:</b>
+    # <p>Currently this function is only called under WXMSW, the other ports only support {Wx::ListCtrl#on_get_item_attr}
+    # </p>
+    # </div>
     # @see Wx::ListCtrl#on_get_item_attr
     # @see  Wx::ListCtrl#on_get_item_text
     # @see  Wx::ListCtrl#on_get_item_image
@@ -1165,6 +1274,7 @@ module Wx
     def on_get_item_column_attr(item, column) end
     
     # Override this function in the derived class for a control with {Wx::LC_VIRTUAL} and {Wx::LC_REPORT} styles in order to specify the image index for the given line and column.
+    # 
     # The base class version always calls {Wx::ListCtrl#on_get_item_image} for the first column, else it returns -1.
     # @see Wx::ListCtrl#on_get_item_text
     # @see  Wx::ListCtrl#on_get_item_image
@@ -1176,6 +1286,7 @@ module Wx
     def on_get_item_column_image(item, column) end
     
     # This function must be overridden in the derived class for a control with {Wx::LC_VIRTUAL} style using images.
+    # 
     # If the control doesn't use images, i.e. {Wx::ListCtrl#set_normal_images} or {Wx::ListCtrl#set_small_images} hadn't been called, it is not necessary to override it.
     # It should return the index of the items image in the controls image list or -1 for no image.
     # In a control with {Wx::LC_REPORT} style, {Wx::ListCtrl#on_get_item_image} only gets called for the first column of each line.
@@ -1188,6 +1299,7 @@ module Wx
     def on_get_item_image(item) end
     
     # This function <b>must</b> be overridden in the derived class for a control with {Wx::LC_VIRTUAL} style.
+    # 
     # It should return the string containing the text of the given column for the specified item.
     # @see Wx::ListCtrl#set_item_count
     # @see  Wx::ListCtrl#on_get_item_image
@@ -1199,6 +1311,7 @@ module Wx
     def on_get_item_text(item, column) end
     
     # This function <b>must</b> be overridden in the derived class for a control with {Wx::LC_VIRTUAL} style that uses checkboxes.
+    # 
     # It should return whether the checkbox of the specified item is checked.
     # @see Wx::ListCtrl#enable_check_boxes
     # @see  Wx::ListCtrl#on_get_item_text
@@ -1209,6 +1322,7 @@ module Wx
   end # ListCtrl
   
   # This class stores information about a {Wx::ListCtrl} item or column.
+  # 
   # {Wx::ListItem} is a class which contains information about:
   # 
   # - Zero based item position; see {Wx::ListItem#set_id} and {Wx::ListItem#get_id}.
@@ -1236,15 +1350,16 @@ module Wx
   # - {Wx::LIST_MASK_FORMAT}: The column format field is valid.
   # 
   # The {Wx::ListItem} object can also contain item-specific colour and font information: for this you need to call one of {Wx::ListItem#set_text_colour}, {Wx::ListItem#set_background_colour} or {Wx::ListItem#set_font} functions on it passing it the colour/font to use. If the colour/font is not specified, the default list control colour/font is used.
-  # === 
   # 
   # Category:  Data Structures
   # @see Wx::ListCtrl 
   # 
   # 
+  # @wxrb_require USE_LISTCTRL
   class ListItem < Object
   
     # Sets client data for the item.
+    # 
     # Please note that client data is associated with the item and not with subitems.
     # @param data [Object] 
     # @return [void]
@@ -1260,6 +1375,7 @@ module Wx
     def clear; end
     
     # Returns the alignment for this item.
+    # 
     # Can be one of {Wx::ListColumnFormat::LIST_FORMAT_LEFT}, {Wx::ListColumnFormat::LIST_FORMAT_RIGHT} or {Wx::ListColumnFormat::LIST_FORMAT_CENTRE}.
     # @return [Wx::ListColumnFormat]
     def get_align; end
@@ -1291,6 +1407,7 @@ module Wx
     alias_method :image, :get_image
     
     # Returns a bit mask indicating which fields of the structure are valid.
+    # 
     # Can be any combination of the following values:
     # 
     # - {Wx::LIST_MASK_STATE}: <b>GetState</b> is valid.
@@ -1304,6 +1421,7 @@ module Wx
     alias_method :mask, :get_mask
     
     # Returns a bit field representing the state of the item.
+    # 
     # Can be any combination of:
     # 
     # - {Wx::LIST_STATE_DONTCARE}: No special flags (the values of this constant is 0).
@@ -1326,12 +1444,14 @@ module Wx
     alias_method :text_colour, :get_text_colour
     
     # Meaningful only for column headers in report mode.
+    # 
     # Returns the column width.
     # @return [Integer]
     def get_width; end
     alias_method :width, :get_width
     
     # Sets the alignment for the item.
+    # 
     # See also {Wx::ListItem#get_align}
     # @param align [Wx::ListColumnFormat] 
     # @return [void]
@@ -1345,6 +1465,7 @@ module Wx
     alias_method :background_colour=, :set_background_colour
     
     # Sets the zero-based column.
+    # 
     # Meaningful only in report mode.
     # @param col [Integer] 
     # @return [void]
@@ -1370,6 +1491,7 @@ module Wx
     alias_method :image=, :set_image
     
     # Sets the mask of valid fields.
+    # 
     # See {Wx::ListItem#get_mask}.
     # @param mask [Integer] 
     # @return [void]
@@ -1377,6 +1499,7 @@ module Wx
     alias_method :mask=, :set_mask
     
     # Sets the item state flags (note that the valid state flags are influenced by the value of the state mask, see {Wx::ListItem#set_state_mask}).
+    # 
     # See {Wx::ListItem#get_state} for valid flag values.
     # @param state [Integer] 
     # @return [void]
@@ -1384,6 +1507,7 @@ module Wx
     alias_method :state=, :set_state
     
     # Sets the bitmask that is used to determine which of the state flags are to be set.
+    # 
     # See also {Wx::ListItem#set_state}.
     # @param stateMask [Integer] 
     # @return [void]
@@ -1403,6 +1527,7 @@ module Wx
     alias_method :text_colour=, :set_text_colour
     
     # Meaningful only for column headers in report mode.
+    # 
     # Sets the column width.
     # @param width [Integer] 
     # @return [void]
@@ -1412,13 +1537,14 @@ module Wx
   end # ListItem
   
   # Represents the attributes (colour, font, ...) of an item of a control with multiple items such as e.g.
+  # 
   # {Wx::ListCtrl}.
-  # === 
   # 
   # Category:  Data Structures
   # @see wxListCtrl Overview
   # 
   # 
+  # @wxrb_require USE_LISTCTRL
   class ItemAttr < ::Object
   
     # @overload initialize()
@@ -1459,6 +1585,7 @@ module Wx
     
     # Returns true if either text or background colour is set.
     # 
+    # 
     # @see Wx::ItemAttr#has_background_colour
     # @see  Wx::ItemAttr#has_text_colour 
     # @return [Boolean]
@@ -1501,17 +1628,18 @@ module Wx
   end # ItemAttr
   
   # This class currently simply presents a simpler to use interface for the {Wx::ListCtrl}  it can be thought of as a façade for that complicated class.
+  # 
   # Using it is preferable to using {Wx::ListCtrl} directly whenever possible because in the future some ports might implement {Wx::ListView} but not the full set of {Wx::ListCtrl} features.
   # Other than different interface, this class is identical to {Wx::ListCtrl}. In particular, it uses the same events, same window styles and so on.
-  # === 
   # 
-  # Category:  {Wx::Controls}  <div class='appearance'><span class='appearance'>Appearance:</span><table><tr><td> wxMSW Appearance
-  #   </td><td> wxGTK Appearance
-  #   </td><td> wxOSX 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::ListView#set_column_image 
   # 
   # 
+  # @wxrb_require USE_LISTCTRL
   class ListView < ListCtrl
   
     # @overload initialize()
@@ -1520,6 +1648,7 @@ module Wx
     # @overload initialize(parent, winid=Wx::StandardID::ID_ANY, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::LC_REPORT, validator=Wx::DEFAULT_VALIDATOR, name=Wx::LIST_CTRL_NAME_STR)
     #   Constructor, creating and showing a listview control.
     #   
+    #   
     #   @see Wx::ListView#create
     #   @see  Wx::Validator 
     #   @param parent [Wx::Window]  Parent window. Must not be NULL.
@@ -1534,6 +1663,7 @@ module Wx
     
     # Resets the column image  after calling this function, no image will be shown.
     # 
+    # 
     # @see Wx::ListView#set_column_image 
     # @param col [Integer]  the column to clear image for
     # @return [void]
@@ -1545,6 +1675,7 @@ module Wx
     def focus(index) end
     
     # Returns the first selected item in a (presumably) multiple selection control.
+    # 
     # Together with {Wx::ListView#get_next_selected} it can be used to iterate over all selected items in the control.
     # The first selected item, if any, -1 otherwise.
     # @return [Integer]
@@ -1553,6 +1684,7 @@ module Wx
     
     # Returns the currently focused item or -1 if none.
     # 
+    # 
     # @see Wx::ListView#is_selected
     # @see  Wx::ListView#focus 
     # @return [Integer]
@@ -1560,6 +1692,7 @@ module Wx
     alias_method :focused_item, :get_focused_item
     
     # Used together with {Wx::ListView#get_first_selected} to iterate over all selected items in the control.
+    # 
     # Returns the next selected item or -1 if there are no more of them.
     # @param item [Integer] 
     # @return [Integer]
@@ -1568,6 +1701,7 @@ module Wx
     
     # Returns true if the item with the given index is selected, false otherwise.
     # 
+    # 
     # @see Wx::ListView#get_first_selected
     # @see  Wx::ListView#get_next_selected 
     # @param index [Integer] 
@@ -1576,6 +1710,7 @@ module Wx
     alias_method :selected?, :is_selected
     
     # Selects or unselects the given item.
+    # 
     # Notice that this method inherits the unusual behaviour of {Wx::ListCtrl#set_item_state} which sends a {Wx::EVT_LIST_ITEM_SELECTED} event when it is used to select an item, contrary to the usual rule that only the user actions result in selection.
     # @param n [Integer]  the item to select or unselect
     # @param on [Boolean]  if true (default), selects the item, otherwise unselects it
@@ -1583,6 +1718,7 @@ module Wx
     def select(n, on=true) end
     
     # Sets the column image for the specified column.
+    # 
     # To use the column images, the control must have a valid image list with at least one image.
     # @param col [Integer]  the column to set image for
     # @param image [Integer]  the index of the column image in the controls image list