wxruby3 0.9.0-x64-mingw-ucrt → 0.9.2-x64-mingw-ucrt

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

@@ -10,6 +10,7 @@ module Wx
   # 
   # 
   # 
+  # @wxrb_require USE_GRAPHICS_CONTEXT
   class AntialiasMode < Wx::Enum
   
     # No anti-aliasing.
@@ -26,6 +27,7 @@ module Wx
   # 
   # 
   # 
+  # @wxrb_require USE_GRAPHICS_CONTEXT
   class InterpolationQuality < Wx::Enum
   
     # default interpolation, based on type of context, in general medium quality
@@ -54,6 +56,7 @@ module Wx
   # 
   # The description give a short equation on how the values of a resulting pixel are calculated. R = Result, S = Source, D = Destination, colors premultiplied with alpha Ra, Sa, Da their alpha components
   # 
+  # @wxrb_require USE_GRAPHICS_CONTEXT
   class CompositionMode < Wx::Enum
   
     # Indicates invalid or unsupported composition mode.
@@ -122,6 +125,7 @@ module Wx
   # 
   # 
   # 
+  # @wxrb_require USE_GRAPHICS_CONTEXT
   class GradientType < Wx::Enum
   
     # 
@@ -192,9 +196,11 @@ module Wx
   #   end
   # ```
   # 
-  # For some renderers (like Direct2D or Cairo) processing of drawing operations may be deferred (Direct2D render target normally builds up a batch of rendering commands but defers processing of these commands, Cairo operates on a separate surface) so to make drawing results visible you need to update the content of the context by calling {Wx::GraphicsContext#flush} or by destroying the context.
-  # 
-  # === 
+  # <div class="wxrb-remark">
+  # <b>Remark:</b>
+  # <p>For some renderers (like Direct2D or Cairo) processing of drawing operations may be deferred (Direct2D render target normally builds up a batch of rendering commands but defers processing of these commands, Cairo operates on a separate surface) so to make drawing results visible you need to update the content of the context by calling {Wx::GraphicsContext#flush} or by destroying the context.
+  # </p>
+  # </div>>
   # 
   # Category:  Graphics Device Interface (GDI), Device Contexts
   # @see Wx::GraphicsRenderer#create_context
@@ -204,8 +210,18 @@ module Wx
   # 
   # 
   # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
+  # @wxrb_require USE_GRAPHICS_CONTEXT
   class GraphicsContext < GraphicsObject
   
+    # Creates a {Wx::GraphicsContext} from a {Wx::PRT::PrinterDC}.
+    # Under GTK+, this will only work when using the GtkPrint printing backend which is available since GTK+ 2.10.
+    # @see Wx::GraphicsRenderer#create_context
+    # @see  Printing Under Unix (GTK+) 
+    # @param printerDC [Wx::PRT::PrinterDC] 
+    # @return [Wx::GraphicsContext]
+    # @wxrb_require WXMSW|WXOSX|USE_GTKPRINT
+    def self.create(printerDC) end
+    
     # Resets the clipping to original shape.
     # @return [void]
     def reset_clip; end
@@ -214,10 +230,17 @@ module Wx
     #   Sets the clipping region to the intersection of the given region and the previously set clipping region.
     #   The clipping region is an area to which drawing is restricted.
     #   
+    #   <div class="wxrb-remark">
+    #   <b>Remark:</b>
+    #   <p>
+    #   
     #   - Clipping region should be given in logical coordinates.
     #   - Calling this function can only make the clipping region smaller, never larger.
     #   - You need to call {Wx::GraphicsContext#reset_clip} first if you want to set the clipping region exactly to the region specified.
-    #   - If resulting clipping region is empty, then all drawing upon the context is clipped out (all changes made by drawing operations are masked out).
+    #   - If resulting clipping region is empty, then all drawing upon the context is clipped out (all changes made by drawing operations are masked out). 
+    #   
+    #   </p>
+    #   </div>>
     #   @param region [Wx::Region] 
     #   @return [void]
     # @overload clip(x, y, w, h)
@@ -230,7 +253,14 @@ module Wx
     def clip(*args) end
     
     # Returns bounding box of the current clipping region.
+    # <div class="wxrb-remark">
+    # <b>Remark:</b>
+    # <p>
+    # 
     # - If clipping region is empty, then empty rectangle is returned (x, y, w, h are set to zero).
+    # 
+    # </p>
+    # </div>>
     # @return [Array(Float,Float,Float,Float)]
     def get_clip_box; end
     alias_method :clip_box, :get_clip_box
@@ -482,14 +512,23 @@ module Wx
     
     # @overload create_font(font, col=Wx::BLACK)
     #   Creates a native graphics font from a {Wx::Font} and a text colour.
-    #   For Direct2D graphics fonts can be created from TrueType fonts only.
+    #   <div class="wxrb-remark">
+    #   <b>Remark:</b>
+    #   <p>For Direct2D graphics fonts can be created from TrueType fonts only. 
+    #   </p>
+    #   </div>>
     #   @param font [Wx::Font,Wx::FontInfo] 
     #   @param col [Wx::Colour,String,Symbol] 
     #   @return [Wx::GraphicsFont]
     # @overload create_font(sizeInPixels, facename, flags=Wx::FontFlag::FONTFLAG_DEFAULT, col=Wx::BLACK)
     #   Creates a font object with the specified attributes.
     #   The use of overload taking {Wx::Font} is preferred, see Wx::GraphicsRenderer#create_font for more details.
-    #   For Direct2D graphics fonts can be created from TrueType fonts only.
+    #   
+    #   <div class="wxrb-remark">
+    #   <b>Remark:</b>
+    #   <p>For Direct2D graphics fonts can be created from TrueType fonts only.
+    #   </p>
+    #   </div>>
     #   @param sizeInPixels [Float] 
     #   @param facename [String] 
     #   @param flags [Integer] 
@@ -499,7 +538,11 @@ module Wx
     
     # @overload set_font(font, colour)
     #   Sets the font for drawing text.
-    #   For Direct2D only TrueType fonts can be used.
+    #   <div class="wxrb-remark">
+    #   <b>Remark:</b>
+    #   <p>For Direct2D only TrueType fonts can be used. 
+    #   </p>
+    #   </div>>
     #   @param font [Wx::Font,Wx::FontInfo] 
     #   @param colour [Wx::Colour,String,Symbol] 
     #   @return [void]
@@ -602,7 +645,11 @@ module Wx
     alias_method :antialias_mode, :get_antialias_mode
     
     # Sets the interpolation quality, returns true if it is supported.
-    # Not implemented in Cairo backend currently.
+    # <div class="wxrb-remark">
+    # <b>Remark:</b>
+    # <p>Not implemented in Cairo backend currently. 
+    # </p>
+    # </div>>
     # @param interpolation [Wx::InterpolationQuality] 
     # @return [Boolean]
     def set_interpolation_quality(interpolation) end
@@ -694,12 +741,11 @@ module Wx
   end # GraphicsContext
   
   # Represents a single gradient stop in a collection of gradient stops as represented by {Wx::GraphicsGradientStops}.
-  # === 
-  # 
   # Category:  Graphics Device Interface (GDI)
   # 
   # 
   # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
+  # @wxrb_require USE_GRAPHICS_CONTEXT
   class GraphicsGradientStop < ::Object
   
     # Return the stop colour.
@@ -729,12 +775,12 @@ module Wx
   # Represents a collection of {Wx::GraphicGradientStop} values for use with CreateLinearGradientBrush and CreateRadialGradientBrush.
   # The stops are maintained in order of position. If two or more stops are added with the same position then the one(s) added later come later. This can be useful for producing discontinuities in the colour gradient.
   # Notice that this class is write-once, you can't modify the stops once they had been added.
-  # === 
   # 
   # Category:  Graphics Device Interface (GDI)
   # 
   # 
   # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
+  # @wxrb_require USE_GRAPHICS_CONTEXT
   class GraphicsGradientStops < ::Object
   
     # @overload add(stop)
@@ -753,7 +799,7 @@ module Wx
     # @param startCol [Wx::Colour] 
     # @param endCol [Wx::Colour] 
     # @return [Wx::GraphicsGradientStops]
-    def initialize(startCol=Wx::TransparentColour, endCol=Wx::TransparentColour) end
+    def initialize(startCol=Wx::TRANSPARENT_COLOUR, endCol=Wx::TRANSPARENT_COLOUR) end
     
     # Returns the stop at the given index.
     # @param n [unsigned]  The index, must be in [0, {Wx::GraphicsGradientStops#get_count}) range.
@@ -799,6 +845,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 GraphicsPenInfo < ::Object
   
     # @param colour [Wx::Colour,String,Symbol] 

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

@@ -10,6 +10,7 @@ module Wx
   # 
   # 
   # 
+  # @wxrb_require USE_GRAPHICS_CONTEXT
   class AntialiasMode < Wx::Enum
   
     # No anti-aliasing.
@@ -26,6 +27,7 @@ module Wx
   # 
   # 
   # 
+  # @wxrb_require USE_GRAPHICS_CONTEXT
   class InterpolationQuality < Wx::Enum
   
     # default interpolation, based on type of context, in general medium quality
@@ -54,6 +56,7 @@ module Wx
   # 
   # The description give a short equation on how the values of a resulting pixel are calculated. R = Result, S = Source, D = Destination, colors premultiplied with alpha Ra, Sa, Da their alpha components
   # 
+  # @wxrb_require USE_GRAPHICS_CONTEXT
   class CompositionMode < Wx::Enum
   
     # Indicates invalid or unsupported composition mode.
@@ -122,6 +125,7 @@ module Wx
   # 
   # 
   # 
+  # @wxrb_require USE_GRAPHICS_CONTEXT
   class GradientType < Wx::Enum
   
     # 
@@ -164,7 +168,6 @@ module Wx
   
   # This class is the superclass of native graphics objects like pens etc.
   # It allows reference counting. Not instantiated by user code.
-  # === 
   # 
   # Category:  Graphics Device Interface (GDI)
   # @see Wx::GraphicsBrush
@@ -173,6 +176,7 @@ module Wx
   # @see  Wx::GraphicsPath 
   # 
   # 
+  # @wxrb_require USE_GRAPHICS_CONTEXT
   class GraphicsObject < Object
   
     # 
@@ -185,30 +189,30 @@ module Wx
   
   # A {Wx::GraphicsPen} is a native representation of a pen.
   # The contents are specific and private to the respective renderer. Instances are ref counted and can therefore be assigned as usual. The only way to get a valid instance is via {Wx::GraphicsContext#create_pen} or Wx::GraphicsRenderer#create_pen.
-  # === 
   # 
   # Category:  Graphics Device Interface (GDI)
   # 
+  # @wxrb_require USE_GRAPHICS_CONTEXT
   class GraphicsPen < GraphicsObject
   
   end # GraphicsPen
   
   # A {Wx::GraphicsBrush} is a native representation of a brush.
   # The contents are specific and private to the respective renderer. Instances are ref counted and can therefore be assigned as usual. The only way to get a valid instance is via {Wx::GraphicsContext#create_brush} or Wx::GraphicsRenderer#create_brush.
-  # === 
   # 
   # Category:  Graphics Device Interface (GDI)
   # 
+  # @wxrb_require USE_GRAPHICS_CONTEXT
   class GraphicsBrush < GraphicsObject
   
   end # GraphicsBrush
   
   # A {Wx::GraphicsPath} is a native representation of a geometric path.
   # The contents are specific and private to the respective renderer. Instances are reference counted and can therefore be assigned as usual. The only way to get a valid instance is by using {Wx::GraphicsContext#create_path} or Wx::GraphicsRenderer#create_path.
-  # === 
   # 
   # Category:  Graphics Device Interface (GDI)
   # 
+  # @wxrb_require USE_GRAPHICS_CONTEXT
   class GraphicsPath < GraphicsObject
   
     # Adds an arc of a circle.
@@ -338,20 +342,20 @@ module Wx
   
   # A {Wx::GraphicsFont} is a native representation of a font.
   # The contents are specific and private to the respective renderer. Instances are ref counted and can therefore be assigned as usual. The only way to get a valid instance is via {Wx::GraphicsContext#create_font} or Wx::GraphicsRenderer#create_font.
-  # === 
   # 
   # Category:  Graphics Device Interface (GDI)
   # 
+  # @wxrb_require USE_GRAPHICS_CONTEXT
   class GraphicsFont < GraphicsObject
   
   end # GraphicsFont
   
   # A {Wx::GraphicsMatrix} is a native representation of an affine matrix.
   # The contents are specific and private to the respective renderer. Instances are ref counted and can therefore be assigned as usual. The only way to get a valid instance is via {Wx::GraphicsContext#create_matrix} or Wx::GraphicsRenderer#create_matrix.
-  # === 
   # 
   # Category:  Graphics Device Interface (GDI)
   # 
+  # @wxrb_require USE_GRAPHICS_CONTEXT
   class GraphicsMatrix < GraphicsObject
   
     # Concatenates the matrix passed with the current matrix.
@@ -424,6 +428,7 @@ module Wx
   # Represents a bitmap.
   # The objects of this class are not created directly but only via {Wx::GraphicsContext} or {Wx::GraphicsRenderer} CreateBitmap(), CreateBitmapFromImage() or CreateSubBitmap() methods. They can subsequently be used with {Wx::GraphicsContext#draw_bitmap}. The only other operation is testing for the bitmap validity which can be performed using {Wx::GraphicsBitmap#is_null} method inherited from the base class.
   # 
+  # @wxrb_require USE_GRAPHICS_CONTEXT
   class GraphicsBitmap < GraphicsObject
   
     # Default constructor creates an invalid bitmap.