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

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

@@ -13,11 +13,17 @@ module Wx
   # 
   # The following event-handler methods redirect the events to member method or handler blocks for {Wx::MenuEvent} events.
   # Event handler methods for events emitted by this class:
+  # 
   # - {Wx::EvtHandler#evt_menu}(id, meth = nil, &block): Process a {Wx::EVT_MENU} command, which is generated by a menu item. This type of event is sent as {Wx::CommandEvent}. 
+  # 
   # - {Wx::EvtHandler#evt_menu_range}(id1,  id2, meth = nil, &block): Process a {Wx::EVT_MENU} command, which is generated by a range of menu items. This type of event is sent as {Wx::CommandEvent}. 
+  # 
   # - {Wx::EvtHandler#evt_menu_open}(meth = nil, &block): A menu is about to be opened. On Windows, this is only sent once for each navigation of the menubar (up until all menus have closed). This type of event is sent as {Wx::MenuEvent}. 
+  # 
   # - {Wx::EvtHandler#evt_menu_close}(meth = nil, &block): A menu has been just closed. This type of event is sent as {Wx::MenuEvent}. 
+  # 
   # - {Wx::EvtHandler#evt_menu_highlight}(id, meth = nil, &block): The menu item with the specified id has been highlighted. If the id is {Wx::StandardID::ID_NONE}, highlighting has been removed from the previously highlighted menu item and there is no highlighted item any more. This is used by {Wx::Frame} to show help prompts in the status bar. This type of event is sent as {Wx::MenuEvent}. 
+  # 
   # - {Wx::EvtHandler#evt_menu_highlight_all}(meth = nil, &block): A menu item has been highlighted, i.e. the currently selected menu item has changed. This type of event is sent as {Wx::MenuEvent}. 
   # 
   # === 
@@ -30,7 +36,7 @@ module Wx
   class MenuItem < Object
   
     # Returns the background colour associated with the menu item.
-    # Availability:  only available for the {Wx::MSW} port.  {Wx::msw}
+    # Availability:  only available for the wxMSW port.  {Wx::msw}
     # @return [Wx::Colour]
     def get_background_colour; end
     alias_method :background_colour, :get_background_colour
@@ -49,13 +55,13 @@ module Wx
     alias_method :bitmap_bundle, :get_bitmap_bundle
     
     # Returns the bitmap used for disabled items.
-    # Availability:  only available for the {Wx::MSW} port.  {Wx::msw}
+    # Availability:  only available for the wxMSW port.  {Wx::msw}
     # @return [Wx::Bitmap]
     def get_disabled_bitmap; end
     alias_method :disabled_bitmap, :get_disabled_bitmap
     
     # Returns the font associated with the menu item.
-    # Availability:  only available for the {Wx::MSW} port.  {Wx::msw}
+    # Availability:  only available for the wxMSW port.  {Wx::msw}
     # @return [Wx::Font]
     def get_font; end
     alias_method :font, :get_font
@@ -87,12 +93,12 @@ module Wx
     alias_method :item_label_text, :get_item_label_text
     
     # Returns the item kind, one of {Wx::ItemKind::ITEM_SEPARATOR}, {Wx::ItemKind::ITEM_NORMAL}, {Wx::ItemKind::ITEM_CHECK} or {Wx::ItemKind::ITEM_RADIO}.
-    # @return [ItemKind]
+    # @return [Wx::ItemKind]
     def get_kind; end
     alias_method :kind, :get_kind
     
     # Gets the width of the menu item checkmark bitmap.
-    # Availability:  only available for the {Wx::MSW} port.  {Wx::msw}
+    # Availability:  only available for the wxMSW port.  {Wx::msw}
     # @return [Integer]
     def get_margin_width; end
     alias_method :margin_width, :get_margin_width
@@ -108,7 +114,7 @@ module Wx
     alias_method :sub_menu, :get_sub_menu
     
     # Returns the text colour associated with the menu item.
-    # Availability:  only available for the {Wx::MSW} port.  {Wx::msw}
+    # Availability:  only available for the wxMSW port.  {Wx::msw}
     # @return [Wx::Colour]
     def get_text_colour; end
     alias_method :text_colour, :get_text_colour
@@ -120,43 +126,43 @@ module Wx
     
     # Returns true if the item is a check item.
     # Unlike {Wx::MenuItem#is_checkable} this doesn't return true for the radio buttons.
-    # @return [true,false]
+    # @return [Boolean]
     def is_check; end
     alias_method :check?, :is_check
     
     # Returns true if the item is checkable.
     # Notice that the radio buttons are considered to be checkable as well, so this method returns true for them too. Use {Wx::MenuItem#is_check} if you want to test for the check items only.
-    # @return [true,false]
+    # @return [Boolean]
     def is_checkable; end
     alias_method :checkable?, :is_checkable
     
     # Returns true if the item is checked.
-    # @return [true,false]
+    # @return [Boolean]
     def is_checked; end
     alias_method :checked?, :is_checked
     
     # Returns true if the item is enabled.
-    # @return [true,false]
+    # @return [Boolean]
     def is_enabled; end
     alias_method :enabled?, :is_enabled
     
     # Returns true if the item is a radio button.
-    # @return [true,false]
+    # @return [Boolean]
     def is_radio; end
     alias_method :radio?, :is_radio
     
     # Returns true if the item is a separator.
-    # @return [true,false]
+    # @return [Boolean]
     def is_separator; end
     alias_method :separator?, :is_separator
     
     # Returns true if the item is a submenu.
-    # @return [true,false]
+    # @return [Boolean]
     def is_sub_menu; end
     alias_method :sub_menu?, :is_sub_menu
     
     # Sets the background colour associated with the menu item.
-    # Availability:  only available for the {Wx::MSW} port.  {Wx::msw}
+    # Availability:  only available for the wxMSW port.  {Wx::msw}
     # @param colour [Wx::Colour,String,Symbol] 
     # @return [void]
     def set_background_colour(colour) end
@@ -171,16 +177,16 @@ module Wx
     #   Sets the checked or unchecked bitmap for the menu item.
     #   It is equivalent to {Wx::MenuItem#set_bitmaps(bmp,wxNullBitmap)} if checked is true or SetBitmaps({Wx::NULL_BITMAP}, bmp) otherwise.
     #   Note that different bitmaps for checked and unchecked item states are not supported in most ports, while setting just a single bitmap using the overload above is supported in all of them.
-    #   Availability:  only available for the {Wx::MSW} port.  {Wx::msw}
+    #   Availability:  only available for the wxMSW port.  {Wx::msw}
     #   @param bmp [Wx::BitmapBundle,Wx::Bitmap,Wx::Icon,Wx::Image] 
-    #   @param checked [true,false] 
+    #   @param checked [Boolean] 
     #   @return [void]
     def set_bitmap(*args) end
     alias_method :bitmap=, :set_bitmap
     
     # Sets the checked/unchecked bitmaps for the menu item.
     # The first bitmap is also used as the single bitmap for uncheckable menu items.
-    # Availability:  only available for the {Wx::MSW} port.  {Wx::msw}
+    # Availability:  only available for the wxMSW port.  {Wx::msw}
     # @param checked [Wx::BitmapBundle,Wx::Bitmap,Wx::Icon,Wx::Image] 
     # @param unchecked [Wx::BitmapBundle,Wx::Bitmap,Wx::Icon,Wx::Image] 
     # @return [void]
@@ -188,14 +194,14 @@ module Wx
     alias_method :bitmaps=, :set_bitmaps
     
     # Sets the to be used for disabled menu items.
-    # Availability:  only available for the {Wx::MSW} port.  {Wx::msw}
+    # Availability:  only available for the wxMSW port.  {Wx::msw}
     # @param disabled [Wx::BitmapBundle,Wx::Bitmap,Wx::Icon,Wx::Image] 
     # @return [void]
     def set_disabled_bitmap(disabled) end
     alias_method :disabled_bitmap=, :set_disabled_bitmap
     
     # Sets the font associated with the menu item.
-    # Availability:  only available for the {Wx::MSW} port.  {Wx::msw}
+    # Availability:  only available for the wxMSW port.  {Wx::msw}
     # @param font [Wx::Font,Wx::FontInfo] 
     # @return [void]
     def set_font(font) end
@@ -212,21 +218,96 @@ module Wx
     # The label string for the normal menu items (not separators) may include the accelerator which can be used to activate the menu item from keyboard. An accelerator key can be specified using the ampersand <code>&</code> character. In order to embed an ampersand character in the menu item text, the ampersand must be doubled.
     # Optionally you can specify also an accelerator string appending a tab character <code>\t</code> followed by a valid key combination (e.g. <code>CTRL+V</code>). Its general syntax is any combination of <code>"CTRL"</code>, <code>"RAWCTRL"</code>, <code>"ALT"</code> and <code>"SHIFT"</code> strings (case doesn't matter) separated by either <code>'-'</code> or <code>'+'</code> characters and followed by the accelerator itself. Notice that CTRL corresponds to the "Ctrl" key on most platforms but not under macOS where it is mapped to "Cmd" key on Mac keyboard. Usually this is exactly what you want in portable code but if you really need to use the (rarely used for this purpose) "Ctrl" key even under Mac, you may use RAWCTRL to prevent this mapping. Under the other platforms RAWCTRL is the same as plain CTRL.
     # The accelerator may be any alphanumeric character, any function key (from F1 to F12), any numpad digit key using KP_ prefix (i.e. from KP_0 to KP_9) or one of the special strings listed below (again, case doesn't matter) corresponding to the specified key code:
-    # - Del or Delete: {Wx::K_DELETE}- Back: {Wx::K_BACK}- Ins or Insert: {Wx::K_INSERT}- Enter or Return: {Wx::K_RETURN}- PgUp or PageUp: {Wx::K_PAGEUP}- PgDn or PageDown: {Wx::K_PAGEDOWN}- Left: {Wx::K_LEFT}- Right: {Wx::K_RIGHT}- Up: {Wx::K_UP}- Down: {Wx::K_DOWN}- Home: {Wx::K_HOME}- End: {Wx::K_END}- Space: {Wx::K_SPACE}- Tab: {Wx::K_TAB}- Esc or Escape: {Wx::K_ESCAPE}- Cancel: {Wx::K_CANCEL}- Clear: {Wx::K_CLEAR}- Menu: {Wx::K_MENU}- Pause: {Wx::K_PAUSE}- Capital: {Wx::K_CAPITAL}- Select: {Wx::K_SELECT}- Print: {Wx::K_PRINT}- Execute: {Wx::K_EXECUTE}- Snapshot: {Wx::K_SNAPSHOT}- Help: {Wx::K_HELP}- Add: {Wx::K_ADD}- Separator: {Wx::K_SEPARATOR}- Subtract: {Wx::K_SUBTRACT}- Decimal: {Wx::K_DECIMAL}- Divide: {Wx::K_DIVIDE}- Num_lock: {Wx::K_NUMLOCK}- Scroll_lock: {Wx::K_SCROLL}- KP_Space: {Wx::K_NUMPAD}_SPACE- KP_Tab: {Wx::K_NUMPAD}_TAB- KP_Enter: {Wx::K_NUMPAD}_ENTER- KP_Home: {Wx::K_NUMPAD}_HOME- KP_Left: {Wx::K_NUMPAD}_LEFT- KP_Up: {Wx::K_NUMPAD}_UP- KP_Right: {Wx::K_NUMPAD}_RIGHT- KP_Down: {Wx::K_NUMPAD}_DOWN- KP_PageUp: {Wx::K_NUMPAD}_PAGEUP- KP_PageDown: {Wx::K_NUMPAD}_PAGEDOWN- KP_Prior: {Wx::K_NUMPAD}_PAGEUP- KP_Next: {Wx::K_NUMPAD}_PAGEDOWN- KP_End: {Wx::K_NUMPAD}_END- KP_Begin: {Wx::K_NUMPAD}_BEGIN- KP_Insert: {Wx::K_NUMPAD}_INSERT- KP_Delete: {Wx::K_NUMPAD}_DELETE- KP_Equal: {Wx::K_NUMPAD}_EQUAL- KP_Multiply: {Wx::K_NUMPAD}_MULTIPLY- KP_Add: {Wx::K_NUMPAD}_ADD- KP_Separator: {Wx::K_NUMPAD}_SEPARATOR- KP_Subtract: {Wx::K_NUMPAD}_SUBTRACT- KP_Decimal: {Wx::K_NUMPAD}_DECIMAL- KP_Divide: {Wx::K_NUMPAD}_DIVIDE- Windows_Left: {Wx::K_WINDOWS}_LEFT- Windows_Right: {Wx::K_WINDOWS}_RIGHT- Windows_Menu: {Wx::K_WINDOWS}_MENU- Command: {Wx::K_COMMAND}
+    # 
+    # - Del or Delete: {Wx::K_DELETE}
+    # - Back: {Wx::K_BACK}
+    # - Ins or Insert: {Wx::K_INSERT}
+    # - Enter or Return: {Wx::K_RETURN}
+    # - PgUp or PageUp: {Wx::K_PAGEUP}
+    # - PgDn or PageDown: {Wx::K_PAGEDOWN}
+    # - Left: {Wx::K_LEFT}
+    # - Right: {Wx::K_RIGHT}
+    # - Up: {Wx::K_UP}
+    # - Down: {Wx::K_DOWN}
+    # - Home: {Wx::K_HOME}
+    # - End: {Wx::K_END}
+    # - Space: {Wx::K_SPACE}
+    # - Tab: {Wx::K_TAB}
+    # - Esc or Escape: {Wx::K_ESCAPE}
+    # - Cancel: {Wx::K_CANCEL}
+    # - Clear: {Wx::K_CLEAR}
+    # - Menu: {Wx::K_MENU}
+    # - Pause: {Wx::K_PAUSE}
+    # - Capital: {Wx::K_CAPITAL}
+    # - Select: {Wx::K_SELECT}
+    # - Print: {Wx::K_PRINT}
+    # - Execute: {Wx::K_EXECUTE}
+    # - Snapshot: {Wx::K_SNAPSHOT}
+    # - Help: {Wx::K_HELP}
+    # - Add: {Wx::K_ADD}
+    # - Separator: {Wx::K_SEPARATOR}
+    # - Subtract: {Wx::K_SUBTRACT}
+    # - Decimal: {Wx::K_DECIMAL}
+    # - Divide: {Wx::K_DIVIDE}
+    # - Num_lock: {Wx::K_NUMLOCK}
+    # - Scroll_lock: {Wx::K_SCROLL}
+    # - KP_Space: {Wx::K_NUMPAD}_SPACE
+    # - KP_Tab: {Wx::K_NUMPAD}_TAB
+    # - KP_Enter: {Wx::K_NUMPAD}_ENTER
+    # - KP_Home: {Wx::K_NUMPAD}_HOME
+    # - KP_Left: {Wx::K_NUMPAD}_LEFT
+    # - KP_Up: {Wx::K_NUMPAD}_UP
+    # - KP_Right: {Wx::K_NUMPAD}_RIGHT
+    # - KP_Down: {Wx::K_NUMPAD}_DOWN
+    # - KP_PageUp: {Wx::K_NUMPAD}_PAGEUP
+    # - KP_PageDown: {Wx::K_NUMPAD}_PAGEDOWN
+    # - KP_Prior: {Wx::K_NUMPAD}_PAGEUP
+    # - KP_Next: {Wx::K_NUMPAD}_PAGEDOWN
+    # - KP_End: {Wx::K_NUMPAD}_END
+    # - KP_Begin: {Wx::K_NUMPAD}_BEGIN
+    # - KP_Insert: {Wx::K_NUMPAD}_INSERT
+    # - KP_Delete: {Wx::K_NUMPAD}_DELETE
+    # - KP_Equal: {Wx::K_NUMPAD}_EQUAL
+    # - KP_Multiply: {Wx::K_NUMPAD}_MULTIPLY
+    # - KP_Add: {Wx::K_NUMPAD}_ADD
+    # - KP_Separator: {Wx::K_NUMPAD}_SEPARATOR
+    # - KP_Subtract: {Wx::K_NUMPAD}_SUBTRACT
+    # - KP_Decimal: {Wx::K_NUMPAD}_DECIMAL
+    # - KP_Divide: {Wx::K_NUMPAD}_DIVIDE
+    # - Windows_Left: {Wx::K_WINDOWS}_LEFT
+    # - Windows_Right: {Wx::K_WINDOWS}_RIGHT
+    # - Windows_Menu: {Wx::K_WINDOWS}_MENU
+    # - Command: {Wx::K_COMMAND}
     # 
     # Examples:
     # 
-    # ```
-    #   m_pMyMenuItem->SetItemLabel("My &item\tCTRL+I");
-    #   m_pMyMenuItem2->SetItemLabel("Clean && build\tF7");
-    #   m_pMyMenuItem3->SetItemLabel("Simple item");
-    #   m_pMyMenuItem4->SetItemLabel("Item with &accelerator");
+    # ```ruby
+    #   @my_menu_item.set_item_label("My &item\tCTRL+I")
+    #   @my_menu_item2.set_item_label("Clean && build\tF7")
+    #   @my_menu_item3.set_item_label("Simple item")
+    #   @my_menu_item4.set_item_label("Item with &accelerator")
     # ```
     # 
-    # In {Wx::GTK} using <code>"SHIFT"</code> with non-alphabetic characters currently doesn't work, even in combination with other modifiers, due to GTK+ limitation. E.g. <code>Shift+Ctrl+A</code> works but <code>Shift+Ctrl+1</code> or <code>Shift+/</code> do not, so avoid using accelerators of this form in portable code.
+    # In wxGTK using <code>"SHIFT"</code> with non-alphabetic characters currently doesn't work, even in combination with other modifiers, due to GTK+ limitation. E.g. <code>Shift+Ctrl+A</code> works but <code>Shift+Ctrl+1</code> or <code>Shift+/</code> do not, so avoid using accelerators of this form in portable code.
     # 
     # In {Wx::GTk}, the left/right/up/down arrow keys do not work as accelerator keys for a menu item unless a modifier key is used. Additionally, the following keycodes are not supported as menu accelerator keys:
-    # - {Wx::K_COMMAND}/{Wx::K_CONTROL}- {Wx::K_SHIFT}- {Wx::K_ALT}- {Wx::K_SCROLL}- {Wx::K_CAPITAL}- {Wx::K_NUMLOCK}- {Wx::K_NUMPAD}_TAB- {Wx::K_TAB}- {Wx::K_WINDOWS}_LEFT- {Wx::K_WINDOWS}_RIGHT- {Wx::K_ADD}- {Wx::K_SEPARATOR}- {Wx::K_SUBTRACT}- {Wx::K_DECIMAL}- {Wx::K_DIVIDE}- {Wx::K_SNAPSHOT}
+    # 
+    # - {Wx::K_COMMAND}/{Wx::K_CONTROL}
+    # - {Wx::K_SHIFT}
+    # - {Wx::K_ALT}
+    # - {Wx::K_SCROLL}
+    # - {Wx::K_CAPITAL}
+    # - {Wx::K_NUMLOCK}
+    # - {Wx::K_NUMPAD}_TAB
+    # - {Wx::K_TAB}
+    # - {Wx::K_WINDOWS}_LEFT
+    # - {Wx::K_WINDOWS}_RIGHT
+    # - {Wx::K_ADD}
+    # - {Wx::K_SEPARATOR}
+    # - {Wx::K_SUBTRACT}
+    # - {Wx::K_DECIMAL}
+    # - {Wx::K_DIVIDE}
+    # - {Wx::K_SNAPSHOT}
     # @see Wx::MenuItem#get_item_label
     # @see  Wx::MenuItem#get_item_label_text 
     # @param label [String] 
@@ -235,7 +316,7 @@ module Wx
     alias_method :item_label=, :set_item_label
     
     # Sets the width of the menu item checkmark bitmap.
-    # Availability:  only available for the {Wx::MSW} port.  {Wx::msw}
+    # Availability:  only available for the wxMSW port.  {Wx::msw}
     # @param width [Integer] 
     # @return [void]
     def set_margin_width(width) end
@@ -254,7 +335,7 @@ module Wx
     alias_method :sub_menu=, :set_sub_menu
     
     # Sets the text colour associated with the menu item.
-    # Availability:  only available for the {Wx::MSW} port.  {Wx::msw}
+    # Availability:  only available for the wxMSW port.  {Wx::msw}
     # @param colour [Wx::Colour,String,Symbol] 
     # @return [void]
     def set_text_colour(colour) end
@@ -269,7 +350,7 @@ module Wx
     # Add an extra accelerator for this menu item.
     # Additional accelerators are not shown in the item's label, but still will trigger the menu command when pressed.
     # They can be useful to let multiple keys be used as accelerators for the same command, e.g. {Wx::K_ADD} and {Wx::K_NUMPAD}_ADD.
-    # Availability:  only available for the {Wx::MSW}, {Wx::GTK} ports.  {Wx::msw},{Wx::gtk}
+    # Availability:  only available for the wxMSW, wxGTK ports.  {Wx::msw},{Wx::gtk}
     # @param accel [Wx::AcceleratorEntry] 
     # @return [void]
     def add_extra_accel(accel) end
@@ -280,22 +361,22 @@ module Wx
     def clear_extra_accels; end
     
     # Constructs a {Wx::MenuItem} object.
-    # Menu items can be standard, or "stock menu items", or custom. For the standard menu items (such as commands to open a file, exit the program and so on, see Stock Items for the full list) it is enough to specify just the stock ID and leave text and helpString empty. Some platforms (currently {Wx::GTK} only, and see the remark in {Wx::MenuItem#set_bitmap} documentation) will also show standard bitmaps for stock menu items.
+    # Menu items can be standard, or "stock menu items", or custom. For the standard menu items (such as commands to open a file, exit the program and so on, see Stock Items for the full list) it is enough to specify just the stock ID and leave text and helpString empty. Some platforms (currently wxGTK only, and see the remark in {Wx::MenuItem#set_bitmap} documentation) will also show standard bitmaps for stock menu items.
     # Leaving at least text empty for the stock menu items is actually strongly recommended as they will have appearance and keyboard interface (including standard accelerators) familiar to the user.
     # For the custom (non-stock) menu items, text must be specified and while helpString may be left empty, it's recommended to pass the item description (which is automatically shown by the library in the status bar when the menu item is selected) in this parameter.
     # Finally note that you can e.g. use a stock menu label without using its stock help string:
     # 
-    # ```
-    #   // use all stock properties:
-    #   helpMenu->Append(wxID_ABOUT);
+    # ```ruby
+    #   # use all stock properties:
+    #   helpMenu.append(wxID_ABOUT)
     #   
-    #   // use the stock label and the stock accelerator but not the stock help string:
-    #   helpMenu->Append(wxID_ABOUT, "", "My custom help string");
+    #   # use the stock label and the stock accelerator but not the stock help string:
+    #   helpMenu.append(Wx::ID_ABOUT, "", "My custom help string")
     #   
-    #   // use all stock properties except for the bitmap:
-    #   wxMenuItem *mymenu = new wxMenuItem(helpMenu, wxID_ABOUT);
-    #   mymenu->SetBitmap(wxArtProvider::GetBitmap(wxART_WARNING));
-    #   helpMenu->Append(mymenu);
+    #   # use all stock properties except for the bitmap:
+    #   mymenu = Wx::MenuItem.new(helpMenu, Wx::ID_ABOUT)
+    #   mymenu.set_bitmap(Wx::ArtProvider.get_bitmap(Wx::ART_WARNING))
+    #   helpMenu.append(mymenu)
     # ```
     # 
     # that is, stock properties are set independently one from the other.
@@ -303,27 +384,27 @@ module Wx
     # @param id [Integer]  Identifier for this menu item. May be {Wx::StandardID::ID_SEPARATOR}, in which case the given kind is ignored and taken to be {Wx::ItemKind::ITEM_SEPARATOR} instead.
     # @param text [String]  Text for the menu item, as shown on the menu. See {Wx::MenuItem#set_item_label} for more info.
     # @param helpString [String]  Optional help string that will be shown on the status bar.
-    # @param kind [ItemKind]  May be {Wx::ItemKind::ITEM_SEPARATOR}, {Wx::ItemKind::ITEM_NORMAL}, {Wx::ItemKind::ITEM_CHECK} or {Wx::ItemKind::ITEM_RADIO}.
+    # @param kind [Wx::ItemKind]  May be {Wx::ItemKind::ITEM_SEPARATOR}, {Wx::ItemKind::ITEM_NORMAL}, {Wx::ItemKind::ITEM_CHECK} or {Wx::ItemKind::ITEM_RADIO}.
     # @param subMenu [Wx::Menu]  If non-NULL, indicates that the menu item is a submenu.
-    # @return [MenuItem]
+    # @return [Wx::MenuItem]
     def initialize(parentMenu=nil, id=Wx::StandardID::ID_SEPARATOR, text=(''), helpString=(''), kind=Wx::ItemKind::ITEM_NORMAL, subMenu=nil) end
     
     # Checks or unchecks the menu item.
     # Note that this only works when the item is already appended to a menu.
-    # @param check [true,false] 
+    # @param check [Boolean] 
     # @return [void]
     def check(check=true) end
     
     # Enables or disables the menu item.
-    # @param enable [true,false] 
+    # @param enable [Boolean] 
     # @return [void]
     def enable(enable=true) end
     
     # Strips all accelerator characters and mnemonics from the given text.
     # For example:
     # 
-    # ```
-    #   wxMenuItem::GetLabelText("&Hello\tCtrl-h");
+    # ```ruby
+    #   Wx::MenuItem.get_label_text("&Hello\tCtrl-h")
     # ```
     # 
     # will return just <code>"Hello"</code>.

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

@@ -14,11 +14,10 @@ module Wx
   # This is a convenient function which is usually used instead of using {Wx::MessageDialog} directly. Notice however that some of the features, such as extended text and custom labels for the message box buttons, are not provided by this function but only by {Wx::MessageDialog}.
   # The return value is one of: {Wx::YES}, {Wx::NO}, {Wx::CANCEL}, {Wx::OK} or {Wx::HELP} (notice that this return value is <b>different</b> from the return value of {Wx::MessageDialog#show_modal}).
   # For example: 
-  # ```
-  #   int answer = wxMessageBox("Quit program?", "Confirm",
-  #                             wxYES_NO | wxCANCEL, main_frame);
-  #   if (answer == wxYES)
-  #       main_frame->Close();
+  # ```ruby
+  #   answer = Wx.message_box("Quit program?", "Confirm",
+  #                            Wx::YES_NO | Wx::CANCEL, main_frame)
+  #   main_frame.close if answer == Wx::YES
   # ```
   # 
   # message may contain newline characters, in which case the message will be split into separate lines, to cater for large messages.
@@ -35,24 +34,41 @@ module Wx
   # === Styles
   # 
   # This class supports the following styles:
-  #  
+  # 
   # - {Wx::OK}: Puts an Ok button in the message box. May be combined with {Wx::CANCEL}. 
+  # 
   # - {Wx::CANCEL}: Puts a Cancel button in the message box. Must be combined with either {Wx::OK} or {Wx::YES_NO}. 
-  # - {Wx::YES_NO}: Puts Yes and No buttons in the message box. It is recommended to always use {Wx::CANCEL} with this style as otherwise the message box won't have a close button under {Wx::MSW} and the user will be forced to answer it. 
-  # - {Wx::HELP}: Puts a Help button to the message box. This button can have special appearance or be specially positioned if its label is not changed from the default one. Notice that using this button is not supported when showing a message box from non-main thread in {Wx::OSX}/Cocoa. Available since wxWidgets 2.9.3. 
+  # 
+  # - {Wx::YES_NO}: Puts Yes and No buttons in the message box. It is recommended to always use {Wx::CANCEL} with this style as otherwise the message box won't have a close button under wxMSW and the user will be forced to answer it. 
+  # 
+  # - {Wx::HELP}: Puts a Help button to the message box. This button can have special appearance or be specially positioned if its label is not changed from the default one. Notice that using this button is not supported when showing a message box from non-main thread in wxOSX/Cocoa. Available since wxWidgets 2.9.3. 
+  # 
   # - {Wx::NO_DEFAULT}: Makes the "No" button default, can only be used with {Wx::YES_NO}. 
-  # - {Wx::CANCEL_DEFAULT}: Makes the "Cancel" button default, can only be used with {Wx::CANCEL}. This style is currently not supported (and ignored) in {Wx::OSX}. 
+  # 
+  # - {Wx::CANCEL_DEFAULT}: Makes the "Cancel" button default, can only be used with {Wx::CANCEL}. This style is currently not supported (and ignored) in wxOSX. 
+  # 
   # - {Wx::YES_DEFAULT}: Makes the "Yes" button default, this is the default behaviour and this flag exists solely for symmetry with {Wx::NO_DEFAULT}. 
+  # 
   # - {Wx::OK_DEFAULT}: Makes the "OK" button default, this is the default behaviour and this flag exists solely for symmetry with {Wx::CANCEL_DEFAULT}. 
+  # 
   # - {Wx::ICON_NONE}: Displays no icon in the dialog if possible (an icon might still be displayed if the current platform mandates its use). This style may be used to prevent the dialog from using the default icon based on {Wx::YES_NO} presence as explained in {Wx::ICON_QUESTION} and {Wx::ICON_INFORMATION} documentation below. 
+  # 
   # - {Wx::ICON_ERROR}: Displays an error icon in the dialog. 
+  # 
   # - {Wx::ICON_WARNING}: Displays a warning icon in the dialog. This style should be used for informative warnings or, in combination with {Wx::YES_NO} or {Wx::CANCEL}, for questions that have potentially serious consequences (caution icon is used on macOS in this case). 
-  # - {Wx::ICON_QUESTION}: Displays a question mark symbol. This icon is automatically used with {Wx::YES_NO} so it's usually unnecessary to specify it explicitly. This style is not supported for message dialogs under {Wx::MSW} when a task dialog is used to implement them (i.e. when running under Windows Vista or later) because Microsoft guidelines indicate that no icon should be used for routine confirmations. If it is specified, no icon will be displayed. 
+  # 
+  # - {Wx::ICON_QUESTION}: Displays a question mark symbol. This icon is automatically used with {Wx::YES_NO} so it's usually unnecessary to specify it explicitly. This style is not supported for message dialogs under wxMSW when a task dialog is used to implement them (i.e. when running under Windows Vista or later) because Microsoft guidelines indicate that no icon should be used for routine confirmations. If it is specified, no icon will be displayed. 
+  # 
   # - {Wx::ICON_INFORMATION}: Displays an information symbol. This icon is used by default if {Wx::YES_NO} is not given so it is usually unnecessary to specify it explicitly. 
+  # 
   # - {Wx::ICON_EXCLAMATION}: Alias for {Wx::ICON_WARNING}. 
+  # 
   # - {Wx::ICON_HAND}: Alias for {Wx::ICON_ERROR}. 
-  # - {Wx::ICON_AUTH_NEEDED}: Displays an authentication needed symbol. This style is only supported for message dialogs under {Wx::MSW} when a task dialog is used to implement them (i.e. when running under Windows Vista or later). In other cases the default icon selection logic will be used. Note this can be combined with other styles to provide a fallback. For instance, using {Wx::ICON_AUTH_NEEDED} | {Wx::ICON_QUESTION} will show a shield symbol on Windows Vista or above and a question symbol on other platforms. Available since wxWidgets 2.9.5 
+  # 
+  # - {Wx::ICON_AUTH_NEEDED}: Displays an authentication needed symbol. This style is only supported for message dialogs under wxMSW when a task dialog is used to implement them (i.e. when running under Windows Vista or later). In other cases the default icon selection logic will be used. Note this can be combined with other styles to provide a fallback. For instance, using {Wx::ICON_AUTH_NEEDED} | {Wx::ICON_QUESTION} will show a shield symbol on Windows Vista or above and a question symbol on other platforms. Available since wxWidgets 2.9.5 
+  # 
   # - {Wx::STAY_ON_TOP}: Makes the message box stay on top of all other windows and not only just its parent (currently implemented only under MSW and GTK). 
+  # 
   # - {Wx::GeometryCentre::CENTRE}: Centre the message box on its parent or on the screen if parent is not specified. Setting this style under MSW makes no differences as the dialog is always centered on the parent. 
   # 
   # === 
@@ -74,7 +90,7 @@ module Wx
     # @param caption [String]  The dialog title.
     # @param style [Integer]  Combination of style flags described above.
     # @param pos [Array(Integer, Integer), Wx::Point]  Dialog position (ignored under MSW).
-    # @return [MessageDialog]
+    # @return [Wx::MessageDialog]
     def initialize(parent, message, caption=Wx::MESSAGE_BOX_CAPTION_STR, style=(Wx::OK|Wx::GeometryCentre::CENTRE), pos=Wx::DEFAULT_POSITION) end
     
     # Sets the extended message for the dialog: this message is usually an extension of the short message specified in the constructor or set with {Wx::MessageDialog#set_message}.
@@ -87,8 +103,8 @@ module Wx
     # Sets the label for the Help button.
     # Please see the remarks in {Wx::MessageDialog#set_yes_no_labels} documentation.
     # Notice that changing the label of the help button resets its special status (if any, this depends on the platform) and it will be treated just like another button in this case.
-    # @param help [ButtonLabel] 
-    # @return [true,false]
+    # @param help [String,Integer] 
+    # @return [Boolean]
     def set_help_label(help) end
     alias_method :help_label=, :set_help_label
     
@@ -100,45 +116,47 @@ module Wx
     
     # Overrides the default labels of the OK and Cancel buttons.
     # Please see the remarks in {Wx::MessageDialog#set_yes_no_labels} documentation.
-    # @param ok [ButtonLabel] 
-    # @param cancel [ButtonLabel] 
-    # @return [true,false]
+    # @param ok [String,Integer] 
+    # @param cancel [String,Integer] 
+    # @return [Boolean]
     def set_ok_cancel_labels(ok, cancel) end
     
     # Overrides the default label of the OK button.
     # Please see the remarks in {Wx::MessageDialog#set_yes_no_labels} documentation.
-    # @param ok [ButtonLabel] 
-    # @return [true,false]
+    # @param ok [String,Integer] 
+    # @return [Boolean]
     def set_ok_label(ok) end
     alias_method :ok_label=, :set_ok_label
     
     # Overrides the default labels of the Yes, No and Cancel buttons.
     # Please see the remarks in {Wx::MessageDialog#set_yes_no_labels} documentation.
-    # @param yes [ButtonLabel] 
-    # @param no [ButtonLabel] 
-    # @param cancel [ButtonLabel] 
-    # @return [true,false]
+    # @param yes [String,Integer] 
+    # @param no [String,Integer] 
+    # @param cancel [String,Integer] 
+    # @return [Boolean]
     def set_yes_no_cancel_labels(yes, no, cancel) end
     
     # Overrides the default labels of the Yes and No buttons.
     # The arguments of this function can be either strings or one of the standard identifiers, such as {Wx::StandardID::ID_APPLY} or {Wx::StandardID::ID_OPEN}. Notice that even if the label is specified as an identifier, the return value of the dialog {Wx::MessageDialog#show_modal} method still remains one of {Wx::StandardID::ID_OK}, {Wx::StandardID::ID_CANCEL}, {Wx::StandardID::ID_YES} or {Wx::StandardID::ID_NO} values, i.e. this identifier changes only the label appearance but not the return code generated by the button. It is possible to mix stock identifiers and string labels in the same function call, for example: 
-    # ```
-    #   wxMessageDialog dlg(...);
-    #   dlg.SetYesNoLabels(wxID_SAVE, _("&Don't save"));
+    # ```ruby
+    #   Wx.MessageDialog(...) do |dlg|
+    #     dlg.set_yes_no_labels(Wx::ID_SAVE, "&Don't save")
+    #   end
     # ```
     # 
     # Also notice that this function is not currently available on all platforms (although as of wxWidgets 2.9.0 it is implemented in all major ports), so it may return false to indicate that the labels couldn't be changed. If it returns true, the labels were set successfully.
     # Typically, if the function was used successfully, the main dialog message may need to be changed, e.g.: 
+    # ```ruby
+    #   Wx.MessageDialog(...) do |dlg|
+    #     if dlg.set_yes_no_labels("&Quit, "&Don't quit")
+    #       dlg.set_message('What do you want to do?')
+    #     else # buttons have standard "Yes"/"No" values, so rephrase the question
+    #       dlg.set_message('Do you really want to quit?')
+    #   end
     # ```
-    #   wxMessageDialog dlg(...);
-    #   if ( dlg.SetYesNoLabels(_("&Quit"), _("&Don't quit")) )
-    #       dlg.SetMessage(_("What do you want to do?"));
-    #   else // buttons have standard "Yes"/"No" values, so rephrase the question
-    #       dlg.SetMessage(_("Do you really want to quit?"));
-    # ```
-    # @param yes [ButtonLabel] 
-    # @param no [ButtonLabel] 
-    # @return [true,false]
+    # @param yes [String,Integer] 
+    # @param no [String,Integer] 
+    # @return [Boolean]
     def set_yes_no_labels(yes, no) end
     
     # Shows the dialog, returning one of {Wx::StandardID::ID_OK}, {Wx::StandardID::ID_CANCEL}, {Wx::StandardID::ID_YES}, {Wx::StandardID::ID_NO} or {Wx::StandardID::ID_HELP}.
@@ -162,7 +180,7 @@ module Wx
     def get_message_dialog_style; end
     alias_method :message_dialog_style, :get_message_dialog_style
     
-    # @return [true,false]
+    # @return [Boolean]
     def has_custom_labels; end
     alias_method :has_custom_labels?, :has_custom_labels
     

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

@@ -12,16 +12,25 @@ module Wx
   # === Styles
   # 
   # This class supports the following styles:
-  #  
+  # 
   # - {Wx::ICONIZE}: Display the frame iconized (minimized) (Windows only). 
+  # 
   # - {Wx::CAPTION}: Puts a caption on the frame. 
+  # 
   # - {Wx::MINIMIZE}: Identical to {Wx::ICONIZE}. 
+  # 
   # - {Wx::MINIMIZE_BOX}: Displays a minimize box on the frame (Windows and Motif only). 
+  # 
   # - {Wx::MAXIMIZE}: Displays the frame maximized (Windows only). 
+  # 
   # - {Wx::MAXIMIZE_BOX}: Displays a maximize box on the frame (Windows and Motif only). 
+  # 
   # - {Wx::CLOSE_BOX}: Displays a close box on the frame. 
+  # 
   # - {Wx::STAY_ON_TOP}: Stay on top of other windows (Windows only). 
+  # 
   # - {Wx::SYSTEM_MENU}: Displays a system menu (Windows and Motif only). 
+  # 
   # - {Wx::RESIZE_BORDER}: Displays a resizable border around the window. 
   # 
   # This class has miniframe functionality under Windows and GTK, i.e. the presence of mini frame will not be noted in the task bar and focus behaviour is different. On other platforms, it behaves like a normal frame.
@@ -39,7 +48,7 @@ module Wx
   
     # @overload initialize()
     #   Default ctor.
-    #   @return [MiniFrame]
+    #   @return [Wx::MiniFrame]
     # @overload initialize(parent, id, title, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=(Wx::CAPTION|Wx::RESIZE_BORDER), name=Wx::FrameNameStr)
     #   Constructor, creating the window.
     #   The frame behaves like a normal frame on non-Windows platforms.
@@ -51,11 +60,11 @@ module Wx
     #   @param size [Array(Integer, Integer), Wx::Size]  The window size. The value {Wx::DEFAULT_SIZE} indicates a default size, chosen by either the windowing system or wxWidgets, depending on platform.
     #   @param style [Integer]  The window style. See {Wx::MiniFrame}.
     #   @param name [String]  The name of the window. This parameter is used to associate a name with the item, allowing the application user to set Motif resource values for individual windows.
-    #   @return [MiniFrame]
+    #   @return [Wx::MiniFrame]
     def initialize(*args) end
     
     # Used in two-step frame construction.
-    # See {Wx::MiniFrame#mini_frame} for further details.
+    # See {Wx::MiniFrame#initialize} for further details.
     # @param parent [Wx::Window] 
     # @param id [Integer] 
     # @param title [String] 
@@ -63,7 +72,7 @@ module Wx
     # @param size [Array(Integer, Integer), Wx::Size] 
     # @param style [Integer] 
     # @param name [String] 
-    # @return [true,false]
+    # @return [Boolean]
     def create(parent, id, title, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=(Wx::CAPTION|Wx::RESIZE_BORDER), name=Wx::FrameNameStr) end
     
   end # MiniFrame