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

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

@@ -481,28 +481,46 @@ module Wx
   # === 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 {Wx::GTK}. 
+  # 
+  # - {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. 
+  # 
   # - {Wx::TE_PASSWORD}: The text will be echoed as asterisks. 
+  # 
   # - {Wx::TE_READONLY}: The text will not be user-editable. 
+  # 
   # - {Wx::TE_RICH}: Use rich text control under MSW, this allows having more than 64KB of text in the control. This style is ignored under other platforms and it is recommended to use {Wx::TE_RICH2} instead of it under MSW. 
+  # 
   # - {Wx::TE_RICH2}: Use rich text control version 2.0 or higher under MSW, this style is ignored under other platforms. Note that this style may be turned on automatically even if it is not used explicitly when creating a text control with a long (i.e. much more than 64KiB) initial text, as creating the control would simply fail in this case under MSW if neither this style nor {Wx::TE_RICH} is used. 
+  # 
   # - {Wx::TE_AUTO_URL}: Highlight the URLs and generate the {Wx::TextUrlEvents} when mouse events occur over them. 
+  # 
   # - {Wx::TE_NOHIDESEL}: By default, the Windows text control doesn't show the selection when it doesn't have focus - use this style to force it to always show it. It doesn't do anything under other platforms. 
+  # 
   # - {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 {Wx::MSW} but not under {Wx::GTK} or {Wx::OSX}. 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 ({Wx::MSW}, {Wx::GTK}, {Wx::OSX}). 
-  # - {Wx::TE_RIGHT}: The text in the control will be right-justified ({Wx::MSW}, {Wx::GTK}, {Wx::OSX}). 
+  # 
+  # - {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_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}, {Wx::GTK}, {Wx::OSX}). 
-  # - {Wx::TE_WORDWRAP}: For multiline controls only: wrap the lines too long to be shown entirely at word boundaries ({Wx::Univ}, {Wx::MSW}, {Wx::GTK}, {Wx::OSX}). 
+  # 
+  # - {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_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 {Wx::MSW}, {Wx::GTK} and {Wx::OSX}. {Wx::TE_READONLY}, {Wx::TE_PASSWORD} and wrapping styles can be dynamically changed under {Wx::GTK} but not {Wx::MSW}. 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
   # 
@@ -522,67 +540,14 @@ module Wx
   # 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.
   # So the following code correctly describes what it does: the second call to {Wx::TextCtrl#set_default_style} doesn't change the text foreground colour (which stays red) while the last one doesn't change the background colour (which stays grey):
   # 
+  # ```ruby
+  #   text.set_default_style(Wx::TextAttr.new(Wx::RED))
+  #   text.append_text("Red text\n")
+  #   text.set_default_style(Wx::TextAttr.new(Wx::NULL_COLOUR, Wx::LIGHT_GREY))
+  #   text.append_text("Red on grey text\n")
+  #   text.set_default_style(Wx::TextAttr.new(Wx::BLUE))
+  #   text.append_text("Blue on grey text\n")
   # ```
-  #   text->SetDefaultStyle(wxTextAttr(*wxRED));
-  #   text->AppendText("Red text\n");
-  #   text->SetDefaultStyle(wxTextAttr(wxNullColour, *wxLIGHT_GREY));
-  #   text->AppendText("Red on grey text\n");
-  #   text->SetDefaultStyle(wxTextAttr(*wxBLUE));
-  #   text->AppendText("Blue on grey text\n");
-  # ```
-  # 
-  # == 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.
   # 
@@ -591,16 +556,20 @@ module Wx
   # 
   # 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_text}(id, meth = nil, &block): Respond to a {Wx::EVT_TEXT} event, generated when the text changes. Notice that this event will be sent when the text controls contents changes  whether this is due to user input or comes from the program itself (for example, if {Wx::TextCtrl#set_value} is called); see {Wx::TextCtrl#change_value} for a function which does not send this event. This event is however not sent during the control creation. 
+  # 
   # - {Wx::EvtHandler#evt_text_enter}(id, meth = nil, &block): Respond to a {Wx::EVT_TEXT_ENTER} event, generated when enter is pressed in a text control which must have {Wx::TE_PROCESS_ENTER} style for this event to be generated. 
+  # 
   # - {Wx::EvtHandler#evt_text_url}(id, meth = nil, &block): A mouse event occurred over an URL in the text control. 
+  # 
   # - {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> {Wx::MSW} Appearance
-  #   </td><td> {Wx::GTK} Appearance
-  #   </td><td> {Wx::OSX} 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 
@@ -610,18 +579,9 @@ module Wx
   
     include Wx::TextEntry
   
-    # Enable the automatic replacement of new lines characters in a single-line text field with spaces under macOS.
-    # This feature is enabled by default and will replace any new line (<code>\n</code>) character entered into a single-line text field with the space character. Usually single-line text fields are not expected to hold multiple lines of text (that is what {Wx::TE_MULTILINE} is for, after all) and it is impossible to have multiple lines of text in them under non-Mac platforms. However, under macOS/Cocoa, a single-line text control can still show multiple lines and this function allows to lift the restriction preventing multiple lines from being entered unless {Wx::TE_MULTILINE} is specified.
-    # This function is only available for macOS/Cocoa. It also has no effect if the {Wx::TE_MULTILINE} flag is set on a text control.
-    # 
-    # Availability:  only available for the {Wx::OSX/Cocoa} port.  {Wx::osx}
-    # @param enable [true,false] 
-    # @return [void]
-    def osx_enable_new_line_replacement(enable) end
-    
     # @overload initialize()
     #   Default ctor.
-    #   @return [TextCtrl]
+    #   @return [Wx::TextCtrl]
     # @overload initialize(parent, id, value=(''), pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, validator=Wx::DEFAULT_VALIDATOR, name=Wx::TextCtrlNameStr)
     #   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.
@@ -635,7 +595,7 @@ module Wx
     #   @param style [Integer]  Window style. See {Wx::TextCtrl}.
     #   @param validator [Wx::Validator]  Window validator.
     #   @param name [String]  Window name.
-    #   @return [TextCtrl]
+    #   @return [Wx::TextCtrl]
     def initialize(*args) end
     
     # Creates the text control for two-step construction.
@@ -648,7 +608,7 @@ module Wx
     # @param style [Integer] 
     # @param validator [Wx::Validator] 
     # @param name [String] 
-    # @return [void]
+    # @return [Boolean]
     def create(parent, id, value=(''), pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, validator=Wx::DEFAULT_VALIDATOR, name=Wx::TextCtrlNameStr) end
     
     # Resets the internal modified flag as if the current changes had been saved.
@@ -656,7 +616,7 @@ module Wx
     def discard_edits; end
     
     # Delete the undo history.
-    # Currently only implemented in {Wx::MSW} (for controls using {Wx::TE_RICH2} style only) and {Wx::OSX} (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
     
@@ -664,18 +624,9 @@ module Wx
     # 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] 
-    # @return [void]
+    # @return [Boolean]
     def emulate_key_press(event) end
     
-    # Enable or disable native spell checking on this text control if it is available on the current platform.
-    # Currently this is supported in {Wx::MSW} (when running under Windows 8 or later), {Wx::GTK} when using GTK 3 and {Wx::OSX}. In addition, {Wx::MSW} requires that the text control has the {Wx::TE_RICH2} style set, while {Wx::OSX} requires that the control has the {Wx::TE_MULTILINE} style.
-    # When using {Wx::GTK}, this method only works if gspell library was available during the library build.
-    # 
-    # true if proof checking has been successfully enabled or disabled, false otherwise (usually because the corresponding functionality is not available under the current platform or for this type of text control).
-    # @param options [Wx::TextProofOptions]  A {Wx::TextProofOptions} object specifying the desired behaviour of the proof checker (e.g. language to use, spell check, grammar check, etc.) and whether the proof checks should be enabled at all. By default, spelling checks for the current language are enabled. Passing Wx::TextProofOptions#disable disables all the checks.
-    # @return [void]
-    def enable_proof_check(options=(Wx::TextProofOptions.default())) end
-    
     # Returns the style currently used for the new text.
     # 
     # @see Wx::TextCtrl#set_default_style 
@@ -698,7 +649,7 @@ 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 {Wx::GTK} and {Wx::OSX}/Cocoa ports while it is the number of physical lines, i.e. the count of lines actually shown in the control, in {Wx::MSW}. Because of this discrepancy, it is not recommended to use this function.
+    # 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.
     # @return [Integer]
     def get_number_of_lines; end
@@ -711,30 +662,30 @@ module Wx
     # @see  Wx::TextAttr 
     # @param position [Integer] 
     # @param style [Wx::TextAttr] 
-    # @return [void]
+    # @return [Boolean]
     def get_style(position, style) end
     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}, {Wx::MSW} and {Wx::GTK} 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.
-    # @return [Array(TextCtrlHitTestResult,Integer,Integer)]
+    # @return [Array(Wx::TextCtrlHitTestResult,Integer,Integer)]
     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 [void]
+    # @return [Boolean]
     def is_modified; end
     alias_method :modified?, :is_modified
     
     # Returns true if this is a multi line edit control and false otherwise.
     # 
     # @see Wx::TextCtrl#is_single_line 
-    # @return [void]
+    # @return [Boolean]
     def is_multi_line; end
     alias_method :multi_line?, :is_multi_line
     
@@ -742,21 +693,15 @@ module Wx
     # 
     # @see Wx::TextCtrl#is_single_line
     # @see  Wx::TextCtrl#is_multi_line 
-    # @return [void]
+    # @return [Boolean]
     def is_single_line; end
     alias_method :single_line?, :is_single_line
     
-    # Returns the current text proofing options.
-    # This function is implemented for the same platforms as {Wx::TextCtrl#enable_proof_check} and returns {Wx::TextProofOptions} with all checks disabled, i.e. such that Wx::TextProofOptions#any_checks_enabled returns false.
-    # @return [Wx::TextProofOptions]
-    def get_proof_check_options; end
-    alias_method :proof_check_options, :get_proof_check_options
-    
     # 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}.
-    # @return [void]
+    # @return [Boolean]
     def load_file(filename, fileType=Wx::TEXT_TYPE_ANY) end
     
     # Mark text as modified (dirty).
@@ -781,7 +726,7 @@ 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 {Wx::MSW}, {Wx::GTK} ports.  {Wx::msw},{Wx::gtk} . Additionally, {Wx::GTK} 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.  {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.
     # 
     # 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
@@ -794,7 +739,7 @@ module Wx
     # 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}.
-    # @return [void]
+    # @return [Boolean]
     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.
@@ -805,7 +750,7 @@ module Wx
     # true on success, false if an error occurred (this may also mean that the styles are not supported under this platform).
     # @see Wx::TextCtrl#get_default_style 
     # @param style [Wx::TextAttr]  The style for the new text.
-    # @return [void]
+    # @return [Boolean]
     def set_default_style(style) end
     alias_method :default_style=, :set_default_style
     
@@ -813,7 +758,7 @@ module Wx
     # 
     # @see Wx::TextCtrl#mark_dirty
     # @see  Wx::TextCtrl#discard_edits 
-    # @param modified [true,false] 
+    # @param modified [Boolean] 
     # @return [void]
     def set_modified(modified) end
     alias_method :modified=, :set_modified
@@ -827,7 +772,7 @@ module Wx
     # @param start [Integer]  The start of the range to change.
     # @param end_ [Integer] 
     # @param style [Wx::TextAttr]  The new style for the range.
-    # @return [void]
+    # @return [Boolean]
     def set_style(start, end_, style) end
     
     # Makes the line containing the given position visible.

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

@@ -24,14 +24,14 @@ module Wx
     #   When margins are given as {Wx::Point}, x indicates the left and y the top margin. Use -1 to indicate that an existing value should be used.
     #   true if setting of all requested margins was successful.
     #   @param pt [Array(Integer, Integer), Wx::Point] 
-    #   @return [true,false]
+    #   @return [Boolean]
     # @overload set_margins(left, top=-1)
     #   Attempts to set the control margins.
     #   When margins are given as {Wx::Point}, x indicates the left and y the top margin. Use -1 to indicate that an existing value should be used.
     #   true if setting of all requested margins was successful.
     #   @param left [Integer] 
     #   @param top [Integer] 
-    #   @return [true,false]
+    #   @return [Boolean]
     def set_margins(*args) end
     alias_method :margins=, :set_margins
     
@@ -47,7 +47,7 @@ module Wx
     #   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_file_names 
     #   @param choices [Array<String>] 
-    #   @return [true,false]
+    #   @return [Boolean]
     # @overload auto_complete(completer)
     #   Enable auto-completion using the provided completer object.
     #   This method should be used instead of {Wx::TextEntry#auto_complete} overload taking the array of possible completions if the total number of strings is too big as it allows returning the completions dynamically, depending on the text already entered by user and so is more efficient.
@@ -57,49 +57,49 @@ module Wx
     #   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::TextCompleter 
     #   @param completer [Wx::TextCompleter]  The object to be used for generating completions if non-NULL. If it is NULL, auto-completion is disabled. The {Wx::TextEntry} object takes ownership of this pointer and will delete it in any case (i.e. even if this method returns false).
-    #   @return [true,false]
+    #   @return [Boolean]
     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 {Wx::MSW} 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 
-    # @return [true,false]
+    # @return [Boolean]
     def auto_complete_file_names; end
     
     # 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 {Wx::MSW} 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 
-    # @return [true,false]
+    # @return [Boolean]
     def auto_complete_directories; end
     
     # Returns true if the selection can be copied to the clipboard.
-    # @return [true,false]
+    # @return [Boolean]
     def can_copy; end
     alias_method :can_copy?, :can_copy
     
     # Returns true if the selection can be cut to the clipboard.
-    # @return [true,false]
+    # @return [Boolean]
     def can_cut; end
     alias_method :can_cut?, :can_cut
     
     # Returns true if the contents of the clipboard can be pasted into the text control.
     # On some platforms (Motif, GTK) this is an approximation and returns true if the control is editable, false otherwise.
-    # @return [true,false]
+    # @return [Boolean]
     def can_paste; end
     alias_method :can_paste?, :can_paste
     
     # Returns true if there is a redo facility available and the last operation can be redone.
-    # @return [true,false]
+    # @return [Boolean]
     def can_redo; end
     alias_method :can_redo?, :can_redo
     
     # Returns true if there is an undo facility available and the last operation can be undone.
-    # @return [true,false]
+    # @return [Boolean]
     def can_undo; end
     alias_method :can_undo?, :can_undo
     
@@ -135,15 +135,13 @@ module Wx
     # Notice that insertion position is, in general, different from the index of the character the cursor position at in the string returned by {Wx::TextEntry#get_value}. While this is always the case for the single line controls, multi-line controls can use two characters <code>"\\r\\n"</code> as line separator (this is notably the case under MSW) meaning that indices in the control and its string value are offset by 1 for every line.
     # Hence to correctly get the character at the current cursor position, taking into account that there can be none if the cursor is at the end of the string, you could do the following:
     # 
-    # ```
-    #   wxString GetCurrentChar(wxTextCtrl *tc)
-    #   {
-    #       long pos = tc->GetInsertionPoint();
-    #       if ( pos == tc->GetLastPosition() )
-    #           return wxString();
+    # ```ruby
+    #   def get_current_char(txt_ctrl)
+    #      pos = txt_ctrl.get_insertion_point
+    #      return '' if pos == txt_ctrl.get_last_position
     #   
-    #       return tc->GetRange(pos, pos + 1);
-    #   }
+    #      txt_ctrl.get_range(pos, pos + 1)
+    #   end
     # ```
     # @return [Integer]
     def get_insertion_point; end
@@ -182,13 +180,13 @@ module Wx
     
     # Returns true if the controls contents may be edited by user (note that it always can be changed by the program).
     # In other words, this functions returns true if the control hasn't been put in read-only mode by a previous call to {Wx::TextEntry#set_editable}.
-    # @return [true,false]
+    # @return [Boolean]
     def is_editable; end
     alias_method :editable?, :is_editable
     
     # Returns true if the control is currently empty.
     # This is the same as <code>Wx::TextEntry#get_value</code>.empty() but can be much more efficient for the multiline controls containing big amounts of text.
-    # @return [true,false]
+    # @return [Boolean]
     def is_empty; end
     alias_method :empty?, :is_empty
     
@@ -219,7 +217,7 @@ module Wx
     # Makes the text item editable or read-only, overriding the <b>{Wx::TE_READONLY}</b> flag.
     # 
     # @see Wx::TextEntry#is_editable 
-    # @param editable [true,false]  If true, the control is editable. If false, the control is read-only.
+    # @param editable [Boolean]  If true, the control is editable. If false, the control is read-only.
     # @return [void]
     def set_editable(editable) end
     alias_method :editable=, :set_editable
@@ -238,7 +236,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 {Wx::GTK} 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
@@ -273,7 +271,7 @@ module Wx
     # 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.
     # @param hint [String] 
-    # @return [true,false]
+    # @return [Boolean]
     def set_hint(hint) end
     alias_method :hint=, :set_hint
     
@@ -327,7 +325,7 @@ module Wx
     # 
     # true to continue with calling {Wx::TextCompleter#get_next} or false to indicate that there are no matches and {Wx::TextCompleter#get_next} shouldn't be called at all.
     # @param prefix [String]  The prefix for which completions are to be generated.
-    # @return [true,false]
+    # @return [Boolean]
     def start(prefix) end
     
     # Called to retrieve the next completion.
@@ -343,33 +341,24 @@ module Wx
   # A simpler base class for custom completer objects.
   # This class may be simpler to use than the base {Wx::TextCompleter} as it allows to implement only a single virtual method instead of two of them (at the price of storing all completions in a temporary array).
   # Here is a simple example of a custom completer that completes the names of some chess pieces. Of course, as the total list here has only four items it would have been much simpler to just specify the array containing all the completions in this example but the same approach could be used when the total number of completions is much higher provided the number of possibilities for each word is still relatively small: 
-  # ```
-  #   class MyTextCompleter : public wxTextCompleterSimple
-  #   {
-  #   public:
-  #       virtual void GetCompletions(const wxString& prefix, wxArrayString& res)
-  #       {
-  #           const wxString firstWord = prefix.BeforeFirst(' ');
-  #           if ( firstWord == "white" )
-  #           {
-  #               res.push_back("white pawn");
-  #               res.push_back("white rook");
-  #           }
-  #           else if ( firstWord == "black" )
-  #           {
-  #               res.push_back("black king");
-  #               res.push_back("black queen");
-  #           }
-  #           else
-  #           {
-  #               res.push_back("white");
-  #               res.push_back("black");
-  #           }
-  #       }
-  #   };
+  # ```ruby
+  #   class MyTextCompleter < Wx::TextCompleterSimple
+  # 
+  #     def get_completions(prefix)
+  #       firstWord = prefix.split(' ').shift
+  #       if firstWord == 'white'
+  #         ['white pawn', 'white rook']
+  #       elsif firstWord == 'black'
+  #         ['black king', 'black queen']
+  #       else
+  #         ['white', 'black']
+  #       end
+  #     end
+  # 
+  #   end
   #   ...
-  #   wxTextCtrl *text = ...;
-  #   text->AutoComplete(new MyTextCompleter);
+  #   text_ctrl = ...
+  #   text_ctrl.auto_complete(MyTextCompleter.new)
   # ```
   # 
   # ===
@@ -383,9 +372,8 @@ module Wx
     # Please notice that the returned values should start with the prefix, otherwise they will be simply ignored, making adding them to the array in the first place useless.
     # Notice that this function may be called from thread other than main one (this is currently always the case under MSW) so the appropriate synchronization mechanism should be used to protect the shared data.
     # @param prefix [String]  The possibly empty prefix that the user had already entered.
-    # @param res [Array<String>]  Initially empty array that should be filled with all possible completions (possibly none if there are no valid possibilities starting with the given prefix).
-    # @return [void]
-    def get_completions(prefix, res) end
+    # @return [Array<String>]
+    def get_completions(prefix) end
     alias_method :completions, :get_completions
     
   end # TextCompleterSimple