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

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

@@ -52,6 +52,7 @@ module Wx
   # @see  Wx::TreeCtrl#set_item_image 
   # 
   # 
+  # @wxrb_require USE_TREECTRL
   class TreeItemIcon < Wx::Enum
   
     # To get/set the item image for when the item is <b>not</b> selected and <b>not</b> expanded.
@@ -229,19 +230,20 @@ module Wx
   EVT_TREE_ITEM_MENU = 10124
   
   # A tree control presents information as a hierarchy, with items that may be expanded to show further items.
+  # 
   # Items in a tree control are referenced by {Wx::TreeItemId} handles, which may be tested for validity by calling {Wx::TreeItemId#is_ok}.
   # A similar control with a fully native implementation for GTK+ and macOS as well is {Wx::DataViewTreeCtrl}.
   # 
-  # == Images in wxTreeCtrl
+  # ## Images in wxTreeCtrl
   # 
   # {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 wxMSW 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
+  # ## Events
   # 
   # To intercept events from a tree control, use the event table macros described in {Wx::TreeEvent}.
-  # === Styles
+  # ### Styles
   # 
   # This class supports the following styles:
   # 
@@ -271,7 +273,7 @@ module Wx
   # 
   # - {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
+  # ### 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:
@@ -321,11 +323,10 @@ module Wx
   # See also Window Styles.
   # <b>Win32</b> <b>notes:</b> 
   # {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> 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::DataViewTreeCtrl
   # @see  Wx::TreeEvent
@@ -336,6 +337,7 @@ module Wx
   # @see  Wx::WithImages 
   # 
   # 
+  # @wxrb_require USE_TREECTRL
   class TreeCtrl < Control
   
     include Wx::WithImages
@@ -346,6 +348,7 @@ module Wx
     # @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::TREE_CTRL_NAME_STR)
     #   Constructor, creating and showing a tree control.
     #   
+    #   
     #   @see Wx::TreeCtrl#create
     #   @see  Wx::Validator 
     #   @param parent [Wx::Window]  Parent window. Must not be NULL.
@@ -359,6 +362,7 @@ module Wx
     def initialize(*args) end
     
     # Adds the root node to the tree, returning the new item.
+    # 
     # The image and selImage parameters are an index within the normal image list specifying the image to use for unselected and selected items, respectively. If image > -1 and selImage is -1, the same image is used for both selected and unselected items.
     # @param text [String] 
     # @param image [Integer] 
@@ -368,6 +372,7 @@ module Wx
     def add_root(text, image=-1, selImage=-1, data=nil) end
     
     # Appends an item to the end of the branch identified by parent, return a new item id.
+    # 
     # The image and selImage parameters are an index within the normal image list specifying the image to use for unselected and selected items, respectively. If image > -1 and selImage is -1, the same image is used for both selected and unselected items.
     # @param parent [Wx::TreeItemId] 
     # @param text [String] 
@@ -384,12 +389,14 @@ module Wx
     
     # Collapses the root item.
     # 
+    # 
     # @see Wx::TreeCtrl#expand_all 
     # @return [void]
     def collapse_all; end
     
     # Collapses this item and all of its children, recursively.
     # 
+    # 
     # @see Wx::TreeCtrl#expand_all_children 
     # @param item [Wx::TreeItemId] 
     # @return [void]
@@ -401,6 +408,7 @@ module Wx
     def collapse_and_reset(item) end
     
     # Creates the tree control.
+    # 
     # See {Wx::TreeCtrl#initialize} for further details.
     # @param parent [Wx::Window] 
     # @param id [Integer] 
@@ -413,6 +421,7 @@ module Wx
     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::TREE_CTRL_NAME_STR) end
     
     # Deletes the specified item.
+    # 
     # A EVT_TREE_DELETE_ITEM event will be generated.
     # This function may cause a subsequent call to {Wx::TreeCtrl#get_next_child} to fail.
     # @param item [Wx::TreeItemId] 
@@ -420,11 +429,13 @@ module Wx
     def delete(item) end
     
     # Deletes all items in the control.
+    # 
     # This function generates {Wx::EVT_TREE_DELETE_ITEM} events for each item being deleted, including the root one if it is shown, i.e. unless {Wx::TR_HIDE_ROOT} style is used.
     # @return [void]
     def delete_all_items; end
     
     # Deletes all children of the given item (but not the item itself).
+    # 
     # A {Wx::EVT_TREE_DELETE_ITEM} event will be generated for every item being deleted.
     # If you have called {Wx::TreeCtrl#set_item_has_children}, you may need to call it again since {Wx::TreeCtrl#delete_children} does not automatically clear the setting.
     # @param item [Wx::TreeItemId] 
@@ -432,14 +443,21 @@ 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 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
     
     # Ends label editing.
+    # 
     # If cancelEdit is true, the edit will be cancelled.
-    # This function is currently supported under Windows only.
+    # 
+    # <div class="wxrb-note">
+    # <b>Note:</b>
+    # <p>This function is currently supported under Windows only.
+    # </p>
+    # </div>
     # @see Wx::TreeCtrl#edit_label 
     # @param item [Wx::TreeItemId] 
     # @param discardChanges [Boolean] 
@@ -447,6 +465,7 @@ module Wx
     def end_edit_label(item, discardChanges=false) end
     
     # Scrolls and/or expands items to ensure that the given item is visible.
+    # 
     # This method can be used, and will work, even while the window is frozen (see {Wx::Window#freeze}).
     # @param item [Wx::TreeItemId] 
     # @return [void]
@@ -467,6 +486,7 @@ module Wx
     def expand_all_children(item) end
     
     # Retrieves the rectangle bounding the item.
+    # 
     # If textOnly is true, only the rectangle around the item's label will be returned, otherwise the item's image is also taken into account.
     # The return value is true if the rectangle was successfully retrieved or <code></code> false if it was not (in this case rect is not changed)  for example, if the item is currently invisible.
     # 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.
@@ -478,6 +498,7 @@ module Wx
     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 [Boolean] 
@@ -491,8 +512,14 @@ module Wx
     alias_method :count, :get_count
     
     # 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 wxMSW.
+    # 
+    # <div class="wxrb-note">
+    # <b>Note:</b>
+    # <p>This is currently only implemented for WXMSW. 
+    # </p>
+    # </div>
     # @return [Wx::TextCtrl]
     def get_edit_control; end
     alias_method :edit_control, :get_edit_control
@@ -503,6 +530,7 @@ module Wx
     alias_method :first_visible_item, :get_first_visible_item
     
     # Returns the item last clicked or otherwise selected.
+    # 
     # Unlike {Wx::TreeCtrl#get_selection}, it can be used whether or not the control has the {Wx::TR_MULTIPLE} style.
     # @return [Wx::TreeItemId]
     def get_focused_item; end
@@ -524,6 +552,7 @@ module Wx
     alias_method :indent, :get_indent
     
     # Returns the current tree control spacing.
+    # 
     # This is the number of horizontal pixels between the buttons and the state images.
     # @return [Integer]
     def get_spacing; end
@@ -536,6 +565,7 @@ module Wx
     alias_method :item_background_colour, :get_item_background_colour
     
     # Returns the tree item data associated with the item.
+    # 
     # - GetPlData(item): returns the Perl data associated with the Wx::TreeItemData. It is just the same as tree->GetItemData(item)->GetData().
     # @see Wx::TreeItemData
     # @param item [Wx::TreeItemId] 
@@ -544,6 +574,7 @@ module Wx
     alias_method :item_data, :get_item_data
     
     # Returns the font of the item label.
+    # 
     # If the font hadn't been explicitly set for the specified item with {Wx::TreeCtrl#set_item_font}, returns an invalid {Wx::NULL_FONT} font. {Wx::TreeCtrl#get_font} can be used to retrieve the global tree control font used for the items without any specific font.
     # @param item [Wx::TreeItemId] 
     # @return [Wx::Font]
@@ -551,6 +582,7 @@ module Wx
     alias_method :item_font, :get_item_font
     
     # Gets the specified item image.
+    # 
     # The value of which may be:
     # 
     # - {Wx::TreeItemIcon::TreeItemIcon_Normal}: to get the normal item image.
@@ -589,6 +621,7 @@ module Wx
     
     # Returns the last child of the item (or an invalid tree item if this item has no children).
     # 
+    # 
     # @see Wx::TreeCtrl#get_first_child
     # @see  Wx::TreeCtrl#get_next_sibling
     # @see  Wx::TreeCtrl#get_last_child 
@@ -598,6 +631,7 @@ module Wx
     alias_method :last_child, :get_last_child
     
     # Returns the next sibling of the specified item; call {Wx::TreeCtrl#get_prev_sibling} for the previous sibling.
+    # 
     # Returns an invalid tree item if there are no further siblings.
     # @see Wx::TreeCtrl#get_prev_sibling 
     # @param item [Wx::TreeItemId] 
@@ -606,13 +640,19 @@ module Wx
     alias_method :next_sibling, :get_next_sibling
     
     # Returns the next visible item or an invalid item if this item is the last visible one.
-    # The item itself must be visible.
+    # 
+    # <div class="wxrb-note">
+    # <b>Note:</b>
+    # <p>The item itself must be visible. 
+    # </p>
+    # </div>
     # @param item [Wx::TreeItemId] 
     # @return [Wx::TreeItemId]
     def get_next_visible(item) end
     alias_method :next_visible, :get_next_visible
     
     # Returns the previous sibling of the specified item; call {Wx::TreeCtrl#get_next_sibling} for the next sibling.
+    # 
     # Returns an invalid tree item if there are no further children.
     # @see Wx::TreeCtrl#get_next_sibling 
     # @param item [Wx::TreeItemId] 
@@ -621,13 +661,19 @@ module Wx
     alias_method :prev_sibling, :get_prev_sibling
     
     # Returns the previous visible item or an invalid item if this item is the first visible one.
-    # The item itself must be visible.
+    # 
+    # <div class="wxrb-note">
+    # <b>Note:</b>
+    # <p>The item itself must be visible. 
+    # </p>
+    # </div>
     # @param item [Wx::TreeItemId] 
     # @return [Wx::TreeItemId]
     def get_prev_visible(item) end
     alias_method :prev_visible, :get_prev_visible
     
     # 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 [Boolean]
@@ -640,6 +686,7 @@ module Wx
     alias_method :root_item, :get_root_item
     
     # Returns the selection, or an invalid item if there is no selection.
+    # 
     # This function only works with the controls without {Wx::TR_MULTIPLE} style, use {Wx::TreeCtrl#get_selections} for the controls which do have this style or, if a single item is wanted, use {Wx::TreeCtrl#get_focused_item}.
     # @return [Wx::TreeItemId]
     def get_selection; end
@@ -651,6 +698,7 @@ module Wx
     alias_method :state_image_list, :get_state_image_list
     
     # 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.
@@ -669,6 +717,7 @@ module Wx
     def hit_test(point) end
     
     # Inserts an item after a given one (previous).
+    # 
     # The image and selImage parameters are an index within the normal image list specifying the image to use for unselected and selected items, respectively. If image > -1 and selImage is -1, the same image is used for both selected and unselected items.
     # @param parent [Wx::TreeItemId] 
     # @param previous [Wx::TreeItemId] 
@@ -681,6 +730,7 @@ module Wx
     
     # Returns true if the given item is in bold state.
     # 
+    # 
     # @see Wx::TreeCtrl#set_item_bold 
     # @param item [Wx::TreeItemId] 
     # @return [Boolean]
@@ -716,6 +766,7 @@ module Wx
     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.
+    # 
     # The function should return a negative, zero or positive value if the first item is less than, equal to or greater than the second one.
     # Please note that you <b>must</b> use {Wx::RTTI} macros {declare_dynamic_class} and {implement_dynamic_class} if you override this function because otherwise the base class considers that it is not overridden and uses the default comparison, i.e. sorts the items alphabetically, which allows it optimize away the calls to the virtual function completely.
     # @see Wx::TreeCtrl#sort_children 
@@ -725,6 +776,7 @@ module Wx
     def on_compare_items(item1, item2) end
     
     # Appends an item as the first child of parent, return a new item id.
+    # 
     # The image and selImage parameters are an index within the normal image list specifying the image to use for unselected and selected items, respectively. If image > -1 and selImage is -1, the same image is used for both selected and unselected items.
     # @param parent [Wx::TreeItemId] 
     # @param text [String] 
@@ -735,6 +787,7 @@ module Wx
     def prepend_item(parent, text, image=-1, selImage=-1, data=nil) end
     
     # Scrolls the specified item into view.
+    # 
     # Note that this method doesn't work while the window is frozen (See {Wx::Window#freeze}), at least under MSW.
     # @see Wx::TreeCtrl#ensure_visible 
     # @param item [Wx::TreeItemId] 
@@ -742,6 +795,7 @@ module Wx
     def scroll_to(item) end
     
     # Selects the given item.
+    # 
     # 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] 
@@ -756,7 +810,8 @@ 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 wxMSW.
+    # 
+    # 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
@@ -770,6 +825,7 @@ module Wx
     
     # Makes item appear in bold font if bold parameter is true or resets it to the normal state.
     # 
+    # 
     # @see Wx::TreeCtrl#is_bold 
     # @param item [Wx::TreeItemId] 
     # @param bold [Boolean] 
@@ -778,6 +834,7 @@ module Wx
     alias_method :item_bold=, :set_item_bold
     
     # Sets the item client data.
+    # 
     # Notice that the client data previously associated with the item (if any) is not freed by this function and so calling this function multiple times for the same item will result in memory leaks unless you delete the old item data pointer yourself.
     # @param item [Wx::TreeItemId] 
     # @param data [Object] 
@@ -792,6 +849,7 @@ module Wx
     alias_method :item_drop_highlight=, :set_item_drop_highlight
     
     # Sets the item's font.
+    # 
     # All items in the tree should have the same height to avoid text clipping, so the fonts height should be the same for all of them, although font attributes may vary.
     # @see Wx::TreeCtrl#set_item_bold 
     # @param item [Wx::TreeItemId] 
@@ -800,6 +858,7 @@ module Wx
     def set_item_font(item, font) end
     
     # 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 [Boolean] 
@@ -808,6 +867,7 @@ module Wx
     alias_method :item_has_children=, :set_item_has_children
     
     # Sets the specified item's image.
+    # 
     # See {Wx::TreeCtrl#get_item_image} for the description of the which parameter.
     # @param item [Wx::TreeItemId] 
     # @param image [Integer] 
@@ -816,6 +876,7 @@ module Wx
     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).
@@ -839,6 +900,7 @@ module Wx
     def set_item_text_colour(item, col) end
     
     # 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 [Boolean] 
@@ -847,6 +909,7 @@ module Wx
     alias_method :quick_best_size=, :set_quick_best_size
     
     # Sets the state image list (from which application-defined state images are taken).
+    # 
     # Image list assigned with this method will <b>not</b> be deleted by {Wx::TreeCtrl}'s destructor, you must delete it yourself.
     # @see Wx::TreeCtrl#assign_state_image_list. 
     # @param imageList [Wx::ImageList] 
@@ -855,14 +918,21 @@ module Wx
     alias_method :state_image_list=, :set_state_image_list
     
     # Sets the mode flags associated with the display of the tree control.
+    # 
     # The new mode takes effect immediately.
-    # Generic only; MSW ignores changes.
+    # 
+    # <div class="wxrb-note">
+    # <b>Note:</b>
+    # <p>Generic only; MSW ignores changes. 
+    # </p>
+    # </div>
     # @param styles [Integer] 
     # @return [void]
     def set_window_style(styles) end
     alias_method :window_style=, :set_window_style
     
     # Sorts the children of the given item using {Wx::TreeCtrl#on_compare_items}.
+    # 
     # You should override that method to change the sort order (the default is ascending case-sensitive alphabetical order).
     # @see Wx::TreeItemData
     # @see  Wx::TreeCtrl#on_compare_items 
@@ -876,6 +946,7 @@ module Wx
     def toggle(item) end
     
     # Toggles the given item between selected and unselected states.
+    # 
     # For multiselection controls only.
     # @param item [Wx::TreeItemId] 
     # @return [void]
@@ -890,12 +961,14 @@ module Wx
     def unselect_all; end
     
     # Unselects the given item.
+    # 
     # This works in multiselection controls only.
     # @param item [Wx::TreeItemId] 
     # @return [void]
     def unselect_item(item) end
     
     # Select all the immediate children of the given parent.
+    # 
     # This function can be used with multiselection controls only.
     # @param parent [Wx::TreeItemId] 
     # @return [void]

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

@@ -7,8 +7,9 @@
 module Wx
 
   # A tree event holds information about events associated with {Wx::TreeCtrl} objects.
+  # 
   # To process input from a tree control, use these event handler macros to direct input to member functions that take a {Wx::TreeEvent} argument.
-  # === Events using this class
+  # ### Events using this class
   # 
   # The following event-handler methods redirect the events to member method or handler blocks for {Wx::TreeEvent} events.
   # Event handler methods:
@@ -55,28 +56,29 @@ module Wx
   # 
   # - {Wx::EvtHandler#evt_tree_state_image_click}(id, meth = nil, &block): The state image has been clicked. 
   # 
-  # === 
-  # 
   # Category:  {Wx::Events}
   # @see Wx::TreeCtrl 
   # 
   # 
+  # @wxrb_require USE_TREECTRL
   class TreeEvent < NotifyEvent
   
     # Constructor, used by wxWidgets itself only.
-    # @param commandType [Wx::CommandLinkButton::EventType] 
+    # @param commandType [Wx::StaticLine::EventType] 
     # @param tree [Wx::TreeCtrl] 
     # @param item [Wx::TreeItemId] 
     # @return [Wx::TreeEvent]
     def initialize(commandType, tree, item=(Wx::TreeItemId.new())) end
     
     # Returns the item.
+    # 
     # Note that the item may be invalid for {Wx::EVT_TREE_SEL_CHANGED} events when the previously selected item has been deselected and there is no new selection any longer, as it notably happens when deleting all tree control items.
     # @return [Wx::TreeItemId]
     def get_item; end
     alias_method :item, :get_item
     
     # Returns the key code if the event is a key event.
+    # 
     # Use {Wx::TreeEvent#get_key_event} to get the values of the modifier keys for this event (i.e. Shift or Ctrl).
     # @return [Integer]
     def get_key_code; end
@@ -98,18 +100,21 @@ module Wx
     alias_method :old_item, :get_old_item
     
     # Returns the position of the mouse pointer if the event is a drag or menu-context event.
+    # 
     # In both cases the position is in client coordinates - i.e. relative to the {Wx::TreeCtrl} window (so that you can pass it directly to e.g. {Wx::Window#popup_menu}).
     # @return [Wx::Point]
     def get_point; end
     alias_method :point, :get_point
     
     # Returns true if the label edit was cancelled.
+    # 
     # This should be called from within an EVT_TREE_END_LABEL_EDIT handler.
     # @return [Boolean]
     def is_edit_cancelled; end
     alias_method :edit_cancelled?, :is_edit_cancelled
     
     # Set the tooltip for the item (valid for EVT_TREE_ITEM_GETTOOLTIP events).
+    # 
     # Windows only.
     # @param tooltip [String] 
     # @return [void]

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

@@ -23,10 +23,11 @@ module Wx
   EVT_TREEBOOK_NODE_EXPANDED = 10089
   
   # This class is an extension of the {Wx::Notebook} class that allows a tree structured set of pages to be shown in a control.
+  # 
   # A classic example is a netscape preferences dialog that shows a tree of preference sections on the left and select section page on the right.
   # To use the class simply create it and populate with pages using {Wx::Treebook#insert_page}, {Wx::Treebook#insert_sub_page}, {Wx::Treebook#add_page}, {Wx::Treebook#add_sub_page}.
   # If your tree is no more than 1 level in depth then you could simply use {Wx::Treebook#add_page} and {Wx::Treebook#add_sub_page} to sequentially populate your tree by adding at every step a page or a subpage to the end of the tree.
-  # === 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::BookCtrlEvent} events.
   # Event handler methods for events emitted by this class:
@@ -39,8 +40,6 @@ module Wx
   # 
   # - {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. 
   # 
-  # === 
-  # 
   # Category:  Book Controls
   # @see Wx::BookCtrl
   # @see  Wx::BookCtrlEvent
@@ -51,6 +50,7 @@ module Wx
   # @see  Notebook Sample 
   # 
   # 
+  # @wxrb_require USE_TREEBOOK
   class Treebook < BookCtrlBase
   
     # @overload initialize()
@@ -68,6 +68,7 @@ module Wx
     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] 
@@ -77,6 +78,7 @@ module Wx
     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] 
@@ -91,6 +93,7 @@ module Wx
     def collapse_node(pageId) end
     
     # Creates a treebook control.
+    # 
     # See {Wx::Treebook#initialize} for the description of the parameters.
     # @param parent [Wx::Window] 
     # @param id [Integer] 
@@ -102,12 +105,14 @@ module Wx
     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 [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 [Boolean] 
@@ -121,12 +126,18 @@ module Wx
     alias_method :page_parent, :get_page_parent
     
     # Returns the currently selected page, or {Wx::NOT_FOUND} if none was selected.
-    # This method may return either the previously or newly selected page when called from the EVT_TREEBOOK_PAGE_CHANGED() handler depending on the platform and so {Wx::BookCtrlEvent#get_selection} should be used instead in this case.
+    # 
+    # <div class="wxrb-note">
+    # <b>Note:</b>
+    # <p>This method may return either the previously or newly selected page when called from the EVT_TREEBOOK_PAGE_CHANGED() handler depending on the platform and so {Wx::BookCtrlEvent#get_selection} should be used instead in this case. 
+    # </p>
+    # </div>
     # @return [Integer]
     def get_selection; end
     alias_method :selection, :get_selection
     
     # Inserts a new page just before the page indicated by pagePos.
+    # 
     # The new page is placed before pagePos page and on the same level. NULL could be specified for page to create an empty page.
     # @param pagePos [Integer] 
     # @param page [Wx::Window] 
@@ -137,6 +148,7 @@ module Wx
     def insert_page(pagePos, page, text, bSelect=false, imageId=Wx::NOT_FOUND) end
     
     # Inserts a sub page under the specified page.
+    # 
     # NULL could be specified for page to create an empty page.
     # @param pagePos [Integer] 
     # @param page [Wx::Window] 

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

@@ -7,14 +7,19 @@
 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.
   # 
-  # ===
+  # <div class="wxrb-note">
+  # <b>Note:</b>
+  # <p>This class currently doesn't work when using Wayland with WXGTK.
+  # </p>
+  # </div>
   # 
   # 
   # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
+  # @wxrb_require USE_UIACTIONSIMULATOR
   class UIActionSimulator < ::Object
   
     # Default constructor.
@@ -62,6 +67,7 @@ module Wx
     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.
@@ -81,6 +87,7 @@ module Wx
     def char(keycode, modifiers=Wx::KeyModifier::MOD_NONE) end
     
     # Simulate selection of an item with the given text.
+    # 
     # This method selects an item in the currently focused {Wx::Choice}, {Wx::ComboBox}, {Wx::ListBox} and similar controls. It does it by simulating keyboard events, so the behaviour should be the same as if the item was really selected by the user.
     # Notice that the implementation of this method uses {yield} and so events can be dispatched from it.
     # 
@@ -90,6 +97,7 @@ module Wx
     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 [Boolean]