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

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

@@ -22,6 +22,46 @@ module Wx
     
   end # FileSystemOpenFlags
   
+  # Parameter indicating how file offset should be interpreted.
+  # 
+  class SeekMode < Wx::Enum
+  
+    # Seek from the file beginning.
+    # 
+    FromStart = Wx::SeekMode.new(0)
+    
+    # Seek from the current position.
+    # 
+    FromCurrent = Wx::SeekMode.new(1)
+    
+    # Seek from end of the file.
+    # 
+    FromEnd = Wx::SeekMode.new(2)
+    
+  end # SeekMode
+  
+  # IO stream error codes.
+  # 
+  class StreamError < Wx::Enum
+  
+    # No error occurred.
+    # 
+    STREAM_NO_ERROR = Wx::StreamError.new(0)
+    
+    # EOF reached.
+    # 
+    STREAM_EOF = Wx::StreamError.new(1)
+    
+    # generic write error on the last write call.
+    # 
+    STREAM_WRITE_ERROR = Wx::StreamError.new(2)
+    
+    # generic read error on the last read call.
+    # 
+    STREAM_READ_ERROR = Wx::StreamError.new(3)
+    
+  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.
@@ -44,7 +84,7 @@ module Wx
     # @param location [String]  The full location (aka filename) of the file
     # @param mimetype [String]  MIME type of this file. It may be left empty, in which case the type will be determined from file's extension (location must not be empty in this case).
     # @param anchor [String]  Anchor. See {Wx::FSFile#get_anchor} for details.
-    # @param modif [Wx::DateTime]  Modification date and time for this file.
+    # @param modif [Time,Date,DateTime]  Modification date and time for this file.
     # @return [Wx::FSFile]
     def initialize(stream, location, mimetype, anchor, modif) end
     
@@ -82,7 +122,7 @@ module Wx
     alias_method :mime_type, :get_mime_type
     
     # Returns time when this file was modified.
-    # @return [Wx::DateTime]
+    # @return [Time,Date,DateTime]
     def get_modification_time; end
     alias_method :modification_time, :get_modification_time
     
@@ -118,7 +158,7 @@ module Wx
     
     # 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 [Wx::FileOffset]
+    # @return [Integer]
     def get_length; end
     alias_method :length, :get_length
     
@@ -132,12 +172,12 @@ module Wx
     # Returns true if no error occurred on the stream.
     # 
     # @see Wx::StreamBase#get_last_error 
-    # @return [true,false]
+    # @return [Boolean]
     def is_ok; end
     alias_method :ok?, :is_ok
     
     # Returns true if the stream supports seeking to arbitrary offsets.
-    # @return [true,false]
+    # @return [Boolean]
     def is_seekable; end
     alias_method :seekable?, :is_seekable
     
@@ -146,7 +186,7 @@ module Wx
     # @see Wx::StreamBase#get_last_error 
     # @param error [Wx::StreamError] 
     # @return [void]
-    def reset(error=Wx::STREAM_NO_ERROR) end
+    def reset(error=Wx::StreamError::STREAM_NO_ERROR) end
     
   end # StreamBase
   
@@ -166,12 +206,12 @@ module Wx
     def initialize; end
     
     # Returns true if some data is available in the stream right now, so that calling {Wx::InputStream#read} wouldn't block.
-    # @return [true,false]
+    # @return [Boolean]
     def can_read; end
     alias_method :can_read?, :can_read
     
     # Returns true after an attempt has been made to read past the end of the stream.
-    # @return [true,false]
+    # @return [Boolean]
     def eof; end
     
     # Returns the first character in the input queue and removes it, blocking until it appears if necessary.
@@ -196,22 +236,22 @@ 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::FromCurrent} (this is implemented by reading data and simply discarding it).
+    # 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.
-    # @param pos [Wx::FileOffset]  Offset to seek to.
-    # @param mode [Wx::SeekMode]  One of {Wx::FromStart}, {Wx::FromEnd}, {Wx::FromCurrent}.
-    # @return [Wx::FileOffset]
-    def seek_i(pos, mode=Wx::FromStart) end
+    # @param pos [Integer]  Offset to seek to.
+    # @param mode [Wx::SeekMode]  One of {Wx::SeekMode::FromStart}, {Wx::SeekMode::FromEnd}, {Wx::SeekMode::FromCurrent}.
+    # @return [Integer]
+    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 [Wx::FileOffset]
+    # @return [Integer]
     def tell_i; end
     
     # This function acts like the previous one except that it takes only one character: it is sometimes shorter to use than the generic function.
     # @param c [Integer] 
-    # @return [true,false]
+    # @return [Boolean]
     def ungetch(c) end
     
   end # InputStream
@@ -234,7 +274,7 @@ module Wx
     # 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 [true,false]
+    # @return [Boolean]
     def close; end
     
     # Returns the number of bytes written during the last {Wx::OutputStream#write}.
@@ -249,13 +289,13 @@ module Wx
     
     # Changes the stream current position.
     # The new stream position or {Wx::InvalidOffset} on error.
-    # @param pos [Wx::FileOffset]  Offset to seek to.
-    # @param mode [Wx::SeekMode]  One of {Wx::FromStart}, {Wx::FromEnd}, {Wx::FromCurrent}.
-    # @return [Wx::FileOffset]
-    def seek_o(pos, mode=Wx::FromStart) end
+    # @param pos [Integer]  Offset to seek to.
+    # @param mode [Wx::SeekMode]  One of {Wx::SeekMode::FromStart}, {Wx::SeekMode::FromEnd}, {Wx::SeekMode::FromCurrent}.
+    # @return [Integer]
+    def seek_o(pos, mode=Wx::SeekMode::FromStart) end
     
     # Returns the current stream position.
-    # @return [Wx::FileOffset]
+    # @return [Integer]
     def tell_o; end
     
   end # OutputStream

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

@@ -71,7 +71,7 @@ module Wx
     def initialize(*args) end
     
     # Creates the gauge for two-step construction.
-    # See {Wx::Gauge#gauge} for further details.
+    # See {Wx::Gauge#initialize} for further details.
     # @param parent [Wx::Window] 
     # @param id [Integer] 
     # @param range [Integer] 
@@ -80,7 +80,7 @@ module Wx
     # @param style [Integer] 
     # @param validator [Wx::Validator] 
     # @param name [String] 
-    # @return [true,false]
+    # @return [Boolean]
     def create(parent, id, range, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::GA_HORIZONTAL, validator=Wx::DEFAULT_VALIDATOR, name=Wx::GaugeNameStr) end
     
     # Returns the maximum position of the gauge.
@@ -98,7 +98,7 @@ module Wx
     alias_method :value, :get_value
     
     # Returns true if the gauge is vertical (has {Wx::GA_VERTICAL} style) and false otherwise.
-    # @return [true,false]
+    # @return [Boolean]
     def is_vertical; end
     alias_method :vertical?, :is_vertical
     

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

@@ -14,57 +14,43 @@ module Wx
   # 
   class GBSizerItem < SizerItem
   
-    # @overload get_pos()
-    #   Get the grid position of the item.
-    #   @return [Wx::GBPosition]
-    # @overload get_pos(row, col)
-    #   Get the grid position of the item.
-    #   @param row [int] 
-    #   @param col [int] 
-    #   @return [void]
-    def get_pos(*args) end
+    # Get the grid position of the item.
+    # @return [Wx::GBPosition]
+    def get_pos; end
     alias_method :pos, :get_pos
     
-    # @overload get_span()
-    #   Get the row and column spanning of the item.
-    #   @return [Wx::GBSpan]
-    # @overload get_span(rowspan, colspan)
-    #   Get the row and column spanning of the item.
-    #   @param rowspan [int] 
-    #   @param colspan [int] 
-    #   @return [void]
-    def get_span(*args) end
+    # Get the row and column spanning of the item.
+    # @return [Wx::GBSpan]
+    def get_span; end
     alias_method :span, :get_span
     
     # Get the row and column of the endpoint of this item.
-    # @param row [int] 
-    # @param col [int] 
-    # @return [void]
-    def get_end_pos(row, col) end
+    # @return [Array(Integer,Integer)]
+    def get_end_pos; end
     alias_method :end_pos, :get_end_pos
     
     # @overload intersects(other)
     #   Returns true if this item and the other item intersect.
     #   @param other [Wx::GBSizerItem] 
-    #   @return [true,false]
+    #   @return [Boolean]
     # @overload intersects(pos, span)
     #   Returns true if the given pos/span would intersect with this item.
     #   @param pos [Wx::GBPosition] 
     #   @param span [Wx::GBSpan] 
-    #   @return [true,false]
+    #   @return [Boolean]
     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 [true,false]
+    # @return [Boolean]
     def set_pos(pos) end
     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 [true,false]
+    # @return [Boolean]
     def set_span(span) end
     alias_method :span=, :set_span
     

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

@@ -301,7 +301,7 @@ module Wx
   
   # Returns true if the display is colour, false otherwise.
   # Use of this function is not recommended in the new code as it only works for the primary display. Use Wx::Display#get_depth to retrieve the depth of the appropriate display and compare it with 1 instead.
-  # @return [true,false]
+  # @return [Boolean]
   def self.colour_display; end
   
   # Returns the depth of the display (a value of 1 denotes a monochrome display).
@@ -358,7 +358,7 @@ module Wx
   
     # Returns true if neither of the point components is equal to {Wx::DEFAULT_COORD}.
     # This method is typically used before calling {Wx::Point#set_defaults}.
-    # @return [true,false]
+    # @return [Boolean]
     def is_fully_specified; end
     alias_method :fully_specified?, :is_fully_specified
     
@@ -534,7 +534,7 @@ module Wx
     
     # Returns true if neither of the size object components is equal to -1, which is used as default for the size values in wxWidgets (hence the predefined {Wx::DEFAULT_SIZE} has both of its components equal to -1).
     # This method is typically used before calling {Wx::Size#set_defaults}.
-    # @return [true,false]
+    # @return [Boolean]
     def is_fully_specified; end
     alias_method :fully_specified?, :is_fully_specified
     
@@ -702,15 +702,15 @@ module Wx
     #   Returns true if the given point is inside the rectangle (or on its boundary) and false otherwise.
     #   @param x [Integer] 
     #   @param y [Integer] 
-    #   @return [true,false]
+    #   @return [Boolean]
     # @overload contains(pt)
     #   Returns true if the given point is inside the rectangle (or on its boundary) and false otherwise.
     #   @param pt [Array(Integer, Integer), Wx::Point] 
-    #   @return [true,false]
+    #   @return [Boolean]
     # @overload contains(rect)
     #   Returns true if the given rectangle is completely inside this rectangle (or touches its boundary) and false otherwise.
     #   @param rect [Wx::Rect] 
-    #   @return [true,false]
+    #   @return [Boolean]
     def contains(*args) end
     
     # Gets the bottom point of the rectangle.
@@ -792,11 +792,11 @@ module Wx
     
     # Returns true if this rectangle has a non-empty intersection with the rectangle rect and false otherwise.
     # @param rect [Wx::Rect] 
-    # @return [true,false]
+    # @return [Boolean]
     def intersects(rect) end
     
     # Returns true if this rectangle has a width or height less than or equal to 0 and false otherwise.
-    # @return [true,false]
+    # @return [Boolean]
     def is_empty; end
     alias_method :empty?, :is_empty
     

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

@@ -59,7 +59,7 @@ module Wx
     
     # Collapse the given path.
     # @param path [String] 
-    # @return [true,false]
+    # @return [Boolean]
     def collapse_path(path) end
     
     # Collapses the entire tree.
@@ -67,7 +67,7 @@ module Wx
     def collapse_tree; end
     
     # Create function for two-step construction.
-    # See {Wx::GenericDirCtrl#generic_dir_ctrl} for details.
+    # See {Wx::GenericDirCtrl#initialize} for details.
     # @param parent [Wx::Window] 
     # @param id [Integer] 
     # @param dir [String] 
@@ -77,12 +77,12 @@ module Wx
     # @param filter [String] 
     # @param defaultFilter [Integer] 
     # @param name [String] 
-    # @return [true,false]
+    # @return [Boolean]
     def create(parent, id=Wx::StandardID::ID_ANY, dir=Wx::DIR_DIALOG_DEFAULT_FOLDER_STR, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::DIRCTRL_DEFAULT_STYLE, filter=(''), defaultFilter=0, name=Wx::TreeCtrlNameStr) end
     
     # Tries to expand as much of the given path as possible, so that the filename or directory is visible in the tree control.
     # @param path [String] 
-    # @return [true,false]
+    # @return [Boolean]
     def expand_path(path) end
     
     # Gets the default path.
@@ -177,14 +177,14 @@ module Wx
     def set_path(path) end
     alias_method :path=, :set_path
     
-    # @param show [true,false]  If true, hidden folders and files will be displayed by the control. If false, they will not be displayed.
+    # @param show [Boolean]  If true, hidden folders and files will be displayed by the control. If false, they will not be displayed.
     # @return [void]
     def show_hidden(show) end
     
     # Selects the given item.
     # In multiple selection controls, can be also used to deselect a currently selected item if the value of select is false. Existing selections are not changed. Only visible items can be (de)selected, otherwise use {Wx::GenericDirCtrl#expand_path}.
     # @param path [String] 
-    # @param select [true,false] 
+    # @param select [Boolean] 
     # @return [void]
     def select_path(path, select=true) end