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

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

@@ -120,7 +120,7 @@ module Wx
   
   # Standard cursors.
   # 
-  # Notice that under {Wx::MSW} some of these cursors are defined in wx.rc file and not by the system itself so you should include this file from your own resource file (possibly creating a trivial resource file just containing a single include line if you don't need it otherwise) to be able to use them.
+  # Notice that under wxMSW some of these cursors are defined in wx.rc file and not by the system itself so you should include this file from your own resource file (possibly creating a trivial resource file just containing a single include line if you don't need it otherwise) to be able to use them.
   # See {Wx::Cursor}.
   # 
   class StockCursor < Wx::Enum
@@ -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,18 +358,17 @@ 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
     
     # Combine this object with another one replacing the uninitialized values.
     # It is typically used like this:
     # 
-    # ```
-    #   if ( !pos.IsFullySpecified() )
-    #   {
-    #       pos.SetDefaults(GetDefaultPosition());
-    #   }
+    # ```ruby
+    #   if !pos.is_fully_specified
+    #     pos.set_defaults(get_default_position)
+    #   end
     # ```
     # @see Wx::Point#is_fully_specified
     # @param pt [Array(Integer, Integer), Wx::Point] 
@@ -404,23 +403,21 @@ module Wx
     # @overload initialize()
     #   Constructs a point.
     #   Initializes the internal x and y coordinates to zero.
-    #   @return [Point]
+    #   @return [Wx::Point]
     # @overload initialize(x, y)
     #   Initializes the point object with the given x and y coordinates.
     #   @param x [Integer] 
     #   @param y [Integer] 
-    #   @return [Point]
+    #   @return [Wx::Point]
     # @overload initialize(pt)
     #   Converts the given {Wx::RealPoint} (with floating point coordinates) to a {Wx::Point} instance.
     #   Notice that this truncates the floating point values of pt components, if you want to round them instead you need to do it manually, e.g. 
-    #   ```
-    #     #include <wx/math.h>    // for wxRound()
-    #     
-    #     wxRealPoint rp = ...;
-    #     wxPoint p(wxRound(rp.x), wxRound(rp.y));
+    #   ```ruby
+    #     real_point = ...
+    #     p = Wx::Point.new(real_point.x.round, real_point.y.round)
     #   ```
     #   @param pt [Wx::RealPoint] 
-    #   @return [Point]
+    #   @return [Wx::Point]
     def initialize(*args) end
     
   end # Point
@@ -497,12 +494,12 @@ module Wx
     
     # @overload initialize()
     #   Initializes this size object with zero width and height.
-    #   @return [Size]
+    #   @return [Wx::Size]
     # @overload initialize(width, height)
     #   Initializes this size object with the given width and height.
     #   @param width [Integer] 
     #   @param height [Integer] 
-    #   @return [Size]
+    #   @return [Wx::Size]
     def initialize(*args) end
     
     # Decrements this object so that both of its dimensions are not greater than the corresponding dimensions of the size.
@@ -537,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
     
@@ -558,11 +555,10 @@ module Wx
     # Combine this size object with another one replacing the default (i.e. equal to -1) components of this object with those of the other.
     # It is typically used like this:
     # 
-    # ```
-    #   if ( !size.IsFullySpecified() )
-    #   {
-    #       size.SetDefaults(GetDefaultSize());
-    #   }
+    # ```ruby
+    #   if !size.is_fully_specified
+    #     size.set_defaults(get_default_size)
+    #   end
     # ```
     # @see Wx::Size#is_fully_specified 
     # @param sizeDefault [Array(Integer, Integer), Wx::Size] 
@@ -640,7 +636,9 @@ module Wx
     #   Increases the size of the rectangle.
     #   The left border is moved farther left and the right border is moved farther right by dx. The upper border is moved farther up and the bottom border is moved farther down by dy. (Note that the width and height of the rectangle thus change by 2*dx and 2*dy, respectively.) If one or both of dx and dy are negative, the opposite happens: the rectangle size decreases in the respective direction.
     #   Inflating and deflating behaves "naturally". Defined more precisely, that means:
-    #   - "Real" inflates (that is, dx and/or dy = 0) are not constrained. Thus inflating a rectangle can cause its upper left corner to move into the negative numbers. (2.5.4 and older forced the top left coordinate to not fall below (0, 0), which implied a forced move of the rectangle.)- Deflates are clamped to not reduce the width or height of the rectangle below zero. In such cases, the top-left corner is nonetheless handled properly. For example, a rectangle at (10, 10) with size (20, 40) that is inflated by (-15, -15) will become located at (20, 25) at size (0, 10). Finally, observe that the width and height are treated independently. In the above example, the width is reduced by 20, whereas the height is reduced by the full 30 (rather than also stopping at 20, when the width reached zero).
+    #   
+    #   - "Real" inflates (that is, dx and/or dy = 0) are not constrained. Thus inflating a rectangle can cause its upper left corner to move into the negative numbers. (2.5.4 and older forced the top left coordinate to not fall below (0, 0), which implied a forced move of the rectangle.)
+    #   - Deflates are clamped to not reduce the width or height of the rectangle below zero. In such cases, the top-left corner is nonetheless handled properly. For example, a rectangle at (10, 10) with size (20, 40) that is inflated by (-15, -15) will become located at (20, 25) at size (0, 10). Finally, observe that the width and height are treated independently. In the above example, the width is reduced by 20, whereas the height is reduced by the full 30 (rather than also stopping at 20, when the width reached zero).
     #   @see Wx::Rect#deflate 
     #   @param dx [Integer] 
     #   @param dy [Integer] 
@@ -649,7 +647,9 @@ module Wx
     #   Increases the size of the rectangle.
     #   The left border is moved farther left and the right border is moved farther right by dx. The upper border is moved farther up and the bottom border is moved farther down by dy. (Note that the width and height of the rectangle thus change by 2*dx and 2*dy, respectively.) If one or both of dx and dy are negative, the opposite happens: the rectangle size decreases in the respective direction.
     #   Inflating and deflating behaves "naturally". Defined more precisely, that means:
-    #   - "Real" inflates (that is, dx and/or dy = 0) are not constrained. Thus inflating a rectangle can cause its upper left corner to move into the negative numbers. (2.5.4 and older forced the top left coordinate to not fall below (0, 0), which implied a forced move of the rectangle.)- Deflates are clamped to not reduce the width or height of the rectangle below zero. In such cases, the top-left corner is nonetheless handled properly. For example, a rectangle at (10, 10) with size (20, 40) that is inflated by (-15, -15) will become located at (20, 25) at size (0, 10). Finally, observe that the width and height are treated independently. In the above example, the width is reduced by 20, whereas the height is reduced by the full 30 (rather than also stopping at 20, when the width reached zero).
+    #   
+    #   - "Real" inflates (that is, dx and/or dy = 0) are not constrained. Thus inflating a rectangle can cause its upper left corner to move into the negative numbers. (2.5.4 and older forced the top left coordinate to not fall below (0, 0), which implied a forced move of the rectangle.)
+    #   - Deflates are clamped to not reduce the width or height of the rectangle below zero. In such cases, the top-left corner is nonetheless handled properly. For example, a rectangle at (10, 10) with size (20, 40) that is inflated by (-15, -15) will become located at (20, 25) at size (0, 10). Finally, observe that the width and height are treated independently. In the above example, the width is reduced by 20, whereas the height is reduced by the full 30 (rather than also stopping at 20, when the width reached zero).
     #   @see Wx::Rect#deflate 
     #   @param diff [Array(Integer, Integer), Wx::Size] 
     #   @return [Wx::Rect]
@@ -657,7 +657,9 @@ module Wx
     #   Increases the size of the rectangle.
     #   The left border is moved farther left and the right border is moved farther right by dx. The upper border is moved farther up and the bottom border is moved farther down by dy. (Note that the width and height of the rectangle thus change by 2*dx and 2*dy, respectively.) If one or both of dx and dy are negative, the opposite happens: the rectangle size decreases in the respective direction.
     #   Inflating and deflating behaves "naturally". Defined more precisely, that means:
-    #   - "Real" inflates (that is, dx and/or dy = 0) are not constrained. Thus inflating a rectangle can cause its upper left corner to move into the negative numbers. (2.5.4 and older forced the top left coordinate to not fall below (0, 0), which implied a forced move of the rectangle.)- Deflates are clamped to not reduce the width or height of the rectangle below zero. In such cases, the top-left corner is nonetheless handled properly. For example, a rectangle at (10, 10) with size (20, 40) that is inflated by (-15, -15) will become located at (20, 25) at size (0, 10). Finally, observe that the width and height are treated independently. In the above example, the width is reduced by 20, whereas the height is reduced by the full 30 (rather than also stopping at 20, when the width reached zero).
+    #   
+    #   - "Real" inflates (that is, dx and/or dy = 0) are not constrained. Thus inflating a rectangle can cause its upper left corner to move into the negative numbers. (2.5.4 and older forced the top left coordinate to not fall below (0, 0), which implied a forced move of the rectangle.)
+    #   - Deflates are clamped to not reduce the width or height of the rectangle below zero. In such cases, the top-left corner is nonetheless handled properly. For example, a rectangle at (10, 10) with size (20, 40) that is inflated by (-15, -15) will become located at (20, 25) at size (0, 10). Finally, observe that the width and height are treated independently. In the above example, the width is reduced by 20, whereas the height is reduced by the full 30 (rather than also stopping at 20, when the width reached zero).
     #   @see Wx::Rect#deflate 
     #   @param diff [Integer] 
     #   @return [Wx::Rect]
@@ -671,44 +673,44 @@ module Wx
     # @overload initialize()
     #   Default constructor.
     #   Initializes to zero the internal x, y, width and height members.
-    #   @return [Rect]
+    #   @return [Wx::Rect]
     # @overload initialize(x, y, width, height)
     #   Creates a {Wx::Rect} object from x, y, width and height values.
     #   @param x [Integer] 
     #   @param y [Integer] 
     #   @param width [Integer] 
     #   @param height [Integer] 
-    #   @return [Rect]
+    #   @return [Wx::Rect]
     # @overload initialize(topLeft, bottomRight)
     #   Creates a {Wx::Rect} object from top-left and bottom-right points.
     #   The width of the rectangle will be <code>bottomRight.x-topLeft.x+1</code> and the height will be <code>bottomRight.y-topLeft.y+1</code>.
     #   @param topLeft [Wx::Point] 
     #   @param bottomRight [Wx::Point] 
-    #   @return [Rect]
+    #   @return [Wx::Rect]
     # @overload initialize(pos, size)
     #   Creates a {Wx::Rect} object from position pos and size values.
     #   @param pos [Array(Integer, Integer), Wx::Point] 
     #   @param size [Array(Integer, Integer), Wx::Size] 
-    #   @return [Rect]
+    #   @return [Wx::Rect]
     # @overload initialize(size)
     #   Creates a {Wx::Rect} object from size values at the origin.
     #   @param size [Array(Integer, Integer), Wx::Size] 
-    #   @return [Rect]
+    #   @return [Wx::Rect]
     def initialize(*args) end
     
     # @overload contains(x, y)
     #   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.
@@ -790,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
     
@@ -929,16 +931,16 @@ module Wx
     
     # @overload initialize()
     #   Initializes to zero the x and y members.
-    #   @return [RealPoint]
+    #   @return [Wx::RealPoint]
     # @overload initialize(x, y)
     #   Initializes the point with the given coordinates.
     #   @param x [Float] 
     #   @param y [Float] 
-    #   @return [RealPoint]
+    #   @return [Wx::RealPoint]
     # @overload initialize(pt)
     #   Converts the given {Wx::Point} (with integer coordinates) to a {Wx::RealPoint}.
     #   @param pt [Array(Integer, Integer), Wx::Point] 
-    #   @return [RealPoint]
+    #   @return [Wx::RealPoint]
     def initialize(*args) end
     
   end # RealPoint
@@ -1093,7 +1095,7 @@ module Wx
   
     # Constructs the colour database.
     # It will be initialized at the first use.
-    # @return [ColourDatabase]
+    # @return [Wx::ColourDatabase]
     def initialize; end
     
     # Adds a colour to the database.

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

@@ -22,7 +22,7 @@ module Wx
   class GDIObject < Object
   
     # Default constructor.
-    # @return [GDIObject]
+    # @return [Wx::GDIObject]
     def initialize; end
     
   end # GDIObject

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

@@ -11,32 +11,38 @@ module Wx
   # === Styles
   # 
   # This class supports the following styles:
-  #  
+  # 
   # - {Wx::DIRCTRL_DIR_ONLY}: Only show directories, and not files. 
+  # 
   # - {Wx::DIRCTRL_3D_INTERNAL}: Use 3D borders for internal controls. This is the default. 
+  # 
   # - {Wx::DIRCTRL_SELECT_FIRST}: When setting the default path, select the first file in the directory. 
+  # 
   # - {Wx::DIRCTRL_SHOW_FILTERS}: Show the drop-down filter list. 
+  # 
   # - {Wx::DIRCTRL_EDIT_LABELS}: Allow the folder and file labels to be editable. 
+  # 
   # - {Wx::DIRCTRL_MULTIPLE}: Allows multiple files and folders to be selected. 
   # 
   # === 
   # 
-  # Category:  {Wx::Controls}  <div class='appearance'><span class='appearance'>Appearance:</span><table><tr><td> {Wx::MSW} Appearance
-  #   </td><td> {Wx::GTK} Appearance
-  #   </td><td> {Wx::OSX} 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>
   # === Events emitted by this class
   # 
   # Event handler methods for events emitted by this class:
-  #  
+  # 
   # - {Wx::EvtHandler#evt_dirctrl_selectionchanged}(id, meth = nil, &block): Selected directory has changed. Processes a {Wx::EVT_DIRCTRL_SELECTIONCHANGED} event type. Notice that this event is generated even for the changes done by the program itself and not only those done by the user. Available since wxWidgets 2.9.5. 
+  # 
   # - {Wx::EvtHandler#evt_dirctrl_fileactivated}(id, meth = nil, &block): The user activated a file by double-clicking or pressing Enter. Available since wxWidgets 2.9.5.
   # 
   class GenericDirCtrl < Control
   
     # @overload initialize()
     #   Default constructor.
-    #   @return [GenericDirCtrl]
+    #   @return [Wx::GenericDirCtrl]
     # @overload initialize(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)
     #   Main constructor.
     #   @param parent [Wx::Window]  Parent window.
@@ -48,12 +54,12 @@ module Wx
     #   @param filter [String]  A filter string, using the same syntax as that for {Wx::FileDialog}. This may be empty if filters are not being used. Example: <code>"All files (*.*)|*.*|JPEG files (*.jpg)|*.jpg"</code>
     #   @param defaultFilter [Integer]  The zero-indexed default filter setting.
     #   @param name [String]  The window name.
-    #   @return [GenericDirCtrl]
+    #   @return [Wx::GenericDirCtrl]
     def initialize(*args) end
     
     # Collapse the given path.
     # @param path [String] 
-    # @return [true,false]
+    # @return [Boolean]
     def collapse_path(path) end
     
     # Collapses the entire tree.
@@ -61,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] 
@@ -71,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.
@@ -171,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