wxruby3 0.9.2-x64-mingw-ucrt → 0.9.4-x64-mingw-ucrt

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

@@ -7,6 +7,7 @@
 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}
@@ -20,12 +21,14 @@ module Wx
   
     # @overload set_margins(pt)
     #   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 pt [Array(Integer, Integer), Wx::Point] 
     #   @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] 
@@ -35,11 +38,12 @@ module Wx
     alias_method :margins=, :set_margins
     
     # Appends the text to the end of the text control.
+    # 
     # <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>>
+    # </div>
     # @see Wx::TextEntry#write_text 
     # @param text [String]  Text to write to the text control.
     # @return [void]
@@ -47,12 +51,14 @@ module Wx
     
     # @overload auto_complete(choices)
     #   Call this function to enable auto-completion of the text typed in a single-line text control using the given choices.
+    #   
     #   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 [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.
     #   The specified completer object will be used to retrieve the list of possible completions for the already entered text and will be deleted by {Wx::TextEntry} itself when it's not needed any longer.
     #   Notice that you need to include <code>Wx::/textcompleter.h</code> in order to define your class inheriting from {Wx::TextCompleter}.
@@ -64,6 +70,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.
     # 
     # true if the auto-completion was enabled or false if the operation failed, typically because auto-completion is not supported by the current platform.
@@ -72,6 +79,7 @@ module Wx
     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 WXMSW port and does nothing under the other platforms.
     # 
@@ -91,6 +99,7 @@ module Wx
     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 [Boolean]
     def can_paste; end
@@ -107,6 +116,7 @@ module Wx
     alias_method :can_undo?, :can_undo
     
     # Sets the new text control value.
+    # 
     # It also marks the control as not-modified which means that IsModified() would return false immediately after the call to {Wx::TextEntry#change_value}.
     # The insertion point is set to the start of the control (i.e. position 0) by this function.
     # This functions does not generate the {Wx::EVT_TEXT} event but otherwise is identical to {Wx::TextEntry#set_value}.
@@ -116,6 +126,7 @@ module Wx
     def change_value(value) end
     
     # Clears the text in the control.
+    # 
     # Note that this function will generate a {Wx::EVT_TEXT} event, i.e. its effect is identical to calling SetValue("").
     # @return [void]
     def clear; end
@@ -129,11 +140,13 @@ module Wx
     def cut; end
     
     # Convert all text entered into the control to upper case.
+    # 
     # Call this method to ensure that all text entered into the control is converted on the fly to upper case. If the control is not empty, its existing contents is also converted to upper case.
     # @return [void]
     def force_upper; end
     
     # Returns the insertion point, or cursor, position.
+    # 
     # This is defined as the zero based index of the character position to the right of the insertion point. For example, if the insertion point is at the end of the single-line text control, it is equal to {Wx::TextEntry#get_last_position}.
     # 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:
@@ -156,6 +169,7 @@ module Wx
     alias_method :last_position, :get_last_position
     
     # Returns the string containing the text starting in the positions from and up to to in the control.
+    # 
     # The positions must have been returned by another {Wx::TextCtrl} method. Please note that the positions in a multiline {Wx::TextCtrl} do <b>not</b> correspond to the indices in the string returned by {Wx::TextEntry#get_value} because of the different new line representations (CR or CR LF) and so this method should be used to obtain the correct results instead of extracting parts of the entire value. It may also be more efficient, especially if the control contains a lot of data.
     # @param from [Integer] 
     # @param to [Integer] 
@@ -164,30 +178,35 @@ module Wx
     alias_method :range, :get_range
     
     # Gets the current selection span.
+    # 
     # If the returned values are equal, there was no selection. Please note that the indices returned may be used with the other {Wx::TextCtrl} methods but don't necessarily represent the correct indices into the string returned by {Wx::TextEntry#get_value} for multiline controls under Windows (at least,) you should use {Wx::TextEntry#get_string_selection} to get the selected text.
     # @return [Array(Integer,Integer)]
     def get_selection; end
     alias_method :selection, :get_selection
     
     # Gets the text currently selected in the control.
+    # 
     # If there is no selection, the returned string is empty.
     # @return [String]
     def get_string_selection; end
     alias_method :string_selection, :get_string_selection
     
     # Gets the contents of the control.
+    # 
     # Notice that for a multiline text control, the lines will be separated by (Unix-style) <code>\n</code> characters, even under Windows where they are separated by a <code>\r\n</code> sequence in the native control.
     # @return [String]
     def get_value; end
     alias_method :value, :get_value
     
     # 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 [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 [Boolean]
     def is_empty; end
@@ -198,11 +217,13 @@ module Wx
     def paste; end
     
     # If there is a redo facility and the last operation can be redone, redoes the last operation.
+    # 
     # Does nothing if there is no redo facility.
     # @return [void]
     def redo_; end
     
     # Removes the text starting at the first given position up to (but not including) the character at the last position.
+    # 
     # This function puts the current insertion point position at to as a side effect.
     # @param from [Integer]  The first position.
     # @param to [Integer]  The last position.
@@ -210,6 +231,7 @@ module Wx
     def remove(from, to) end
     
     # Replaces the text starting at the first position up to (but not including) the character at the last position with the given text.
+    # 
     # This function puts the current insertion point position at to as a side effect.
     # @param from [Integer]  The first position.
     # @param to [Integer]  The last position.
@@ -219,6 +241,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 [Boolean]  If true, the control is editable. If false, the control is read-only.
     # @return [void]
@@ -232,11 +255,13 @@ module Wx
     alias_method :insertion_point=, :set_insertion_point
     
     # Sets the insertion point at the end of the text control.
+    # 
     # This is equivalent to calling {Wx::TextCtrl#set_insertion_point} with {Wx::TextCtrl#get_last_position} argument.
     # @return [void]
     def set_insertion_point_end; end
     
     # 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.
@@ -246,6 +271,7 @@ module Wx
     alias_method :max_length=, :set_max_length
     
     # Selects the text starting at the first position up to (but not including) the character at the last position.
+    # 
     # If both parameters are equal to -1 all text in the control is selected.
     # Notice that the insertion point will be moved to from by this function.
     # @see Wx::TextEntry#select_all 
@@ -256,6 +282,7 @@ module Wx
     
     # Selects all text in the control.
     # 
+    # 
     # @see Wx::TextEntry#set_selection 
     # @return [void]
     def select_all; end
@@ -265,6 +292,7 @@ module Wx
     def select_none; end
     
     # Sets a hint shown in an empty unfocused text control.
+    # 
     # 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.
@@ -273,7 +301,7 @@ module Wx
     # <b>Remark:</b>
     # <p>Currently implemented natively on Windows (Vista and later only), macOS and GTK+ (3.2 and later).
     # </p>
-    # </div>>
+    # </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.
@@ -282,32 +310,35 @@ module Wx
     # <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>>
+    # </div>
     # @param hint [String] 
     # @return [Boolean]
     def set_hint(hint) end
     alias_method :hint=, :set_hint
     
     # Returns the current hint string.
+    # 
     # See {Wx::TextEntry#set_hint} for more information about hints.
     # @return [String]
     def get_hint; end
     alias_method :hint, :get_hint
     
     # 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.
     # 
     # <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>>
+    # </div>
     # @see Wx::TextEntry#set_margins
     # @return [Wx::Point]
     def get_margins; end
     alias_method :margins, :get_margins
     
     # Sets the new text control value.
+    # 
     # It also marks the control as not-modified which means that IsModified() would return false immediately after the call to {Wx::TextEntry#set_value}.
     # The insertion point is set to the start of the control (i.e. position 0) by this function unless the control value doesn't change at all, in which case the insertion point is left at its original position.
     # Note that, unlike most other functions changing the controls values, this function generates a {Wx::EVT_TEXT} event. To avoid this you can use {Wx::TextEntry#change_value} instead.
@@ -317,16 +348,18 @@ module Wx
     alias_method :value=, :set_value
     
     # If there is an undo facility and the last operation can be undone, undoes the last operation.
+    # 
     # Does nothing if there is no undo facility.
     # @return [void]
     def undo; end
     
     # Writes the text into the text control at the current insertion position.
+    # 
     # <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>>
+    # </div>
     # @param text [String]  Text to write to the text control.
     # @return [void]
     def write_text(text) end
@@ -334,14 +367,14 @@ module Wx
   end # TextEntry
   
   # Base class for custom text completer objects.
+  # 
   # Custom completer objects used with {Wx::TextEntry#auto_complete} must derive from this class and implement its pure virtual method returning the completions. You would typically use a custom completer when the total number of completions is too big for performance to be acceptable if all of them need to be returned at once but if they can be generated hierarchically, i.e. only the first component initially, then the second one after the user finished entering the first one and so on.
   # When inheriting from this class you need to implement its two pure virtual methods. This allows returning the results incrementally and may or not be convenient depending on where do they come from. If you prefer to return all the completions at once, you should inherit from {Wx::TextCompleterSimple} instead.
   # 
-  # 
-  # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
   class TextCompleter < ::Object
   
     # Function called to start iteration over the completions for the given prefix.
+    # 
     # This function could start a database query, for example, if the results are read from a database.
     # Notice that under some platforms (currently MSW only) it is called from another thread context and so the appropriate synchronization mechanism should be used to access any data also used by the main UI thread.
     # 
@@ -351,6 +384,7 @@ module Wx
     def start(prefix) end
     
     # Called to retrieve the next completion.
+    # 
     # All completions returned by this function should start with the prefix passed to the last call to {Wx::TextCompleter#start}.
     # Notice that, as {Wx::TextCompleter#start}, this method is called from a worker thread context under MSW.
     # The next completion or an empty string to indicate that there are no more of them.
@@ -361,6 +395,7 @@ module Wx
   end # TextCompleter
   
   # 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: 
   # ```ruby
@@ -383,11 +418,10 @@ 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
   
     # Pure virtual method returning all possible completions for the given prefix.
+    # 
     # The custom completer should examine the provided prefix and return all the possible completions for it in the output array res.
     # 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.

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

@@ -15,6 +15,7 @@ module Wx
   GET_PASSWORD_FROM_USER_PROMPT_STR = "Enter Password"
   
   # Pop up a dialog box with title set to caption, message, and a default_value.
+  # 
   # The user may type in text and press OK to return this text, or press Cancel to return the empty string.
   # If centre is true, the message text (which may include new line characters) is centred; if false, the message is left-justified.
   # This function is a wrapper around {Wx::TextEntryDialog} and while it is usually more convenient to use, using the dialog directly is more flexible, e.g. it allows you to specify the {Wx::TE_MULTILINE} to allow the user enter multiple lines of text while this function is limited to single line entry only.
@@ -29,6 +30,7 @@ module Wx
   def self.get_text_from_user(message, caption=Wx::GET_TEXT_FROM_USER_PROMPT_STR, default_value=(''), parent=nil, x=Wx::DEFAULT_COORD, y=Wx::DEFAULT_COORD, centre=true) end
   
   # Similar to {get_text_from_user} but the text entered in the dialog is not shown on screen but replaced with stars.
+  # 
   # This is intended to be used for entering passwords as the function name implies.
   # @param message [String] 
   # @param caption [String] 
@@ -41,6 +43,7 @@ module Wx
   def self.get_password_from_user(message, caption=Wx::GET_PASSWORD_FROM_USER_PROMPT_STR, default_value=(''), parent=nil, x=Wx::DEFAULT_COORD, y=Wx::DEFAULT_COORD, centre=true) end
   
   # 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
@@ -52,6 +55,7 @@ module Wx
   
     # @overload set_text_validator(validator)
     #   Associate a validator with the text control used by the dialog.
+    #   
     #   These methods can be used to limit the user entry to only some characters, e.g. 
     #   ```ruby
     #     Wx::TextEntryDialog(self, ...) do |dlg|
@@ -68,6 +72,7 @@ module Wx
     #   @return [void]
     # @overload set_text_validator(style=Wx::TextValidatorStyle::FILTER_NONE)
     #   Associate a validator with the text control used by the dialog.
+    #   
     #   These methods can be used to limit the user entry to only some characters, e.g. 
     #   ```ruby
     #     Wx::TextEntryDialog(self, ...) do |dlg|
@@ -87,10 +92,12 @@ module Wx
     
     # @overload initialize()
     #   Default constructor.
+    #   
     #   Call {Wx::TextEntryDialog#create} to really create the dialog later.
     #   @return [Wx::TextEntryDialog]
     # @overload initialize(parent, message, caption=Wx::GET_TEXT_FROM_USER_PROMPT_STR, value=(''), style=Wx::TextEntryDialogStyle, pos=Wx::DEFAULT_POSITION)
     #   Constructor.
+    #   
     #   Use {Wx::TextEntryDialog#show_modal} to show the dialog.
     #   See {Wx::TextEntryDialog#create} method for parameter description.
     #   @param parent [Wx::Window] 
@@ -118,6 +125,7 @@ module Wx
     
     # This function sets the maximum number of characters the user can enter into this dialog.
     # 
+    # 
     # @see Wx::TextEntry#set_max_length
     # @param len [Integer] 
     # @return [void]
@@ -131,12 +139,14 @@ module Wx
     alias_method :value=, :set_value
     
     # Convert all text entered into the text control used by the dialog to upper case.
+    # 
     # Call this method to ensure that all text entered into the text control used by the dialog is converted on the fly to upper case. If the text control is not empty, its existing contents is also converted to upper case.
     # @see Wx::TextEntry#force_upper
     # @return [void]
     def force_upper; end
     
     # Shows the dialog, returning {Wx::StandardID::ID_OK} if the user pressed OK, and {Wx::StandardID::ID_CANCEL} otherwise.
+    # 
     # Call {Wx::TextEntryDialog#get_value} to retrieve the values of the string entered by the user after showing the dialog.
     # @return [Integer]
     def show_modal; end
@@ -144,6 +154,7 @@ module Wx
   end # TextEntryDialog
   
   # 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
@@ -154,6 +165,7 @@ module Wx
   class PasswordEntryDialog < TextEntryDialog
   
     # Constructor.
+    # 
     # Use {Wx::TextEntryDialog#show_modal} to show the dialog.
     # @param parent [Wx::Window]  Parent window.
     # @param message [String]  Message to show on the dialog.

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

@@ -68,6 +68,7 @@ module Wx
   end # TextValidatorStyle
   
   # {Wx::TextValidator} validates text controls, providing a variety of filtering behaviours.
+  # 
   # For more information, please see wxValidator Overview.
   # 
   # Category:  {Wx::Validators}
@@ -81,6 +82,11 @@ module Wx
   # @wxrb_require USE_VALIDATORS
   class TextValidator < Validator
   
+    # Copy constructor.
+    # @param validator [Wx::TextValidator] 
+    # @return [Wx::TextValidator]
+    def initialize(validator) end
+    
     # Clones the text validator using the copy constructor.
     # @return [Wx::TextValidator]
     def clone; end
@@ -107,6 +113,7 @@ module Wx
     
     # Returns the validator style.
     # 
+    # 
     # @see Wx::TextValidator#has_flag 
     # @return [Integer]
     def get_style; end
@@ -119,6 +126,7 @@ module Wx
     alias_method :has_flag?, :has_flag
     
     # Sets the exclude list (invalid values for the user input).
+    # 
     # <div class="wxrb-note">
     # <b>Note:</b>
     # <p>Beware that exclusion takes priority over inclusion. 
@@ -130,6 +138,7 @@ module Wx
     alias_method :excludes=, :set_excludes
     
     # Sets the exclude char list (invalid characters for the user input).
+    # 
     # <div class="wxrb-note">
     # <b>Note:</b>
     # <p>Beware that exclusion takes priority over inclusion. 
@@ -148,6 +157,7 @@ module Wx
     
     # Sets the include list (valid values for the user input).
     # 
+    # 
     # @see Wx::TextValidator#is_included 
     # @param stringList [Array<String>] 
     # @return [void]
@@ -155,6 +165,7 @@ module Wx
     alias_method :includes=, :set_includes
     
     # Sets the include char list (additional valid values for the user input).
+    # 
     # <div class="wxrb-note">
     # <b>Note:</b>
     # <p>Any explicitly excluded characters will still be excluded even if they're part of chars. 
@@ -166,6 +177,7 @@ module Wx
     alias_method :char_includes=, :set_char_includes
     
     # Adds exclude to the list of excluded values.
+    # 
     # <div class="wxrb-note">
     # <b>Note:</b>
     # <p>Beware that exclusion takes priority over inclusion.
@@ -176,6 +188,7 @@ module Wx
     def add_exclude(exclude) end
     
     # Adds include to the list of included values.
+    # 
     # <div class="wxrb-note">
     # <b>Note:</b>
     # <p>Any explicitly excluded characters will still be excluded.
@@ -186,6 +199,7 @@ module Wx
     def add_include(include) end
     
     # Adds chars to the list of excluded characters.
+    # 
     # <div class="wxrb-note">
     # <b>Note:</b>
     # <p>Beware that exclusion takes priority over inclusion.
@@ -196,6 +210,7 @@ module Wx
     def add_char_excludes(chars) end
     
     # Adds chars to the list of included characters.
+    # 
     # <div class="wxrb-note">
     # <b>Note:</b>
     # <p>Any explicitly excluded characters will still be excluded even if they're part of chars.
@@ -206,6 +221,7 @@ module Wx
     def add_char_includes(chars) end
     
     # Sets the validator style which must be a combination of one or more of the {Wx::TextValidatorStyle} values.
+    # 
     # Note that not all possible combinations make sense! Also, some combinations have shorter and more idiomatic alternative, e.g. {Wx::TextValidatorStyle::FILTER_ALPHANUMERIC} can be used instead of <code>wxFILTER_ALPHA|wxFILTER_DIGITS</code>.
     # @param style [Integer] 
     # @return [void]

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

@@ -11,6 +11,7 @@ module Wx
   TP_DEFAULT = 0
   
   # This control allows the user to enter time.
+  # 
   # 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.
@@ -50,6 +51,7 @@ module Wx
     def initialize(*args) end
     
     # Create the control window.
+    # 
     # This method should only be used for objects created using default constructor.
     # 
     # true if the control was successfully created or false if creation failed.
@@ -65,6 +67,7 @@ module Wx
     def create(parent, id, dt=Wx::DEFAULT_DATE_TIME, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::TP_DEFAULT, validator=Wx::DEFAULT_VALIDATOR, name=Wx::TIME_PICKER_CTRL_NAME_STR) end
     
     # Returns the currently entered time as hours, minutes and seconds.
+    # 
     # All the arguments must be non-NULL, false is returned otherwise and none of them is modified.
     # @see Wx::TimePickerCtrl#set_time
     # @return [Array(Boolean,Integer,Integer,Integer)]
@@ -72,12 +75,14 @@ module Wx
     alias_method :time, :get_time
     
     # Returns the currently entered time.
+    # 
     # The date part of the returned {Wx::DateTime} object is always set to today and should be ignored, only the time part is relevant.
     # @return [Time,Date,DateTime]
     def get_value; end
     alias_method :value, :get_value
     
     # Changes the current time of the control.
+    # 
     # Calling this method does not result in a time change event.
     # 
     # true if the time was changed or false on failure, e.g. if the time components were invalid.
@@ -89,6 +94,7 @@ module Wx
     def set_time(hour, min, sec) end
     
     # Changes the current value of the control.
+    # 
     # The date part of dt is ignored, only the time part is displayed in the control. The dt object must however be valid.
     # In particular, notice that it is a bad idea to use default {Wx::DateTime} constructor from hour, minute and second values as it uses the today date for the date part, which means that some values can be invalid if today happens to be the day of DST change. For example, when switching to summer time, the time 2:00 typically doesn't exist as the clocks jump directly to 3:00. To avoid this problem, use a fixed date on which DST is known not to change (e.g. Jan 1, 2012) for the date part of the argument or use {Wx::TimePickerCtrl#set_time}.
     # Calling this method does not result in a time change event.

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

@@ -7,6 +7,7 @@
 module Wx
 
   # The {Wx::Timer} class allows you to execute code at specified intervals.
+  # 
   # Its precision is platform-dependent, but in general will not be better than 1ms nor worse than 1s.
   # There are three different ways to use this class:
   # 
@@ -31,10 +32,12 @@ module Wx
   
     # @overload initialize()
     #   Default constructor.
+    #   
     #   If you use it to construct the object and don't call {Wx::Timer#set_owner} later, you must override {Wx::Timer#notify} method to process the notifications.
     #   @return [Wx::Timer]
     # @overload initialize(owner, id=-1)
     #   Creates a timer and associates it with owner.
+    #   
     #   Please see {Wx::Timer#set_owner} for the description of parameters.
     #   @param owner [Wx::EvtHandler] 
     #   @param id [Integer] 
@@ -52,6 +55,7 @@ module Wx
     alias_method :interval, :get_interval
     
     # Returns the current owner of the timer.
+    # 
     # If non-NULL this is the event handler which will receive the timer events (see {Wx::TimerEvent}) when the timer is running.
     # @return [Wx::EvtHandler]
     def get_owner; end
@@ -68,12 +72,14 @@ module Wx
     alias_method :running?, :is_running
     
     # This member should be overridden by the user if the default constructor was used and {Wx::Timer#set_owner} wasn't called.
+    # 
     # Perform whatever action which is to be taken periodically here.
     # Notice that throwing exceptions from this method is currently not supported, use event-based timer handling approach if an exception can be thrown while handling timer notifications.
     # @return [void]
     def notify; end
     
     # Associates the timer with the given owner object.
+    # 
     # When the timer is running, the owner will receive timer events (see {Wx::TimerEvent}) with id equal to id specified here.
     # @param owner [Wx::EvtHandler] 
     # @param id [Integer] 
@@ -82,6 +88,7 @@ module Wx
     alias_method :owner=, :set_owner
     
     # (Re)starts the timer.
+    # 
     # If milliseconds parameter is -1 (value by default), the previous value is used. Returns false if the timer could not be started, true otherwise (in MS Windows timers are a limited resource).
     # If oneShot is false (the default), the {Wx::Timer#notify} function will be called repeatedly until the timer is stopped. If true, it will be called only once and the timer will stop automatically.
     # To make your code more readable you may also use the following symbolic constants:
@@ -96,6 +103,7 @@ module Wx
     def start(milliseconds=-1, oneShot=Wx::TIMER_CONTINUOUS) end
     
     # Starts the timer for a once-only notification.
+    # 
     # This is a simple wrapper for {Wx::Timer#start} with {Wx::TIMER_ONE_SHOT} parameter.
     # @param milliseconds [Integer] 
     # @return [Boolean]

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

@@ -17,6 +17,7 @@ module Wx
   EVT_TIMER = 10005
   
   # {Wx::TimerEvent} object is passed to the event handler of timer events (see {Wx::Timer#set_owner}).
+  # 
   # For example:
   # 
   # ```ruby

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

@@ -8,6 +8,7 @@ module Wx
 
   # This function creates a {Wx::TipProvider} which may be used with {show_tip}.
   # 
+  # 
   # @see wxTipProvider Overview
   # @param filename [String]  The name of the file containing the tips, one per line.
   # @param currentTip [Integer]  The index of the first tip to show. Normally this index is remembered between the 2 program runs.
@@ -15,6 +16,7 @@ module Wx
   def self.create_file_tip_provider(filename, currentTip) end
   
   # This function shows a "startup tip" to the user.
+  # 
   # The return value is the state of the "Show tips at startup" checkbox.
   # @see wxTipProvider Overview
   # @param parent [Wx::Window]  The parent window for the modal dialog.
@@ -24,6 +26,7 @@ module Wx
   def self.show_tip(parent, tipProvider, showAtStartup=true) end
   
   # 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}.
   # 
@@ -41,12 +44,14 @@ module Wx
     def initialize(currentTip) end
     
     # Returns the index of the current tip (i.e. the one which would be returned by {Wx::TipProvider#get_tip}).
+    # 
     # The program usually remembers the value returned by this function after calling {show_tip}. Note that it is not the same as the value which was passed to {show_tip} + 1 because the user might have pressed the "Next" button in the tip dialog.
     # @return [Integer]
     def get_current_tip; end
     alias_method :current_tip, :get_current_tip
     
     # Return the text of the current tip and pass to the next one.
+    # 
     # This function is pure virtual, it should be implemented in the derived classes.
     # @return [String]
     def get_tip; end