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

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

@@ -7,6 +7,7 @@
 module Wx
 
   # A menu is a popup (or pull down) list of items, one of which may be selected before the menu goes away (clicking elsewhere dismisses the menu).
+  # 
   # Menus may be used to construct either menu bars or popup menus.
   # A menu item has an integer ID associated with it which can be used to identify the selection, or to change the menu item in some way. A menu item with a special identifier {Wx::StandardID::ID_SEPARATOR} is a separator item and doesn't have an associated command but just makes a separator line appear in the menu.
   # 
@@ -42,6 +43,7 @@ module Wx
   class Menu < EvtHandler
   
     # Returns the list of items in the menu.
+    # 
     # {Wx::MenuItemList} is a pseudo-template list class containing {Wx::MenuItem} pointers, see {Wx::List}.
     # @return [Wx::MenuItemList]
     def get_menu_items; end
@@ -59,6 +61,7 @@ module Wx
     
     # @overload append(id, item=(''), helpString=(''), kind=Wx::ItemKind::ITEM_NORMAL)
     #   Adds a menu item.
+    #   
     #   Example: 
     #   ```ruby
     #     file_menu.append(ID_NEW_FILE, "&New file\tCTRL+N", "Creates a new XYZ document")
@@ -72,7 +75,7 @@ module Wx
     #   <b>Remark:</b>
     #   <p>This command can be used after the menu has been shown, as well as on initial creation of a menu or menubar.
     #   </p>
-    #   </div>>
+    #   </div>
     #   @see Wx::Menu#append_separator
     #   @see  Wx::Menu#append_check_item
     #   @see  Wx::Menu#append_radio_item
@@ -89,13 +92,14 @@ module Wx
     #   @return [Wx::MenuItem]
     # @overload append(menuItem)
     #   Adds a menu item object.
+    #   
     #   This is the most generic variant of {Wx::Menu#append} method because it may be used for both items (including separators) and submenus and because you can also specify various extra properties of a menu item this way, such as bitmaps and fonts.
     #   
     #   <div class="wxrb-remark">
     #   <b>Remark:</b>
     #   <p>See the remarks for the other {Wx::Menu#append} overloads.
     #   </p>
-    #   </div>>
+    #   </div>
     #   @see Wx::Menu#append_separator
     #   @see  Wx::Menu#append_check_item
     #   @see  Wx::Menu#append_radio_item
@@ -111,6 +115,7 @@ module Wx
     
     # Adds a checkable item to the end of the menu.
     # 
+    # 
     # @see Wx::Menu#append
     # @see  Wx::Menu#insert_check_item 
     # @param id [Integer] 
@@ -120,6 +125,7 @@ module Wx
     def append_check_item(id, item, help=('')) end
     
     # Adds a radio item to the end of the menu.
+    # 
     # All consequent radio items form a group and when an item in the group is checked, all the others are automatically unchecked.
     # 
     # <div class="wxrb-note">
@@ -137,12 +143,14 @@ module Wx
     
     # Adds a separator to the end of the menu.
     # 
+    # 
     # @see Wx::Menu#append
     # @see  Wx::Menu#insert_separator 
     # @return [Wx::MenuItem]
     def append_separator; end
     
     # Adds the given submenu to this menu.
+    # 
     # text is the text shown in the menu for it and help is the help string shown in the status bar when the submenu item is selected.
     # @see Wx::Menu#insert
     # @see  Wx::Menu#prepend 
@@ -153,12 +161,14 @@ module Wx
     def append_sub_menu(submenu, text, help=('')) end
     
     # Inserts a break in a menu, causing the next appended item to appear in a new column.
+    # 
     # This function only actually inserts a break in WXMSW and does nothing under the other platforms.
     # @return [void]
     def break_; end
     
     # Checks or unchecks the menu item.
     # 
+    # 
     # @see Wx::Menu#is_checked 
     # @param id [Integer]  The menu item identifier.
     # @param check [Boolean]  If true, the item will be checked, otherwise it will be unchecked.
@@ -167,6 +177,7 @@ module Wx
     
     # @overload delete(id)
     #   Deletes the menu item from the menu.
+    #   
     #   If the item is a submenu, it will <b>not</b> be deleted. Use {Wx::Menu#destroy} if you want to delete a submenu.
     #   @see Wx::Menu#find_item
     #   @see  Wx::Menu#destroy
@@ -175,6 +186,7 @@ module Wx
     #   @return [Boolean]
     # @overload delete(item)
     #   Deletes the menu item from the menu.
+    #   
     #   If the item is a submenu, it will <b>not</b> be deleted. Use {Wx::Menu#destroy} if you want to delete a submenu.
     #   @see Wx::Menu#find_item
     #   @see  Wx::Menu#destroy
@@ -185,6 +197,7 @@ module Wx
     
     # @overload destroy(id)
     #   Deletes the menu item from the menu.
+    #   
     #   If the item is a submenu, it will be deleted. Use {Wx::Menu#remove} if you want to keep the submenu (for example, to reuse it later).
     #   @see Wx::Menu#find_item
     #   @see  Wx::Menu#delete
@@ -193,6 +206,7 @@ module Wx
     #   @return [Boolean]
     # @overload destroy(item)
     #   Deletes the menu item from the menu.
+    #   
     #   If the item is a submenu, it will be deleted. Use {Wx::Menu#remove} if you want to keep the submenu (for example, to reuse it later).
     #   @see Wx::Menu#find_item
     #   @see  Wx::Menu#delete
@@ -203,6 +217,7 @@ module Wx
     
     # Enables or disables (greys out) a menu item.
     # 
+    # 
     # @see Wx::Menu#is_enabled 
     # @param id [Integer]  The menu item identifier.
     # @param enable [Boolean]  true to enable the menu item, false to disable it.
@@ -210,6 +225,7 @@ module Wx
     def enable(id, enable) end
     
     # Finds the menu item object associated with the given menu item identifier and, optionally, the position of the item in the menu.
+    # 
     # Unlike {Wx::Menu#find_item}, this function doesn't recurse but only looks at the direct children of this menu.
     # 
     # Menu item object or NULL if not found.
@@ -219,21 +235,22 @@ module Wx
     
     # @overload find_item(itemString)
     #   Finds the menu id for a menu item string.
+    #   
     #   Menu item identifier, or {Wx::NOT_FOUND} if none is found.
     #   
     #   <div class="wxrb-remark">
     #   <b>Remark:</b>
     #   <p>Any special menu codes are stripped out of source and target strings before matching. 
     #   </p>
-    #   </div>>
+    #   </div>
     #   @param itemString [String]  Menu item string to find.
     #   @return [Integer]
-    # @overload find_item(id, menu=nil)
+    # @overload find_item(id)
     #   Finds the menu item object associated with the given menu item identifier and, optionally, the (sub)menu it belongs to.
+    #   
     #   Menu item object or NULL if none is found.
     #   @param id [Integer]  Menu item identifier.
-    #   @param menu [Wx::Menu]  If the pointer is not NULL, it will be filled with the item's parent menu (if the item was found)
-    #   @return [Wx::MenuItem]
+    #   @return [Array(Wx::MenuItem,Wx::Menu)]
     def find_item(*args) end
     
     # Returns the {Wx::MenuItem} given a position in the menu.
@@ -242,6 +259,7 @@ module Wx
     def find_item_by_position(position) end
     
     # Returns the help string associated with a menu item.
+    # 
     # The help string, or the empty string if there is no help string or the item was not found.
     # @see Wx::Menu#set_help_string
     # @see  Wx::Menu#append 
@@ -251,6 +269,7 @@ module Wx
     alias_method :help_string, :get_help_string
     
     # Returns a menu item label.
+    # 
     # The item label, or the empty string if the item was not found.
     # @see Wx::Menu#get_label_text
     # @see  Wx::Menu#set_label 
@@ -260,6 +279,7 @@ module Wx
     alias_method :label, :get_label
     
     # Returns a menu item label, without any of the original mnemonics and accelerators.
+    # 
     # The item label, or the empty string if the item was not found.
     # @see Wx::Menu#get_label
     # @see  Wx::Menu#set_label 
@@ -275,6 +295,7 @@ module Wx
     
     # Returns the title of the menu.
     # 
+    # 
     # @see Wx::Menu#set_title 
     # @return [Wx::String]
     def get_title; end
@@ -282,6 +303,7 @@ module Wx
     
     # @overload insert(pos, menuItem)
     #   Inserts the given item before the position pos.
+    #   
     #   Inserting the item at position {Wx::Menu#get_menu_item_count} is the same as appending it.
     #   @see Wx::Menu#append
     #   @see  Wx::Menu#prepend 
@@ -290,6 +312,7 @@ module Wx
     #   @return [Wx::MenuItem]
     # @overload insert(pos, id, item=(''), helpString=(''), kind=Wx::ItemKind::ITEM_NORMAL)
     #   Inserts the given item before the position pos.
+    #   
     #   Inserting the item at position {Wx::Menu#get_menu_item_count} is the same as appending it.
     #   @see Wx::Menu#append
     #   @see  Wx::Menu#prepend 
@@ -301,6 +324,7 @@ module Wx
     #   @return [Wx::MenuItem]
     # @overload insert(pos, id, text, submenu, help=(''))
     #   Inserts the given submenu before the position pos.
+    #   
     #   text is the text shown in the menu for it and help is the help string shown in the status bar when the submenu item is selected.
     #   @see Wx::Menu#append_sub_menu
     #   @see  Wx::Menu#prepend 
@@ -314,6 +338,7 @@ module Wx
     
     # Inserts a checkable item at the given position.
     # 
+    # 
     # @see Wx::Menu#insert
     # @see  Wx::Menu#append_check_item 
     # @param pos [Integer] 
@@ -325,6 +350,7 @@ module Wx
     
     # Inserts a radio item at the given position.
     # 
+    # 
     # @see Wx::Menu#insert
     # @see  Wx::Menu#append_radio_item 
     # @param pos [Integer] 
@@ -336,6 +362,7 @@ module Wx
     
     # Inserts a separator at the given position.
     # 
+    # 
     # @see Wx::Menu#insert
     # @see  Wx::Menu#append_separator 
     # @param pos [Integer] 
@@ -343,6 +370,7 @@ module Wx
     def insert_separator(pos) end
     
     # Determines whether a menu item is checked.
+    # 
     # true if the menu item is checked, false otherwise.
     # @see Wx::Menu#check 
     # @param id [Integer]  The menu item identifier.
@@ -351,6 +379,7 @@ module Wx
     alias_method :checked?, :is_checked
     
     # Determines whether a menu item is enabled.
+    # 
     # true if the menu item is enabled, false otherwise.
     # @see Wx::Menu#enable 
     # @param id [Integer]  The menu item identifier.
@@ -361,6 +390,7 @@ module Wx
     # @overload prepend(item)
     #   Inserts the given item at position 0, i.e. before all the other existing items.
     #   
+    #   
     #   @see Wx::Menu#append
     #   @see  Wx::Menu#insert 
     #   @param item [Wx::MenuItem] 
@@ -368,6 +398,7 @@ module Wx
     # @overload prepend(id, item=(''), helpString=(''), kind=Wx::ItemKind::ITEM_NORMAL)
     #   Inserts the given item at position 0, i.e. before all the other existing items.
     #   
+    #   
     #   @see Wx::Menu#append
     #   @see  Wx::Menu#insert 
     #   @param id [Integer] 
@@ -378,6 +409,7 @@ module Wx
     # @overload prepend(id, text, submenu, help=(''))
     #   Inserts the given submenu at position 0.
     #   
+    #   
     #   @see Wx::Menu#append_sub_menu
     #   @see  Wx::Menu#insert 
     #   @param id [Integer] 
@@ -389,6 +421,7 @@ module Wx
     
     # Inserts a checkable item at position 0.
     # 
+    # 
     # @see Wx::Menu#prepend
     # @see  Wx::Menu#append_check_item 
     # @param id [Integer] 
@@ -399,6 +432,7 @@ module Wx
     
     # Inserts a radio item at position 0.
     # 
+    # 
     # @see Wx::Menu#prepend
     # @see  Wx::Menu#append_radio_item 
     # @param id [Integer] 
@@ -409,6 +443,7 @@ module Wx
     
     # Inserts a separator at position 0.
     # 
+    # 
     # @see Wx::Menu#prepend
     # @see  Wx::Menu#append_separator 
     # @return [Wx::MenuItem]
@@ -416,6 +451,7 @@ module Wx
     
     # @overload remove(id)
     #   Removes the menu item from the menu but doesn't delete the associated C++ object.
+    #   
     #   This allows you to reuse the same item later by adding it back to the menu (especially useful with submenus).
     #   
     #   A pointer to the item which was detached from the menu.
@@ -423,6 +459,7 @@ module Wx
     #   @return [Wx::MenuItem]
     # @overload remove(item)
     #   Removes the menu item from the menu but doesn't delete the associated C++ object.
+    #   
     #   This allows you to reuse the same item later by adding it back to the menu (especially useful with submenus).
     #   
     #   A pointer to the item which was detached from the menu.
@@ -432,6 +469,7 @@ module Wx
     
     # Sets an item's help string.
     # 
+    # 
     # @see Wx::Menu#get_help_string 
     # @param id [Integer]  The menu item identifier.
     # @param helpString [String]  The help string to set.
@@ -440,6 +478,7 @@ module Wx
     
     # Sets the label of a menu item.
     # 
+    # 
     # @see Wx::Menu#append
     # @see  Wx::Menu#get_label 
     # @param id [Integer]  The menu item identifier.
@@ -448,11 +487,12 @@ module Wx
     def set_label(id, label) end
     
     # Sets the title of the menu.
+    # 
     # <div class="wxrb-remark">
     # <b>Remark:</b>
     # <p>Notice that you can only call this method directly for the popup menus, to change the title of a menu that is part of a menu bar you need to use {Wx::MenuBar#set_label_top}.
     # </p>
-    # </div>>
+    # </div>
     # @see Wx::Menu#get_title 
     # @param title [String]  The title to set.
     # @return [void]
@@ -460,6 +500,7 @@ module Wx
     alias_method :title=, :set_title
     
     # Update the state of all menu items, recursively, by generating {Wx::EVT_UPDATE_UI} events for them.
+    # 
     # This is an internal wxWidgets function and shouldn't normally be called from outside of the library. If it is called, source argument should not be used, it is deprecated and exists only for backwards compatibility.
     # @param source [Wx::EvtHandler] 
     # @return [void]

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

@@ -7,11 +7,12 @@
 module Wx
 
   # A menu bar is a series of menus accessible from the top of a frame.
+  # 
   # <div class="wxrb-remark">
   # <b>Remark:</b>
   # <p>To respond to a menu selection, provide a handler for EVT_MENU, in the frame that contains the menu bar.
   # </p>
-  # </div>>
+  # </div>
   # 
   # If you have a toolbar which uses the same identifiers as your EVT_MENU entries, events from the toolbar will also be processed by your EVT_MENU event handlers.
   # Tip: under Windows, if you discover that menu shortcuts (for example, Alt-F to show the file menu) are not working, check any EVT_CHAR events you are handling in child windows. If you are not calling event.Skip() for events that you don't process in these event handlers, menu shortcuts may cease to work.
@@ -30,6 +31,7 @@ module Wx
     def initialize(style=0) end
     
     # Adds the item to the end of the menu bar.
+    # 
     # true on success, false if an error occurred.
     # @see Wx::MenuBar#insert 
     # @param menu [Wx::Menu]  The menu to add. Do not deallocate this menu after calling {Wx::MenuBar#append}.
@@ -38,22 +40,24 @@ module Wx
     def append(menu, title) end
     
     # Checks or unchecks a menu item.
+    # 
     # <div class="wxrb-remark">
     # <b>Remark:</b>
     # <p>Only use this when the menu bar has been associated with a frame; otherwise, use the {Wx::Menu} equivalent call. 
     # </p>
-    # </div>>
+    # </div>
     # @param id [Integer]  The menu item identifier.
     # @param check [Boolean]  If true, checks the menu item, otherwise the item is unchecked.
     # @return [void]
     def check(id, check) end
     
     # Enables or disables (greys out) a menu item.
+    # 
     # <div class="wxrb-remark">
     # <b>Remark:</b>
     # <p>Only use this when the menu bar has been associated with a frame; otherwise, use the {Wx::Menu} equivalent call. 
     # </p>
-    # </div>>
+    # </div>
     # @param id [Integer]  The menu item identifier.
     # @param enable [Boolean]  true to enable the item, false to disable it.
     # @return [void]
@@ -66,43 +70,47 @@ module Wx
     alias_method :enabled_top?, :is_enabled_top
     
     # Enables or disables a whole menu.
+    # 
     # <div class="wxrb-remark">
     # <b>Remark:</b>
     # <p>Only use this when the menu bar has been associated with a frame. 
     # </p>
-    # </div>>
+    # </div>
     # @param pos [Integer]  The position of the menu, starting from zero.
     # @param enable [Boolean]  true to enable the menu, false to disable it.
     # @return [void]
     def enable_top(pos, enable) end
     
     # Finds the menu item object associated with the given menu item identifier.
+    # 
     # The found menu item object, or NULL if one was not found.
     # @param id [Integer]  Menu item identifier.
-    # @param menu [Wx::Menu]  If not NULL, menu will get set to the associated menu.
-    # @return [Wx::MenuItem]
-    def find_item(id, menu=nil) end
+    # @return [Array(Wx::MenuItem,Wx::Menu)]
+    def find_item(id) end
     
     # Returns the index of the menu with the given title or {Wx::NOT_FOUND} if no such menu exists in this menubar.
+    # 
     # The title parameter may specify either the menu title (with accelerator characters, i.e. <code>"&File"</code>) or just the menu label (<code>"File"</code>) indifferently.
     # @param title [String] 
     # @return [Integer]
     def find_menu(title) end
     
     # Finds the menu item id for a menu name/menu item string pair.
+    # 
     # The menu item identifier, or {Wx::NOT_FOUND} if none was found.
     # 
     # <div class="wxrb-remark">
     # <b>Remark:</b>
     # <p>Any special menu codes are stripped out of source and target strings before matching. 
     # </p>
-    # </div>>
+    # </div>
     # @param menuString [String]  Menu title to find.
     # @param itemString [String]  Item to find.
     # @return [Integer]
     def find_menu_item(menuString, itemString) end
     
     # Gets the help string associated with the menu item identifier.
+    # 
     # The help string, or the empty string if there was no help string or the menu item was not found.
     # @see Wx::MenuBar#set_help_string 
     # @param id [Integer]  The menu item identifier.
@@ -111,13 +119,14 @@ module Wx
     alias_method :help_string, :get_help_string
     
     # Gets the label associated with a menu item.
+    # 
     # The menu item label, or the empty string if the item was not found.
     # 
     # <div class="wxrb-remark">
     # <b>Remark:</b>
     # <p>Use only after the menubar has been associated with a frame. 
     # </p>
-    # </div>>
+    # </div>
     # @param id [Integer]  The menu item identifier.
     # @return [String]
     def get_label(id) end
@@ -135,6 +144,7 @@ module Wx
     alias_method :menu_count, :get_menu_count
     
     # Returns the label of a top-level menu.
+    # 
     # Note that the returned string includes the accelerator characters that have been specified in the menu title string during its construction.
     # 
     # The menu label, or the empty string if the menu was not found.
@@ -143,7 +153,7 @@ module Wx
     # <b>Remark:</b>
     # <p>Use only after the menubar has been associated with a frame.
     # </p>
-    # </div>>
+    # </div>
     # @see Wx::MenuBar#get_menu_label_text
     # @see  Wx::MenuBar#set_menu_label 
     # @param pos [Integer]  Position of the menu on the menu bar, starting from zero.
@@ -152,6 +162,7 @@ module Wx
     alias_method :menu_label, :get_menu_label
     
     # Returns the label of a top-level menu.
+    # 
     # Note that the returned string does not include any accelerator characters that may have been specified in the menu title string during its construction.
     # 
     # The menu label, or the empty string if the menu was not found.
@@ -160,7 +171,7 @@ module Wx
     # <b>Remark:</b>
     # <p>Use only after the menubar has been associated with a frame.
     # </p>
-    # </div>>
+    # </div>
     # @see Wx::MenuBar#get_menu_label
     # @see  Wx::MenuBar#set_menu_label 
     # @param pos [Integer]  Position of the menu on the menu bar, starting from zero.
@@ -169,6 +180,7 @@ module Wx
     alias_method :menu_label_text, :get_menu_label_text
     
     # Inserts the menu at the given position into the menu bar.
+    # 
     # Inserting menu at position 0 will insert it in the very beginning of it, inserting at position {Wx::MenuBar#get_menu_count} is the same as calling {Wx::MenuBar#append}.
     # 
     # true on success, false if an error occurred.
@@ -180,6 +192,7 @@ module Wx
     def insert(pos, menu, title) end
     
     # Determines whether an item is checked.
+    # 
     # true if the item was found and is checked, false otherwise.
     # @param id [Integer]  The menu item identifier.
     # @return [Boolean]
@@ -187,6 +200,7 @@ module Wx
     alias_method :checked?, :is_checked
     
     # Determines whether an item is enabled.
+    # 
     # true if the item was found and is enabled, false otherwise.
     # @param id [Integer]  The menu item identifier.
     # @return [Boolean]
@@ -194,6 +208,7 @@ module Wx
     alias_method :enabled?, :is_enabled
     
     # Removes the menu from the menu bar and returns the menu object - the caller is responsible for deleting it.
+    # 
     # This function may be used together with {Wx::MenuBar#insert} to change the menubar dynamically.
     # @see Wx::MenuBar#replace 
     # @param pos [Integer] 
@@ -201,6 +216,7 @@ module Wx
     def remove(pos) end
     
     # Replaces the menu at the given position with another one.
+    # 
     # The menu which was previously at position pos. The caller is responsible for deleting it.
     # @see Wx::MenuBar#insert
     # @see  Wx::MenuBar#remove 
@@ -212,6 +228,7 @@ module Wx
     
     # Sets the help string associated with a menu item.
     # 
+    # 
     # @see Wx::MenuBar#get_help_string 
     # @param id [Integer]  Menu item identifier.
     # @param helpString [String]  Help string to associate with the menu item.
@@ -219,11 +236,12 @@ module Wx
     def set_help_string(id, helpString) end
     
     # Sets the label of a menu item.
+    # 
     # <div class="wxrb-remark">
     # <b>Remark:</b>
     # <p>Use only after the menubar has been associated with a frame.
     # </p>
-    # </div>>
+    # </div>
     # @see Wx::MenuBar#get_label 
     # @param id [Integer]  Menu item identifier.
     # @param label [String]  Menu item label.
@@ -231,11 +249,12 @@ module Wx
     def set_label(id, label) end
     
     # Sets the label of a top-level menu.
+    # 
     # <div class="wxrb-remark">
     # <b>Remark:</b>
     # <p>Use only after the menubar has been associated with a frame. 
     # </p>
-    # </div>>
+    # </div>
     # @param pos [Integer]  The position of a menu on the menu bar, starting from zero.
     # @param label [String]  The menu label.
     # @return [void]