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

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

@@ -58,6 +58,7 @@ module Wx
   FULLSCREEN_ALL = 31
   
   # {Wx::TopLevelWindow} is a common base class for {Wx::Dialog} and {Wx::Frame}.
+  # 
   # It is an abstract base class meaning that you never work with objects of this class directly, but all of its methods are also applicable for the two classes above.
   # Note that the instances of {Wx::TopLevelWindow} are managed by wxWidgets in the internal top level window list.
   # ### Events emitted by this class
@@ -111,6 +112,7 @@ module Wx
     
     # Returns true if the platform supports making the window translucent.
     # 
+    # 
     # @see Wx::TopLevelWindow#set_transparent 
     # @return [Boolean]
     def can_set_transparent; end
@@ -123,18 +125,21 @@ module Wx
     
     # Centres the window on screen.
     # 
+    # 
     # @see Wx::Window#centre_on_parent 
     # @param direction [Integer]  Specifies the direction for the centering. May be {Wx::Orientation::HORIZONTAL}, {Wx::Orientation::VERTICAL} or {Wx::Orientation::BOTH}.
     # @return [void]
     def centre_on_screen(direction=Wx::Orientation::BOTH) end
     
     # Enables or disables the Close button (most often in the right upper corner of a dialog) and the Close entry of the system menu (most often in the left upper corner of the dialog).
+    # 
     # Returns true if operation was successful. This may be wrong on X11 (including GTK+) where the window manager may not support this operation and there is no way to find out.
     # @param enable [Boolean] 
     # @return [Boolean]
     def enable_close_button(enable=true) end
     
     # Enables or disables the Maximize button (in the right or left upper corner of a frame or dialog).
+    # 
     # Currently only implemented for WXMSW and WXOSX.
     # The window style must contain {Wx::MAXIMIZE_BOX}.
     # Returns true if operation was successful. Note that a successful operation does not change the window style flags.
@@ -143,6 +148,7 @@ module Wx
     def enable_maximize_button(enable=true) end
     
     # Enables or disables the Minimize button (in the right or left upper corner of a frame or dialog).
+    # 
     # Currently only implemented for WXMSW and WXOSX.
     # The window style must contain {Wx::MINIMIZE_BOX}.
     # Note that in WXMSW a successful operation will change the window style flags.
@@ -152,12 +158,14 @@ module Wx
     def enable_minimize_button(enable=true) end
     
     # Returns a pointer to the button which is the default for this window, or NULL.
+    # 
     # The default button is the one activated by pressing the Enter key.
     # @return [Wx::Window]
     def get_default_item; end
     alias_method :default_item, :get_default_item
     
     # Returns the standard icon of the window.
+    # 
     # The icon will be invalid if it hadn't been previously set by {Wx::TopLevelWindow#set_icon}.
     # @see Wx::TopLevelWindow#get_icons 
     # @return [Wx::Icon]
@@ -165,6 +173,7 @@ module Wx
     alias_method :icon, :get_icon
     
     # Returns all icons associated with the window, there will be none of them if neither {Wx::TopLevelWindow#set_icon} nor {Wx::TopLevelWindow#set_icons} had been called before.
+    # 
     # Use {Wx::TopLevelWindow#get_icon} to get the main icon of the window.
     # @see Wx::IconBundle 
     # @return [Wx::IconBundle]
@@ -173,12 +182,14 @@ module Wx
     
     # Gets a string containing the window title.
     # 
+    # 
     # @see Wx::TopLevelWindow#set_title 
     # @return [String]
     def get_title; end
     alias_method :title, :get_title
     
     # Iconizes or restores the window.
+    # 
     # Note that in WXGTK the change to the window state is not immediate, i.e. {Wx::TopLevelWindow#is_iconized} will typically return false right after a call to {Wx::TopLevelWindow#iconize} and its return value will only change after the control flow returns to the event loop and the notification about the window being really iconized is received.
     # @see Wx::TopLevelWindow#is_iconized
     # @see  Wx::TopLevelWindow#restore
@@ -199,6 +210,7 @@ module Wx
     
     # Returns true if the window is in fullscreen mode.
     # 
+    # 
     # @see Wx::TopLevelWindow#show_full_screen 
     # @return [Boolean]
     def is_full_screen; end
@@ -215,6 +227,7 @@ module Wx
     alias_method :maximized?, :is_maximized
     
     # Lays out the children using the window sizer or resizes the only child of the window to cover its entire area.
+    # 
     # This class overrides the base class {Wx::TopLevelWindow#layout} method to check if this window contains exactly one child  which is commonly the case, with {Wx::Panel} being often created as the only child of {Wx::TopLevelWindow}  and, if this is the case, resizes this child window to cover the entire client area.
     # Note that if you associate a sizer with this window, the sizer takes precedence and the only-child-resizing is only used as fallback.
     # false if nothing was done because the window has neither a sizer nor a single child, true otherwise.
@@ -222,6 +235,7 @@ module Wx
     def layout; end
     
     # Maximizes or restores the window.
+    # 
     # Note that, just as with {Wx::TopLevelWindow#iconize}, the change to the window state is not immediate in at least WXGTK port.
     # @see Wx::TopLevelWindow#restore
     # @see  Wx::TopLevelWindow#iconize 
@@ -230,6 +244,7 @@ module Wx
     def maximize(maximize=true) end
     
     # MSW-specific function for accessing the system menu.
+    # 
     # Returns a {Wx::Menu} pointer representing the system menu of the window under MSW. The returned {Wx::Menu} may be used, if non-NULL, to add extra items to the system menu. The usual {Wx::EVT_MENU} events (that can be processed using EVT_MENU event table macro) will then be generated for them. All the other {Wx::Menu} methods may be used as well but notice that they won't allow you to access any standard system menu items (e.g. they can't be deleted or modified in any way currently).
     # Notice that because of the native system limitations the identifiers of the items added to the system menu must be multiples of 16, otherwise no events will be generated for them.
     # The returned pointer must not be deleted, it is owned by the window and will be only deleted when the window itself is destroyed.
@@ -243,6 +258,7 @@ module Wx
     def msw_get_system_menu; end
     
     # Use a system-dependent way to attract users attention to the window when it is in background.
+    # 
     # flags may have the value of either {Wx::USER_ATTENTION_INFO} (default) or {Wx::USER_ATTENTION_ERROR} which results in a more drastic action. When in doubt, use the default value.
     # 
     # <div class="wxrb-note">
@@ -257,6 +273,7 @@ module Wx
     def request_user_attention(flags=Wx::USER_ATTENTION_INFO) end
     
     # Restore a previously iconized or maximized window to its normal state.
+    # 
     # In WXGTK this method currently doesn't return the maximized window to its normal state and you must use {Wx::TopLevelWindow#maximize} with false argument explicitly for this. In the other ports, it both unmaximizes the maximized windows and uniconizes the iconized ones.
     # @see Wx::TopLevelWindow#iconize
     # @see  Wx::TopLevelWindow#maximize 
@@ -265,6 +282,7 @@ module Wx
     
     # Changes the default item for the panel, usually win is a button.
     # 
+    # 
     # @see Wx::TopLevelWindow#get_default_item 
     # @param win [Wx::Window] 
     # @return [Wx::Window]
@@ -281,11 +299,12 @@ module Wx
     alias_method :tmp_default_item, :get_tmp_default_item
     
     # Sets the icon for this window.
+    # 
     # <div class="wxrb-remark">
     # <b>Remark:</b>
     # <p>The window takes a 'copy' of icon, but since it uses reference counting, the copy is very quick. It is safe to delete icon after calling this function.
     # </p>
-    # </div>>
+    # </div>
     # 
     # <div class="wxrb-note">
     # <b>Note:</b>
@@ -300,6 +319,7 @@ module Wx
     alias_method :icon=, :set_icon
     
     # Sets several icons of different sizes for this window: this allows using different icons for different situations (e.g.
+    # 
     # task switching bar, taskbar, window title bar) instead of scaling, with possibly bad looking results, the only icon set by {Wx::TopLevelWindow#set_icon}.
     # 
     # <div class="wxrb-note">
@@ -327,13 +347,14 @@ module Wx
     
     # @overload set_size_hints(minW, minH, maxW=-1, maxH=-1, incW=-1, incH=-1)
     #   Allows specification of minimum and maximum window sizes, and window size increments.
+    #   
     #   If a pair of values is not set (or set to -1), no constraints will be used.
     #   
     #   <div class="wxrb-remark">
     #   <b>Remark:</b>
     #   <p>Notice that this function not only prevents the user from resizing the window outside the given bounds but it also prevents the program itself from doing it using {Wx::Window#set_size}. 
     #   </p>
-    #   </div>>
+    #   </div>
     #   @param minW [Integer]  The minimum width.
     #   @param minH [Integer]  The minimum height.
     #   @param maxW [Integer]  The maximum width.
@@ -343,13 +364,14 @@ module Wx
     #   @return [void]
     # @overload set_size_hints(minSize, maxSize=Wx::DEFAULT_SIZE, incSize=Wx::DEFAULT_SIZE)
     #   Allows specification of minimum and maximum window sizes, and window size increments.
+    #   
     #   If a pair of values is not set (or set to -1), no constraints will be used.
     #   
     #   <div class="wxrb-remark">
     #   <b>Remark:</b>
     #   <p>Notice that this function not only prevents the user from resizing the window outside the given bounds but it also prevents the program itself from doing it using {Wx::Window#set_size}. 
     #   </p>
-    #   </div>>
+    #   </div>
     #   @param minSize [Array(Integer, Integer), Wx::Size]  The minimum size of the window.
     #   @param maxSize [Array(Integer, Integer), Wx::Size]  The maximum size of the window.
     #   @param incSize [Array(Integer, Integer), Wx::Size]  Increment size (only taken into account under X11-based ports such as WXGTK/{Wx::Motif}/WXX11).
@@ -359,6 +381,7 @@ module Wx
     
     # Sets the window title.
     # 
+    # 
     # @see Wx::TopLevelWindow#get_title 
     # @param title [String]  The window title.
     # @return [void]
@@ -366,6 +389,7 @@ module Wx
     alias_method :title=, :set_title
     
     # If the platform supports it will set the window to be translucent.
+    # 
     # Note that in WXGTK this function must be called before the window is shown the first time it's called (but it can be called again after showing the window too).
     # See the shaped sample for an example of using this function.
     # @param alpha [Integer]  Determines how opaque or transparent the window will be, if the platform supports the operation. A value of 0 sets the window to be fully transparent, and a value of 255 sets the window to be fully opaque.
@@ -374,11 +398,13 @@ module Wx
     alias_method :transparent=, :set_transparent
     
     # This virtual function is not meant to be called directly but can be overridden to return false (it returns true by default) to allow the application to close even if this, presumably not very important, window is still opened.
+    # 
     # By default, the application stays alive as long as there are any open top level windows.
     # @return [Boolean]
     def should_prevent_app_exit; end
     
     # Sets the file name represented by this {Wx::TopLevelWindow}.
+    # 
     # Under macOS, this file name is used to set the "proxy icon", which appears in the window title bar near its title, corresponding to this file name. Under other platforms it currently doesn't do anything but it is harmless to call it now and it might be implemented to do something useful in the future so you're encouraged to use it for any window representing a file-based document.
     # @param filename [String] 
     # @return [void]
@@ -386,11 +412,13 @@ module Wx
     alias_method :represented_filename=, :set_represented_filename
     
     # Show the {Wx::TopLevelWindow}, but do not give it keyboard focus.
+    # 
     # This can be used for pop up or notification windows that should not steal the current focus.
     # @return [void]
     def show_without_activating; end
     
     # Depending on the value of show parameter the window is either shown full screen or restored to its normal state.
+    # 
     # style is a bit list containing some or all of the following values, which indicate what elements of the window to hide in full-screen mode:
     # 
     # - {Wx::FULLSCREEN_NOMENUBAR} 
@@ -416,12 +444,14 @@ module Wx
     
     # Get the current content protection of the window.
     # 
+    # 
     # @see Wx::TopLevelWindow#set_content_protection
     # @return [Wx::ContentProtection]
     def get_content_protection; end
     alias_method :content_protection, :get_content_protection
     
     # Set content protection for the window.
+    # 
     # When content protection is enabled contents of this window will not be included in screen captures.
     # Obviously this can't provide absolute security as there might be workarounds and tools that bypass this protection. Additionally a screen could always be photographed.
     # true if the content protection was changed, false if running under an unsupported OS.
@@ -441,6 +471,7 @@ module Wx
     alias_method :content_protection=, :set_content_protection
     
     # Get the default size for a new top level window.
+    # 
     # This is used internally by wxWidgets on some platforms to determine the default size for a window created using {Wx::DEFAULT_SIZE} so it is not necessary to use it when creating a {Wx::TopLevelWindow}, however it may be useful if a rough estimation of the window size is needed for some other reason.
     # @return [Wx::Size]
     def self.get_default_size; end

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

@@ -230,6 +230,7 @@ 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}.
   # 
@@ -347,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.
@@ -360,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] 
@@ -369,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] 
@@ -385,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]
@@ -402,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] 
@@ -414,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] 
@@ -421,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] 
@@ -433,12 +443,14 @@ 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.
     # @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.
     # 
     # <div class="wxrb-note">
@@ -453,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]
@@ -473,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.
@@ -484,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] 
@@ -497,6 +512,7 @@ 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.
     # 
     # <div class="wxrb-note">
@@ -514,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
@@ -535,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
@@ -547,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] 
@@ -555,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]
@@ -562,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.
@@ -600,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 
@@ -609,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] 
@@ -617,6 +640,7 @@ 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.
+    # 
     # <div class="wxrb-note">
     # <b>Note:</b>
     # <p>The item itself must be visible. 
@@ -628,6 +652,7 @@ module Wx
     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] 
@@ -636,6 +661,7 @@ 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.
+    # 
     # <div class="wxrb-note">
     # <b>Note:</b>
     # <p>The item itself must be visible. 
@@ -647,6 +673,7 @@ module Wx
     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]
@@ -659,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
@@ -670,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.
@@ -688,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] 
@@ -700,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]
@@ -735,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 
@@ -744,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] 
@@ -754,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] 
@@ -761,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] 
@@ -775,6 +810,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 WXMSW.
     # @param spacing [Integer] 
     # @return [void]
@@ -789,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] 
@@ -797,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] 
@@ -811,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] 
@@ -819,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] 
@@ -827,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] 
@@ -835,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).
@@ -858,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] 
@@ -866,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] 
@@ -874,6 +918,7 @@ 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.
     # 
     # <div class="wxrb-note">
@@ -887,6 +932,7 @@ module Wx
     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 
@@ -900,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]
@@ -914,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,6 +7,7 @@
 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
   # 
@@ -63,19 +64,21 @@ module Wx
   class TreeEvent < NotifyEvent
   
     # Constructor, used by wxWidgets itself only.
-    # @param commandType [Wx::Slider::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
@@ -97,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]