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

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

@@ -236,7 +236,7 @@ module Wx
   # 
   # {Wx::TreeCtrl} inherits from {Wx::WithImages} classes providing the functions for associating images with the control items. Each item refers to its image using an index, which can possibly by {Wx::WithImages::NO_IMAGE} to indicate that the item doesn't use any image at all, and the corresponding image is taken either from the vector passed to {Wx::WithImages#set_images} or from the image list passed to {Wx::WithImages#set_image_list} or {Wx::WithImages#assign_image_list} functions.
   # In addition to normal images, handled with the methods mentioned above, {Wx::TreeCtrl} also provides optional state images that may be used to indicate some additional state of the item, e.g. checked or unchecked status. These images can be set using {Wx::TreeCtrl#set_state_image_list} and {Wx::TreeCtrl#assign_state_image_list} functions that behave in the same way as the corresponding methods of {Wx::WithImages}.
-  # Finally, in the generic version of this control ({Wx::GenericTreeCtrl}), also provides {Wx::TreeCtrl#set_buttons_image_list} and {Wx::TreeCtrl#assign_buttons_image_list}, which can be used to change the images used for the control buttons, used to expand or collapse its branches. These methods are not available in the native {Wx::MSW} and {Wx::Qt} implementations.
+  # Finally, in the generic version of this control ({Wx::GenericTreeCtrl}), also provides {Wx::TreeCtrl#set_buttons_image_list} and {Wx::TreeCtrl#assign_buttons_image_list}, which can be used to change the images used for the control buttons, used to expand or collapse its branches. These methods are not available in the native wxMSW and {Wx::Qt} implementations.
   # 
   # == Events
   # 
@@ -244,45 +244,78 @@ module Wx
   # === Styles
   # 
   # This class supports the following styles:
-  #  
+  # 
   # - {Wx::TR_EDIT_LABELS}: Use this style if you wish the user to be able to edit labels in the tree control. 
+  # 
   # - {Wx::TR_NO_BUTTONS}: For convenience to document that no buttons are to be drawn. 
+  # 
   # - {Wx::TR_HAS_BUTTONS}: Use this style to show + and - buttons to the left of parent items. 
+  # 
   # - {Wx::TR_TWIST_BUTTONS}: Selects alternative style of <code>+/<code>-</code> buttons</code> and shows rotating ("twisting") arrows instead. Currently this style is only implemented under Microsoft Windows Vista and later Windows versions and is ignored under the other platforms as enabling it is equivalent to using Wx::SystemThemedControl#enable_system_theme. 
+  # 
   # - {Wx::TR_NO_LINES}: Use this style to hide vertical level connectors. 
+  # 
   # - {Wx::TR_FULL_ROW_HIGHLIGHT}: Use this style to have the background colour and the selection highlight extend over the entire horizontal row of the tree control window. (This flag is ignored under Windows unless you specify {Wx::TR_NO_LINES} as well.) 
+  # 
   # - {Wx::TR_LINES_AT_ROOT}: Use this style to show lines leading to the root nodes (unless no {Wx::TR_NO_LINES} is also used, in which case no lines are shown). Note that in the MSW version, if this style is omitted, not only the lines, but also the button used for expanding the root item is not shown, which can be unexpected, so it is recommended to always use it. 
+  # 
   # - {Wx::TR_HIDE_ROOT}: Use this style to suppress the display of the root node, effectively causing the first-level nodes to appear as a series of root nodes. 
+  # 
   # - {Wx::TR_ROW_LINES}: Use this style to draw a contrasting border between displayed rows. 
+  # 
   # - {Wx::TR_HAS_VARIABLE_ROW_HEIGHT}: Use this style to cause row heights to be just big enough to fit the content. If not set, all rows use the largest row height. The default is that this flag is unset. Generic only. 
+  # 
   # - {Wx::TR_SINGLE}: For convenience to document that only one item may be selected at a time. Selecting another item causes the current selection, if any, to be deselected. This is the default. 
+  # 
   # - {Wx::TR_MULTIPLE}: Use this style to allow a range of items to be selected. If a second range is selected, the current range, if any, is deselected. 
+  # 
   # - {Wx::TR_DEFAULT_STYLE}: The set of flags that are closest to the defaults for the native control for a particular toolkit. 
   # 
   # === Events emitted by this class
   # 
   # The following event-handler methods redirect the events to member method or handler blocks for {Wx::TreeEvent} events.
   # Event handler methods for events emitted by this class:
+  # 
   # - {Wx::EvtHandler#evt_tree_begin_drag}(id, meth = nil, &block): Begin dragging with the left mouse button. If you want to enable left-dragging you need to intercept this event and explicitly call {Wx::TreeEvent#allow}, as it's vetoed by default. Processes a {Wx::EVT_TREE_BEGIN_DRAG} event type. 
+  # 
   # - {Wx::EvtHandler#evt_tree_begin_rdrag}(id, meth = nil, &block): Begin dragging with the right mouse button. If you want to enable right-dragging you need to intercept this event and explicitly call {Wx::TreeEvent#allow}, as it's vetoed by default. Processes a {Wx::EVT_TREE_BEGIN_RDRAG} event type. 
+  # 
   # - {Wx::EvtHandler#evt_tree_end_drag}(id, meth = nil, &block): End dragging with the left or right mouse button. Processes a {Wx::EVT_TREE_END_DRAG} event type. 
+  # 
   # - {Wx::EvtHandler#evt_tree_begin_label_edit}(id, meth = nil, &block): Begin editing a label. This can be prevented by calling Veto(). Processes a {Wx::EVT_TREE_BEGIN_LABEL_EDIT} event type. 
+  # 
   # - {Wx::EvtHandler#evt_tree_end_label_edit}(id, meth = nil, &block): Finish editing a label. This can be prevented by calling Veto(). Processes a {Wx::EVT_TREE_END_LABEL_EDIT} event type. 
+  # 
   # - {Wx::EvtHandler#evt_tree_delete_item}(id, meth = nil, &block): An item was deleted. Processes a {Wx::EVT_TREE_DELETE_ITEM} event type. 
+  # 
   # - {Wx::EvtHandler#evt_tree_get_info}(id, meth = nil, &block): Request information from the application. Processes a {Wx::EVT_TREE_GET_INFO} event type. 
+  # 
   # - {Wx::EvtHandler#evt_tree_set_info}(id, meth = nil, &block): Information is being supplied. Processes a {Wx::EVT_TREE_SET_INFO} event type. 
+  # 
   # - {Wx::EvtHandler#evt_tree_item_activated}(id, meth = nil, &block): The item has been activated, i.e. chosen by double clicking it with mouse or from keyboard. Processes a {Wx::EVT_TREE_ITEM_ACTIVATED} event type. 
+  # 
   # - {Wx::EvtHandler#evt_tree_item_collapsed}(id, meth = nil, &block): The item has been collapsed. Processes a {Wx::EVT_TREE_ITEM_COLLAPSED} event type. 
+  # 
   # - {Wx::EvtHandler#evt_tree_item_collapsing}(id, meth = nil, &block): The item is being collapsed. This can be prevented by calling Veto(). Processes a {Wx::EVT_TREE_ITEM_COLLAPSING} event type. 
+  # 
   # - {Wx::EvtHandler#evt_tree_item_expanded}(id, meth = nil, &block): The item has been expanded. Processes a {Wx::EVT_TREE_ITEM_EXPANDED} event type. 
+  # 
   # - {Wx::EvtHandler#evt_tree_item_expanding}(id, meth = nil, &block): The item is being expanded. This can be prevented by calling Veto(). Processes a {Wx::EVT_TREE_ITEM_EXPANDING} event type. 
+  # 
   # - {Wx::EvtHandler#evt_tree_item_right_click}(id, meth = nil, &block): The user has clicked the item with the right mouse button. Processes a {Wx::EVT_TREE_ITEM_RIGHT_CLICK} event type. 
+  # 
   # - {Wx::EvtHandler#evt_tree_item_middle_click}(id, meth = nil, &block): The user has clicked the item with the middle mouse button. This is only supported by the generic control. Processes a {Wx::EVT_TREE_ITEM_MIDDLE_CLICK} event type. 
+  # 
   # - {Wx::EvtHandler#evt_tree_sel_changed}(id, meth = nil, &block): Selection has changed. Processes a {Wx::EVT_TREE_SEL_CHANGED} event type. 
+  # 
   # - {Wx::EvtHandler#evt_tree_sel_changing}(id, meth = nil, &block): Selection is changing. This can be prevented by calling Veto(). Processes a {Wx::EVT_TREE_SEL_CHANGING} event type. 
+  # 
   # - {Wx::EvtHandler#evt_tree_key_down}(id, meth = nil, &block): A key has been pressed. Processes a {Wx::EVT_TREE_KEY_DOWN} event type. 
+  # 
   # - {Wx::EvtHandler#evt_tree_item_gettooltip}(id, meth = nil, &block): The opportunity to set the item tooltip is being given to the application (call {Wx::TreeEvent#set_tool_tip}). Windows only. Processes a {Wx::EVT_TREE_ITEM_GETTOOLTIP} event type. 
+  # 
   # - {Wx::EvtHandler#evt_tree_item_menu}(id, meth = nil, &block): The context menu for the selected item has been requested, either by a right click or by using the menu key. Notice that these events always carry a valid tree item and so are not generated when (right) clicking outside of the items area. If you need to handle such events, consider using {Wx::EVT_CONTEXT_MENU} instead. Processes a {Wx::EVT_TREE_ITEM_MENU} event type. 
+  # 
   # - {Wx::EvtHandler#evt_tree_state_image_click}(id, meth = nil, &block): The state image has been clicked. Processes a {Wx::EVT_TREE_STATE_IMAGE_CLICK} event type. 
   # 
   # See also Window Styles.
@@ -290,9 +323,9 @@ module Wx
   # {Wx::TreeCtrl} class uses the standard common treeview control under Win32 implemented in the system library comctl32.dll. Some versions of this library are known to have bugs with handling the tree control colours: the usual symptom is that the expanded items leave black (or otherwise incorrectly coloured) background behind them, especially for the controls using non-default background colour. The recommended solution is to upgrade the comctl32.dll to a newer version: see http://www.microsoft.com/downloads/details.aspx?familyid=cb2cf3a2-8025-4e8f-8511-9b476a8d35d2
   # === 
   # 
-  # 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::DataViewTreeCtrl
   # @see  Wx::TreeEvent
@@ -309,7 +342,7 @@ module Wx
   
     # @overload initialize()
     #   Default Constructor.
-    #   @return [TreeCtrl]
+    #   @return [Wx::TreeCtrl]
     # @overload initialize(parent, id=Wx::StandardID::ID_ANY, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::TR_DEFAULT_STYLE, validator=Wx::DEFAULT_VALIDATOR, name=Wx::TreeCtrlNameStr)
     #   Constructor, creating and showing a tree control.
     #   
@@ -322,7 +355,7 @@ module Wx
     #   @param style [Integer]  Window style. See {Wx::TreeCtrl}.
     #   @param validator [Wx::Validator]  Window validator.
     #   @param name [String]  Window name.
-    #   @return [TreeCtrl]
+    #   @return [Wx::TreeCtrl]
     def initialize(*args) end
     
     # Adds the root node to the tree, returning the new item.
@@ -376,7 +409,7 @@ module Wx
     # @param style [Integer] 
     # @param validator [Wx::Validator] 
     # @param name [String] 
-    # @return [true,false]
+    # @return [Boolean]
     def create(parent, id=Wx::StandardID::ID_ANY, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::TR_DEFAULT_STYLE, validator=Wx::DEFAULT_VALIDATOR, name=Wx::TreeCtrlNameStr) end
     
     # Deletes the specified item.
@@ -399,8 +432,8 @@ module Wx
     def delete_children(item) 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.
-    # @param on [true,false] 
+    # 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
     
@@ -409,7 +442,7 @@ module Wx
     # This function is currently supported under Windows only.
     # @see Wx::TreeCtrl#edit_label 
     # @param item [Wx::TreeItemId] 
-    # @param discardChanges [true,false] 
+    # @param discardChanges [Boolean] 
     # @return [void]
     def end_edit_label(item, discardChanges=false) end
     
@@ -439,15 +472,15 @@ module Wx
     # Notice that the rectangle coordinates are logical, not physical ones. So, for example, the x coordinate may be negative if the tree has a horizontal scrollbar and its position is not 0.
     # @param item [Wx::TreeItemId] 
     # @param rect [Wx::Rect] 
-    # @param textOnly [true,false] 
-    # @return [true,false]
+    # @param textOnly [Boolean] 
+    # @return [Boolean]
     def get_bounding_rect(item, rect, textOnly=false) end
     alias_method :bounding_rect, :get_bounding_rect
     
     # Returns the number of items in the branch.
     # If recursively is true, returns the total number of descendants, otherwise only one level of children is counted.
     # @param item [Wx::TreeItemId] 
-    # @param recursively [true,false] 
+    # @param recursively [Boolean] 
     # @return [Integer]
     def get_children_count(item, recursively=true) end
     alias_method :children_count, :get_children_count
@@ -459,7 +492,7 @@ module Wx
     
     # Returns the edit control being currently used to edit a label.
     # Returns NULL if no label is being edited.
-    # This is currently only implemented for {Wx::MSW}.
+    # This is currently only implemented for wxMSW.
     # @return [Wx::TextCtrl]
     def get_edit_control; end
     alias_method :edit_control, :get_edit_control
@@ -519,9 +552,13 @@ module Wx
     
     # Gets the specified item image.
     # The value of which may be:
-    # - {Wx::TreeItemIcon::TreeItemIcon_Normal}: to get the normal item image.- {Wx::TreeItemIcon::TreeItemIcon_Selected}: to get the selected item image (i.e. the image which is shown when the item is currently selected).- {Wx::TreeItemIcon::TreeItemIcon_Expanded}: to get the expanded image (this only makes sense for items which have children - then this image is shown when the item is expanded and the normal image is shown when it is collapsed).- {Wx::TreeItemIcon::TreeItemIcon_SelectedExpanded}: to get the selected expanded image (which is shown when an expanded item is currently selected).
+    # 
+    # - {Wx::TreeItemIcon::TreeItemIcon_Normal}: to get the normal item image.
+    # - {Wx::TreeItemIcon::TreeItemIcon_Selected}: to get the selected item image (i.e. the image which is shown when the item is currently selected).
+    # - {Wx::TreeItemIcon::TreeItemIcon_Expanded}: to get the expanded image (this only makes sense for items which have children - then this image is shown when the item is expanded and the normal image is shown when it is collapsed).
+    # - {Wx::TreeItemIcon::TreeItemIcon_SelectedExpanded}: to get the selected expanded image (which is shown when an expanded item is currently selected).
     # @param item [Wx::TreeItemId] 
-    # @param which [TreeItemIcon] 
+    # @param which [Wx::TreeItemIcon] 
     # @return [Integer]
     def get_item_image(item, which=Wx::TreeItemIcon::TreeItemIcon_Normal) end
     alias_method :item_image, :get_item_image
@@ -593,7 +630,7 @@ module Wx
     # Returns true if the control will use a quick calculation for the best size, looking only at the first and last items.
     # The default is false.
     # @see Wx::TreeCtrl#set_quick_best_size 
-    # @return [true,false]
+    # @return [Boolean]
     def get_quick_best_size; end
     alias_method :quick_best_size, :get_quick_best_size
     
@@ -616,7 +653,17 @@ module Wx
     # Calculates which (if any) item is under the given point, returning the tree item id at this point plus extra information flags.
     # flags is a bitlist of the following:
     # 
-    # - {Wx::TREE_HITTEST_ABOVE}: Above the client area.- {Wx::TREE_HITTEST_BELOW}: Below the client area.- {Wx::TREE_HITTEST_NOWHERE}: In the client area but below the last item.- {Wx::TREE_HITTEST_ONITEMBUTTON}: On the button associated with an item.- {Wx::TREE_HITTEST_ONITEMICON}: On the bitmap associated with an item.- {Wx::TREE_HITTEST_ONITEMINDENT}: In the indentation associated with an item.- {Wx::TREE_HITTEST_ONITEMLABEL}: On the label (string) associated with an item.- {Wx::TREE_HITTEST_ONITEMRIGHT}: In the area to the right of an item.- {Wx::TREE_HITTEST_ONITEMSTATEICON}: On the state icon for a tree view item that is in a user-defined state.- {Wx::TREE_HITTEST_TOLEFT}: To the right of the client area.- {Wx::TREE_HITTEST_TORIGHT}: To the left of the client area.
+    # - {Wx::TREE_HITTEST_ABOVE}: Above the client area.
+    # - {Wx::TREE_HITTEST_BELOW}: Below the client area.
+    # - {Wx::TREE_HITTEST_NOWHERE}: In the client area but below the last item.
+    # - {Wx::TREE_HITTEST_ONITEMBUTTON}: On the button associated with an item.
+    # - {Wx::TREE_HITTEST_ONITEMICON}: On the bitmap associated with an item.
+    # - {Wx::TREE_HITTEST_ONITEMINDENT}: In the indentation associated with an item.
+    # - {Wx::TREE_HITTEST_ONITEMLABEL}: On the label (string) associated with an item.
+    # - {Wx::TREE_HITTEST_ONITEMRIGHT}: In the area to the right of an item.
+    # - {Wx::TREE_HITTEST_ONITEMSTATEICON}: On the state icon for a tree view item that is in a user-defined state.
+    # - {Wx::TREE_HITTEST_TOLEFT}: To the right of the client area.
+    # - {Wx::TREE_HITTEST_TORIGHT}: To the left of the client area.
     # @param point [Array(Integer, Integer), Wx::Point] 
     # @return [Array(Wx::TreeItemId,Integer)]
     def hit_test(point) end
@@ -636,36 +683,36 @@ module Wx
     # 
     # @see Wx::TreeCtrl#set_item_bold 
     # @param item [Wx::TreeItemId] 
-    # @return [true,false]
+    # @return [Boolean]
     def is_bold(item) end
     alias_method :bold?, :is_bold
     
     # Returns true if the control is empty (i.e. has no items, even no root one).
-    # @return [true,false]
+    # @return [Boolean]
     def is_empty; end
     alias_method :empty?, :is_empty
     
     # Returns true if the item is expanded (only makes sense if it has children).
     # @param item [Wx::TreeItemId] 
-    # @return [true,false]
+    # @return [Boolean]
     def is_expanded(item) end
     alias_method :expanded?, :is_expanded
     
     # Returns true if the item is selected.
     # @param item [Wx::TreeItemId] 
-    # @return [true,false]
+    # @return [Boolean]
     def is_selected(item) end
     alias_method :selected?, :is_selected
     
     # Returns true if the item is visible on the screen.
     # @param item [Wx::TreeItemId] 
-    # @return [true,false]
+    # @return [Boolean]
     def is_visible(item) end
     alias_method :visible?, :is_visible
     
     # Returns true if the item has children.
     # @param item [Wx::TreeItemId] 
-    # @return [true,false]
+    # @return [Boolean]
     def item_has_children(item) end
     
     # Override this function in the derived class to change the sort order of the items in the tree control.
@@ -698,7 +745,7 @@ module Wx
     # In multiple selection controls, can be also used to deselect a currently selected item if the value of select is false.
     # Notice that calling this method will generate {Wx::EVT_TREE_SEL_CHANGING} and {Wx::EVT_TREE_SEL_CHANGED} events and that the change could be vetoed by the former event handler.
     # @param item [Wx::TreeItemId] 
-    # @param select [true,false] 
+    # @param select [Boolean] 
     # @return [void]
     def select_item(item, select=true) end
     
@@ -709,7 +756,7 @@ module Wx
     alias_method :indent=, :set_indent
     
     # Sets the spacing for the tree control.
-    # Spacing is the number of horizontal pixels between the buttons and the state images. This has no effect under {Wx::MSW}.
+    # Spacing is the number of horizontal pixels between the buttons and the state images. This has no effect under wxMSW.
     # @param spacing [Integer] 
     # @return [void]
     def set_spacing(spacing) end
@@ -725,7 +772,7 @@ module Wx
     # 
     # @see Wx::TreeCtrl#is_bold 
     # @param item [Wx::TreeItemId] 
-    # @param bold [true,false] 
+    # @param bold [Boolean] 
     # @return [void]
     def set_item_bold(item, bold=true) end
     alias_method :item_bold=, :set_item_bold
@@ -739,7 +786,7 @@ module Wx
     
     # Gives the item the visual feedback for Drag'n'Drop actions, which is useful if something is dragged from the outside onto the tree control (as opposed to a DnD operation within the tree control, which already is implemented internally).
     # @param item [Wx::TreeItemId] 
-    # @param highlight [true,false] 
+    # @param highlight [Boolean] 
     # @return [void]
     def set_item_drop_highlight(item, highlight=true) end
     alias_method :item_drop_highlight=, :set_item_drop_highlight
@@ -755,7 +802,7 @@ module Wx
     # Force appearance of the button next to the item.
     # This is useful to allow the user to expand the items which don't have any children now, but instead adding them only when needed, thus minimizing memory usage and loading time.
     # @param item [Wx::TreeItemId] 
-    # @param hasChildren [true,false] 
+    # @param hasChildren [Boolean] 
     # @return [void]
     def set_item_has_children(item, hasChildren=true) end
     alias_method :item_has_children=, :set_item_has_children
@@ -764,13 +811,16 @@ module Wx
     # See {Wx::TreeCtrl#get_item_image} for the description of the which parameter.
     # @param item [Wx::TreeItemId] 
     # @param image [Integer] 
-    # @param which [TreeItemIcon] 
+    # @param which [Wx::TreeItemIcon] 
     # @return [void]
     def set_item_image(item, image, which=Wx::TreeItemIcon::TreeItemIcon_Normal) end
     
     # Sets the specified item state.
     # The value of state may be an index into the state image list, or one of the special values:
-    # - {Wx::TREE_ITEMSTATE_NONE}: to disable the item state (the state image will be not displayed).- {Wx::TREE_ITEMSTATE_NEXT}: to set the next item state.- {Wx::TREE_ITEMSTATE_PREV}: to set the previous item state.
+    # 
+    # - {Wx::TREE_ITEMSTATE_NONE}: to disable the item state (the state image will be not displayed).
+    # - {Wx::TREE_ITEMSTATE_NEXT}: to set the next item state.
+    # - {Wx::TREE_ITEMSTATE_PREV}: to set the previous item state.
     # @param item [Wx::TreeItemId] 
     # @param state [Integer] 
     # @return [void]
@@ -791,7 +841,7 @@ module Wx
     # If true is passed, specifies that the control will use a quick calculation for the best size, looking only at the first and last items.
     # Otherwise, it will look at all items. The default is false.
     # @see Wx::TreeCtrl#get_quick_best_size 
-    # @param quickBestSize [true,false] 
+    # @param quickBestSize [Boolean] 
     # @return [void]
     def set_quick_best_size(quickBestSize) end
     alias_method :quick_best_size=, :set_quick_best_size

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

@@ -12,26 +12,47 @@ module Wx
   # 
   # The following event-handler methods redirect the events to member method or handler blocks for {Wx::TreeEvent} events.
   # Event handler methods:
+  # 
   # - {Wx::EvtHandler#evt_tree_begin_drag}(id, meth = nil, &block): Begin dragging with the left mouse button. If you want to enable left-dragging you need to intercept this event and explicitly call {Wx::TreeEvent#allow}, as it's vetoed by default. Also notice that the control must have an associated image list (see SetImageList()) to drag its items under MSW. 
+  # 
   # - {Wx::EvtHandler#evt_tree_begin_rdrag}(id, meth = nil, &block): Begin dragging with the right mouse button. If you want to enable right-dragging you need to intercept this event and explicitly call {Wx::TreeEvent#allow}, as it's vetoed by default. 
+  # 
   # - {Wx::EvtHandler#evt_tree_end_drag}(id, meth = nil, &block): End dragging with the left or right mouse button. 
+  # 
   # - {Wx::EvtHandler#evt_tree_begin_label_edit}(id, meth = nil, &block): Begin editing a label. This can be prevented by calling {Wx::TreeEvent#veto}. 
+  # 
   # - {Wx::EvtHandler#evt_tree_end_label_edit}(id, meth = nil, &block): Finish editing a label. This can be prevented by calling {Wx::TreeEvent#veto}. 
+  # 
   # - {Wx::EvtHandler#evt_tree_delete_item}(id, meth = nil, &block): Delete an item. 
+  # 
   # - {Wx::EvtHandler#evt_tree_get_info}(id, meth = nil, &block): Request information from the application. 
+  # 
   # - {Wx::EvtHandler#evt_tree_set_info}(id, meth = nil, &block): Information is being supplied. 
+  # 
   # - {Wx::EvtHandler#evt_tree_item_activated}(id, meth = nil, &block): The item has been activated, i.e. chosen by double clicking it with mouse or from keyboard. 
+  # 
   # - {Wx::EvtHandler#evt_tree_item_collapsed}(id, meth = nil, &block): The item has been collapsed. 
+  # 
   # - {Wx::EvtHandler#evt_tree_item_collapsing}(id, meth = nil, &block): The item is being collapsed. This can be prevented by calling {Wx::TreeEvent#veto}. 
+  # 
   # - {Wx::EvtHandler#evt_tree_item_expanded}(id, meth = nil, &block): The item has been expanded. 
+  # 
   # - {Wx::EvtHandler#evt_tree_item_expanding}(id, meth = nil, &block): The item is being expanded. This can be prevented by calling {Wx::TreeEvent#veto}. 
+  # 
   # - {Wx::EvtHandler#evt_tree_item_right_click}(id, meth = nil, &block): The user has clicked the item with the right mouse button. 
+  # 
   # - {Wx::EvtHandler#evt_tree_item_middle_click}(id, meth = nil, &block): The user has clicked the item with the middle mouse button. 
+  # 
   # - {Wx::EvtHandler#evt_tree_sel_changed}(id, meth = nil, &block): Selection has changed. 
+  # 
   # - {Wx::EvtHandler#evt_tree_sel_changing}(id, meth = nil, &block): Selection is changing. This can be prevented by calling {Wx::TreeEvent#veto}. 
+  # 
   # - {Wx::EvtHandler#evt_tree_key_down}(id, meth = nil, &block): A key has been pressed. 
+  # 
   # - {Wx::EvtHandler#evt_tree_item_gettooltip}(id, meth = nil, &block): The opportunity to set the item tooltip is being given to the application (call {Wx::TreeEvent#set_tool_tip}). Windows only. 
+  # 
   # - {Wx::EvtHandler#evt_tree_item_menu}(id, meth = nil, &block): The context menu for the selected item has been requested, either by a right click or by using the menu key. 
+  # 
   # - {Wx::EvtHandler#evt_tree_state_image_click}(id, meth = nil, &block): The state image has been clicked. 
   # 
   # === 
@@ -43,10 +64,10 @@ module Wx
   class TreeEvent < NotifyEvent
   
     # Constructor, used by wxWidgets itself only.
-    # @param commandType [Integer] 
+    # @param commandType [Wx::CommandLinkButton::EventType] 
     # @param tree [Wx::TreeCtrl] 
     # @param item [Wx::TreeItemId] 
-    # @return [TreeEvent]
+    # @return [Wx::TreeEvent]
     def initialize(commandType, tree, item=(Wx::TreeItemId.new())) end
     
     # Returns the item.
@@ -84,7 +105,7 @@ module Wx
     
     # Returns true if the label edit was cancelled.
     # This should be called from within an EVT_TREE_END_LABEL_EDIT handler.
-    # @return [true,false]
+    # @return [Boolean]
     def is_edit_cancelled; end
     alias_method :edit_cancelled?, :is_edit_cancelled
     

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

@@ -30,9 +30,13 @@ module Wx
   # 
   # 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_treebook_page_changed}(id, meth = nil, &block): The page selection was changed. Processes a {Wx::EVT_TREEBOOK_PAGE_CHANGED} event. 
+  # 
   # - {Wx::EvtHandler#evt_treebook_page_changing}(id, meth = nil, &block): The page selection is about to be changed. Processes a {Wx::EVT_TREEBOOK_PAGE_CHANGING} event. This event can be {Wx::vetoed}. 
+  # 
   # - {Wx::EvtHandler#evt_treebook_node_collapsed}(id, meth = nil, &block): The page node is going to be collapsed. Processes a {Wx::EVT_TREEBOOK_NODE_COLLAPSED} event. 
+  # 
   # - {Wx::EvtHandler#evt_treebook_node_expanded}(id, meth = nil, &block): The page node is going to be expanded. Processes a {Wx::EVT_TREEBOOK_NODE_EXPANDED} event. 
   # 
   # === 
@@ -51,7 +55,7 @@ module Wx
   
     # @overload initialize()
     #   Default constructor.
-    #   @return [Treebook]
+    #   @return [Wx::Treebook]
     # @overload initialize(parent, id, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::BK_DEFAULT, name=(''))
     #   Creates an empty {Wx::Treebook}.
     #   @param parent [Wx::Window]  The parent window. Must be non-NULL.
@@ -60,30 +64,30 @@ module Wx
     #   @param size [Array(Integer, Integer), Wx::Size]  The window size.
     #   @param style [Integer]  The window style. See {Wx::Notebook}.
     #   @param name [String]  The name of the control (used only under Motif).
-    #   @return [Treebook]
+    #   @return [Wx::Treebook]
     def initialize(*args) end
     
     # Adds a new page.
     # The page is placed at the topmost level after all other pages. NULL could be specified for page to create an empty page.
     # @param page [Wx::Window] 
     # @param text [String] 
-    # @param bSelect [true,false] 
+    # @param bSelect [Boolean] 
     # @param imageId [Integer] 
-    # @return [true,false]
+    # @return [Boolean]
     def add_page(page, text, bSelect=false, imageId=Wx::NOT_FOUND) end
     
     # Adds a new child-page to the last top-level page.
     # NULL could be specified for page to create an empty page.
     # @param page [Wx::Window] 
     # @param text [String] 
-    # @param bSelect [true,false] 
+    # @param bSelect [Boolean] 
     # @param imageId [Integer] 
-    # @return [true,false]
+    # @return [Boolean]
     def add_sub_page(page, text, bSelect=false, imageId=Wx::NOT_FOUND) end
     
     # Shortcut for {Wx::Treebook#expand_node}( pageId, false ).
     # @param pageId [Integer] 
-    # @return [true,false]
+    # @return [Boolean]
     def collapse_node(pageId) end
     
     # Creates a treebook control.
@@ -94,20 +98,20 @@ module Wx
     # @param size [Array(Integer, Integer), Wx::Size] 
     # @param style [Integer] 
     # @param name [String] 
-    # @return [true,false]
+    # @return [Boolean]
     def create(parent, id, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::BK_DEFAULT, name=('')) end
     
     # Deletes the page at the specified position and all its children.
     # Could trigger page selection change in a case when selected page is removed. In that case its parent is selected (or the next page if no parent).
     # @param pagePos [Integer] 
-    # @return [true,false]
+    # @return [Boolean]
     def delete_page(pagePos) end
     
     # Expands (collapses) the pageId node.
     # Returns the previous state. May generate page changing events (if selected page is under the collapsed branch, then its parent is autoselected).
     # @param pageId [Integer] 
-    # @param expand [true,false] 
-    # @return [true,false]
+    # @param expand [Boolean] 
+    # @return [Boolean]
     def expand_node(pageId, expand=true) end
     
     # Returns the parent page of the given one or {Wx::NOT_FOUND} if this is a top-level page.
@@ -127,9 +131,9 @@ module Wx
     # @param pagePos [Integer] 
     # @param page [Wx::Window] 
     # @param text [String] 
-    # @param bSelect [true,false] 
+    # @param bSelect [Boolean] 
     # @param imageId [Integer] 
-    # @return [true,false]
+    # @return [Boolean]
     def insert_page(pagePos, page, text, bSelect=false, imageId=Wx::NOT_FOUND) end
     
     # Inserts a sub page under the specified page.
@@ -137,14 +141,14 @@ module Wx
     # @param pagePos [Integer] 
     # @param page [Wx::Window] 
     # @param text [String] 
-    # @param bSelect [true,false] 
+    # @param bSelect [Boolean] 
     # @param imageId [Integer] 
-    # @return [true,false]
+    # @return [Boolean]
     def insert_sub_page(pagePos, page, text, bSelect=false, imageId=Wx::NOT_FOUND) end
     
     # Returns true if the page represented by pageId is expanded.
     # @param pageId [Integer] 
-    # @return [true,false]
+    # @return [Boolean]
     def is_node_expanded(pageId) end
     alias_method :node_expanded?, :is_node_expanded
     

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

@@ -9,6 +9,7 @@ module Wx
   # {Wx::UIActionSimulator} is a class used to simulate user interface actions such as a mouse click or a key press.
   # Common usage for this class would be to provide playback and record (aka macro recording) functionality for users, or to drive unit tests by simulating user sessions.
   # See the wxUIActionSimulator Sample for an example of using this class.
+  # This class currently doesn't work when using Wayland with wxGTK.
   # 
   # ===
   # 
@@ -17,39 +18,39 @@ module Wx
   class UIActionSimulator < ::Object
   
     # Default constructor.
-    # @return [UIActionSimulator]
+    # @return [Wx::UIActionSimulator]
     def initialize; end
     
     # @overload mouse_move(x, y)
     #   Move the mouse to the specified coordinates.
     #   @param x [Integer]  x coordinate to move to, in screen coordinates.
     #   @param y [Integer]  y coordinate to move to, in screen coordinates.
-    #   @return [true,false]
+    #   @return [Boolean]
     # @overload mouse_move(point)
     #   Move the mouse to the specified coordinates.
     #   @param point [Array(Integer, Integer), Wx::Point]  Point to move to, in screen coordinates.
-    #   @return [true,false]
+    #   @return [Boolean]
     def mouse_move(*args) end
     
     # Press a mouse button.
-    # @param button [Integer]  Button to press. Valid constants are {Wx::MOUSE_BTN_LEFT}, {Wx::MOUSE_BTN_MIDDLE}, and {Wx::MOUSE_BTN_RIGHT}.
-    # @return [true,false]
-    def mouse_down(button=Wx::MOUSE_BTN_LEFT) end
+    # @param button [Integer]  Button to press. Valid constants are {Wx::MouseButton::MOUSE_BTN_LEFT}, {Wx::MouseButton::MOUSE_BTN_MIDDLE}, and {Wx::MouseButton::MOUSE_BTN_RIGHT}.
+    # @return [Boolean]
+    def mouse_down(button=Wx::MouseButton::MOUSE_BTN_LEFT) end
     
     # Release a mouse button.
     # @param button [Integer]  Button to press. See {Wx::UIActionSimulator#mouse_down} for a list of valid constants.
-    # @return [true,false]
-    def mouse_up(button=Wx::MOUSE_BTN_LEFT) end
+    # @return [Boolean]
+    def mouse_up(button=Wx::MouseButton::MOUSE_BTN_LEFT) end
     
     # Click a mouse button.
     # @param button [Integer]  Button to press. See {Wx::UIActionSimulator#mouse_down} for a list of valid constants.
-    # @return [true,false]
-    def mouse_click(button=Wx::MOUSE_BTN_LEFT) end
+    # @return [Boolean]
+    def mouse_click(button=Wx::MouseButton::MOUSE_BTN_LEFT) end
     
     # Double-click a mouse button.
     # @param button [Integer]  Button to press. See {Wx::UIActionSimulator#mouse_down} for a list of valid constants.
-    # @return [true,false]
-    def mouse_dbl_click(button=Wx::MOUSE_BTN_LEFT) end
+    # @return [Boolean]
+    def mouse_dbl_click(button=Wx::MouseButton::MOUSE_BTN_LEFT) end
     
     # Perform a drag and drop operation.
     # @param x1 [Integer]  x start coordinate, in screen coordinates.
@@ -57,26 +58,26 @@ module Wx
     # @param x2 [Integer]  x destination coordinate, in screen coordinates.
     # @param y2 [Integer]  y destination coordinate, in screen coordinates.
     # @param button [Integer]  Button to press. See {Wx::UIActionSimulator#mouse_down} for a list of valid constants.
-    # @return [true,false]
-    def mouse_drag_drop(x1, y1, x2, y2, button=Wx::MOUSE_BTN_LEFT) end
+    # @return [Boolean]
+    def mouse_drag_drop(x1, y1, x2, y2, button=Wx::MouseButton::MOUSE_BTN_LEFT) end
     
     # Press a key.
     # If you are using modifiers then it needs to be paired with an identical KeyUp or the modifiers will not be released (MSW and macOS).
     # @param keycode [Integer]  Key to operate on, as an integer. It is interpreted as a {Wx::KeyCode}.
     # @param modifiers [Integer]  A combination of {Wx::KeyModifier} flags to be pressed with the given keycode.
-    # @return [true,false]
+    # @return [Boolean]
     def key_down(keycode, modifiers=Wx::KeyModifier::MOD_NONE) end
     
     # Release a key.
     # @param keycode [Integer]  Key to operate on, as an integer. It is interpreted as a {Wx::KeyCode}.
     # @param modifiers [Integer]  A combination of {Wx::KeyModifier} flags to be pressed with the given keycode.
-    # @return [true,false]
+    # @return [Boolean]
     def key_up(keycode, modifiers=Wx::KeyModifier::MOD_NONE) end
     
     # Press and release a key.
     # @param keycode [Integer]  Key to operate on, as an integer. It is interpreted as a {Wx::KeyCode}.
     # @param modifiers [Integer]  A combination of {Wx::KeyModifier} flags to be pressed with the given keycode.
-    # @return [true,false]
+    # @return [Boolean]
     def char(keycode, modifiers=Wx::KeyModifier::MOD_NONE) end
     
     # Simulate selection of an item with the given text.
@@ -85,13 +86,13 @@ module Wx
     # 
     # true if the item text was successfully selected or false if the currently focused window is not one of the controls allowing item selection or if the item with the given text was not found in it.
     # @param text [String]  The text of the item to select.
-    # @return [true,false]
+    # @return [Boolean]
     def select(text) end
     
     # Emulate typing in the keys representing the given string.
     # Currently only the ASCII letters are universally supported. Digits and punctuation characters can be used with the standard QWERTY (US) keyboard layout but may not work with other layouts.
     # @param text [String]  The string, containing only US ASCII characters, to type.
-    # @return [true,false]
+    # @return [Boolean]
     def text(text) end
     
   end # UIActionSimulator