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

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

@@ -0,0 +1,250 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+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.
+  # === 
+  # 
+  # Category:  Virtual File System
+  # @see Wx::FileSystemHandler
+  # @see  Wx::FSFile
+  # @see  wxFileSystem Overview 
+  # 
+  # 
+  # 
+  # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
+  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
+    
+    # Remove a filesystem handler from the list of handlers.
+    # @param handler [Wx::FileSystemHandler] 
+    # @return [Wx::FileSystemHandler]
+    def self.remove_handler(handler) end
+    
+    # Converts a {Wx::FileName} into an URL.
+    # 
+    # @see Wx::FileSystem.url_to_file_name
+    # @see  Wx::FileName 
+    # @param filename [String] 
+    # @return [String]
+    def self.file_name_to_url(filename) end
+    
+    # This static function returns true if there is a registered handler which can open the given location.
+    # @param location [String] 
+    # @return [Boolean]
+    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]
+    def self.url_to_file_name(url) end
+    
+  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.
+  # Also consult the list of available handlers.
+  # Note that the handlers are shared by all instances of {Wx::FileSystem}.
+  # {Wx::HTML} library provides handlers for local files and HTTP or FTP protocol.
+  # 
+  # The location parameter passed to {Wx::FileSystemHandler#open_file} or {Wx::FileSystemHandler#can_open} methods is always an absolute path. You don't need to check the FS's current path.
+  # 
+  # === 
+  # 
+  # Category:  Virtual File System
+  # @see Wx::FileSystem
+  # @see  Wx::FSFile
+  # @see  wxFileSystem Overview 
+  # 
+  # 
+  class FileSystemHandler < Object
+  
+    # Constructor.
+    # @return [Wx::FileSystemHandler]
+    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:
+    # 
+    # ```
+    #   bool MyHand::CanOpen(const wxString& location)
+    #   {
+    #       return (GetProtocol(location) == "http");
+    #   }
+    # ```
+    # 
+    # Must be overridden in derived handlers.
+    # @param location [String] 
+    # @return [Boolean]
+    def can_open(location) end
+    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] 
+    # @param flags [Integer] 
+    # @return [String]
+    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.
+    # @return [Wx::FSFile]
+    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: 
+    # ```
+    #   GetMimeTypeFromExt("index.htm") == "text/html"
+    # ```
+    # @param location [String] 
+    # @return [String]
+    def self.get_mime_type_from_ext(location) end
+    
+  end # FileSystemHandler
+  
+  # A file system handler for accessing files inside of archives.
+  # 
+  # 
+  class ArchiveFSHandler < FileSystemHandler
+  
+    # @return [Wx::ArchiveFSHandler]
+    def initialize; end
+    
+    # @return [void]
+    def cleanup; end
+    
+  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:
+  # 
+  # ```
+  #   #ifndef __WXMSW__
+  #   #include "logo.xpm"
+  #   #endif
+  #   
+  #   void MyFrame::OnAbout(wxCommandEvent&)
+  #   {
+  #       wxFileSystem::AddHandler(new wxMemoryFSHandler);
+  #       wxMemoryFSHandler::AddFile("logo.png", wxBITMAP(logo), wxBITMAP_TYPE_PNG);
+  #       wxMemoryFSHandler::AddFile("about.htm",
+  #                               "<html><body>About: "
+  #                               "<img src=\"memory:logo.png\"></body></html>");
+  #   
+  #       wxDialog dlg(this, -1, wxString(_("About")));
+  #       wxBoxSizer *topsizer;
+  #       topsizer = new wxBoxSizer(wxVERTICAL);
+  #   #ifdef USE_WEBVIEW
+  #       wxWebView* browser = wxWebView::New(&dlg, wxID_ANY, wxWebViewDefaultURLStr,
+  #                                wxDefaultPosition, wxSize(380, 160));
+  #       browser->RegisterHandler(wxSharedPtr<wxWebViewHandler>(new wxWebViewFSHandler("memory")));
+  #       browser->LoadURL("memory:about.htm");
+  #   #else // Use wxHtml
+  #       wxHtmlWindow *browser;
+  #       browser = new wxHtmlWindow(&dlg, -1, wxDefaultPosition,
+  #                                  wxSize(380, 160), wxHW_SCROLLBAR_NEVER);
+  #       browser->SetBorders(0);
+  #       browser->LoadPage("memory:about.htm");
+  #       browser->SetSize(browser->GetInternalRepresentation()->GetWidth(),
+  #                   browser->GetInternalRepresentation()->GetHeight());
+  #   #endif
+  #       topsizer->Add(browser, 1, wxALL, 10);
+  #       topsizer->Add(new wxStaticLine(&dlg, -1), 0, wxEXPAND | wxLEFT | wxRIGHT, 10);
+  #       topsizer->Add(new wxButton(&dlg, wxID_OK, "Ok"),
+  #                   0, wxALL | wxALIGN_RIGHT, 15);
+  #       dlg.SetAutoLayout(true);
+  #       dlg.SetSizer(topsizer);
+  #       topsizer->Fit(&dlg);
+  #       dlg.Centre();
+  #       dlg.ShowModal();
+  #   
+  #       wxMemoryFSHandler::RemoveFile("logo.png");
+  #       wxMemoryFSHandler::RemoveFile("about.htm");
+  #   }
+  # ```
+  # 
+  # === 
+  # 
+  # Category:  Virtual File System
+  # @see Wx::MemoryFSHandler.add_file_with_mime_type 
+  # 
+  # 
+  class MemoryFSHandler < FileSystemHandler
+  
+    # @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.
+    #   you must use a type value (aka image format) that wxWidgets can save (e.g. JPG, PNG, see {Wx::Image} documentation)!
+    #   @see Wx::MemoryFSHandler.add_file_with_mime_type 
+    #   @param filename [String] 
+    #   @param image [Wx::Image] 
+    #   @param type [Wx::BitmapType] 
+    #   @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.
+    #   you must use a type value (aka image format) that wxWidgets can save (e.g. JPG, PNG, see {Wx::Image} documentation)!
+    #   @see Wx::MemoryFSHandler.add_file_with_mime_type 
+    #   @param filename [String] 
+    #   @param bitmap [Wx::Bitmap] 
+    #   @param type [Wx::BitmapType] 
+    #   @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.
+    #   you must use a type value (aka image format) that wxWidgets can save (e.g. JPG, PNG, see {Wx::Image} documentation)!
+    #   @see Wx::MemoryFSHandler.add_file_with_mime_type 
+    #   @param filename [String] 
+    #   @param textdata [String] 
+    #   @return [void]
+    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] 
+    # @param textdata [String] 
+    # @param mimetype [String] 
+    # @return [void]
+    def self.add_file_with_mime_type(filename, textdata, mimetype) end
+    
+    # Constructor.
+    # @return [Wx::MemoryFSHandler]
+    def initialize; end
+    
+    # Removes a file from memory FS and frees the occupied memory.
+    # @param filename [String] 
+    # @return [void]
+    def self.remove_file(filename) end
+    
+  end # MemoryFSHandler
+  
+
+end

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

@@ -75,10 +75,15 @@ module Wx
   # 
   # The following event-handler methods redirect the events to member method or handler blocks for {Wx::FindDialogEvent} events.
   # Event handler methods:
+  # 
   # - {Wx::EvtHandler#evt_find}(id, meth = nil, &block): Find button was pressed in the dialog. 
+  # 
   # - {Wx::EvtHandler#evt_find_next}(id, meth = nil, &block): Find next button was pressed in the dialog. 
+  # 
   # - {Wx::EvtHandler#evt_find_replace}(id, meth = nil, &block): Replace button was pressed in the dialog. 
+  # 
   # - {Wx::EvtHandler#evt_find_replace_all}(id, meth = nil, &block): Replace all button was pressed in the dialog. 
+  # 
   # - {Wx::EvtHandler#evt_find_close}(id, meth = nil, &block): The dialog is being destroyed, any pointers to it cannot be used any longer. 
   # 
   # === 
@@ -88,9 +93,9 @@ module Wx
   class FindDialogEvent < CommandEvent
   
     # Constructor used by wxWidgets only.
-    # @param commandType [Integer] 
+    # @param commandType [Wx::CommandLinkButton::EventType] 
     # @param id [Integer] 
-    # @return [FindDialogEvent]
+    # @return [Wx::FindDialogEvent]
     def initialize(commandType=Wx::EVT_NULL, id=0) end
     
     # Return the pointer to the dialog which generated this event.

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

@@ -17,7 +17,7 @@ module Wx
   
     # Constructor initializes the flags to default value (0).
     # @param flags [Integer] 
-    # @return [FindReplaceData]
+    # @return [Wx::FindReplaceData]
     def initialize(flags=0) end
     
     # Get the string to find.

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

@@ -21,7 +21,7 @@ module Wx
     # @param data [Wx::FindReplaceData] 
     # @param title [String] 
     # @param style [Integer] 
-    # @return [FindReplaceDialog]
+    # @return [Wx::FindReplaceDialog]
     def initialize(parent, data, title, style=0) end
     
     # Creates the dialog; use {Wx::Window#show} to show it on screen.
@@ -30,7 +30,7 @@ module Wx
     # @param data [Wx::FindReplaceData] 
     # @param title [String] 
     # @param style [Integer] 
-    # @return [true,false]
+    # @return [Boolean]
     def create(parent, data, title, style=0) end
     
     # Get the {Wx::FindReplaceData} object used by this dialog.

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

@@ -23,13 +23,13 @@ module Wx
     #   @param cols [Integer] 
     #   @param vgap [Integer] 
     #   @param hgap [Integer] 
-    #   @return [FlexGridSizer]
+    #   @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 [FlexGridSizer]
+    #   @return [Wx::FlexGridSizer]
     # @overload initialize(rows, cols, vgap, hgap)
     #   {Wx::FlexGridSizer} constructors.
     #   Please see {Wx::GridSizer::GridSizer} documentation.
@@ -37,14 +37,14 @@ module Wx
     #   @param cols [Integer] 
     #   @param vgap [Integer] 
     #   @param hgap [Integer] 
-    #   @return [FlexGridSizer]
+    #   @return [Wx::FlexGridSizer]
     # @overload initialize(rows, cols, gap)
     #   {Wx::FlexGridSizer} constructors.
     #   Please see {Wx::GridSizer::GridSizer} documentation.
     #   @param rows [Integer] 
     #   @param cols [Integer] 
     #   @param gap [Array(Integer, Integer), Wx::Size] 
-    #   @return [FlexGridSizer]
+    #   @return [Wx::FlexGridSizer]
     def initialize(*args) end
     
     # Specifies that column idx (starting from zero) should be grown if there is extra space available to the sizer.
@@ -64,7 +64,10 @@ module Wx
     
     # 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.- {Wx::Orientation::HORIZONTAL}: Columns are flexibly sized.- {Wx::Orientation::BOTH}: Both rows and columns are flexibly sized (this is the default value).
+    # 
+    # - {Wx::Orientation::VERTICAL}: Rows are flexibly sized.
+    # - {Wx::Orientation::HORIZONTAL}: Columns are flexibly sized.
+    # - {Wx::Orientation::BOTH}: Both rows and columns are flexibly sized (this is the default value).
     # @see Wx::FlexGridSizer#set_flexible_direction 
     # @return [Integer]
     def get_flexible_direction; end
@@ -73,22 +76,25 @@ module Wx
     # 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:
-    # - {Wx::FlexSizerGrowMode::FLEX_GROWMODE_NONE}: Sizer doesn't grow its elements at all in the non-flexible direction.- {Wx::FlexSizerGrowMode::FLEX_GROWMODE_SPECIFIED}: Sizer honors growable columns/rows set with {Wx::FlexGridSizer#add_growable_col} and {Wx::FlexGridSizer#add_growable_row} in the non-flexible direction as well. In this case equal sizing applies to minimum sizes of columns or rows (this is the default value).- {Wx::FlexSizerGrowMode::FLEX_GROWMODE_ALL}: Sizer equally stretches all columns or rows in the non-flexible direction, independently of the proportions applied in the flexible direction.
+    # 
+    # - {Wx::FlexSizerGrowMode::FLEX_GROWMODE_NONE}: Sizer doesn't grow its elements at all in the non-flexible direction.
+    # - {Wx::FlexSizerGrowMode::FLEX_GROWMODE_SPECIFIED}: Sizer honors growable columns/rows set with {Wx::FlexGridSizer#add_growable_col} and {Wx::FlexGridSizer#add_growable_row} in the non-flexible direction as well. In this case equal sizing applies to minimum sizes of columns or rows (this is the default value).
+    # - {Wx::FlexSizerGrowMode::FLEX_GROWMODE_ALL}: Sizer equally stretches all columns or rows in the non-flexible direction, independently of the proportions applied in the flexible direction.
     # @see Wx::FlexGridSizer#set_flexible_direction
     # @see  Wx::FlexGridSizer#set_non_flexible_grow_mode 
-    # @return [FlexSizerGrowMode]
+    # @return [Wx::FlexSizerGrowMode]
     def get_non_flexible_grow_mode; end
     alias_method :non_flexible_grow_mode, :get_non_flexible_grow_mode
     
     # Returns true if column idx is growable.
     # @param idx [Integer] 
-    # @return [true,false]
+    # @return [Boolean]
     def is_col_growable(idx) end
     alias_method :col_growable?, :is_col_growable
     
     # Returns true if row idx is growable.
     # @param idx [Integer] 
-    # @return [true,false]
+    # @return [Boolean]
     def is_row_growable(idx) end
     alias_method :row_growable?, :is_row_growable
     
@@ -112,7 +118,7 @@ module Wx
     
     # 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 [FlexSizerGrowMode] 
+    # @param mode [Wx::FlexSizerGrowMode] 
     # @return [void]
     def set_non_flexible_grow_mode(mode) end
     alias_method :non_flexible_grow_mode=, :set_non_flexible_grow_mode