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

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

@@ -10,6 +10,7 @@ module Wx
   # 
   # 
   # 
+  # @wxrb_require USE_FILESYSTEM
   class FileSystemOpenFlags < Wx::Enum
   
     # Open for reading.
@@ -24,6 +25,7 @@ module Wx
   
   # Parameter indicating how file offset should be interpreted.
   # 
+  # @wxrb_require USE_FILESYSTEM
   class SeekMode < Wx::Enum
   
     # Seek from the file beginning.
@@ -42,6 +44,7 @@ module Wx
   
   # IO stream error codes.
   # 
+  # @wxrb_require USE_FILESYSTEM
   class StreamError < Wx::Enum
   
     # No error occurred.
@@ -63,10 +66,14 @@ module Wx
   end # StreamError
   
   # This class represents a single file opened by {Wx::FileSystem}.
+  # 
   # It provides more information than wxWidgets' input streams (stream, filename, mime type, anchor).
-  # Any pointer returned by a method of {Wx::FSFile} is valid only as long as the {Wx::FSFile} object exists. For example a call to {Wx::FSFile#get_stream} doesn't create the stream but only returns the pointer to it. In other words after 10 calls to {Wx::FSFile#get_stream} you will have obtained ten identical pointers.
   # 
-  # === 
+  # <div class="wxrb-note">
+  # <b>Note:</b>
+  # <p>Any pointer returned by a method of {Wx::FSFile} is valid only as long as the {Wx::FSFile} object exists. For example a call to {Wx::FSFile#get_stream} doesn't create the stream but only returns the pointer to it. In other words after 10 calls to {Wx::FSFile#get_stream} you will have obtained ten identical pointers.
+  # </p>
+  # </div>
   # 
   # Category:  Virtual File System, File Handling
   # @see Wx::FileSystemHandler
@@ -74,9 +81,11 @@ module Wx
   # @see  wxFileSystem Overview 
   # 
   # 
+  # @wxrb_require USE_FILESYSTEM
   class FSFile < Object
   
     # Constructor.
+    # 
     # You probably won't use it. See the Note for details.
     # 
     # If you are not sure of the meaning of these params, see the description of the GetXXXX() functions.
@@ -89,26 +98,29 @@ module Wx
     def initialize(stream, location, mimetype, anchor, modif) end
     
     # Detaches the stream from the {Wx::FSFile} object.
+    # 
     # That is, the stream obtained with {Wx::FSFile#get_stream} will continue its existence after the {Wx::FSFile} object is deleted.
     # You will have to delete the stream yourself.
     # @return [Wx::InputStream]
     def detach_stream; end
     
     # Returns anchor (if present).
+    # 
     # The term of <b>anchor</b> can be easily explained using few examples:
-    # index.htm#anchor                      // 'anchor' is anchor
+    # index.htm\#anchor                      // 'anchor' is anchor
     # index/{Wx::001}.htm                       // NO anchor here!
-    # archive/main.zip#zip:index.htm#global // 'global'
-    # archive/main.zip#zip:index.htm        // NO anchor here!
+    # archive/main.zip\#zip:index.htm\#global // 'global'
+    # archive/main.zip\#zip:index.htm        // NO anchor here!
     # 
-    # Usually an anchor is presented only if the MIME type is 'text/html'. But it may have some meaning with other files; for example myanim.avi#200 may refer to position in animation or reality.wrl::MyView may refer to a predefined view in VRML.
+    # Usually an anchor is presented only if the MIME type is 'text/html'. But it may have some meaning with other files; for example myanim.avi\#200 may refer to position in animation or reality.wrl::MyView may refer to a predefined view in VRML.
     # @return [Wx::String]
     def get_anchor; end
     alias_method :anchor, :get_anchor
     
     # Returns full location of the file, including path and protocol.
+    # 
     # Examples: http://www.{Wx::widgets}.org
-    # http://www.ms.mff.cuni.cz/~vsla8348/{Wx::html}/archive.zip#zip:info.txt
+    # http://www.ms.mff.cuni.cz/~vsla8348/{Wx::html}/archive.zip\#zip:info.txt
     # file:/home/vasek/index.htm
     # relative-file.htm
     # @return [Wx::String]
@@ -116,6 +128,7 @@ module Wx
     alias_method :location, :get_location
     
     # Returns the MIME type of the content of this file.
+    # 
     # It is either extension-based (see {Wx::MimeTypesManager}) or extracted from HTTP protocol Content-Type header.
     # @return [Wx::String]
     def get_mime_type; end
@@ -127,6 +140,7 @@ module Wx
     alias_method :modification_time, :get_modification_time
     
     # Returns pointer to the stream.
+    # 
     # You can use the returned stream to directly access data. You may suppose that the stream provide Seek and GetSize functionality (even in the case of the HTTP protocol which doesn't provide this by default. {Wx::HTML} uses local cache to work around this and to speed up the connection).
     # @return [Wx::InputStream]
     def get_stream; end
@@ -135,8 +149,8 @@ module Wx
   end # FSFile
   
   # This class is the base class of most stream related classes in wxWidgets.
+  # 
   # It must not be used directly.
-  # === 
   # 
   # Category:  {Wx::Streams}
   # @see Wx::StreamBuffer 
@@ -144,9 +158,11 @@ module Wx
   # 
   # 
   # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
+  # @wxrb_require USE_FILESYSTEM
   class StreamBase < ::Object
   
     # Creates a dummy stream object.
+    # 
     # It doesn't do anything.
     # @return [Wx::StreamBase]
     def initialize; end
@@ -157,12 +173,14 @@ module Wx
     alias_method :last_error, :get_last_error
     
     # Returns the length of the stream in bytes.
+    # 
     # If the length cannot be determined (this is always the case for socket streams for example), returns {Wx::InvalidOffset}.
     # @return [Integer]
     def get_length; end
     alias_method :length, :get_length
     
     # This function returns the size of the stream.
+    # 
     # For example, for a file it is the size of the file.
     # There are streams which do not have size by definition, such as socket streams. In that cases, {Wx::StreamBase#get_size} returns 0 so you should always test its return value.
     # @return [Integer]
@@ -171,6 +189,7 @@ module Wx
     
     # Returns true if no error occurred on the stream.
     # 
+    # 
     # @see Wx::StreamBase#get_last_error 
     # @return [Boolean]
     def is_ok; end
@@ -182,6 +201,7 @@ module Wx
     alias_method :seekable?, :is_seekable
     
     # Resets the stream state.
+    # 
     # By default, resets the stream to good state, i.e. clears any errors. Since wxWidgets 2.9.3 can be also used to explicitly set the state to the specified error (the error argument didn't exist in the previous versions).
     # @see Wx::StreamBase#get_last_error 
     # @param error [Wx::StreamError] 
@@ -191,14 +211,15 @@ module Wx
   end # StreamBase
   
   # {Wx::InputStream} is an abstract base class which may not be used directly.
+  # 
   # It is the base class of all streams which provide a {Wx::InputStream#read} function, i.e. which can be used to read data from a source (e.g. a file, a socket, etc).
   # If you want to create your own input stream, you'll need to derive from this class and implement the protected {Wx::InputStream#on_sys_read} function only.
-  # === 
   # 
   # Category:  {Wx::Streams}
   # 
   # 
   # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
+  # @wxrb_require USE_FILESYSTEM
   class InputStream < StreamBase
   
     # Creates a dummy input stream.
@@ -215,6 +236,7 @@ module Wx
     def eof; end
     
     # Returns the first character in the input queue and removes it, blocking until it appears if necessary.
+    # 
     # On success returns a value between 0 - 255; on end of file returns {Wx::EOF}.
     # @return [Integer]
     def get_c; end
@@ -229,6 +251,7 @@ module Wx
     def peek; end
     
     # Reads data from the input queue and stores it in the specified output stream.
+    # 
     # The data is read until an error is raised by one of the two streams.
     # This function returns a reference on the current object, so the user can test any states of the stream right away.
     # @param stream_out [IO,Wx::OutputStream] 
@@ -236,6 +259,7 @@ module Wx
     def read(stream_out) end
     
     # Changes the stream current position.
+    # 
     # This operation in general is possible only for seekable streams (see {Wx::StreamBase#is_seekable}); non-seekable streams support only seeking positive amounts in mode {Wx::SeekMode::FromCurrent} (this is implemented by reading data and simply discarding it).
     # 
     # The new stream position or {Wx::InvalidOffset} on error.
@@ -245,6 +269,7 @@ module Wx
     def seek_i(pos, mode=Wx::SeekMode::FromStart) end
     
     # Returns the current stream position or {Wx::InvalidOffset} if it's not available (e.g.
+    # 
     # socket streams do not have a size nor a current stream position).
     # @return [Integer]
     def tell_i; end
@@ -257,14 +282,15 @@ module Wx
   end # InputStream
   
   # {Wx::OutputStream} is an abstract base class which may not be used directly.
+  # 
   # It is the base class of all streams which provide a {Wx::OutputStream#write} function, i.e. which can be used to output data (e.g. to a file, to a socket, etc).
   # If you want to create your own output stream, you'll need to derive from this class and implement the protected {Wx::OutputStream#on_sys_write} function only.
-  # === 
   # 
   # Category:  {Wx::Streams}
   # 
   # 
   # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
+  # @wxrb_require USE_FILESYSTEM
   class OutputStream < StreamBase
   
     # Creates a dummy {Wx::OutputStream} object.
@@ -272,12 +298,14 @@ module Wx
     def initialize; end
     
     # Closes the stream, returning false if an error occurs.
+    # 
     # The stream is closed implicitly in the destructor if {Wx::OutputStream#close} is not called explicitly.
     # If this stream wraps another stream or some other resource such as a file, then the underlying resource is closed too if it is owned by this stream, or left open otherwise.
     # @return [Boolean]
     def close; end
     
     # Returns the number of bytes written during the last {Wx::OutputStream#write}.
+    # 
     # It may return 0 even if there is no error on the stream if it is only temporarily impossible to write to it.
     # @return [Integer]
     def last_write; end
@@ -288,6 +316,7 @@ module Wx
     def put_c(c) end
     
     # Changes the stream current position.
+    # 
     # The new stream position or {Wx::InvalidOffset} on error.
     # @param pos [Integer]  Offset to seek to.
     # @param mode [Wx::SeekMode]  One of {Wx::SeekMode::FromStart}, {Wx::SeekMode::FromEnd}, {Wx::SeekMode::FromCurrent}.

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

@@ -22,11 +22,12 @@ module Wx
   GA_TEXT = 64
   
   # A gauge is a horizontal or vertical bar which shows a quantity (often time).
+  # 
   # {Wx::Gauge} supports two working modes: determinate and indeterminate progress.
   # The first is the usual working mode (see {Wx::Gauge#set_value} and {Wx::Gauge#set_range}) while the second can be used when the program is doing some processing but you don't know how much progress is being done. In this case, you can periodically call the {Wx::Gauge#pulse} function to make the progress bar switch to indeterminate mode (graphically it's usually a set of blocks which move or bounce in the bar control).
   # {Wx::Gauge} supports dynamic switch between these two work modes.
   # There are no user commands for the gauge.
-  # === Styles
+  # ### Styles
   # 
   # This class supports the following styles:
   # 
@@ -40,16 +41,15 @@ module Wx
   # 
   # - {Wx::GA_PROGRESS}: Reflect the value of gauge in the application taskbar button under Windows 7 and later and the dock icon under macOS, ignored under the other platforms. This flag is only available in wxWidgets 3.1.0 and later. 
   # 
-  # === 
-  # 
-  # Category:  {Wx::Controls}  <div class='appearance'><span class='appearance'>Appearance:</span><table><tr><td> wxMSW Appearance
-  #   </td><td> wxGTK Appearance
-  #   </td><td> wxOSX Appearance
+  # Category:  {Wx::Controls}  <div class='appearance'><span class='appearance'>Appearance:</span><table><tr><td> WXMSW Appearance
+  #   </td><td> WXGTK Appearance
+  #   </td><td> WXOSX Appearance
   #   </td></tr></table></div>
   # @see Wx::Slider
   # @see  Wx::ScrollBar 
   # 
   # 
+  # @wxrb_require USE_GAUGE
   class Gauge < Control
   
     # @overload initialize()
@@ -58,6 +58,7 @@ module Wx
     # @overload initialize(parent, id, range, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::GA_HORIZONTAL, validator=Wx::DEFAULT_VALIDATOR, name=Wx::GAUGE_NAME_STR)
     #   Constructor, creating and showing a gauge.
     #   
+    #   
     #   @see Wx::Gauge#create 
     #   @param parent [Wx::Window]  Window parent.
     #   @param id [Integer]  Window identifier.
@@ -71,6 +72,7 @@ module Wx
     def initialize(*args) end
     
     # Creates the gauge for two-step construction.
+    # 
     # See {Wx::Gauge#initialize} for further details.
     # @param parent [Wx::Window] 
     # @param id [Integer] 
@@ -85,6 +87,7 @@ module Wx
     
     # Returns the maximum position of the gauge.
     # 
+    # 
     # @see Wx::Gauge#set_range 
     # @return [Integer]
     def get_range; end
@@ -92,6 +95,7 @@ module Wx
     
     # Returns the current position of the gauge.
     # 
+    # 
     # @see Wx::Gauge#set_value 
     # @return [Integer]
     def get_value; end
@@ -103,13 +107,19 @@ module Wx
     alias_method :vertical?, :is_vertical
     
     # Switch the gauge to indeterminate mode (if required) and makes the gauge move a bit to indicate the user that some progress has been made.
-    # After calling this function the value returned by {Wx::Gauge#get_value} is undefined and thus you need to explicitly call {Wx::Gauge#set_value} if you want to restore the determinate mode.
+    # 
+    # <div class="wxrb-note">
+    # <b>Note:</b>
+    # <p>After calling this function the value returned by {Wx::Gauge#get_value} is undefined and thus you need to explicitly call {Wx::Gauge#set_value} if you want to restore the determinate mode. 
+    # </p>
+    # </div>
     # @return [void]
     def pulse; end
     
     # Sets the range (maximum value) of the gauge.
+    # 
     # This function makes the gauge switch to determinate mode, if it's not already.
-    # When the gauge is in indeterminate mode, under wxMSW the gauge repeatedly goes from zero to range and back; under other ports when in indeterminate mode, the range setting is ignored.
+    # When the gauge is in indeterminate mode, under WXMSW the gauge repeatedly goes from zero to range and back; under other ports when in indeterminate mode, the range setting is ignored.
     # @see Wx::Gauge#get_range 
     # @param range [Integer] 
     # @return [void]
@@ -117,6 +127,7 @@ module Wx
     alias_method :range=, :set_range
     
     # Sets the position of the gauge.
+    # 
     # The pos must be between 0 and the gauge range as returned by {Wx::Gauge#get_range}, inclusive.
     # This function makes the gauge switch to determinate mode, if it was in indeterminate mode before.
     # @see Wx::Gauge#get_value 

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

@@ -7,11 +7,13 @@
 module Wx
 
   # The {Wx::GBSizerItem} class is used by the {Wx::GridBagSizer} for tracking the items in the sizer.
+  # 
   # It adds grid position and spanning information to the normal {Wx::SizerItem} by adding {Wx::GBPosition} and {Wx::GBSpan} attributes. Most of the time you will not need to use a {Wx::GBSizerItem} directly in your code, but there are a couple of cases where it is handy.
-  # === 
   # 
   # Category:  Window Layout
   # 
+  # 
+  # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
   class GBSizerItem < SizerItem
   
     # Get the grid position of the item.
@@ -41,6 +43,7 @@ module Wx
     def intersects(*args) end
     
     # If the item is already a member of a sizer then first ensure that there is no other item that would intersect with this one at the new position, then set the new position.
+    # 
     # Returns true if the change is successful and after the next Layout the item will be moved.
     # @param pos [Wx::GBPosition] 
     # @return [Boolean]
@@ -48,6 +51,7 @@ module Wx
     alias_method :pos=, :set_pos
     
     # If the item is already a member of a sizer then first ensure that there is no other item that would intersect with this one with its new spanning size, then set the new spanning.
+    # 
     # Returns true if the change is successful and after the next Layout the item will be resized.
     # @param span [Wx::GBSpan] 
     # @return [Boolean]

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

@@ -7,6 +7,7 @@
 module Wx
 
   # {Wx::GCDC} is a device context that draws on a {Wx::GraphicsContext}.
+  # 
   # {Wx::GCDC} does its best to implement {Wx::DC} API, but the following features are not (fully) implemented because {Wx::GraphicsContext} doesn't support them:
   # 
   # - {Wx::GCDC#get_pixel} method is not implemented and always returns false because modern graphics layers don't support retrieving the contents of the drawn pixels.
@@ -15,8 +16,6 @@ module Wx
   # - Similarly, {Wx::RasterOperationMode} parameter of {Wx::GCDC#blit} and {Wx::GCDC#stretch_blit} can only be one of the supported logical functions listed above, using any other function will result in an assertion failure and not drawing anything.
   # - For Direct2D-based {Wx::GraphicsContext}, only true-type fonts can be used in the font-related functions.
   # 
-  # === 
-  # 
   # Category:  Device Contexts
   # @see Wx::DC
   # @see  Wx::GraphicsContext 
@@ -24,6 +23,7 @@ module Wx
   # 
   # 
   # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
+  # @wxrb_require USE_GRAPHICS_CONTEXT
   class GCDC < DC
   
     # Retrieves associated {Wx::GraphicsContext}.
@@ -32,6 +32,7 @@ module Wx
     alias_method :graphics_context, :get_graphics_context
     
     # Set the graphics context to be used for this {Wx::GCDC}.
+    # 
     # Note that this object takes ownership of context and will delete it when it is destroyed or when {Wx::GCDC#set_graphics_context} is called again.
     # Also, unlike the constructor taking {Wx::GraphicsContext}, this method will reapply the current font, pen and brush, so that this object continues to use them, if they had been changed before (which is never the case when constructing {Wx::GCDC} directly from {Wx::GraphicsContext}).
     # @param context [Wx::GraphicsContext]