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

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

@@ -7,6 +7,7 @@
 module Wx
 
   # This control allows the user to select a file.
+  # 
   # The generic implementation is a button which brings up a {Wx::FileDialog} when clicked. Native implementation may differ but this is usually a (small) widget which give access to the file-chooser dialog. It is only available if {Wx::Setup::USE_FILEPICKERCTRL} is set to 1 (the default).
   # ### Styles
   # 
@@ -64,6 +65,7 @@ module Wx
     def initialize(*args) end
     
     # Creates this widget with the given parameters.
+    # 
     # true if the control was successfully created or false if creation failed.
     # @param parent [Wx::Window]  Parent window, must not be non-NULL.
     # @param id [Integer]  The identifier for the control.
@@ -95,6 +97,7 @@ module Wx
     alias_method :file_name=, :set_file_name
     
     # Set the directory to show when starting to browse for files.
+    # 
     # This function is mostly useful for the file picker controls which have no selection initially to configure the directory that should be shown if the user starts browsing for files as otherwise the directory of initially selected file is used, which is usually the desired behaviour and so the directory specified by this function is ignored in this case.
     # @param dir [String] 
     # @return [void]
@@ -102,6 +105,7 @@ module Wx
     alias_method :initial_directory=, :set_initial_directory
     
     # Sets the absolute path of the currently selected file.
+    # 
     # If the control uses {Wx::FLP_FILE_MUST_EXIST} and does not use {Wx::FLP_USE_TEXTCTRL} style, the filename must be a name of an existing file and will be simply ignored by the native WXGTK implementation if this is not the case (the generic implementation used under the other platforms accepts even invalid file names currently, but this is subject to change in the future, don't rely on being able to use non-existent paths with it).
     # @param filename [String] 
     # @return [void]

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

@@ -7,6 +7,7 @@
 module Wx
 
   # This class provides an interface for opening files on different file systems.
+  # 
   # It can handle absolute and/or local filenames.
   # It uses a system of handlers (see {Wx::FileSystemHandler}) to provide access to user-defined virtual file systems.
   # 
@@ -22,6 +23,7 @@ module Wx
   class FileSystem < Object
   
     # Constructor.
+    # 
     # The initial current path of this object will be empty (i.e. {Wx::FileSystem#get_path} == {Wx::EmptyString}) which means that e.g. {Wx::FileSystem#open_file} or {Wx::FileSystem#find_first} functions will use current working directory as current path (see also {Wx::GetCwd}).
     # @return [Wx::FileSystem]
     def initialize; end
@@ -33,6 +35,7 @@ module Wx
     
     # Converts a {Wx::FileName} into an URL.
     # 
+    # 
     # @see Wx::FileSystem.url_to_file_name
     # @see  Wx::FileName 
     # @param filename [String] 
@@ -45,6 +48,7 @@ module Wx
     def self.has_handler_for_path(location) end
     
     # Converts URL into a well-formed filename.
+    # 
     # The URL must use the file protocol.
     # @param url [String] 
     # @return [String]
@@ -53,6 +57,7 @@ module Wx
   end # FileSystem
   
   # Classes derived from {Wx::FileSystemHandler} are used to access virtual file systems.
+  # 
   # Its public interface consists of two methods: {Wx::FileSystemHandler#can_open} and {Wx::FileSystemHandler#open_file}.
   # It provides additional protected methods to simplify the process of opening the file: {Wx::FileSystemHandler.get_protocol}, {Wx::FileSystemHandler.get_left_location}, {Wx::FileSystemHandler.get_right_location}, {Wx::FileSystemHandler.get_anchor}, {Wx::FileSystemHandler.get_mime_type_from_ext}.
   # Please have a look at overview (see {Wx::FileSystem}) if you don't know how locations are constructed.
@@ -63,7 +68,7 @@ module Wx
   # <b>Remark:</b>
   # <p>{Wx::HTML} library provides handlers for local files and HTTP or FTP protocol.
   # </p>
-  # </div>>
+  # </div>
   # 
   # <div class="wxrb-note">
   # <b>Note:</b>
@@ -85,6 +90,7 @@ module Wx
     def initialize; end
     
     # Returns true if the handler is able to open this file.
+    # 
     # This function doesn't check whether the file exists or not, it only checks if it knows the protocol. Example:
     # 
     # ```
@@ -101,6 +107,7 @@ module Wx
     alias_method :can_open?, :can_open
     
     # Works like {find_first_file}.
+    # 
     # Returns the name of the first filename (within filesystem's current path) that matches wildcard. flags may be one of {Wx::FILE} (only files), {Wx::DIR} (only directories) or 0 (both).
     # This method is only called if {Wx::FileSystemHandler#can_open} returns true.
     # @param wildcard [String] 
@@ -109,11 +116,13 @@ module Wx
     def find_first(wildcard, flags=0) end
     
     # Returns next filename that matches parameters passed to {Wx::FileSystem#find_first}.
+    # 
     # This method is only called if {Wx::FileSystemHandler#can_open} returns true and {Wx::FileSystemHandler#find_first} returned a non-empty string.
     # @return [String]
     def find_next; end
     
     # Opens the file and returns {Wx::FSFile} pointer or NULL if failed.
+    # 
     # Must be overridden in derived handlers.
     # @param fs [Wx::FileSystem]  Parent FS (the FS from that OpenFile was called). See the ZIP handler for details of how to use it.
     # @param location [String]  The absolute location of file.
@@ -121,6 +130,7 @@ module Wx
     def open_file(fs, location) end
     
     # Returns the MIME type based on <b>extension</b> of location.
+    # 
     # (While {Wx::FSFile#get_mime_type} returns real MIME type - either extension-based or queried from HTTP.)
     # Example: 
     # ```
@@ -135,6 +145,7 @@ module Wx
   # A file system handler for accessing files inside of archives.
   # 
   # 
+  # 
   # @wxrb_require USE_FILESYSTEM
   class ArchiveFSHandler < FileSystemHandler
   
@@ -147,6 +158,7 @@ module Wx
   end # ArchiveFSHandler
   
   # This {Wx::FileSystem} handler can store arbitrary data in memory stream and make them accessible via an URL.
+  # 
   # It is particularly suitable for storing bitmaps from resources or included XPM files so that they can be used with {Wx::HTML} or {Wx::WebView}.
   # Filenames are prefixed with <code>"memory:"</code>, e.g. <code>"memory:myfile.html"</code>.
   # Example:
@@ -205,6 +217,7 @@ module Wx
   
     # @overload self.add_file(filename, image, type)
     #   Adds a file to the list of the files stored in memory.
+    #   
     #   Stored data (bitmap, text or raw data) will be copied into private memory stream and available under name <code>"memory:"</code> + filename.
     #   When using the overload taking {Wx::String} data, if the string contains only Latin-1 characters (which includes strings created using Wx::String#from8bit_data), its data is used as is. Otherwise, the UTF-8 representation of the string is stored as the data associated with the given filename.
     #   
@@ -220,6 +233,7 @@ module Wx
     #   @return [void]
     # @overload self.add_file(filename, bitmap, type)
     #   Adds a file to the list of the files stored in memory.
+    #   
     #   Stored data (bitmap, text or raw data) will be copied into private memory stream and available under name <code>"memory:"</code> + filename.
     #   When using the overload taking {Wx::String} data, if the string contains only Latin-1 characters (which includes strings created using Wx::String#from8bit_data), its data is used as is. Otherwise, the UTF-8 representation of the string is stored as the data associated with the given filename.
     #   
@@ -235,6 +249,7 @@ module Wx
     #   @return [void]
     # @overload self.add_file(filename, textdata)
     #   Adds a file to the list of the files stored in memory.
+    #   
     #   Stored data (bitmap, text or raw data) will be copied into private memory stream and available under name <code>"memory:"</code> + filename.
     #   When using the overload taking {Wx::String} data, if the string contains only Latin-1 characters (which includes strings created using Wx::String#from8bit_data), its data is used as is. Otherwise, the UTF-8 representation of the string is stored as the data associated with the given filename.
     #   
@@ -250,6 +265,7 @@ module Wx
     def self.add_file(*args) end
     
     # Like {Wx::MemoryFSHandler.add_file}, but lets you explicitly specify added file's MIME type.
+    # 
     # This version should be used whenever you know the MIME type, because it makes accessing the files faster.
     # @see Wx::MemoryFSHandler.add_file 
     # @param filename [String] 

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

@@ -73,6 +73,7 @@ module Wx
   EVT_FIND_CLOSE = 10181
   
   # {Wx::FindReplaceDialog} events.
+  # 
   # ### Events using this class
   # 
   # The following event-handler methods redirect the events to member method or handler blocks for {Wx::FindDialogEvent} events.
@@ -94,7 +95,7 @@ module Wx
   class FindDialogEvent < CommandEvent
   
     # Constructor used by wxWidgets only.
-    # @param commandType [Wx::Slider::EventType] 
+    # @param commandType [Wx::Notebook::EventType] 
     # @param id [Integer] 
     # @return [Wx::FindDialogEvent]
     def initialize(commandType=Wx::EVT_NULL, id=0) end

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

@@ -7,6 +7,7 @@
 module Wx
 
   # {Wx::FindReplaceData} holds the data for {Wx::FindReplaceDialog}.
+  # 
   # It is used to initialize the dialog with the default values and will keep the last values from the dialog when it is closed. It is also updated each time a {Wx::FindDialogEvent} is generated so instead of using the {Wx::FindDialogEvent} methods you can also directly query this object.
   # Note that all <code>SetXXX()</code> methods may only be called before showing the dialog and calling them has no effect later.
   # 

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

@@ -7,6 +7,7 @@
 module Wx
 
   # {Wx::FindReplaceDialog} is a standard modeless dialog which is used to allow the user to search for some text (and possibly replace it with something else).
+  # 
   # The actual searching is supposed to be done in the owner window which is the parent of this dialog. Note that it means that unlike for the other standard dialogs this one <b>must</b> have a parent window. Also note that there is no way to use this dialog in a modal way; it is always, by design and implementation, modeless.
   # Please see the Dialogs Sample sample for an example of using it.
   # 
@@ -16,6 +17,7 @@ module Wx
   class FindReplaceDialog < Dialog
   
     # After using default constructor {Wx::FindReplaceDialog#create} must be called.
+    # 
     # The parent and data parameters must be non-NULL.
     # @param parent [Wx::Window] 
     # @param data [Wx::FindReplaceData] 
@@ -25,6 +27,7 @@ module Wx
     def initialize(parent, data, title, style=0) end
     
     # Creates the dialog; use {Wx::Window#show} to show it on screen.
+    # 
     # The parent and data parameters must be non-NULL.
     # @param parent [Wx::Window] 
     # @param data [Wx::FindReplaceData] 

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

@@ -7,6 +7,7 @@
 module Wx
 
   # A flex grid sizer is a sizer which lays out its children in a two-dimensional table with all table fields in one row having the same height and all fields in one column having the same width, but all rows or all columns are not necessarily the same height or width as in the {Wx::GridSizer}.
+  # 
   # Since wxWidgets 2.5.0, {Wx::FlexGridSizer} can also size items equally in one direction but unequally ("flexibly") in the other. If the sizer is only flexible in one direction (this can be changed using {Wx::FlexGridSizer#set_flexible_direction}), it needs to be decided how the sizer should grow in the other ("non-flexible") direction in order to fill the available space. The {Wx::FlexGridSizer#set_non_flexible_grow_mode} method serves this purpose.
   # 
   # Category:  Window Layout
@@ -18,6 +19,7 @@ module Wx
   
     # @overload initialize(cols, vgap, hgap)
     #   {Wx::FlexGridSizer} constructors.
+    #   
     #   Please see {Wx::GridSizer::GridSizer} documentation.
     #   @param cols [Integer] 
     #   @param vgap [Integer] 
@@ -25,12 +27,14 @@ module Wx
     #   @return [Wx::FlexGridSizer]
     # @overload initialize(cols, gap=(Wx::Size.new(0, 0)))
     #   {Wx::FlexGridSizer} constructors.
+    #   
     #   Please see {Wx::GridSizer::GridSizer} documentation.
     #   @param cols [Integer] 
     #   @param gap [Array(Integer, Integer), Wx::Size] 
     #   @return [Wx::FlexGridSizer]
     # @overload initialize(rows, cols, vgap, hgap)
     #   {Wx::FlexGridSizer} constructors.
+    #   
     #   Please see {Wx::GridSizer::GridSizer} documentation.
     #   @param rows [Integer] 
     #   @param cols [Integer] 
@@ -39,6 +43,7 @@ module Wx
     #   @return [Wx::FlexGridSizer]
     # @overload initialize(rows, cols, gap)
     #   {Wx::FlexGridSizer} constructors.
+    #   
     #   Please see {Wx::GridSizer::GridSizer} documentation.
     #   @param rows [Integer] 
     #   @param cols [Integer] 
@@ -47,6 +52,7 @@ module Wx
     def initialize(*args) end
     
     # Specifies that column idx (starting from zero) should be grown if there is extra space available to the sizer.
+    # 
     # The proportion parameter has the same meaning as the stretch factor for the sizers (see {Wx::BoxSizer}) except that if all proportions are 0, then all columns are resized equally (instead of not being resized at all).
     # Notice that the column must not be already growable, if you need to change the proportion you must call {Wx::FlexGridSizer#remove_growable_col} first and then make it growable (with a different proportion) again. You can use {Wx::FlexGridSizer#is_col_growable} to check whether a column is already growable.
     # @param idx [Integer] 
@@ -55,6 +61,7 @@ module Wx
     def add_growable_col(idx, proportion=0) end
     
     # Specifies that row idx (starting from zero) should be grown if there is extra space available to the sizer.
+    # 
     # This is identical to {Wx::FlexGridSizer#add_growable_col} except that it works with rows and not columns.
     # @param idx [Integer] 
     # @param proportion [Integer] 
@@ -62,6 +69,7 @@ module Wx
     def add_growable_row(idx, proportion=0) end
     
     # Returns a {Wx::Orientation} value that specifies whether the sizer flexibly resizes its columns, rows, or both (default).
+    # 
     # One of the following values:
     # 
     # - {Wx::Orientation::VERTICAL}: Rows are flexibly sized.
@@ -73,6 +81,7 @@ module Wx
     alias_method :flexible_direction, :get_flexible_direction
     
     # Returns the value that specifies how the sizer grows in the "non-flexible" direction if there is one.
+    # 
     # The behaviour of the elements in the flexible direction (i.e. both rows and columns by default, or rows only if {Wx::FlexGridSizer#get_flexible_direction} is {Wx::Orientation::VERTICAL} or columns only if it is {Wx::Orientation::HORIZONTAL}) is always governed by their proportion as specified in the call to {Wx::FlexGridSizer#add_growable_row} or {Wx::FlexGridSizer#add_growable_col}. What happens in the other direction depends on the value of returned by this function as described below.
     # One of the following values:
     # 
@@ -108,6 +117,7 @@ module Wx
     def remove_growable_row(idx) end
     
     # Specifies whether the sizer should flexibly resize its columns, rows, or both.
+    # 
     # Argument direction can be {Wx::Orientation::VERTICAL}, {Wx::Orientation::HORIZONTAL} or {Wx::Orientation::BOTH} (which is the default value). Any other value is ignored.
     # See {Wx::FlexGridSizer#get_flexible_direction} for the explanation of these values. Note that this method does not trigger relayout.
     # @param direction [Integer] 
@@ -116,6 +126,7 @@ module Wx
     alias_method :flexible_direction=, :set_flexible_direction
     
     # Specifies how the sizer should grow in the non-flexible direction if there is one (so {Wx::FlexGridSizer#set_flexible_direction} must have been called previously).
+    # 
     # Argument mode can be one of those documented in {Wx::FlexGridSizer#get_non_flexible_grow_mode}, please see there for their explanation. Note that this method does not trigger relayout.
     # @param mode [Wx::FlexSizerGrowMode] 
     # @return [void]
@@ -133,6 +144,7 @@ module Wx
     alias_method :col_widths, :get_col_widths
     
     # Method which must be overridden in the derived sizer classes.
+    # 
     # The implementation should reposition the children using the current total size available to the sizer (m_size) and the size computed by the last call to {Wx::FlexGridSizer#calc_min}.
     # Note that you should never call this method directly, call {Wx::FlexGridSizer#layout} instead if you need to manually update the sizer elements positions. This method is only called by wxWidgets itself.
     # @param minSize [Array(Integer, Integer), Wx::Size] 
@@ -140,6 +152,7 @@ module Wx
     def reposition_children(minSize) end
     
     # This method is abstract and has to be overwritten by any derived class.
+    # 
     # Here, the sizer will do the actual calculation of its children's minimal sizes.
     # @return [Wx::Size]
     def calc_min; end