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

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

@@ -478,13 +478,13 @@ module Wx
   
   # A text control allows text to be displayed and edited.
   # It may be single line or multi-line. Notice that a lot of methods of the text controls are found in the base {Wx::TextEntry} class which is a common base class for {Wx::TextCtrl} and other controls using a single line text entry field (e.g. {Wx::ComboBox}).
-  # === Styles
+  # ### Styles
   # 
   # This class supports the following styles:
   # 
   # - {Wx::TE_PROCESS_ENTER}: The control will generate the event {Wx::EVT_TEXT_ENTER} that can be handled by the program. Otherwise, i.e. either if this style not specified at all, or it is used, but there is no event handler for this event or the event handler called {Wx::Event#skip} to avoid overriding the default handling, pressing Enter key is either processed internally by the control or used to activate the default button of the dialog, if any. 
   # 
-  # - {Wx::TE_PROCESS_TAB}: Normally, TAB key is used for keyboard navigation and pressing it in a control switches focus to the next one. With this style, this won't happen and if the TAB is not otherwise processed (e.g. by {Wx::EVT_CHAR} event handler), a literal TAB character is inserted into the control. Notice that this style has no effect for single-line text controls when using wxGTK. 
+  # - {Wx::TE_PROCESS_TAB}: Normally, TAB key is used for keyboard navigation and pressing it in a control switches focus to the next one. With this style, this won't happen and if the TAB is not otherwise processed (e.g. by {Wx::EVT_CHAR} event handler), a literal TAB character is inserted into the control. Notice that this style has no effect for single-line text controls when using WXGTK. 
   # 
   # - {Wx::TE_MULTILINE}: The text control allows multiple lines. If this style is not specified, line break characters should not be used in the controls value. 
   # 
@@ -502,39 +502,39 @@ module Wx
   # 
   # - {Wx::HSCROLL}: A horizontal scrollbar will be created and used, so that text won't be wrapped. 
   # 
-  # - {Wx::TE_NO_VSCROLL}: For multiline controls only: vertical scrollbar will never be created. This limits the amount of text which can be entered into the control to what can be displayed in it under wxMSW but not under wxGTK or wxOSX. Currently not implemented for the other platforms. 
+  # - {Wx::TE_NO_VSCROLL}: For multiline controls only: vertical scrollbar will never be created. This limits the amount of text which can be entered into the control to what can be displayed in it under WXMSW but not under WXGTK or WXOSX. Currently not implemented for the other platforms. 
   # 
   # - {Wx::TE_LEFT}: The text in the control will be left-justified (default). 
   # 
-  # - {Wx::TE_CENTRE}: The text in the control will be centered (wxMSW, wxGTK, wxOSX). 
+  # - {Wx::TE_CENTRE}: The text in the control will be centered (WXMSW, WXGTK, WXOSX). 
   # 
-  # - {Wx::TE_RIGHT}: The text in the control will be right-justified (wxMSW, wxGTK, wxOSX). 
+  # - {Wx::TE_RIGHT}: The text in the control will be right-justified (WXMSW, WXGTK, WXOSX). 
   # 
   # - {Wx::TE_DONTWRAP}: Same as {Wx::HSCROLL} style: don't wrap at all, show horizontal scrollbar instead. 
   # 
-  # - {Wx::TE_CHARWRAP}: For multiline controls only: wrap the lines too long to be shown entirely at any position ({Wx::Univ}, wxGTK, wxOSX). 
+  # - {Wx::TE_CHARWRAP}: For multiline controls only: wrap the lines too long to be shown entirely at any position ({Wx::Univ}, WXGTK, WXOSX). 
   # 
-  # - {Wx::TE_WORDWRAP}: For multiline controls only: wrap the lines too long to be shown entirely at word boundaries ({Wx::Univ}, wxMSW, wxGTK, wxOSX). 
+  # - {Wx::TE_WORDWRAP}: For multiline controls only: wrap the lines too long to be shown entirely at word boundaries ({Wx::Univ}, WXMSW, WXGTK, WXOSX). 
   # 
   # - {Wx::TE_BESTWRAP}: For multiline controls only: wrap the lines at word boundaries or at any other character if there are words longer than the window width (this is the default). 
   # 
   # - {Wx::TE_CAPITALIZE}: On PocketPC and Smartphone, causes the first letter to be capitalized. 
   # 
-  # Note that alignment styles ({Wx::TE_LEFT}, {Wx::TE_CENTRE} and {Wx::TE_RIGHT}) can be changed dynamically after control creation on wxMSW, wxGTK and wxOSX. {Wx::TE_READONLY}, {Wx::TE_PASSWORD} and wrapping styles can be dynamically changed under wxGTK but not wxMSW. The other styles can be only set during control creation.
+  # Note that alignment styles ({Wx::TE_LEFT}, {Wx::TE_CENTRE} and {Wx::TE_RIGHT}) can be changed dynamically after control creation on WXMSW, WXGTK and WXOSX. {Wx::TE_READONLY}, {Wx::TE_PASSWORD} and wrapping styles can be dynamically changed under WXGTK but not WXMSW. The other styles can be only set during control creation.
   # 
-  # == wxTextCtrl Text Format
+  # ## wxTextCtrl Text Format
   # 
   # The multiline text controls always store the text as a sequence of lines separated by <code>'\n'</code> characters, i.e. in the Unix text format even on non-Unix platforms. This allows the user code to ignore the differences between the platforms but at a price: the indices in the control such as those returned by {Wx::TextCtrl#get_insertion_point} or {Wx::TextCtrl#get_selection} can <b>not</b> be used as indices into the string returned by {Wx::TextCtrl#get_value} as they're going to be slightly off for platforms using <code>"\\r\\n"</code> as separator (as Windows does).
   # Instead, if you need to obtain a substring between the 2 indices obtained from the control with the help of the functions mentioned above, you should use {Wx::TextCtrl#get_range}. And the indices themselves can only be passed to other methods, for example {Wx::TextCtrl#set_insertion_point} or {Wx::TextCtrl#set_selection}.
   # To summarize: never use the indices returned by (multiline) {Wx::TextCtrl} as indices into the string it contains, but only as arguments to be passed back to the other {Wx::TextCtrl} methods. This problem doesn't arise for single-line platforms however where the indices in the control do correspond to the positions in the value string.
   # 
-  # == wxTextCtrl Positions and Coordinates
+  # ## wxTextCtrl Positions and Coordinates
   # 
   # It is possible to use either linear positions, i.e. roughly (but not always exactly, as explained in the previous section) the index of the character in the text contained in the control or X-Y coordinates, i.e. column and line of the character when working with this class and it provides the functions {Wx::TextCtrl#position_to_xy} and {Wx::TextCtrl#xy_to_position} to convert between the two.
   # Additionally, a position in the control can be converted to its coordinates in pixels using {Wx::TextCtrl#position_to_coords} which can be useful to e.g. show a popup menu near the given character. And, in the other direction, {Wx::TextCtrl#hit_test} can be used to find the character under, or near, the given pixel coordinates.
   # To be more precise, positions actually refer to the gaps between characters and not the characters themselves. Thus, position 0 is the one before the very first character in the control and so is a valid position even when the control is empty. And if the control contains a single character, it has two valid positions: 0 before this character and 1  after it. This, when the documentation of various functions mentions "invalid position", it doesn't consider the position just after the last character of the line to be invalid, only the positions beyond that one (e.g. 2 and greater in the single character example) are actually invalid.
   # 
-  # == wxTextCtrl Styles.
+  # ## wxTextCtrl Styles.
   # 
   # Multi-line text controls support styling, i.e. provide a possibility to set colours and font for individual characters in it (note that under Windows {Wx::TE_RICH} style is required for style support). To use the styles you can either call {Wx::TextCtrl#set_default_style} before inserting the text or call {Wx::TextCtrl#set_style} later to change the style of the text already in the control (the first solution is much more efficient).
   # In either case, if the style doesn't specify some of the attributes (for example you only want to set the text colour but without changing the font nor the text background), the values of the default style will be used for them. If there is no default style, the attributes of the text control itself are used.
@@ -549,10 +549,63 @@ module Wx
   #   text.append_text("Blue on grey text\n")
   # ```
   # 
-  # == Event Handling.
+  # ## wxTextCtrl and C++ Streams
+  # 
+  # This class multiply-inherits from std::streambuf (except for some really old compilers using non-standard iostream library), allowing code such as the following:
+  # 
+  # ```
+  #   wxTextCtrl *control = new wxTextCtrl(...);
+  #   
+  #   ostream stream(control)
+  #   
+  #   stream << 123.456 << " some text\n";
+  #   stream.flush();
+  # ```
+  # 
+  # Note that even if your build of wxWidgets doesn't support this (the symbol {Wx::HAS_TEXT_WINDOW_STREAM} has value of 0 then) you can still use {Wx::TextCtrl} itself in a stream-like manner:
+  # 
+  # ```
+  #   wxTextCtrl *control = new wxTextCtrl(...);
+  #   
+  #   *control << 123.456 << " some text\n";
+  # ```
+  # 
+  # However the possibility to create a std::ostream associated with {Wx::TextCtrl} may be useful if you need to redirect the output of a function taking a std::ostream as parameter to a text control.
+  # Another commonly requested need is to redirect std::cout to the text control. This may be done in the following way:
+  # 
+  # ```
+  #   \#include <iostream>
+  #   
+  #   wxTextCtrl *control = new wxTextCtrl(...);
+  #   
+  #   std::streambuf *sbOld = std::cout.rdbuf();
+  #   std::cout.rdbuf(control);
+  #   
+  #   // use cout as usual, the output appears in the text control
+  #   ...
+  #   
+  #   std::cout.rdbuf(sbOld);
+  # ```
+  # 
+  # But wxWidgets provides a convenient class to make it even simpler so instead you may just do
+  # 
+  # ```
+  #   \#include <iostream>
+  #   
+  #   wxTextCtrl *control = new wxTextCtrl(...);
+  #   
+  #   wxStreamToTextRedirector redirect(control);
+  #   
+  #   // all output to cout goes into the text control until the exit from
+  #   // current scope
+  # ```
+  # 
+  # See {Wx::StreamToTextRedirector} for more details.
+  # 
+  # ## Event Handling.
   # 
   # The following commands are processed by default event handlers in {Wx::TextCtrl}: {Wx::StandardID::ID_CUT}, {Wx::StandardID::ID_COPY}, {Wx::StandardID::ID_PASTE}, {Wx::StandardID::ID_UNDO}, {Wx::StandardID::ID_REDO}. The associated UI update events are also processed automatically, when the control has the focus.
-  # === 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::CommandEvent} events.
   # Event handler methods for events emitted by this class:
@@ -565,11 +618,9 @@ module Wx
   # 
   # - {Wx::EvtHandler#evt_text_maxlen}(id, meth = nil, &block): This event is generated when the user tries to enter more text into the control than the limit set by {Wx::TextCtrl#set_max_length}, see its description. 
   # 
-  # === 
-  # 
-  # 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::TextCtrl#create
   # @see  Wx::Validator 
@@ -584,7 +635,11 @@ module Wx
     #   @return [Wx::TextCtrl]
     # @overload initialize(parent, id, value=(''), pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, validator=Wx::DEFAULT_VALIDATOR, name=Wx::TEXT_CTRL_NAME_STR)
     #   Constructor, creating and showing a text control.
-    #   The horizontal scrollbar ({Wx::HSCROLL} style flag) will only be created for multi-line text controls. Without a horizontal scrollbar, text lines that don't fit in the control's size will be wrapped (but no newline character is inserted). Single line controls don't have a horizontal scrollbar, the text is automatically scrolled so that the insertion point is always visible.
+    #   <div class="wxrb-remark">
+    #   <b>Remark:</b>
+    #   <p>The horizontal scrollbar ({Wx::HSCROLL} style flag) will only be created for multi-line text controls. Without a horizontal scrollbar, text lines that don't fit in the control's size will be wrapped (but no newline character is inserted). Single line controls don't have a horizontal scrollbar, the text is automatically scrolled so that the insertion point is always visible.
+    #   </p>
+    #   </div>>
     #   @see Wx::TextCtrl#create
     #   @see  Wx::Validator 
     #   @param parent [Wx::Window]  Parent window. Should not be NULL.
@@ -616,7 +671,7 @@ module Wx
     def discard_edits; end
     
     # Delete the undo history.
-    # Currently only implemented in wxMSW (for controls using {Wx::TE_RICH2} style only) and wxOSX (for multiline text controls only), does nothing in the other ports or for the controls not using the appropriate styles.
+    # Currently only implemented in WXMSW (for controls using {Wx::TE_RICH2} style only) and WXOSX (for multiline text controls only), does nothing in the other ports or for the controls not using the appropriate styles.
     # @return [void]
     def empty_undo_buffer; end
     
@@ -649,8 +704,13 @@ module Wx
     alias_method :line_text, :get_line_text
     
     # Returns the number of lines in the text control buffer.
-    # The returned number is the number of logical lines, i.e. just the count of the number of newline characters in the control + 1, for wxGTK and wxOSX/Cocoa ports while it is the number of physical lines, i.e. the count of lines actually shown in the control, in wxMSW. Because of this discrepancy, it is not recommended to use this function.
-    # Note that even empty text controls have one line (where the insertion point is), so {Wx::TextCtrl#get_number_of_lines} never returns 0.
+    # The returned number is the number of logical lines, i.e. just the count of the number of newline characters in the control + 1, for WXGTK and WXOSX/Cocoa ports while it is the number of physical lines, i.e. the count of lines actually shown in the control, in WXMSW. Because of this discrepancy, it is not recommended to use this function.
+    # 
+    # <div class="wxrb-remark">
+    # <b>Remark:</b>
+    # <p>Note that even empty text controls have one line (where the insertion point is), so {Wx::TextCtrl#get_number_of_lines} never returns 0. 
+    # </p>
+    # </div>>
     # @return [Integer]
     def get_number_of_lines; end
     alias_method :number_of_lines, :get_number_of_lines
@@ -668,7 +728,7 @@ module Wx
     
     # Finds the row and column of the character at the specified point.
     # If the return code is not {Wx::TextCtrlHitTestResult::TE_HT_UNKNOWN} the row and column of the character closest to this position are returned, otherwise the output parameters are not modified.
-    # Please note that this function is currently only implemented in {Wx::Univ}, wxMSW and wxGTK ports and always returns {Wx::TextCtrlHitTestResult::TE_HT_UNKNOWN} in the other ports.
+    # Please note that this function is currently only implemented in {Wx::Univ}, WXMSW and WXGTK ports and always returns {Wx::TextCtrlHitTestResult::TE_HT_UNKNOWN} in the other ports.
     # @see Wx::TextCtrl#position_to_xy
     # @see  Wx::TextCtrl#xy_to_position 
     # @param pt [Array(Integer, Integer), Wx::Point]  The position of the point to check, in window device coordinates.
@@ -711,7 +771,11 @@ module Wx
     def mark_dirty; end
     
     # This event handler function implements default drag and drop behaviour, which is to load the first dropped file into the control.
-    # This is not implemented on non-Windows platforms.
+    # <div class="wxrb-remark">
+    # <b>Remark:</b>
+    # <p>This is not implemented on non-Windows platforms.
+    # </p>
+    # </div>>
     # @see Wx::DropFilesEvent 
     # @param event [Wx::DropFilesEvent]  The drop files event.
     # @return [void]
@@ -726,13 +790,14 @@ module Wx
     
     # Converts given text position to client coordinates in pixels.
     # This function allows finding where is the character at the given position displayed in the text control.
-    # Availability:  only available for the wxMSW, wxGTK ports.  {Wx::msw},{Wx::gtk} . Additionally, wxGTK only implements this method for multiline controls and {Wx::DEFAULT_POSITION} is always returned for the single line ones.
+    # Availability:  only available for the WXMSW, WXGTK ports.   . Additionally, WXGTK only implements this method for multiline controls and {Wx::DEFAULT_POSITION} is always returned for the single line ones.
     # 
     # On success returns a {Wx::Point} which contains client coordinates for the given position in pixels, otherwise returns {Wx::DEFAULT_POSITION}.
     # @see Wx::TextCtrl#xy_to_position
     # @see  Wx::TextCtrl#position_to_xy 
     # @param pos [Integer]  Text position in 0 to {Wx::TextCtrl#get_last_position} range (inclusive).
     # @return [Wx::Point]
+    # @wxrb_require WXMSW|WXGTK
     def position_to_coords(pos) end
     
     # Saves the contents of the control in a text file.

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

@@ -8,7 +8,6 @@ module Wx
 
   # Common base class for single line text entry fields.
   # This class is not a control itself, as it doesn't derive from {Wx::Window}. Instead it is used as a base class by other controls, notably {Wx::TextCtrl} and {Wx::ComboBox} and gathers the methods common to both of them.
-  # === 
   # 
   # Category:  {Wx::Controls}
   # @see Wx::TextCtrl
@@ -36,7 +35,11 @@ module Wx
     alias_method :margins=, :set_margins
     
     # Appends the text to the end of the text control.
-    # After the text is appended, the insertion point will be at the end of the text control. If this behaviour is not desired, the programmer should use {Wx::TextEntry#get_insertion_point} and {Wx::TextEntry#set_insertion_point}.
+    # <div class="wxrb-remark">
+    # <b>Remark:</b>
+    # <p>After the text is appended, the insertion point will be at the end of the text control. If this behaviour is not desired, the programmer should use {Wx::TextEntry#get_insertion_point} and {Wx::TextEntry#set_insertion_point}.
+    # </p>
+    # </div>>
     # @see Wx::TextEntry#write_text 
     # @param text [String]  Text to write to the text control.
     # @return [void]
@@ -61,7 +64,7 @@ module Wx
     def auto_complete(*args) end
     
     # Call this function to enable auto-completion of the text typed in a single-line text control using all valid file system paths.
-    # Notice that currently this function is only implemented in wxMSW port and does nothing under the other platforms.
+    # Notice that currently this function is only implemented in WXMSW port and does nothing under the other platforms.
     # 
     # true if the auto-completion was enabled or false if the operation failed, typically because auto-completion is not supported by the current platform.
     # @see Wx::TextEntry#auto_complete 
@@ -70,7 +73,7 @@ module Wx
     
     # Call this function to enable auto-completion of the text using the file system directories.
     # Unlike {Wx::TextEntry#auto_complete_file_names} which completes both file names and directories, this function only completes the directory names.
-    # Notice that currently this function is only implemented in wxMSW port and does nothing under the other platforms.
+    # Notice that currently this function is only implemented in WXMSW port and does nothing under the other platforms.
     # 
     # true if the auto-completion was enabled or false if the operation failed, typically because auto-completion is not supported by the current platform.
     # @see Wx::TextEntry#auto_complete 
@@ -236,7 +239,7 @@ module Wx
     # This function sets the maximum number of characters the user can enter into the control.
     # In other words, it allows limiting the text value length to len not counting the terminating NUL character.
     # If len is 0, the previously set max length limit, if any, is discarded and the user may enter as much text as the underlying native text control widget supports (typically at least 32Kb). If the user tries to enter more characters into the text control when it already is filled up to the maximal length, a {Wx::EVT_TEXT_MAXLEN} event is sent to notify the program about it (giving it the possibility to show an explanatory message, for example) and the extra input is discarded.
-    # Note that in wxGTK this function may only be used with single line text controls.
+    # Note that in WXGTK this function may only be used with single line text controls.
     # @param len [Integer] 
     # @return [void]
     def set_max_length(len) end
@@ -265,11 +268,21 @@ module Wx
     # The hints are usually used to indicate to the user what is supposed to be entered into the given entry field, e.g. a common use of them is to show an explanation of what can be entered in a {Wx::SearchCtrl}.
     # The hint is shown (usually greyed out) for an empty control until it gets focus and is shown again if the control loses it and remains empty. It won't be shown once the control has a non-empty value, although it will be shown again if the control contents is cleared. Because of this, it generally only makes sense to use hints with the controls which are initially empty.
     # Notice that hints are known as cue banners under MSW or placeholder strings under macOS.
-    # Currently implemented natively on Windows (Vista and later only), macOS and GTK+ (3.2 and later).
+    # 
+    # <div class="wxrb-remark">
+    # <b>Remark:</b>
+    # <p>Currently implemented natively on Windows (Vista and later only), macOS and GTK+ (3.2 and later).
+    # </p>
+    # </div>>
     # 
     # For the platforms without native hints support, the implementation has several known limitations. Notably, the hint display will not be properly updated if you change {Wx::TextEntry} contents programmatically when the hint is displayed using methods other than {Wx::TextEntry#set_value} or {Wx::TextEntry#change_value} or others which use them internally (e.g. {Wx::TextEntry#clear}). In other words, currently you should avoid calling methods such as {Wx::TextEntry#write_text} or {Wx::TextEntry#replace} when using hints and the text control is empty. If you bind to the control's focus and {Wx::EVT_TEXT} events, you must call {Wx::Event#skip} on them so that the generic implementation works correctly.
     # Another limitation is that hints are ignored for the controls with {Wx::TE_PASSWORD} style.
-    # Hints can be used for single line text controls under all platforms, but only MSW and GTK+ 2 support them for multi-line text controls, they are ignored for them under the other platforms.
+    # 
+    # <div class="wxrb-remark">
+    # <b>Remark:</b>
+    # <p>Hints can be used for single line text controls under all platforms, but only MSW and GTK+ 2 support them for multi-line text controls, they are ignored for them under the other platforms.
+    # </p>
+    # </div>>
     # @param hint [String] 
     # @return [Boolean]
     def set_hint(hint) end
@@ -283,7 +296,12 @@ module Wx
     
     # Returns the margins used by the control.
     # The x field of the returned point is the horizontal margin and the y field is the vertical one.
-    # If given margin cannot be accurately determined, its value will be set to -1. On some platforms you cannot obtain valid margin values until you have called {Wx::TextEntry#set_margins}.
+    # 
+    # <div class="wxrb-remark">
+    # <b>Remark:</b>
+    # <p>If given margin cannot be accurately determined, its value will be set to -1. On some platforms you cannot obtain valid margin values until you have called {Wx::TextEntry#set_margins}.
+    # </p>
+    # </div>>
     # @see Wx::TextEntry#set_margins
     # @return [Wx::Point]
     def get_margins; end
@@ -304,7 +322,11 @@ module Wx
     def undo; end
     
     # Writes the text into the text control at the current insertion position.
-    # Newlines in the text string are the only control characters allowed, and they will cause appropriate line breaks. See operator<<() and {Wx::TextEntry#append_text} for more convenient ways of writing to the window. After the write operation, the insertion point will be at the end of the inserted text, so subsequent write operations will be appended. To append text after the user may have interacted with the control, call {Wx::TextCtrl#set_insertion_point_end} before writing.
+    # <div class="wxrb-remark">
+    # <b>Remark:</b>
+    # <p>Newlines in the text string are the only control characters allowed, and they will cause appropriate line breaks. See operator<<() and {Wx::TextEntry#append_text} for more convenient ways of writing to the window. After the write operation, the insertion point will be at the end of the inserted text, so subsequent write operations will be appended. To append text after the user may have interacted with the control, call {Wx::TextCtrl#set_insertion_point_end} before writing. 
+    # </p>
+    # </div>>
     # @param text [String]  Text to write to the text control.
     # @return [void]
     def write_text(text) end
@@ -361,8 +383,6 @@ module Wx
   #   text_ctrl.auto_complete(MyTextCompleter.new)
   # ```
   # 
-  # ===
-  # 
   # 
   # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
   class TextCompleterSimple < TextCompleter

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

@@ -42,12 +42,12 @@ module Wx
   
   # This class represents a dialog that requests a one-line text string from the user.
   # It is implemented as a generic wxWidgets dialog.
-  # === 
   # 
   # Category:  Common Dialogs
   # @see wxTextEntryDialog Overview 
   # 
   # 
+  # @wxrb_require USE_TEXTDLG
   class TextEntryDialog < Dialog
   
     # @overload set_text_validator(validator)
@@ -145,12 +145,12 @@ module Wx
   
   # This class represents a dialog that requests a one-line password string from the user.
   # It is implemented as a generic wxWidgets dialog.
-  # === 
   # 
   # Category:  Common Dialogs
   # @see wxPasswordEntryDialog Overview 
   # 
   # 
+  # @wxrb_require USE_TEXTDLG
   class PasswordEntryDialog < TextEntryDialog
   
     # Constructor.

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

@@ -10,6 +10,7 @@ module Wx
   # 
   # Notice that {Wx::FILTER_EXCLUDE}[_CHAR]_LIST pair can be used to document the purpose of the validator only and are not enforced in the implementation of the {Wx::TextValidator}. Therefore, calling the corresponding member functions: {Wx::TextValidator}::{SetExcludes,SetCharExcludes}(), is enough to create the desired validator.
   # 
+  # @wxrb_require USE_VALIDATORS
   class TextValidatorStyle < Wx::Enum
   
     # No filtering takes place.
@@ -68,7 +69,6 @@ module Wx
   
   # {Wx::TextValidator} validates text controls, providing a variety of filtering behaviours.
   # For more information, please see wxValidator Overview.
-  # === 
   # 
   # Category:  {Wx::Validators}
   # @see wxValidator Overview
@@ -78,6 +78,7 @@ module Wx
   # @see  Wx::FloatingPointValidator 
   # 
   # 
+  # @wxrb_require USE_VALIDATORS
   class TextValidator < Validator
   
     # Clones the text validator using the copy constructor.
@@ -118,16 +119,28 @@ module Wx
     alias_method :has_flag?, :has_flag
     
     # Sets the exclude list (invalid values for the user input).
-    # Beware that exclusion takes priority over inclusion.
+    # <div class="wxrb-note">
+    # <b>Note:</b>
+    # <p>Beware that exclusion takes priority over inclusion. 
+    # </p>
+    # </div>
     # @param stringList [Array<String>] 
     # @return [void]
     def set_excludes(stringList) end
     alias_method :excludes=, :set_excludes
     
     # Sets the exclude char list (invalid characters for the user input).
-    # Beware that exclusion takes priority over inclusion. 
-    # 
-    # This function may cancel the effect of {Wx::TextValidatorStyle::FILTER_SPACE} if the passed in string chars contains the <b>space</b> character.
+    # <div class="wxrb-note">
+    # <b>Note:</b>
+    # <p>Beware that exclusion takes priority over inclusion. 
+    # </p>
+    # </div>
+    # 
+    # <div class="wxrb-note">
+    # <b>Note:</b>
+    # <p>This function may cancel the effect of {Wx::TextValidatorStyle::FILTER_SPACE} if the passed in string chars contains the <b>space</b> character. 
+    # </p>
+    # </div>
     # @param chars [String] 
     # @return [void]
     def set_char_excludes(chars) end
@@ -142,32 +155,52 @@ module Wx
     alias_method :includes=, :set_includes
     
     # Sets the include char list (additional valid values for the user input).
-    # Any explicitly excluded characters will still be excluded even if they're part of chars.
+    # <div class="wxrb-note">
+    # <b>Note:</b>
+    # <p>Any explicitly excluded characters will still be excluded even if they're part of chars. 
+    # </p>
+    # </div>
     # @param chars [String] 
     # @return [void]
     def set_char_includes(chars) end
     alias_method :char_includes=, :set_char_includes
     
     # Adds exclude to the list of excluded values.
-    # Beware that exclusion takes priority over inclusion.
+    # <div class="wxrb-note">
+    # <b>Note:</b>
+    # <p>Beware that exclusion takes priority over inclusion.
+    # </p>
+    # </div>
     # @param exclude [String] 
     # @return [void]
     def add_exclude(exclude) end
     
     # Adds include to the list of included values.
-    # Any explicitly excluded characters will still be excluded.
+    # <div class="wxrb-note">
+    # <b>Note:</b>
+    # <p>Any explicitly excluded characters will still be excluded.
+    # </p>
+    # </div>
     # @param include [String] 
     # @return [void]
     def add_include(include) end
     
     # Adds chars to the list of excluded characters.
-    # Beware that exclusion takes priority over inclusion.
+    # <div class="wxrb-note">
+    # <b>Note:</b>
+    # <p>Beware that exclusion takes priority over inclusion.
+    # </p>
+    # </div>
     # @param chars [String] 
     # @return [void]
     def add_char_excludes(chars) end
     
     # Adds chars to the list of included characters.
-    # Any explicitly excluded characters will still be excluded even if they're part of chars.
+    # <div class="wxrb-note">
+    # <b>Note:</b>
+    # <p>Any explicitly excluded characters will still be excluded even if they're part of chars.
+    # </p>
+    # </div>
     # @param chars [String] 
     # @return [void]
     def add_char_includes(chars) end

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

@@ -14,24 +14,23 @@ module Wx
   # It is similar to {Wx::DatePickerCtrl} but is used for time, and not date, selection. While {Wx::TimePickerCtrl#get_value} and {Wx::TimePickerCtrl#set_value} still work with values of type {Wx::DateTime} (because wxWidgets doesn't provide a time-only class), their date part is ignored by this control.
   # It is only available if {Wx::Setup::USE_TIMEPICKCTRL} is set to 1.
   # This control currently doesn't have any specific flags.
-  # === 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::DateEvent} events.
   # Event handler methods for events emitted by this class:
   # 
   # - {Wx::EvtHandler#evt_time_changed}(id, meth = nil, &block): Process a {Wx::EVT_TIME_CHANGED} event, which fires when the user changes the current selection in the control. 
   # 
-  # === 
-  # 
-  # Category:  Picker Controls  <div class='appearance'><span class='appearance'>Appearance:</span><table><tr><td> wxMSW Appearance
-  #   </td><td> wxGTK Appearance
-  #   </td><td> wxOSX Appearance
+  # Category:  Picker 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::DatePickerCtrl
   # @see  Wx::CalendarCtrl
   # @see  Wx::DateEvent
   # 
   # 
+  # @wxrb_require USE_TIMEPICKCTRL
   class TimePickerCtrl < Control
   
     # @overload initialize()

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

@@ -15,14 +15,18 @@ module Wx
   # - You may use a derived class and the EVT_TIMER macro to connect it to an event handler defined in the derived class. If the default constructor is used, the timer object will be its own owner object, since it is derived from {Wx::EvtHandler}.
   # 
   # In any case, you must start the timer with {Wx::Timer#start} after constructing it before it actually starts sending notifications. It can be stopped later with {Wx::Timer#stop}.
-  # A timer can only be used from the main thread.
   # 
-  # === 
+  # <div class="wxrb-note">
+  # <b>Note:</b>
+  # <p>A timer can only be used from the main thread.
+  # </p>
+  # </div>
   # 
   # Category:  {Wx::Miscellaneous}
   # @see Wx::StopWatch 
   # 
   # 
+  # @wxrb_require USE_TIMER
   class Timer < EvtHandler
   
     # @overload initialize()

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

@@ -40,12 +40,11 @@ module Wx
   #   end
   # ```
   # 
-  # === 
-  # 
   # Category:  {Wx::Events}
   # @see Wx::Timer 
   # 
   # 
+  # @wxrb_require USE_TIMER
   class TimerEvent < Event
   
     # @param timer [Wx::Timer] 

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

@@ -26,13 +26,13 @@ module Wx
   # This is the class used together with {show_tip} function.
   # It must implement {Wx::TipProvider#get_tip} function and return the current tip from it (different tip each time it is called).
   # You will never use this class yourself, but you need it to show startup tips with {show_tip}. Also, if you want to get the tips text from elsewhere than a simple text file, you will want to derive a new class from {Wx::TipProvider} and use it instead of the one returned by {create_file_tip_provider}.
-  # === 
   # 
   # Category:  {Wx::Miscellaneous}
   # @see wxTipProvider Overview
   # @see  show_tip 
   # 
   # 
+  # @wxrb_require USE_STARTUP_TIPS
   class TipProvider < ::Object
   
     # Constructor.

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

@@ -14,24 +14,23 @@ module Wx
   # In other words, it is similar to {Wx::CheckBox} in functionality but looks like a {Wx::Button}.
   # Since wxWidgets version 2.9.0 this control emits an update UI event.
   # You can see {Wx::ToggleButton} in action in Widgets Sample.
-  # === 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::CommandEvent} events.
   # Event handler methods for events emitted by this class:
   # 
   # - {Wx::EvtHandler#evt_togglebutton}(id, meth = nil, &block): Handles a {Wx::EVT_TOGGLEBUTTON} event. 
   # 
-  # === 
-  # 
-  # 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::CheckBox
   # @see  Wx::Button
   # @see  Wx::BitmapToggleButton 
   # 
   # 
+  # @wxrb_require USE_TOGGLEBTN
   class ToggleButton < AnyButton
   
     # @overload initialize()