wxruby3 0.9.1-x64-mingw-ucrt → 0.9.3-x64-mingw-ucrt

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

@@ -477,14 +477,15 @@ module Wx
   EVT_TEXT_MAXLEN = 10128
   
   # 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 +503,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 +550,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 +619,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 +636,12 @@ 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.
@@ -599,6 +656,7 @@ module Wx
     def initialize(*args) end
     
     # Creates the text control for two-step construction.
+    # 
     # This method should be called if the default constructor was used for the control creation. Its parameters have the same meaning as for the non-default constructor.
     # @param parent [Wx::Window] 
     # @param id [Integer] 
@@ -616,11 +674,13 @@ 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
     
     # This function inserts into the control the character which would have been inserted if the given key event had occurred in the text control.
+    # 
     # The event object should be the same as the one passed to EVT_KEY_DOWN handler previously by wxWidgets. Please note that this function doesn't currently work correctly for all keys under any platform but MSW.
     # true if the event resulted in a change to the control, false otherwise.
     # @param event [Wx::KeyEvent] 
@@ -629,12 +689,14 @@ module Wx
     
     # Returns the style currently used for the new text.
     # 
+    # 
     # @see Wx::TextCtrl#set_default_style 
     # @return [Wx::TextAttr]
     def get_default_style; end
     alias_method :default_style, :get_default_style
     
     # Gets the length of the specified line, not including any trailing newline character(s).
+    # 
     # The length of the line, or -1 if lineNo was invalid.
     # @param lineNo [Integer]  Line number (starting from zero).
     # @return [Integer]
@@ -642,6 +704,7 @@ module Wx
     alias_method :line_length, :get_line_length
     
     # Returns the contents of a given line in the text control, not including any trailing newline character(s).
+    # 
     # The contents of the line.
     # @param lineNo [Integer]  The line number, starting from zero.
     # @return [String]
@@ -649,13 +712,20 @@ 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
     
     # Returns the style at this position in the text control.
+    # 
     # Not all platforms support this function.
     # true on success, false if an error occurred (this may also mean that the styles are not supported under this platform).
     # @see Wx::TextCtrl#set_style
@@ -667,8 +737,9 @@ module Wx
     alias_method :style, :get_style
     
     # 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.
@@ -676,6 +747,7 @@ module Wx
     def hit_test(pt) end
     
     # Returns true if the text has been modified by user.
+    # 
     # Note that calling {Wx::TextCtrl#set_value} doesn't make the control modified.
     # @see Wx::TextCtrl#mark_dirty 
     # @return [Boolean]
@@ -684,6 +756,7 @@ module Wx
     
     # Returns true if this is a multi line edit control and false otherwise.
     # 
+    # 
     # @see Wx::TextCtrl#is_single_line 
     # @return [Boolean]
     def is_multi_line; end
@@ -691,6 +764,7 @@ module Wx
     
     # Returns true if this is a single line edit control and false otherwise.
     # 
+    # 
     # @see Wx::TextCtrl#is_single_line
     # @see  Wx::TextCtrl#is_multi_line 
     # @return [Boolean]
@@ -698,6 +772,7 @@ module Wx
     alias_method :single_line?, :is_single_line
     
     # Loads and displays the named file, if it exists.
+    # 
     # true if successful, false otherwise.
     # @param filename [String]  The filename of the file to load.
     # @param fileType [Integer]  The type of file to load. This is currently ignored in {Wx::TextCtrl}.
@@ -706,18 +781,25 @@ module Wx
     
     # Mark text as modified (dirty).
     # 
+    # 
     # @see Wx::TextCtrl#is_modified 
     # @return [void]
     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]
     def on_drop_files(event) end
     
     # Converts given position to a zero-based column, line number pair.
+    # 
     # true on success, false on failure (most likely due to a too large position parameter).
     # @see Wx::TextCtrl#xy_to_position 
     # @param pos [Integer]  Position.
@@ -725,17 +807,20 @@ module Wx
     def position_to_xy(pos) end
     
     # 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.
+    # 
     # true if the operation was successful, false otherwise.
     # @param filename [String]  The name of the file in which to save the text.
     # @param fileType [Integer]  The type of file to save. This is currently ignored in {Wx::TextCtrl}.
@@ -743,6 +828,7 @@ module Wx
     def save_file(filename=(''), fileType=Wx::TEXT_TYPE_ANY) end
     
     # Changes the default style to use for the new text which is going to be added to the control.
+    # 
     # This applies both to the text added programmatically using {Wx::TextCtrl#write_text} or {Wx::TextCtrl#append_text} and to the text entered by the user interactively.
     # If either of the font, foreground, or background colour is not set in style, the values of the previous default style are used for them. If the previous default style didn't set them either, the global font or colours of the text control itself are used as fall back.
     # However if the style parameter is the default {Wx::TextAttr}, then the default style is just reset (instead of being combined with the new style which wouldn't change it at all).
@@ -756,6 +842,7 @@ module Wx
     
     # Marks the control as being modified by the user or not.
     # 
+    # 
     # @see Wx::TextCtrl#mark_dirty
     # @see  Wx::TextCtrl#discard_edits 
     # @param modified [Boolean] 
@@ -764,6 +851,7 @@ module Wx
     alias_method :modified=, :set_modified
     
     # Changes the style of the given range.
+    # 
     # If any attribute within style is not set, the corresponding attribute from {Wx::TextCtrl#get_default_style} is used.
     # 
     # true on success, false if an error occurred (this may also mean that the styles are not supported under this platform).
@@ -781,6 +869,7 @@ module Wx
     def show_position(pos) end
     
     # Converts the given zero based column and line number to a position.
+    # 
     # The position value, or -1 if x or y was invalid.
     # @param x [Integer]  The column number.
     # @param y [Integer]  The line number.