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

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

@@ -120,7 +120,7 @@ module Wx
   
   # Standard cursors.
   # 
-  # 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.
+  # 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
@@ -300,16 +300,31 @@ module Wx
   DEFAULT_SIZE = nil
   
   # 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.
+  # 
+  # <div class="wxrb-note">
+  # <b>Note:</b>
+  # <p>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.
+  # </p>
+  # </div>
+  # 
+  # Include file: \#include <wx/gdicmn.h>
   # @return [Boolean]
   def self.colour_display; end
   
   # Returns the depth of the display (a value of 1 denotes a monochrome display).
-  # 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 instead.
+  # 
+  # <div class="wxrb-note">
+  # <b>Note:</b>
+  # <p>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 instead.
+  # </p>
+  # </div>
+  # 
+  # Include file: \#include <wx/gdicmn.h>
   # @return [Integer]
   def self.display_depth; end
   
   # Globally sets the cursor; only has an effect on Windows, Mac and GTK+.
+  # 
   # You should call this function with {Wx::NULL_CURSOR} to restore the system cursor.
   # @see Wx::Cursor
   # @see  Wx::Window#set_cursor
@@ -318,34 +333,51 @@ module Wx
   def self.set_cursor(cursor) end
   
   # Returns the dimensions of the work area on the display.
+  # 
   # On Windows this means the area not covered by the taskbar, etc. Other platforms are currently defaulting to the whole display until a way is found to provide this info for all window managers, etc.
   # @see Wx::Display
   # @return [Wx::Rect]
   def self.get_client_display_rect; end
   
   # Returns the display resolution in pixels per inch.
+  # 
   # The x component of the returned {Wx::Size} object contains the horizontal resolution and the y one  the vertical resolution.
-  # Use of this function is not recommended in the new code as it only works for the primary display. Use Wx::Display#get_ppi to retrieve the resolution of the appropriate display instead.
+  # 
+  # <div class="wxrb-note">
+  # <b>Note:</b>
+  # <p>Use of this function is not recommended in the new code as it only works for the primary display. Use Wx::Display#get_ppi to retrieve the resolution of the appropriate display instead.
+  # </p>
+  # </div>
+  # 
+  # Include file: \#include <wx/gdicmn.h>
   # @see Wx::Display
   # @return [Wx::Size]
   def self.get_display_ppi; end
   
   # Returns the display size in pixels.
-  # Use of this function is not recommended in the new code as it only works for the primary display. Use Wx::Display#get_geometry to retrieve the size of the appropriate display instead.
+  # 
+  # <div class="wxrb-note">
+  # <b>Note:</b>
+  # <p>Use of this function is not recommended in the new code as it only works for the primary display. Use Wx::Display#get_geometry to retrieve the size of the appropriate display instead.
+  # </p>
+  # </div>
+  # 
+  # Include file: \#include <wx/gdicmn.h>
   # @see Wx::Display
   # @return [Wx::Size]
   def self.get_display_size; end
   
   # Returns the display size in millimeters.
   # 
+  # 
   # @see Wx::Display
   # @return [Wx::Size]
   def self.get_display_size_mm; end
   
   # A {Wx::Point} is a useful data structure for graphics operations.
+  # 
   # It contains integer x and y members. See {Wx::RealPoint} for a floating point version.
   # Note that the width and height stored inside a {Wx::Point} object may be negative and that {Wx::Point} functions do not perform any check against negative values (this is used to e.g. store the special -1 value in {Wx::DEFAULT_POSITION} instance).
-  # === 
   # 
   # Category:  Data Structures
   # Predefined objects/pointers: {Wx::DEFAULT_POSITION}
@@ -357,12 +389,14 @@ module Wx
   class Point < ::Object
   
     # 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 [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:
     # 
     # ```ruby
@@ -402,6 +436,7 @@ module Wx
     
     # @overload initialize()
     #   Constructs a point.
+    #   
     #   Initializes the internal x and y coordinates to zero.
     #   @return [Wx::Point]
     # @overload initialize(x, y)
@@ -411,6 +446,7 @@ module Wx
     #   @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. 
     #   ```ruby
     #     real_point = ...
@@ -423,10 +459,10 @@ module Wx
   end # Point
   
   # A {Wx::Size} is a useful data structure for graphics operations.
+  # 
   # It simply contains integer x and y members.
   # Note that the width and height stored inside a {Wx::Size} object may be negative and that {Wx::Size} functions do not perform any check against negative values (this is used to e.g. store the special -1 value in {Wx::DEFAULT_SIZE} instance). See also {Wx::Size#is_fully_specified} and {Wx::Size#set_defaults} for utility functions regarding the special -1 value.
   # {Wx::Size} is used throughout wxWidgets as well as {Wx::Point} which, although almost equivalent to {Wx::Size}, has a different meaning: {Wx::Point} represents a position while {Wx::Size} represents the size.
-  # === 
   # 
   # Category:  Data Structures
   # Predefined objects/pointers: {Wx::DEFAULT_SIZE}
@@ -441,18 +477,21 @@ module Wx
     # @overload dec_by(pt)
     #   Decreases the size in both x and y directions.
     #   
+    #   
     #   @see Wx::Size#inc_by 
     #   @param pt [Array(Integer, Integer), Wx::Point] 
     #   @return [void]
     # @overload dec_by(size)
     #   Decreases the size in both x and y directions.
     #   
+    #   
     #   @see Wx::Size#inc_by 
     #   @param size [Array(Integer, Integer), Wx::Size] 
     #   @return [void]
     # @overload dec_by(dx, dy)
     #   Decreases the size in both x and y directions.
     #   
+    #   
     #   @see Wx::Size#inc_by 
     #   @param dx [Integer] 
     #   @param dy [Integer] 
@@ -460,6 +499,7 @@ module Wx
     # @overload dec_by(d)
     #   Decreases the size in both x and y directions.
     #   
+    #   
     #   @see Wx::Size#inc_by 
     #   @param d [Integer] 
     #   @return [void]
@@ -468,18 +508,21 @@ module Wx
     # @overload inc_by(pt)
     #   Increases the size in both x and y directions.
     #   
+    #   
     #   @see Wx::Size#dec_by 
     #   @param pt [Array(Integer, Integer), Wx::Point] 
     #   @return [void]
     # @overload inc_by(size)
     #   Increases the size in both x and y directions.
     #   
+    #   
     #   @see Wx::Size#dec_by 
     #   @param size [Array(Integer, Integer), Wx::Size] 
     #   @return [void]
     # @overload inc_by(dx, dy)
     #   Increases the size in both x and y directions.
     #   
+    #   
     #   @see Wx::Size#dec_by 
     #   @param dx [Integer] 
     #   @param dy [Integer] 
@@ -487,6 +530,7 @@ module Wx
     # @overload inc_by(d)
     #   Increases the size in both x and y directions.
     #   
+    #   
     #   @see Wx::Size#dec_by 
     #   @param d [Integer] 
     #   @return [void]
@@ -504,12 +548,14 @@ module Wx
     
     # Decrements this object so that both of its dimensions are not greater than the corresponding dimensions of the size.
     # 
+    # 
     # @see Wx::Size#inc_to 
     # @param size [Array(Integer, Integer), Wx::Size] 
     # @return [void]
     def dec_to(size) end
     
     # Decrements this object to be not bigger than the given size ignoring non-specified components.
+    # 
     # This is similar to {Wx::Size#dec_to} but doesn't do anything for x or y component if the same component of size is not specified, i.e. set to {Wx::DEFAULT_COORD}.
     # @param size [Array(Integer, Integer), Wx::Size] 
     # @return [void]
@@ -527,18 +573,21 @@ module Wx
     
     # Increments this object so that both of its dimensions are not less than the corresponding dimensions of the size.
     # 
+    # 
     # @see Wx::Size#dec_to 
     # @param size [Array(Integer, Integer), Wx::Size] 
     # @return [void]
     def inc_to(size) end
     
     # 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 [Boolean]
     def is_fully_specified; end
     alias_method :fully_specified?, :is_fully_specified
     
     # Scales the dimensions of this object by the given factors.
+    # 
     # If you want to scale both dimensions by the same factor you can also use {Wx::operator*=()}.
     # A reference to this object (so that you can concatenate other operations in the same line).
     # @param xscale [Float] 
@@ -553,6 +602,7 @@ module Wx
     def set(width, height) end
     
     # 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:
     # 
     # ```ruby
@@ -581,6 +631,7 @@ module Wx
   end # Size
   
   # Represents a rectangle with integer coordinates.
+  # 
   # x and y members specify the coordinates of the rectangle top-left corner and width and height specify its width and height respectively. The usual C++ semi-open interval convention is used: point p lies inside the rectangle if and only if both conditions below are satisfied: 
   # ```
   #   x <= p.x < x + width
@@ -589,7 +640,6 @@ module Wx
   # 
   # In other words, the rectangle left and right boundaries are at x and <code>x+width-1</code> and its top and bottom boundaries are at y and <code>y+height-1</code> respectively.
   # Note that the x and y coordinates may be negative, but width and height are always strictly positive for non-empty rectangles.
-  # === 
   # 
   # Category:  Data Structures
   # @see Wx::Point
@@ -601,6 +651,7 @@ module Wx
   class Rect < ::Object
   
     # Returns the rectangle having the same size as this one but centered relatively to the given rectangle r.
+    # 
     # By default, rectangle is centred in both directions but if dir includes only {Wx::Orientation::VERTICAL} or only {Wx::Orientation::HORIZONTAL}, then it is only centered in this direction while the other component of its position remains unchanged.
     # @param r [Wx::Rect] 
     # @param dir [Integer] 
@@ -608,6 +659,7 @@ module Wx
     def centre_in(r, dir=Wx::Orientation::BOTH) end
     
     # Returns the rectangle having the same size as this one but centered relatively to the given rectangle r.
+    # 
     # By default, rectangle is centred in both directions but if dir includes only {Wx::Orientation::VERTICAL} or only {Wx::Orientation::HORIZONTAL}, then it is only centered in this direction while the other component of its position remains unchanged.
     # @param r [Wx::Rect] 
     # @param dir [Integer] 
@@ -616,17 +668,20 @@ module Wx
     
     # @overload deflate(dx, dy)
     #   Decrease the rectangle size.
+    #   
     #   This method is the opposite from {Wx::Rect#inflate}: Deflate(a, b) is equivalent to Inflate(-a, -b). Please refer to {Wx::Rect#inflate} for full description.
     #   @param dx [Integer] 
     #   @param dy [Integer] 
     #   @return [Wx::Rect]
     # @overload deflate(diff)
     #   Decrease the rectangle size.
+    #   
     #   This method is the opposite from {Wx::Rect#inflate}: Deflate(a, b) is equivalent to Inflate(-a, -b). Please refer to {Wx::Rect#inflate} for full description.
     #   @param diff [Array(Integer, Integer), Wx::Size] 
     #   @return [Wx::Rect]
     # @overload deflate(diff)
     #   Decrease the rectangle size.
+    #   
     #   This method is the opposite from {Wx::Rect#inflate}: Deflate(a, b) is equivalent to Inflate(-a, -b). Please refer to {Wx::Rect#inflate} for full description.
     #   @param diff [Integer] 
     #   @return [Wx::Rect]
@@ -634,6 +689,7 @@ module Wx
     
     # @overload inflate(dx, dy)
     #   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:
     #   
@@ -645,6 +701,7 @@ module Wx
     #   @return [Wx::Rect]
     # @overload inflate(diff)
     #   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:
     #   
@@ -655,6 +712,7 @@ module Wx
     #   @return [Wx::Rect]
     # @overload inflate(diff)
     #   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:
     #   
@@ -672,6 +730,7 @@ module Wx
     
     # @overload initialize()
     #   Default constructor.
+    #   
     #   Initializes to zero the internal x, y, width and height members.
     #   @return [Wx::Rect]
     # @overload initialize(x, y, width, height)
@@ -683,6 +742,7 @@ module Wx
     #   @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] 
@@ -750,6 +810,7 @@ module Wx
     
     # Gets the size.
     # 
+    # 
     # @see Wx::Rect#set_size 
     # @return [Wx::Size]
     def get_size; end
@@ -814,6 +875,7 @@ module Wx
     
     # Sets the size.
     # 
+    # 
     # @see Wx::Rect#get_size 
     # @param s [Array(Integer, Integer), Wx::Size] 
     # @return [void]
@@ -839,6 +901,7 @@ module Wx
     alias_method :y=, :set_y
     
     # Set the left side of the rectangle.
+    # 
     # Notice that because the rectangle stores its left side and width, calling {Wx::Rect#set_left} changes the right side position too  but does preserve the width.
     # @param left [Integer] 
     # @return [void]
@@ -846,6 +909,7 @@ module Wx
     alias_method :left=, :set_left
     
     # Set the right side of the rectangle.
+    # 
     # Notice that this doesn't affect {Wx::Rect#get_left} return value but changes the rectangle width to set its right side to the given position.
     # @param right [Integer] 
     # @return [void]
@@ -853,6 +917,7 @@ module Wx
     alias_method :right=, :set_right
     
     # Set the top edge of the rectangle.
+    # 
     # Notice that because the rectangle stores its top side and height, calling {Wx::Rect#set_top} changes the bottom side position too  but does preserve the height.
     # @param top [Integer] 
     # @return [void]
@@ -860,6 +925,7 @@ module Wx
     alias_method :top=, :set_top
     
     # Set the bottom edge of the rectangle.
+    # 
     # Notice that this doesn't affect {Wx::Rect#get_top} return value but changes the rectangle height to set its bottom side to the given position.
     # @param bottom [Integer] 
     # @return [void]
@@ -893,9 +959,9 @@ module Wx
   end # Rect
   
   # A {Wx::RealPoint} is a useful data structure for graphics operations.
+  # 
   # It contains floating point x and y members. See {Wx::Point} for an integer version.
   # Note that the coordinates stored inside a {Wx::RealPoint} object may be negative and that {Wx::RealPoint} functions do not perform any check against negative values.
-  # === 
   # 
   # Category:  Data Structures
   # @see Wx::Point 
@@ -946,6 +1012,7 @@ module Wx
   end # RealPoint
   
   # wxWidgets maintains a database of standard RGB colours for a predefined set of named colours.
+  # 
   # The application may add to this set if desired by using {Wx::ColourDatabase#add_colour} and may use it to look up colours by names using {Wx::ColourDatabase#find} or find the names for the standard colour using {Wx::ColourDatabase#find_name}.
   # There is one predefined, global instance of this class called {Wx::TheColourDatabase}.
   # The standard database contains at least the following colours:
@@ -1083,8 +1150,6 @@ module Wx
   # 
   #  YELLOW GREEN  
   # 
-  # === 
-  # 
   # Category:  Graphics Device Interface (GDI)
   # @see Wx::Colour 
   # 
@@ -1094,11 +1159,13 @@ module Wx
   class ColourDatabase < ::Object
   
     # Constructs the colour database.
+    # 
     # It will be initialized at the first use.
     # @return [Wx::ColourDatabase]
     def initialize; end
     
     # Adds a colour to the database.
+    # 
     # If a colour with the same name already exists, it is replaced.
     # @param colourName [String] 
     # @param colour [Wx::Colour,String,Symbol] 
@@ -1106,12 +1173,14 @@ module Wx
     def add_colour(colourName, colour) end
     
     # Finds a colour given the name.
+    # 
     # Returns an invalid colour object (that is, {Wx::Colour#is_ok} will return false) if the colour wasn't found in the database.
     # @param colourName [String] 
     # @return [Wx::Colour]
     def find(colourName) end
     
     # Finds a colour name given the colour.
+    # 
     # Returns an empty string if the colour is not found in the database.
     # @param colour [Wx::Colour,String,Symbol] 
     # @return [String]

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

@@ -7,9 +7,9 @@
 module Wx
 
   # This class allows platforms to implement functionality to optimise GDI objects, such as {Wx::Pen}, {Wx::Brush} and {Wx::Font}.
+  # 
   # On Windows, the underling GDI objects are a scarce resource and are cleaned up when a usage count goes to zero. On some platforms this class may not have any special functionality.
   # Since the functionality of this class is platform-specific, it is not documented here in detail.
-  # === 
   # 
   # Category:  Graphics Device Interface (GDI)
   # @see Wx::Pen

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

@@ -7,8 +7,9 @@
 module Wx
 
   # This control can be used to place a directory listing (with optional files) on an arbitrary window.
+  # 
   # The control contains a {Wx::TreeCtrl} window representing the directory hierarchy, and optionally, a {Wx::Choice} window containing a list of filters.
-  # === Styles
+  # ### Styles
   # 
   # This class supports the following styles:
   # 
@@ -24,13 +25,11 @@ module Wx
   # 
   # - {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> 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>
-  # === Events emitted by this class
+  # ### Events emitted by this class
   # 
   # Event handler methods for events emitted by this class:
   # 
@@ -38,6 +37,7 @@ module Wx
   # 
   # - {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.
   # 
+  # @wxrb_require USE_DIRDLG|USE_FILEDLG
   class GenericDirCtrl < Control
   
     # @overload initialize()
@@ -67,6 +67,7 @@ module Wx
     def collapse_tree; end
     
     # Create function for two-step construction.
+    # 
     # See {Wx::GenericDirCtrl#initialize} for details.
     # @param parent [Wx::Window] 
     # @param id [Integer] 
@@ -91,12 +92,14 @@ module Wx
     alias_method :default_path, :get_default_path
     
     # Gets selected filename path only (else empty string).
+    # 
     # This function doesn't count a directory as a selection.
     # @return [String]
     def get_file_path; end
     alias_method :file_path, :get_file_path
     
     # Fills the array paths with the currently selected filepaths.
+    # 
     # This function doesn't count a directory as a selection.
     # @param paths [Array<String>] 
     # @return [void]
@@ -149,6 +152,7 @@ module Wx
     def init; end
     
     # Collapse and expand the tree, thus re-creating it from scratch.
+    # 
     # May be used to update the displayed directory content.
     # @return [void]
     def re_create_tree; end
@@ -182,6 +186,7 @@ module Wx
     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 [Boolean] 
@@ -189,6 +194,7 @@ module Wx
     def select_path(path, select=true) end
     
     # Selects only the specified paths, clearing any previous selection.
+    # 
     # Only supported when {Wx::DIRCTRL_MULTIPLE} is set.
     # @param paths [Array<String>] 
     # @return [void]