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

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

@@ -319,7 +319,7 @@ module Wx
   # 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 {Wx::OSX} implementation for report mode that was added in wxWidgets 2.8 was removed in wxWidgets 3.1, meaning for wxWidgets 3.1+ {Wx::OSX} uses the generic implementation for all modes.
+  # 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
   # 
@@ -328,77 +328,109 @@ module Wx
   # 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.
   # 
   # Example of reordering columns: 
-  # ```
-  #   wxListCtrl *list = new wxListCtrl(...);
-  #   for ( int i = 0; i < 3; i++ )
-  #       list->InsertColumn(i, wxString::Format("Column %d", i));
+  # ```ruby
+  #   list = Wx::ListCtrl.new(...)
+  #   3.times { |i| list.insert_column(i, "Column #{i}") }
   #   
-  #   wxArrayInt order(3);
-  #   order[0] = 2;
-  #   order[1] = 0;
-  #   order[2] = 1;
-  #   list->SetColumnsOrder(order);
+  #   order = [2, 0, 1]
+  #   list.set_columns_order(order)
   #   
-  #   // now list->GetColumnsOrder() will return order and
-  #   // list->GetColumnIndexFromOrder(n) will return order[n] and
-  #   // list->GetColumnOrder() will return 1, 2 and 0 for the column 0,
-  #   // 1 and 2 respectively
+  #   # now list.get_columns_order() will return order and
+  #   # list.get_column_index_from_order(n) will return order[n] and
+  #   # list.get_column_order() will return 1, 2 and 0 for the column 0,
+  #   # 1 and 2 respectively
   # ```
   # 
   # === Styles
   # 
   # This class supports the following styles:
-  #  
+  # 
   # - {Wx::LC_LIST}: Multicolumn list view, with optional small icons. Columns are computed automatically, i.e. you don't set columns as in {Wx::LC_REPORT}. In other words, the list wraps, unlike a {Wx::ListBox}. 
+  # 
   # - {Wx::LC_REPORT}: Single or multicolumn report view, with optional header. 
+  # 
   # - {Wx::LC_VIRTUAL}: The application provides items text on demand. May only be used with {Wx::LC_REPORT}. 
+  # 
   # - {Wx::LC_ICON}: Large icon view, with optional labels. 
+  # 
   # - {Wx::LC_SMALL_ICON}: Small icon view, with optional labels. 
+  # 
   # - {Wx::LC_ALIGN_TOP}: Icons align to the top. Win32 default, Win32 only. 
+  # 
   # - {Wx::LC_ALIGN_LEFT}: Icons align to the left. 
+  # 
   # - {Wx::LC_AUTOARRANGE}: Icons arrange themselves. Win32 only. 
+  # 
   # - {Wx::LC_EDIT_LABELS}: Labels are editable: the application will be notified when editing starts. 
+  # 
   # - {Wx::LC_NO_HEADER}: No header in report mode. 
+  # 
   # - {Wx::LC_SINGLE_SEL}: Single selection (default is multiple). 
+  # 
   # - {Wx::LC_SORT_ASCENDING}: Sort in ascending order. (You must still supply a comparison callback in {Wx::ListCtrl#sort_items}.) 
+  # 
   # - {Wx::LC_SORT_DESCENDING}: Sort in descending order. (You must still supply a comparison callback in {Wx::ListCtrl#sort_items}.) 
+  # 
   # - {Wx::LC_HRULES}: Draws light horizontal rules between rows in report mode. 
+  # 
   # - {Wx::LC_VRULES}: Draws light vertical rules between columns in report mode. 
   # 
   # === 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:
+  # 
   # - {Wx::EvtHandler#evt_list_begin_drag}(id, meth = nil, &block): Begin dragging with the left mouse button. Processes a {Wx::EVT_LIST_BEGIN_DRAG} event type. 
+  # 
   # - {Wx::EvtHandler#evt_list_begin_rdrag}(id, meth = nil, &block): Begin dragging with the right mouse button. Processes a {Wx::EVT_LIST_BEGIN_RDRAG} event type. 
+  # 
   # - {Wx::EvtHandler#evt_list_begin_label_edit}(id, meth = nil, &block): Begin editing a label. This can be prevented by calling Veto(). Processes a {Wx::EVT_LIST_BEGIN_LABEL_EDIT} event type. 
+  # 
   # - {Wx::EvtHandler#evt_list_end_label_edit}(id, meth = nil, &block): Finish editing a label. This can be prevented by calling Veto(). Processes a {Wx::EVT_LIST_END_LABEL_EDIT} event type. 
+  # 
   # - {Wx::EvtHandler#evt_list_delete_item}(id, meth = nil, &block): An item was deleted. Processes a {Wx::EVT_LIST_DELETE_ITEM} event type. 
+  # 
   # - {Wx::EvtHandler#evt_list_delete_all_items}(id, meth = nil, &block): All items were deleted. Processes a {Wx::EVT_LIST_DELETE_ALL_ITEMS} event type. 
+  # 
   # - {Wx::EvtHandler#evt_list_item_selected}(id, meth = nil, &block): The item has been selected. Notice that the mouse is captured by the control itself when this event is generated, see event handling overview. Processes a {Wx::EVT_LIST_ITEM_SELECTED} event type. 
+  # 
   # - {Wx::EvtHandler#evt_list_item_deselected}(id, meth = nil, &block): The item has been deselected. Processes a {Wx::EVT_LIST_ITEM_DESELECTED} event type. 
+  # 
   # - {Wx::EvtHandler#evt_list_item_activated}(id, meth = nil, &block): The item has been activated (ENTER or double click). Processes a {Wx::EVT_LIST_ITEM_ACTIVATED} event type. 
+  # 
   # - {Wx::EvtHandler#evt_list_item_focused}(id, meth = nil, &block): The currently focused item has changed. Processes a {Wx::EVT_LIST_ITEM_FOCUSED} event type. 
+  # 
   # - {Wx::EvtHandler#evt_list_item_middle_click}(id, meth = nil, &block): The middle mouse button has been clicked on an item. This is only supported by the generic control. Processes a {Wx::EVT_LIST_ITEM_MIDDLE_CLICK} event type. 
+  # 
   # - {Wx::EvtHandler#evt_list_item_right_click}(id, meth = nil, &block): The right mouse button has been clicked on an item. Processes a {Wx::EVT_LIST_ITEM_RIGHT_CLICK} event type. 
+  # 
   # - {Wx::EvtHandler#evt_list_key_down}(id, meth = nil, &block): A key has been pressed. Processes a {Wx::EVT_LIST_KEY_DOWN} event type. 
+  # 
   # - {Wx::EvtHandler#evt_list_insert_item}(id, meth = nil, &block): An item has been inserted. Processes a {Wx::EVT_LIST_INSERT_ITEM} event type. 
+  # 
   # - {Wx::EvtHandler#evt_list_col_click}(id, meth = nil, &block): A column (m_col) has been left-clicked. Processes a {Wx::EVT_LIST_COL_CLICK} event type. 
+  # 
   # - {Wx::EvtHandler#evt_list_col_right_click}(id, meth = nil, &block): A column (m_col) has been right-clicked. Processes a {Wx::EVT_LIST_COL_RIGHT_CLICK} event type. 
+  # 
   # - {Wx::EvtHandler#evt_list_col_begin_drag}(id, meth = nil, &block): The user started resizing a column - can be vetoed. Processes a {Wx::EVT_LIST_COL_BEGIN_DRAG} event type. 
+  # 
   # - {Wx::EvtHandler#evt_list_col_dragging}(id, meth = nil, &block): The divider between columns is being dragged. Processes a {Wx::EVT_LIST_COL_DRAGGING} event type. 
+  # 
   # - {Wx::EvtHandler#evt_list_col_end_drag}(id, meth = nil, &block): A column has been resized by the user. Processes a {Wx::EVT_LIST_COL_END_DRAG} event type. 
+  # 
   # - {Wx::EvtHandler#evt_list_cache_hint}(id, meth = nil, &block): Prepare cache for a virtual list control. Processes a {Wx::EVT_LIST_CACHE_HINT} event type. 
+  # 
   # - {Wx::EvtHandler#evt_list_item_checked}(id, meth = nil, &block): The item has been checked. Processes a {Wx::EVT_LIST_ITEM_CHECKED} event type (new since wxWidgets 3.1.0). 
+  # 
   # - {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 {Wx::MSW} 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.
+  # 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.
   # 
   # === 
   # 
-  # 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 wxListCtrl Overview
   # @see  Wx::ListView
@@ -414,7 +446,7 @@ module Wx
   
     # @overload initialize()
     #   Default constructor.
-    #   @return [ListCtrl]
+    #   @return [Wx::ListCtrl]
     # @overload initialize(parent, id, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::LC_ICON, validator=Wx::DEFAULT_VALIDATOR, name=Wx::ListCtrlNameStr)
     #   Constructor, creating and showing a list control.
     #   
@@ -427,7 +459,7 @@ module Wx
     #   @param style [Integer]  Window style. See {Wx::ListCtrl}.
     #   @param validator [Wx::Validator]  Window validator.
     #   @param name [String]  Window name.
-    #   @return [ListCtrl]
+    #   @return [Wx::ListCtrl]
     def initialize(*args) end
     
     # Adds a new column to the list control in report view mode.
@@ -440,7 +472,11 @@ module Wx
     
     # 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.- {Wx::LIST_ALIGN_LEFT}: Align to the left side of the control.- {Wx::LIST_ALIGN_TOP}: Align to the top side of the control.- {Wx::LIST_ALIGN_SNAP_TO_GRID}: Snap to grid.
+    # 
+    # - {Wx::LIST_ALIGN_DEFAULT}: Default alignment.
+    # - {Wx::LIST_ALIGN_LEFT}: Align to the left side of the control.
+    # - {Wx::LIST_ALIGN_TOP}: Align to the top side of the control.
+    # - {Wx::LIST_ALIGN_SNAP_TO_GRID}: Snap to grid.
     # @param flag [Integer] 
     # @return [true,false]
     def arrange(flag=Wx::LIST_ALIGN_DEFAULT) end
@@ -494,7 +530,7 @@ 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 {Wx::MSW} 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 [true,false] 
     # @return [void]
     def enable_bell_on_no_match(on=true) end
@@ -502,7 +538,7 @@ module Wx
     # 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 {Wx::MSW}.
+    # Currently only implemented in wxMSW.
     # 
     # true if item editing was finished or false if no item as being edited.
     # @param cancel [true,false]  If true, discard the changes made by user, as if Escape key was pressed. Otherwise, accept the changes as if Return was pressed.
@@ -554,7 +590,7 @@ module Wx
     
     # Gets the column index from its position in visual order.
     # After calling {Wx::ListCtrl#set_columns_order}, the index returned by this function corresponds to the value of the element number pos in the array returned by {Wx::ListCtrl#get_columns_order}.
-    # This function makes sense for report view only and currently is only implemented in the {Wx::MSW} port. Use {Wx::HAS_LISTCTRL_COLUMN_ORDER} to guard uses of this function so that they will start working under the other platforms when support for the column reordering is added there.
+    # This function makes sense for report view only and currently is only implemented in the wxMSW port. Use {Wx::HAS_LISTCTRL_COLUMN_ORDER} to guard uses of this function so that they will start working under the other platforms when support for the column reordering is added there.
     # @see Wx::ListCtrl#get_column_order 
     # @param pos [Integer] 
     # @return [Integer]
@@ -563,7 +599,7 @@ module Wx
     
     # Gets the column visual order position.
     # This function returns the index of the column which appears at the given visual position, e.g. calling it with col equal to 0 returns the index of the first shown column.
-    # This function makes sense for report view only and currently is only implemented in the {Wx::MSW} port. Use {Wx::HAS_LISTCTRL_COLUMN_ORDER} to guard uses of this function so that they will start working under the other platforms when support for the column reordering is added there.
+    # This function makes sense for report view only and currently is only implemented in the wxMSW port. Use {Wx::HAS_LISTCTRL_COLUMN_ORDER} to guard uses of this function so that they will start working under the other platforms when support for the column reordering is added there.
     # @see Wx::ListCtrl#get_columns_order
     # @see  Wx::ListCtrl#get_column_index_from_order 
     # @param col [Integer] 
@@ -579,7 +615,7 @@ module Wx
     
     # Returns the array containing the orders of all columns.
     # On error, an empty array is returned.
-    # This function makes sense for report view only and currently is only implemented in the {Wx::MSW} port. Use {Wx::HAS_LISTCTRL_COLUMN_ORDER} to guard uses of this function so that they will start working under the other platforms when support for the column reordering is added there.
+    # This function makes sense for report view only and currently is only implemented in the wxMSW port. Use {Wx::HAS_LISTCTRL_COLUMN_ORDER} to guard uses of this function so that they will start working under the other platforms when support for the column reordering is added there.
     # @see Wx::ListCtrl#get_column_order
     # @see  Wx::ListCtrl#get_column_index_from_order 
     # @return [Array<Integer>]
@@ -593,14 +629,17 @@ module Wx
     
     # 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 {Wx::MSW} and the generic version, not for the native macOS version.
+    # It is currently only implemented for wxMSW and the generic version, not for the native macOS version.
     # @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.- {Wx::IMAGE_LIST_SMALL}: The small icon image list.- {Wx::IMAGE_LIST_STATE}: The user-defined state image list (unimplemented).
+    # 
+    # - {Wx::IMAGE_LIST_NORMAL}: The normal (large icon) image list.
+    # - {Wx::IMAGE_LIST_SMALL}: The small icon image list.
+    # - {Wx::IMAGE_LIST_STATE}: The user-defined state image list (unimplemented).
     # @param which [Integer] 
     # @return [Wx::ImageList]
     def get_image_list(which) end
@@ -670,28 +709,36 @@ module Wx
     # 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:
     # 
-    # ```
-    #   long item = -1;
-    #   for ( ;; )
-    #   {
-    #       item = listctrl->GetNextItem(item,
-    #                                   wxLIST_NEXT_ALL,
-    #                                   wxLIST_STATE_SELECTED);
-    #       if ( item == -1 )
-    #           break;
-    #   
-    #       // this item is selected - do whatever is needed with it
-    #       wxLogMessage("Item %ld is selected.", item);
-    #   }
+    # ```ruby
+    #   item = -1
+    #   while (item = list_ctrl.get_next_item(item, Wx::LIST_NEXT_ALL, Wx::LIST_STATE_SELECTED)) != -1
+    #     # item is selected - do whatever is needed with it
+    #     Wx.log_message("Item #{item} is selected.")
+    #   end
+    # 
+    #   # alternatively in wxRuby you could do
+    #   list_ctrl.each_selected do |item|
+    #     Wx.log_message("Item #{item} is selected.")
+    #   end
     # ```
     # 
     # geometry can be one of:
-    # - {Wx::LIST_NEXT_ABOVE}: Searches for an item above the specified item.- {Wx::LIST_NEXT_ALL}: Searches for subsequent item by index.- {Wx::LIST_NEXT_BELOW}: Searches for an item below the specified item.- {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 {Wx::MSW} currently and ignored on other platforms.
+    # - {Wx::LIST_NEXT_ABOVE}: Searches for an item above the specified item.
+    # - {Wx::LIST_NEXT_ALL}: Searches for subsequent item by index.
+    # - {Wx::LIST_NEXT_BELOW}: Searches for an item below the specified item.
+    # - {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.
     # 
     # state can be a bitlist of the following:
-    # - {Wx::LIST_STATE_DONTCARE}: Don't care what the state is.- {Wx::LIST_STATE_DROPHILITED}: The item indicates it is a drop target.- {Wx::LIST_STATE_FOCUSED}: The item has the focus.- {Wx::LIST_STATE_SELECTED}: The item is selected.- {Wx::LIST_STATE_CUT}: The item is selected as part of a cut and paste operation.
+    # 
+    # - {Wx::LIST_STATE_DONTCARE}: Don't care what the state is.
+    # - {Wx::LIST_STATE_DROPHILITED}: The item indicates it is a drop target.
+    # - {Wx::LIST_STATE_FOCUSED}: The item has the focus.
+    # - {Wx::LIST_STATE_SELECTED}: The item is selected.
+    # - {Wx::LIST_STATE_CUT}: The item is selected as part of a cut and paste operation.
     # @param item [Integer] 
     # @param geometry [Integer] 
     # @param state [Integer] 
@@ -751,9 +798,18 @@ module Wx
     # 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:
-    # - {Wx::LIST_HITTEST_ABOVE}: Above the control's client area.- {Wx::LIST_HITTEST_BELOW}: Below the control's client area.- {Wx::LIST_HITTEST_TOLEFT}: To the left of the control's client area.- {Wx::LIST_HITTEST_TORIGHT}: To the right of the control's client area.- {Wx::LIST_HITTEST_NOWHERE}: Inside the control's client area but not over an item.- {Wx::LIST_HITTEST_ONITEMICON}: Over an item's icon.- {Wx::LIST_HITTEST_ONITEMLABEL}: Over an item's text.- {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 {Wx::MSW} 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.
+    # - {Wx::LIST_HITTEST_ABOVE}: Above the control's client area.
+    # - {Wx::LIST_HITTEST_BELOW}: Below the control's client area.
+    # - {Wx::LIST_HITTEST_TOLEFT}: To the left of the control's client area.
+    # - {Wx::LIST_HITTEST_TORIGHT}: To the right of the control's client area.
+    # - {Wx::LIST_HITTEST_NOWHERE}: Inside the control's client area but not over an item.
+    # - {Wx::LIST_HITTEST_ONITEMICON}: Over an item's icon.
+    # - {Wx::LIST_HITTEST_ONITEMLABEL}: Over an item's text.
+    # - {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.
     # @param point [Array(Integer, Integer), Wx::Point] 
     # @return [Array(Integer,Integer)]
     def hit_test(point) end
@@ -864,7 +920,7 @@ module Wx
     
     # Changes the order in which the columns are shown.
     # The orders array must have the same number elements as the number of columns and contain each position exactly once. Its n-th element contains the index of the column to be shown in n-th position, so for a control with three columns passing an array with elements 2, 0 and 1 results in the third column being displayed first, the first one next and the second one last.
-    # This function makes sense for report view only and currently is only implemented in the {Wx::MSW} port. Use {Wx::HAS_LISTCTRL_COLUMN_ORDER} to guard uses of this function so that they will start working under the other platforms when support for the column reordering is added there.
+    # This function makes sense for report view only and currently is only implemented in the wxMSW port. Use {Wx::HAS_LISTCTRL_COLUMN_ORDER} to guard uses of this function so that they will start working under the other platforms when support for the column reordering is added there.
     # @see Wx::ListCtrl#get_columns_order 
     # @param orders [Array<Integer>] 
     # @return [true,false]
@@ -873,7 +929,7 @@ module Wx
     
     # 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 {Wx::MSW} 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.
@@ -979,12 +1035,12 @@ module Wx
     # 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 
-    # ```
-    #   list->SetItemState(item, wxLIST_STATE_SELECTED, wxLIST_STATE_SELECTED);
+    # ```ruby
+    #   list.set_item_state(item, Wx::LIST_STATE_SELECTED, Wx::LIST_STATE_SELECTED)
     # ```
     #  while to deselect it you should use 
-    # ```
-    #   list->SetItemState(item, 0, wxLIST_STATE_SELECTED);
+    # ```ruby
+    #   list.set_item_state(item, 0, Wx::LIST_STATE_SELECTED)
     # ```
     # 
     # Consider using {Wx::ListView} if possible to avoid dealing with this error-prone and confusing method.
@@ -1067,7 +1123,7 @@ 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 {Wx::MSW} 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.
     # @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.
@@ -1088,17 +1144,20 @@ module Wx
     # 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: 
-    # ```
-    #   void MyListCtrl::OnColClick(wxListEvent& event)
-    #   {
-    #       int col = event.GetColumn();
-    #       if ( col == -1 )
-    #           return; // clicked outside any column.
+    # ```ruby
+    #   class MyListCtrl
+    # 
+    #     def on_col_click(event)
+    #       col = event.column
+    #       if col == -1
+    #          return # clicked outside any column.
     #   
-    #       const bool ascending = GetUpdatedAscendingSortIndicator(col);
-    #       SortItems(MyCompareFunction, ascending);
-    #       ShowSortIndicator(col, ascending);
-    #   }
+    #       ascending = get_updated_ascending_sort_indicator(col)
+    #       sort_items(ascending) { |itm1_data, itm2_data, data| ... }
+    #       show_sort_indicator(col, ascending)
+    #     end
+    # 
+    #   end
     # ```
     # @param col [Integer] 
     # @return [true,false]
@@ -1129,7 +1188,7 @@ module Wx
     # 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 {Wx::MSW}, the other ports only support {Wx::ListCtrl#on_get_item_attr}
+    # Currently this function is only called under wxMSW, the other ports only support {Wx::ListCtrl#on_get_item_attr}
     # @see Wx::ListCtrl#on_get_item_attr
     # @see  Wx::ListCtrl#on_get_item_text
     # @see  Wx::ListCtrl#on_get_item_image
@@ -1186,9 +1245,30 @@ module Wx
   
   # 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}.- Zero based column index; see {Wx::ListItem#set_column} and {Wx::ListItem#get_column}.- The label (or header for columns); see {Wx::ListItem#set_text} and {Wx::ListItem#get_text}.- The zero based index into an image list; see {Wx::ListItem#get_image} and {Wx::ListItem#set_image}.- Application defined data; see {Wx::ListItem#set_data} and {Wx::ListItem#get_data}.- For columns only: the width of the column; see {Wx::ListItem#set_width} and {Wx::ListItem#get_width}.- For columns only: the format of the column; one of {Wx::ListColumnFormat::LIST_FORMAT_LEFT}, {Wx::ListColumnFormat::LIST_FORMAT_RIGHT}, {Wx::ListColumnFormat::LIST_FORMAT_CENTRE}. See {Wx::ListItem#set_align} and {Wx::ListItem#get_align}.- The state of the item; see {Wx::ListItem#set_state} and {Wx::ListItem#get_state}. This is a bitlist of the following flags:
-  # - {Wx::LIST_STATE_FOCUSED}: The item has the focus.- {Wx::LIST_STATE_SELECTED}: The item is selected.- {Wx::LIST_STATE_DONTCARE}: No special flags (the value of this constant is 0).- {Wx::LIST_STATE_DROPHILITED}: The item is highlighted to receive a drop event. Win32 only.- {Wx::LIST_STATE_CUT}: The item is in the cut state. Win32 only.- A mask indicating which state flags are valid; this is a bitlist of the flags reported above for the item state. See {Wx::ListItem#set_state_mask} and GetStateMask().- A mask indicating which fields of this class are valid; see {Wx::ListItem#set_mask} and {Wx::ListItem#get_mask}. This is a bitlist of the following flags:
-  # - {Wx::LIST_MASK_STATE}: The state field is valid.- {Wx::LIST_MASK_TEXT}: The label field is valid.- {Wx::LIST_MASK_IMAGE}: The image field is valid.- {Wx::LIST_MASK_DATA}: The application-defined data field is valid.- {Wx::LIST_MASK_WIDTH}: The column width field is valid.- {Wx::LIST_MASK_FORMAT}: The column format field is valid.
+  # 
+  # - Zero based item position; see {Wx::ListItem#set_id} and {Wx::ListItem#get_id}.
+  # - Zero based column index; see {Wx::ListItem#set_column} and {Wx::ListItem#get_column}.
+  # - The label (or header for columns); see {Wx::ListItem#set_text} and {Wx::ListItem#get_text}.
+  # - The zero based index into an image list; see {Wx::ListItem#get_image} and {Wx::ListItem#set_image}.
+  # - Application defined data; see {Wx::ListItem#set_data} and {Wx::ListItem#get_data}.
+  # - For columns only: the width of the column; see {Wx::ListItem#set_width} and {Wx::ListItem#get_width}.
+  # - For columns only: the format of the column; one of {Wx::ListColumnFormat::LIST_FORMAT_LEFT}, {Wx::ListColumnFormat::LIST_FORMAT_RIGHT}, {Wx::ListColumnFormat::LIST_FORMAT_CENTRE}. See {Wx::ListItem#set_align} and {Wx::ListItem#get_align}.
+  # - The state of the item; see {Wx::ListItem#set_state} and {Wx::ListItem#get_state}. This is a bitlist of the following flags:
+  # 
+  # - {Wx::LIST_STATE_FOCUSED}: The item has the focus.
+  # - {Wx::LIST_STATE_SELECTED}: The item is selected.
+  # - {Wx::LIST_STATE_DONTCARE}: No special flags (the value of this constant is 0).
+  # - {Wx::LIST_STATE_DROPHILITED}: The item is highlighted to receive a drop event. Win32 only.
+  # - {Wx::LIST_STATE_CUT}: The item is in the cut state. Win32 only.
+  # - A mask indicating which state flags are valid; this is a bitlist of the flags reported above for the item state. See {Wx::ListItem#set_state_mask} and GetStateMask().
+  # - A mask indicating which fields of this class are valid; see {Wx::ListItem#set_mask} and {Wx::ListItem#get_mask}. This is a bitlist of the following flags:
+  # 
+  # - {Wx::LIST_MASK_STATE}: The state field is valid.
+  # - {Wx::LIST_MASK_TEXT}: The label field is valid.
+  # - {Wx::LIST_MASK_IMAGE}: The image field is valid.
+  # - {Wx::LIST_MASK_DATA}: The application-defined data field is valid.
+  # - {Wx::LIST_MASK_WIDTH}: The column width field is valid.
+  # - {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.
   # === 
@@ -1207,7 +1287,7 @@ module Wx
     alias_method :data=, :set_data
     
     # Constructor.
-    # @return [ListItem]
+    # @return [Wx::ListItem]
     def initialize; end
     
     # Resets the item state to the default.
@@ -1247,14 +1327,25 @@ module Wx
     
     # 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.- {Wx::LIST_MASK_TEXT}: <b>GetText</b> is valid.- {Wx::LIST_MASK_IMAGE}: <b>GetImage</b> is valid.- {Wx::LIST_MASK_DATA}: <b>GetData</b> is valid.- {Wx::LIST_MASK_WIDTH}: <b>GetWidth</b> is valid.- {Wx::LIST_MASK_FORMAT}: <b>GetFormat</b> is valid.
+    # 
+    # - {Wx::LIST_MASK_STATE}: <b>GetState</b> is valid.
+    # - {Wx::LIST_MASK_TEXT}: <b>GetText</b> is valid.
+    # - {Wx::LIST_MASK_IMAGE}: <b>GetImage</b> is valid.
+    # - {Wx::LIST_MASK_DATA}: <b>GetData</b> is valid.
+    # - {Wx::LIST_MASK_WIDTH}: <b>GetWidth</b> is valid.
+    # - {Wx::LIST_MASK_FORMAT}: <b>GetFormat</b> is valid.
     # @return [Integer]
     def get_mask; end
     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).- {Wx::LIST_STATE_DROPHILITED}: The item is highlighted to receive a drop event. Win32 only.- {Wx::LIST_STATE_FOCUSED}: The item has the focus.- {Wx::LIST_STATE_SELECTED}: The item is selected.- {Wx::LIST_STATE_CUT}: The item is in the cut state. Win32 only.
+    # 
+    # - {Wx::LIST_STATE_DONTCARE}: No special flags (the values of this constant is 0).
+    # - {Wx::LIST_STATE_DROPHILITED}: The item is highlighted to receive a drop event. Win32 only.
+    # - {Wx::LIST_STATE_FOCUSED}: The item has the focus.
+    # - {Wx::LIST_STATE_SELECTED}: The item is selected.
+    # - {Wx::LIST_STATE_CUT}: The item is in the cut state. Win32 only.
     # @return [Integer]
     def get_state; end
     alias_method :state, :get_state
@@ -1367,13 +1458,13 @@ module Wx
   
     # @overload initialize()
     #   Default Constructor.
-    #   @return [ItemAttr]
+    #   @return [Wx::ItemAttr]
     # @overload initialize(colText, colBack, font)
     #   Construct a {Wx::ItemAttr} with the specified foreground and background colours and font.
     #   @param colText [Wx::Colour,String,Symbol] 
     #   @param colBack [Wx::Colour,String,Symbol] 
     #   @param font [Wx::Font,Wx::FontInfo] 
-    #   @return [ItemAttr]
+    #   @return [Wx::ItemAttr]
     def initialize(*args) end
     
     # Compare two item attributes for equality.
@@ -1449,9 +1540,9 @@ module Wx
   # 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> {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::ListView#set_column_image 
   # 
@@ -1460,7 +1551,7 @@ module Wx
   
     # @overload initialize()
     #   Default constructor.
-    #   @return [ListView]
+    #   @return [Wx::ListView]
     # @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::ListCtrlNameStr)
     #   Constructor, creating and showing a listview control.
     #   
@@ -1473,7 +1564,7 @@ module Wx
     #   @param style [Integer]  Window style. See {Wx::ListCtrl}.
     #   @param validator [Wx::Validator]  Window validator.
     #   @param name [String]  Window name.
-    #   @return [ListView]
+    #   @return [Wx::ListView]
     def initialize(*args) end
     
     # Resets the column image  after calling this function, no image will be shown.

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

@@ -11,27 +11,49 @@ module Wx
   # 
   # The following event-handler methods redirect the events to member method or handler blocks for {Wx::ListEvent} events.
   # Event handler methods:
+  # 
   # - {Wx::EvtHandler#evt_list_begin_drag}(id, meth = nil, &block): Begin dragging with the left mouse button. 
+  # 
   # - {Wx::EvtHandler#evt_list_begin_rdrag}(id, meth = nil, &block): Begin dragging with the right mouse button. 
+  # 
   # - {Wx::EvtHandler#evt_list_begin_label_edit}(id, meth = nil, &block): Begin editing a label. This can be prevented by calling {Wx::ListEvent#veto}. 
+  # 
   # - {Wx::EvtHandler#evt_list_end_label_edit}(id, meth = nil, &block): Finish editing a label. This can be prevented by calling {Wx::ListEvent#veto}. 
+  # 
   # - {Wx::EvtHandler#evt_list_delete_item}(id, meth = nil, &block): Delete an item. 
+  # 
   # - {Wx::EvtHandler#evt_list_delete_all_items}(id, meth = nil, &block): Delete all items. 
+  # 
   # - {Wx::EvtHandler#evt_list_item_selected}(id, meth = nil, &block): The item has been selected. Notice that the mouse is captured by the control itself when this event is generated, see event handling overview. 
+  # 
   # - {Wx::EvtHandler#evt_list_item_deselected}(id, meth = nil, &block): The item has been deselected. {Wx::ListEvent#get_index} may be -1 with virtual lists. 
+  # 
   # - {Wx::EvtHandler#evt_list_item_activated}(id, meth = nil, &block): The item has been activated (ENTER or double click). 
+  # 
   # - {Wx::EvtHandler#evt_list_item_focused}(id, meth = nil, &block): The currently focused item has changed. 
+  # 
   # - {Wx::EvtHandler#evt_list_item_middle_click}(id, meth = nil, &block): The middle mouse button has been clicked on an item. 
+  # 
   # - {Wx::EvtHandler#evt_list_item_right_click}(id, meth = nil, &block): The right mouse button has been clicked on an item. 
+  # 
   # - {Wx::EvtHandler#evt_list_key_down}(id, meth = nil, &block): A key has been pressed. {Wx::ListEvent#get_index} may be -1 if no item is selected. 
+  # 
   # - {Wx::EvtHandler#evt_list_insert_item}(id, meth = nil, &block): An item has been inserted. 
+  # 
   # - {Wx::EvtHandler#evt_list_col_click}(id, meth = nil, &block): A column (m_col) has been left-clicked. 
+  # 
   # - {Wx::EvtHandler#evt_list_col_right_click}(id, meth = nil, &block): A column (m_col) (which can be -1 if the click occurred outside any column) has been right-clicked. 
+  # 
   # - {Wx::EvtHandler#evt_list_col_begin_drag}(id, meth = nil, &block): The user started resizing a column - can be vetoed. 
+  # 
   # - {Wx::EvtHandler#evt_list_col_dragging}(id, meth = nil, &block): The divider between columns is being dragged. 
+  # 
   # - {Wx::EvtHandler#evt_list_col_end_drag}(id, meth = nil, &block): A column has been resized by the user. 
+  # 
   # - {Wx::EvtHandler#evt_list_cache_hint}(id, meth = nil, &block): Prepare cache for a virtual list control 
+  # 
   # - {Wx::EvtHandler#evt_list_item_checked}(id, meth = nil, &block): The item has been checked (new since wxWidgets 3.1.0). 
+  # 
   # - {Wx::EvtHandler#evt_list_item_unchecked}(id, meth = nil, &block): The item has been unchecked (new since wxWidgets 3.1.0). 
   # 
   # === 
@@ -43,9 +65,9 @@ module Wx
   class ListEvent < NotifyEvent
   
     # Constructor.
-    # @param commandType [Integer] 
+    # @param commandType [Wx::AUI::AuiMDIChildFrame::EventType] 
     # @param id [Integer] 
-    # @return [ListEvent]
+    # @return [Wx::ListEvent]
     def initialize(commandType=Wx::EVT_NULL, id=0) end
     
     # For EVT_LIST_CACHE_HINT event only: return the first item which the list control advises us to cache.

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

@@ -38,25 +38,31 @@ module Wx
   # === Styles
   # 
   # This class supports the following styles:
-  #  
+  # 
   # - {Wx::LB_DEFAULT}: Choose the default location for the labels depending on the current platform (left everywhere except Mac where it is top). 
+  # 
   # - {Wx::LB_TOP}: Place labels above the page area. 
+  # 
   # - {Wx::LB_LEFT}: Place labels on the left side. 
+  # 
   # - {Wx::LB_RIGHT}: Place labels on the right side. 
+  # 
   # - {Wx::LB_BOTTOM}: Place labels below the page area. 
   # 
   # === Events emitted by this class
   # 
   # The following event-handler methods redirect the events to member method or handler blocks for {Wx::BookCtrlEvent} events.
   # Event handler methods for events emitted by this class:
+  # 
   # - {Wx::EvtHandler#evt_listbook_page_changed}(id, meth = nil, &block): The page selection was changed. Processes a {Wx::EVT_LISTBOOK_PAGE_CHANGED} event. 
+  # 
   # - {Wx::EvtHandler#evt_listbook_page_changing}(id, meth = nil, &block): The page selection is about to be changed. Processes a {Wx::EVT_LISTBOOK_PAGE_CHANGING} event. This event can be vetoed. 
   # 
   # === 
   # 
-  # Category:  Book 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:  Book 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::BookCtrl
   # @see  Wx::Notebook
@@ -67,7 +73,7 @@ module Wx
   
     # @overload initialize()
     #   Default ctor.
-    #   @return [Listbook]
+    #   @return [Wx::Listbook]
     # @overload initialize(parent, id, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, name=(''))
     #   Constructs a listbook control.
     #   @param parent [Wx::Window] 
@@ -76,7 +82,7 @@ module Wx
     #   @param size [Array(Integer, Integer), Wx::Size] 
     #   @param style [Integer] 
     #   @param name [String] 
-    #   @return [Listbook]
+    #   @return [Wx::Listbook]
     def initialize(*args) end
     
     # Create the list book control that has already been constructed with the default constructor.