wxruby3 0.9.1-x64-mingw-ucrt → 0.9.2-x64-mingw-ucrt

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

@@ -169,6 +169,7 @@ module Wx
   # 
   # 
   # 
+  # @wxrb_require USE_LISTCTRL
   class ListColumnFormat < Wx::Enum
   
     # 
@@ -319,13 +320,23 @@ module Wx
   # Virtual list control can be used as a normal one except that no operations which can take time proportional to the number of items in the control happen  this is required to allow having a practically infinite number of items. For example, in a multiple selection virtual list control, the selections won't be sent when many items are selected at once because this could mean iterating over all the items.
   # Using many of {Wx::ListCtrl} features is shown in the corresponding sample.
   # To intercept events from a list control, use the event table macros described in {Wx::ListEvent}.
-  # The native wxOSX implementation for report mode that was added in wxWidgets 2.8 was removed in wxWidgets 3.1, meaning for wxWidgets 3.1+ wxOSX uses the generic implementation for all modes.
   # 
-  # == Column Ordering
+  # <div class="wxrb-note">
+  # <b>Note:</b>
+  # <p>The native WXOSX implementation for report mode that was added in wxWidgets 2.8 was removed in wxWidgets 3.1, meaning for wxWidgets 3.1+ WXOSX uses the generic implementation for all modes.
+  # </p>
+  # </div>
+  # 
+  # ## Column Ordering
   # 
   # By default, the columns of a list control appear on the screen in order of their indices, i.e. column 0 appears first, then column 1 next, and so on. However this can be changed by using the {Wx::ListCtrl#set_columns_order} function to arbitrarily reorder the columns visual order.
   # The user can also rearrange the columns interactively by dragging them. In this case, the index of the column is not the same as its order and the functions {Wx::ListCtrl#get_column_order} and {Wx::ListCtrl#get_column_index_from_order} should be used to translate between them.
-  # All the other functions still work with the column indices, i.e. the visual positioning of the columns on screen doesn't affect the code setting or getting their values for example.
+  # 
+  # <div class="wxrb-note">
+  # <b>Note:</b>
+  # <p>All the other functions still work with the column indices, i.e. the visual positioning of the columns on screen doesn't affect the code setting or getting their values for example.
+  # </p>
+  # </div>
   # 
   # Example of reordering columns: 
   # ```ruby
@@ -341,7 +352,7 @@ module Wx
   #   # 1 and 2 respectively
   # ```
   # 
-  # === Styles
+  # ### Styles
   # 
   # This class supports the following styles:
   # 
@@ -375,7 +386,7 @@ module Wx
   # 
   # - {Wx::LC_VRULES}: Draws light vertical rules between columns in report mode. 
   # 
-  # === Events emitted by this class
+  # ### Events emitted by this class
   # 
   # The following event-handler methods redirect the events to member method or handler blocks for {Wx::ListEvent} events.
   # Event handler methods for events emitted by this class:
@@ -424,13 +435,15 @@ module Wx
   # 
   # - {Wx::EvtHandler#evt_list_item_unchecked}(id, meth = nil, &block): The item has been unchecked. Processes a {Wx::EVT_LIST_ITEM_UNCHECKED} event type (new since wxWidgets 3.1.0). 
   # 
-  # Under wxMSW this control uses {Wx::SystemThemedControl} for an explorer style appearance by default since wxWidgets 3.1.0. If this is not desired, you can call Wx::SystemThemedControl::EnableSystemTheme with false argument to disable this.
+  # <div class="wxrb-note">
+  # <b>Note:</b>
+  # <p>Under WXMSW this control uses {Wx::SystemThemedControl} for an explorer style appearance by default since wxWidgets 3.1.0. If this is not desired, you can call Wx::SystemThemedControl::EnableSystemTheme with false argument to disable this.
+  # </p>
+  # </div>
   # 
-  # === 
-  # 
-  # Category:  {Wx::Controls}  <div class='appearance'><span class='appearance'>Appearance:</span><table><tr><td> wxMSW Appearance
-  #   </td><td> wxGTK Appearance
-  #   </td><td> wxOSX Appearance
+  # Category:  {Wx::Controls}  <div class='appearance'><span class='appearance'>Appearance:</span><table><tr><td> WXMSW Appearance
+  #   </td><td> WXGTK Appearance
+  #   </td><td> WXOSX Appearance
   #   </td></tr></table></div>
   # @see wxListCtrl Overview
   # @see  Wx::ListView
@@ -442,6 +455,7 @@ module Wx
   # @see  Wx::EditableListBox 
   # 
   # 
+  # @wxrb_require USE_LISTCTRL
   class ListCtrl < Control
   
     # @overload initialize()
@@ -482,7 +496,11 @@ module Wx
     def arrange(flag=Wx::LIST_ALIGN_DEFAULT) end
     
     # Deletes all items and all columns.
-    # This sends an event of type {Wx::EVT_LIST_DELETE_ALL_ITEMS} under all platforms.
+    # <div class="wxrb-note">
+    # <b>Note:</b>
+    # <p>This sends an event of type {Wx::EVT_LIST_DELETE_ALL_ITEMS} under all platforms. 
+    # </p>
+    # </div>
     # @return [void]
     def clear_all; end
     
@@ -530,7 +548,7 @@ module Wx
     def enable_alternate_row_colours(enable=true) end
     
     # Enable or disable a beep if there is no match for the currently entered text when searching for the item from keyboard.
-    # The default is to not beep in this case except in wxMSW where the beep is always generated by the native control and cannot be disabled, i.e. calls to this function do nothing there.
+    # The default is to not beep in this case except in WXMSW where the beep is always generated by the native control and cannot be disabled, i.e. calls to this function do nothing there.
     # @param on [Boolean] 
     # @return [void]
     def enable_bell_on_no_match(on=true) end
@@ -538,7 +556,7 @@ module Wx
     # Finish editing the label.
     # This method allows one to programmatically end editing a list control item in place. Usually it will only be called when editing is in progress, i.e. if {Wx::ListCtrl#get_edit_control} returns non-NULL. In particular, do not call it from EVT_LIST_BEGIN_LABEL_EDIT handler as the edit control is not yet fully created by then, just veto the event in this handler instead to prevent the editing from even starting.
     # Notice that calling this method will result in EVT_LIST_END_LABEL_EDIT event being generated.
-    # Currently only implemented in wxMSW.
+    # Currently only implemented in WXMSW.
     # 
     # true if item editing was finished or false if no item as being edited.
     # @param cancel [Boolean]  If true, discard the changes made by user, as if Escape key was pressed. Otherwise, accept the changes as if Return was pressed.
@@ -601,7 +619,12 @@ module Wx
     
     # Returns the edit control being currently used to edit a label.
     # Returns NULL if no label is being edited.
-    # It is currently only implemented for wxMSW and the generic version, not for the native macOS version.
+    # 
+    # <div class="wxrb-note">
+    # <b>Note:</b>
+    # <p>It is currently only implemented for WXMSW and the generic version, not for the native macOS version. 
+    # </p>
+    # </div>
     # @return [Wx::TextCtrl]
     def get_edit_control; end
     alias_method :edit_control, :get_edit_control
@@ -702,7 +725,11 @@ module Wx
     # - {Wx::LIST_NEXT_LEFT}: Searches for an item to the left of the specified item.
     # - {Wx::LIST_NEXT_RIGHT}: Searches for an item to the right of the specified item.
     # 
-    # this parameter is only supported by wxMSW currently and ignored on other platforms.
+    # <div class="wxrb-note">
+    # <b>Note:</b>
+    # <p>this parameter is only supported by WXMSW currently and ignored on other platforms.
+    # </p>
+    # </div>
     # 
     # state can be a bitlist of the following:
     # 
@@ -781,7 +808,7 @@ module Wx
     # - {Wx::LIST_HITTEST_ONITEMSTATEICON}: Over the checkbox of an item.
     # - {Wx::LIST_HITTEST_ONITEM}: Combination of {Wx::LIST_HITTEST_ONITEMICON}, {Wx::LIST_HITTEST_ONITEMLABEL}, {Wx::LIST_HITTEST_ONITEMSTATEICON}.
     # 
-    # If ptrSubItem is not NULL and the {Wx::ListCtrl} is in the report mode the subitem (or column) number will also be provided. This feature is only available in version 2.7.0 or higher and is currently only implemented under wxMSW and requires at least comctl32.dll of version 4.70 on the host system or the value stored in ptrSubItem will be always -1. To compile this feature into wxWidgets library you need to have access to commctrl.h of version 4.70 that is provided by Microsoft.
+    # If ptrSubItem is not NULL and the {Wx::ListCtrl} is in the report mode the subitem (or column) number will also be provided. This feature is only available in version 2.7.0 or higher and is currently only implemented under WXMSW and requires at least comctl32.dll of version 4.70 on the host system or the value stored in ptrSubItem will be always -1. To compile this feature into wxWidgets library you need to have access to commctrl.h of version 4.70 that is provided by Microsoft.
     # @param point [Array(Integer, Integer), Wx::Point] 
     # @return [Array(Integer,Integer)]
     def hit_test(point) end
@@ -859,7 +886,12 @@ module Wx
     
     # Scrolls the list control.
     # If in icon, small icon or report view mode, dx specifies the number of pixels to scroll. If in list view mode, dx specifies the number of columns to scroll. dy always specifies the number of pixels to scroll vertically.
-    # This method is currently only implemented in the Windows version.
+    # 
+    # <div class="wxrb-note">
+    # <b>Note:</b>
+    # <p>This method is currently only implemented in the Windows version. 
+    # </p>
+    # </div>
     # @param dx [Integer] 
     # @param dy [Integer] 
     # @return [Boolean]
@@ -867,7 +899,12 @@ module Wx
     
     # Sets the background colour.
     # Note that the {Wx::Window#get_background_colour} function of {Wx::Window} base class can be used to retrieve the current background colour.
-    # If alternate row colouring is enabled, then call {Wx::ListCtrl#enable_alternate_row_colours} again after changing the background colour. This will update the alternate row color to match the new background colour.
+    # 
+    # <div class="wxrb-note">
+    # <b>Note:</b>
+    # <p>If alternate row colouring is enabled, then call {Wx::ListCtrl#enable_alternate_row_colours} again after changing the background colour. This will update the alternate row color to match the new background colour. 
+    # </p>
+    # </div>
     # @param col [Wx::Colour,String,Symbol] 
     # @return [Boolean]
     def set_background_colour(col) end
@@ -892,7 +929,7 @@ module Wx
     
     # Change the font and the colours used for the list control header.
     # This method can be used to change the appearance of the header shown by the control in report mode (unless {Wx::LC_NO_HEADER} style is used).
-    # Currently it is implemented only for wxMSW and does nothing in the other ports.
+    # Currently it is implemented only for WXMSW and does nothing in the other ports.
     # 
     # true if the attributes have been updated or false if this is not supported by the current platform.
     # @param attr [Wx::ItemAttr]  The object containing the font and text and background colours to use. It may be default, i.e. not specify any custom font nor colours, to reset any previously set custom attribute.
@@ -1088,9 +1125,14 @@ module Wx
     def extend_rules_and_alternate_colour(extend=true) end
     
     # Show the sort indicator of a specific column in a specific direction.
-    # Sort indicators are only shown in report view and in the native wxMSW version override any column icon, i.e. if the sort indicator is shown for a column, no (other) icon is shown.
+    # Sort indicators are only shown in report view and in the native WXMSW version override any column icon, i.e. if the sort indicator is shown for a column, no (other) icon is shown.
     # This function should typically be called from EVT_LIST_COL_CLICK handler.
-    # This does not actually sort the list, use {Wx::ListCtrl#sort_items} for this.
+    # 
+    # <div class="wxrb-note">
+    # <b>Note:</b>
+    # <p>This does not actually sort the list, use {Wx::ListCtrl#sort_items} for this.
+    # </p>
+    # </div>
     # @param col [Integer]  The column to set the sort indicator for. If <code>-1</code> is given, then the currently shown sort indicator will be removed.
     # @param ascending [Boolean]  If true or false show the sort indicator corresponding to ascending or descending sort order respectively.
     # @return [void]
@@ -1153,7 +1195,12 @@ module Wx
     # This function may be overridden in the derived class for a control with {Wx::LC_VIRTUAL} style.
     # It should return the attribute for the for the specified item and column or NULL to use the default appearance parameters.
     # The base class version returns <code>OnGetItemAttr(item)</code>.
-    # Currently this function is only called under wxMSW, the other ports only support {Wx::ListCtrl#on_get_item_attr}
+    # 
+    # <div class="wxrb-note">
+    # <b>Note:</b>
+    # <p>Currently this function is only called under WXMSW, the other ports only support {Wx::ListCtrl#on_get_item_attr}
+    # </p>
+    # </div>
     # @see Wx::ListCtrl#on_get_item_attr
     # @see  Wx::ListCtrl#on_get_item_text
     # @see  Wx::ListCtrl#on_get_item_image
@@ -1236,12 +1283,12 @@ module Wx
   # - {Wx::LIST_MASK_FORMAT}: The column format field is valid.
   # 
   # The {Wx::ListItem} object can also contain item-specific colour and font information: for this you need to call one of {Wx::ListItem#set_text_colour}, {Wx::ListItem#set_background_colour} or {Wx::ListItem#set_font} functions on it passing it the colour/font to use. If the colour/font is not specified, the default list control colour/font is used.
-  # === 
   # 
   # Category:  Data Structures
   # @see Wx::ListCtrl 
   # 
   # 
+  # @wxrb_require USE_LISTCTRL
   class ListItem < Object
   
     # Sets client data for the item.
@@ -1413,12 +1460,12 @@ module Wx
   
   # Represents the attributes (colour, font, ...) of an item of a control with multiple items such as e.g.
   # {Wx::ListCtrl}.
-  # === 
   # 
   # Category:  Data Structures
   # @see wxListCtrl Overview
   # 
   # 
+  # @wxrb_require USE_LISTCTRL
   class ItemAttr < ::Object
   
     # @overload initialize()
@@ -1503,15 +1550,15 @@ module Wx
   # This class currently simply presents a simpler to use interface for the {Wx::ListCtrl}  it can be thought of as a façade for that complicated class.
   # Using it is preferable to using {Wx::ListCtrl} directly whenever possible because in the future some ports might implement {Wx::ListView} but not the full set of {Wx::ListCtrl} features.
   # Other than different interface, this class is identical to {Wx::ListCtrl}. In particular, it uses the same events, same window styles and so on.
-  # === 
   # 
-  # Category:  {Wx::Controls}  <div class='appearance'><span class='appearance'>Appearance:</span><table><tr><td> wxMSW Appearance
-  #   </td><td> wxGTK Appearance
-  #   </td><td> wxOSX Appearance
+  # Category:  {Wx::Controls}  <div class='appearance'><span class='appearance'>Appearance:</span><table><tr><td> WXMSW Appearance
+  #   </td><td> WXGTK Appearance
+  #   </td><td> WXOSX Appearance
   #   </td></tr></table></div>
   # @see Wx::ListView#set_column_image 
   # 
   # 
+  # @wxrb_require USE_LISTCTRL
   class ListView < ListCtrl
   
     # @overload initialize()

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

@@ -7,7 +7,7 @@
 module Wx
 
   # A list event holds information about events associated with {Wx::ListCtrl} objects.
-  # === Events using this class
+  # ### Events using this class
   # 
   # The following event-handler methods redirect the events to member method or handler blocks for {Wx::ListEvent} events.
   # Event handler methods:
@@ -56,16 +56,15 @@ module Wx
   # 
   # - {Wx::EvtHandler#evt_list_item_unchecked}(id, meth = nil, &block): The item has been unchecked (new since wxWidgets 3.1.0). 
   # 
-  # === 
-  # 
   # Category:  {Wx::Events}
   # @see Wx::ListCtrl 
   # 
   # 
+  # @wxrb_require USE_LISTCTRL
   class ListEvent < NotifyEvent
   
     # Constructor.
-    # @param commandType [Wx::CommandLinkButton::EventType] 
+    # @param commandType [Wx::Slider::EventType] 
     # @param id [Integer] 
     # @return [Wx::ListEvent]
     def initialize(commandType=Wx::EVT_NULL, id=0) end

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

@@ -35,7 +35,7 @@ module Wx
   # {Wx::Listbook} is a class similar to {Wx::Notebook} but which uses a {Wx::ListCtrl} to show the labels instead of the tabs.
   # The underlying {Wx::ListCtrl} displays page labels in a one-column report view by default. Calling Wx::BookCtrl::SetImageList will implicitly switch the control to use an icon view.
   # For usage documentation of this class, please refer to the base abstract class {Wx::BookCtrl}. You can also use the Notebook Sample to see {Wx::Listbook} in action.
-  # === Styles
+  # ### Styles
   # 
   # This class supports the following styles:
   # 
@@ -49,7 +49,7 @@ module Wx
   # 
   # - {Wx::LB_BOTTOM}: Place labels below the page area. 
   # 
-  # === Events emitted by this class
+  # ### Events emitted by this class
   # 
   # The following event-handler methods redirect the events to member method or handler blocks for {Wx::BookCtrlEvent} events.
   # Event handler methods for events emitted by this class:
@@ -58,17 +58,16 @@ module Wx
   # 
   # - {Wx::EvtHandler#evt_listbook_page_changing}(id, meth = nil, &block): The page selection is about to be changed. Processes a {Wx::EVT_LISTBOOK_PAGE_CHANGING} event. This event can be vetoed. 
   # 
-  # === 
-  # 
-  # Category:  Book Controls  <div class='appearance'><span class='appearance'>Appearance:</span><table><tr><td> wxMSW Appearance
-  #   </td><td> wxGTK Appearance
-  #   </td><td> wxOSX Appearance
+  # Category:  Book Controls  <div class='appearance'><span class='appearance'>Appearance:</span><table><tr><td> WXMSW Appearance
+  #   </td><td> WXGTK Appearance
+  #   </td><td> WXOSX Appearance
   #   </td></tr></table></div>
   # @see Wx::BookCtrl
   # @see  Wx::Notebook
   # @see  Notebook Sample 
   # 
   # 
+  # @wxrb_require USE_LISTBOOK
   class Listbook < BookCtrlBase
   
     # @overload initialize()

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

@@ -10,6 +10,7 @@ module Wx
   # 
   # This enum is generated by misc/languages/genlang.py When making changes, please put them into misc/languages/langtabl.txt
   # 
+  # @wxrb_require USE_INTL
   class Language < Wx::Enum
   
     # User's default/preferred language as got from OS.
@@ -3602,6 +3603,7 @@ module Wx
   # 
   # 
   # 
+  # @wxrb_require USE_INTL
   class LayoutDirection < Wx::Enum
   
     # 
@@ -3624,6 +3626,7 @@ module Wx
   # @see Wx::LocaleIdent#get_tag 
   # 
   # 
+  # @wxrb_require USE_INTL
   class LocaleTagType < Wx::Enum
   
     # Default (tag as given or else same as {Wx::LocaleTagType::LOCALE_TAGTYPE_SYSTEM})
@@ -3659,6 +3662,7 @@ module Wx
   # @see  Wx::UILocale#get_info 
   # 
   # 
+  # @wxrb_require USE_INTL
   class LocaleCategory < Wx::Enum
   
     # Number formatting.
@@ -3686,6 +3690,7 @@ module Wx
   # @see Wx::UILocale#get_info 
   # 
   # 
+  # @wxrb_require USE_INTL
   class LocaleInfo < Wx::Enum
   
     # The thousands separator.
@@ -3720,6 +3725,7 @@ module Wx
   # @see Wx::UILocale#get_localized_name 
   # 
   # 
+  # @wxrb_require USE_INTL
   class LocaleName < Wx::Enum
   
     # Display name of a locale.
@@ -3742,6 +3748,7 @@ module Wx
   # @see Wx::UILocale#get_localized_name 
   # 
   # 
+  # @wxrb_require USE_INTL
   class LocaleForm < Wx::Enum
   
     # Name should be returned in the language of the locale itself.
@@ -3758,6 +3765,7 @@ module Wx
   # 
   # 
   # 
+  # @wxrb_require USE_INTL
   class LocaleInitFlags < Wx::Enum
   
     # Don't load {Wx::std}.mo catalog.
@@ -3775,13 +3783,16 @@ module Wx
   def self.get_locale; end
   
   # {Wx::Locale} class encapsulates all language-dependent settings and is a generalization of the C locale concept.
-  # This class is known to have several problems under macOS: first of all, it is impossible to change the application UI locale after launching it under this platform and so using this class doesn't affect the native controls and dialogs there. Additionally, versions of macOS between 11.0 and 12.2 inclusive are affected by a bug when changing C locale can break display of the application menus. Because of this, it is recommended to use {Wx::UILocale} instead of this class for the applications targeting macOS.
+  # <div class="wxrb-note">
+  # <b>Note:</b>
+  # <p>This class is known to have several problems under macOS: first of all, it is impossible to change the application UI locale after launching it under this platform and so using this class doesn't affect the native controls and dialogs there. Additionally, versions of macOS between 11.0 and 12.2 inclusive are affected by a bug when changing C locale can break display of the application menus. Because of this, it is recommended to use {Wx::UILocale} instead of this class for the applications targeting macOS.
+  # </p>
+  # </div>
   # 
   # In wxWidgets this class manages current locale. It also initializes and activates {Wx::Translations} object that manages message catalogs.
   # For a list of the supported languages, please see {Wx::Language} enum values. These constants may be used to specify the language in {Wx::Locale#init} and are returned by {Wx::Locale.get_system_language}.
   # 
   #  
-  # === 
   # 
   # Category:  Application and System configuration
   # @see Wx::Internationalization
@@ -3790,6 +3801,7 @@ module Wx
   # @see  Wx::Translations 
   # 
   # 
+  # @wxrb_require USE_INTL
   class Locale < ::Object
   
     # @overload initialize()
@@ -3950,7 +3962,11 @@ module Wx
     def self.get_system_encoding_name; end
     
     # Tries to detect the user's default locale setting.
-    # This function is somewhat misleading, as it uses the default system locale to determine its return value, and not just the system language. It is preserved for backwards compatibility, but to actually get the language, and not locale, used by the system by default, call Wx::UILocale#get_system_language instead.
+    # <div class="wxrb-note">
+    # <b>Note:</b>
+    # <p>This function is somewhat misleading, as it uses the default system locale to determine its return value, and not just the system language. It is preserved for backwards compatibility, but to actually get the language, and not locale, used by the system by default, call Wx::UILocale#get_system_language instead.
+    # </p>
+    # </div>
     # 
     # Returns the {Wx::Language} value or {Wx::Language::LANGUAGE_UNKNOWN} if the locale is not recognized, as can notably happen when combining any language with a region where this language is not typically spoken.
     # @see Wx::Translations#get_best_translation. 
@@ -3988,8 +4004,33 @@ module Wx
   # 
   # 
   # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
+  # @wxrb_require USE_INTL
   class LanguageInfo < ::Object
   
+    # Win32 language identifiers (LANG_xxxx, SUBLANG_xxxx).
+    # Availability:  only available for the WXMSW port.
+    # 
+    # @return [Integer]
+    def win_lang; end
+    # Win32 language identifiers (LANG_xxxx, SUBLANG_xxxx).
+    # Availability:  only available for the WXMSW port.
+    # 
+    # @param val [Integer]
+    # @return [void]
+    def win_lang=(val); end
+    
+    # Win32 language identifiers (LANG_xxxx, SUBLANG_xxxx).
+    # Availability:  only available for the WXMSW port.
+    # 
+    # @return [Integer]
+    def win_sublang; end
+    # Win32 language identifiers (LANG_xxxx, SUBLANG_xxxx).
+    # Availability:  only available for the WXMSW port.
+    # 
+    # @param val [Integer]
+    # @return [void]
+    def win_sublang=(val); end
+    
     # {Wx::Language} id.
     # It should be greater than {Wx::Language::LANGUAGE_USER_DEFINED} when defining your own language info structure.
     # 
@@ -4075,8 +4116,9 @@ module Wx
     def layout_direction=(val); end
     
     # Return the LCID corresponding to this language.
-    # Availability:  only available for the wxMSW port.  {Wx::msw}
+    # Availability:  only available for the WXMSW port.
     # @return [Integer]
+    # @wxrb_require WXMSW
     def get_lcid; end
     alias_method :lcid, :get_lcid
     

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

@@ -10,6 +10,7 @@ module Wx
   # 
   # 
   # 
+  # @wxrb_require USE_LOG
   class LogLevelValues < Wx::Enum
   
     # program can't continue, abort immediately
@@ -61,15 +62,19 @@ module Wx
   # {Wx::Log} class defines the interface for the log targets used by wxWidgets logging functions as explained in the Logging Overview.
   # The only situations when you need to directly use this class is when you want to derive your own log target because the existing ones don't satisfy your needs.
   # Otherwise, it is completely hidden behind the wxLogXXX() functions and you may not even know about its existence.
-  # For console-mode applications, the default target is {Wx::LogStderr}, so that all {log_xxx} functions print on stderr when {Wx::Setup::USE_GUI} = 0.
   # 
-  # === 
+  # <div class="wxrb-note">
+  # <b>Note:</b>
+  # <p>For console-mode applications, the default target is {Wx::LogStderr}, so that all {log_xxx} functions print on stderr when {Wx::Setup::USE_GUI} = 0.
+  # </p>
+  # </div>
   # 
   # Category:  {Wx::Logging}
   # @see Logging Overview
   # @see  wxLogXXX() functions 
   # 
   # 
+  # @wxrb_require USE_LOG
   class Log < ::Object
   
     # Add the mask to the list of allowed masks for {log_trace}.
@@ -294,12 +299,12 @@ module Wx
   # {Wx::LogBuffer} is a very simple implementation of log sink which simply collects all the logged messages in a string (except the debug messages which are output in the usual way immediately as we're presumably not interested in collecting them for later).
   # The messages from different log function calls are separated by the new lines.
   # All the messages collected so far can be shown to the user (and the current buffer cleared) by calling the overloaded {Wx::LogBuffer#flush} method.
-  # === 
   # 
   # Category:  {Wx::Logging}
   # 
   # 
   # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
+  # @wxrb_require USE_LOG
   class LogBuffer < Log
   
     # The default ctor does nothing.
@@ -325,10 +330,9 @@ module Wx
   #   ...
   # ```
   # 
-  # === 
-  # 
   # Category:  {Wx::Logging}
   # 
+  # @wxrb_require USE_LOG
   class LogChain < Log
   
     # Sets the specified logger (which may be NULL) as the default log target but the log messages are also passed to the previous log target if any.
@@ -370,12 +374,12 @@ module Wx
   # Also notice that if an error message is logged when several informative messages had been already logged before, the informative messages are discarded on the assumption that they are not useful  and may be confusing and hence harmful  any more after the error. The warning and error messages are never discarded however and any informational messages logged after the first error one are also kept (as they may contain information about the error recovery). You may override DoLog() method to change this behaviour.
   # At any rate, it is possible that that several messages were accumulated before this class {Wx::LogGui#flush} method is called. If this is the case, {Wx::LogGui#flush} uses a custom dialog which shows the last message directly and allows the user to view the previously logged ones by expanding the "Details" {Wx::CollapsiblePane} inside it. This custom dialog also provides the buttons for copying the log messages to the clipboard and saving them to a file.
   # However if only a single message is present when {Wx::LogGui#flush} is called, just a {message_box} is used to show it. This has the advantage of being closer to the native behaviour but it doesn't give the user any possibility to copy or save the message (except for the recent Windows versions where <code>Ctrl-C</code> may be pressed in the message box to copy its contents to the clipboard) so you may want to override {Wx::LogGui#do_show_single_log_message} to customize {Wx::LogGui}  the dialogs sample shows how to do this.
-  # === 
   # 
   # Category:  {Wx::Logging}
   # 
   # 
   # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
+  # @wxrb_require USE_LOG
   class LogGui < Log
   
     # Default constructor.
@@ -386,7 +390,6 @@ module Wx
   
   # This class can be used to redirect the log messages to a C file stream (not to be confused with C++ streams).
   # It is the default log target for the non-GUI wxWidgets applications which send all the output to stderr.
-  # === 
   # 
   # Category:  {Wx::Logging}
   # @see Wx::LogStream 
@@ -394,13 +397,13 @@ module Wx
   # 
   # 
   # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
+  # @wxrb_require USE_LOG
   class LogStderr < Log
   
   end # LogStderr
   
   # Using these target all the log messages can be redirected to a text control.
   # The text control must have been created with {Wx::TE_MULTILINE} style by the caller previously.
-  # === 
   # 
   # Category:  {Wx::Logging}
   # @see Wx::TextCtrl
@@ -409,6 +412,7 @@ module Wx
   # 
   # 
   # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
+  # @wxrb_require USE_LOG
   class LogTextCtrl < Log
   
     # Constructs a log target which sends all the log messages to the given text control.
@@ -423,10 +427,10 @@ module Wx
   # It forwards log messages to the previously installed one in addition to processing them itself.
   # Unlike {Wx::LogChain} which is usually used directly as is, this class must be derived from to implement {Wx::Log::DoLog} and/or {Wx::Log::DoLogString} methods.
   # {Wx::LogInterposer} destroys the previous log target in its destructor. If you don't want this to happen, use {Wx::LogInterposerTemp} instead.
-  # === 
   # 
   # Category:  {Wx::Logging}
   # 
+  # @wxrb_require USE_LOG
   class LogInterposer < LogChain
   
     # The default constructor installs this object as the current active log target.
@@ -437,12 +441,12 @@ module Wx
   
   # This class represents a background log window: to be precise, it collects all log messages in the log frame which it manages but also passes them on to the log target which was active at the moment of its creation.
   # This allows you, for example, to show all the log messages in a frame but still continue to process them normally by showing the standard log dialog.
-  # === 
   # 
   # Category:  {Wx::Logging}
   # @see Wx::LogTextCtrl 
   # 
   # 
+  # @wxrb_require USE_LOG
   class LogWindow < LogInterposer
   
     # Creates the log frame window and starts collecting the messages in it.
@@ -513,12 +517,11 @@ module Wx
   #   end
   # ```
   # 
-  # === 
-  # 
   # Category:  {Wx::Logging}
   # 
   # 
   # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
+  # @wxrb_require USE_LOG
   class LogNull < ::Object
   
   end # LogNull
@@ -528,6 +531,7 @@ module Wx
   # 
   # 
   # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
+  # @wxrb_require USE_LOG
   class LogRecordInfo < ::Object
   
   end # LogRecordInfo

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

@@ -7,10 +7,15 @@
 module Wx
 
   # An MDI client window is a child of {Wx::MDIParentFrame}, and manages zero or more {Wx::MDIChildFrame} objects.
+  # <div class="wxrb-remark">
+  # <b>Remark:</b>
+  # <p>
+  # </p>
+  # </div>>
+  # 
   # The client window is the area where MDI child windows exist. It doesn't have to cover the whole parent frame; other windows such as toolbars and a help window might coexist with it. There can be scrollbars on a client window, which are controlled by the parent window style.
   # The {Wx::MDIClientWindow} class is usually adequate without further derivation, and it is created automatically when the MDI parent frame is created. If the application needs to derive a new class, the function {Wx::MDIParentFrame#on_create_client} must be overridden in order to give an opportunity to use a different class of client window.
-  # Under wxMSW, the client window will automatically have a sunken border style when the active child is not maximized, and no border style when a child is maximized.
-  # === 
+  # Under WXMSW, the client window will automatically have a sunken border style when the active child is not maximized, and no border style when a child is maximized.
   # 
   # Category:  Managed Windows
   # @see Wx::MDIChildFrame
@@ -18,6 +23,7 @@ module Wx
   # @see  Wx::Frame 
   # 
   # 
+  # @wxrb_require USE_MDI
   class MDIClientWindow < Window
   
     # Default constructor.