wxruby3 0.9.2-x64-mingw-ucrt → 0.9.4-x64-mingw-ucrt

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

@@ -131,6 +131,7 @@ module Wx
   end # MappingMode
   
   # A {Wx::DC} is a "device context" onto which graphics and text can be drawn.
+  # 
   # It is intended to represent different output devices and offers a common abstract API for drawing on any of them.
   # wxWidgets offers an alternative drawing API based on the modern drawing backends GDI+, CoreGraphics, Cairo and Direct2D. See {Wx::GraphicsContext}, {Wx::GraphicsRenderer} and related classes. There is also a {Wx::GCDC} linking the APIs by offering the {Wx::DC} API on top of a {Wx::GraphicsContext}.
   # {Wx::DC} is an abstract base class and cannot be created directly. Use {Wx::PaintDC}, {Wx::ClientDC}, {Wx::WindowDC}, {Wx::ScreenDC}, {Wx::MemoryDC} or {Wx::PRT::PrinterDC}. Notice that device contexts which are associated with windows (i.e. {Wx::ClientDC}, {Wx::WindowDC} and {Wx::PaintDC}) use the window font and colours by default (starting with wxWidgets 2.9.0) but the other device context classes use system-default values so you always must set the appropriate fonts and colours before using them.
@@ -171,6 +172,7 @@ module Wx
   class DC < Object
   
     # Convert device X coordinate to logical coordinate, using the current mapping mode, user scale factor, device origin and axis orientation.
+    # 
     # <div class="wxrb-note">
     # <b>Note:</b>
     # <p>Affine transformation applied to the coordinate system with {Wx::DC#set_transform_matrix} is not taken into account. 
@@ -181,6 +183,7 @@ module Wx
     def device_to_logical_x(x) end
     
     # Convert device X coordinate to relative logical coordinate, using the current mapping mode and user scale factor but ignoring the axis orientation.
+    # 
     # Use this for converting a horizontal distance like for example a width.
     # 
     # <div class="wxrb-note">
@@ -193,6 +196,7 @@ module Wx
     def device_to_logical_x_rel(x) end
     
     # Converts device Y coordinate to logical coordinate, using the current mapping mode, user scale factor, device origin and axis orientation.
+    # 
     # <div class="wxrb-note">
     # <b>Note:</b>
     # <p>Affine transformation applied to the coordinate system with {Wx::DC#set_transform_matrix} is not taken into account. 
@@ -203,6 +207,7 @@ module Wx
     def device_to_logical_y(y) end
     
     # Convert device Y coordinate to relative logical coordinate, using the current mapping mode and user scale factor but ignoring the axis orientation.
+    # 
     # Use this for converting a vertical distance like for example a height.
     # 
     # <div class="wxrb-note">
@@ -215,6 +220,7 @@ module Wx
     def device_to_logical_y_rel(y) end
     
     # Converts logical X coordinate to device coordinate, using the current mapping mode, user scale factor, device origin and axis orientation.
+    # 
     # <div class="wxrb-note">
     # <b>Note:</b>
     # <p>Affine transformation applied to the coordinate system with {Wx::DC#set_transform_matrix} is not taken into account. 
@@ -225,6 +231,7 @@ module Wx
     def logical_to_device_x(x) end
     
     # Converts logical X coordinate to relative device coordinate, using the current mapping mode and user scale factor but ignoring the axis orientation.
+    # 
     # Use this for converting a horizontal distance like for example a width.
     # 
     # <div class="wxrb-note">
@@ -237,6 +244,7 @@ module Wx
     def logical_to_device_x_rel(x) end
     
     # Converts logical Y coordinate to device coordinate, using the current mapping mode, user scale factor, device origin and axis orientation.
+    # 
     # <div class="wxrb-note">
     # <b>Note:</b>
     # <p>Affine transformation applied to the coordinate system with {Wx::DC#set_transform_matrix} is not taken into account. 
@@ -247,6 +255,7 @@ module Wx
     def logical_to_device_y(y) end
     
     # Converts logical Y coordinate to relative device coordinate, using the current mapping mode and user scale factor but ignoring the axis orientation.
+    # 
     # Use this for converting a vertical distance like for example a height.
     # 
     # <div class="wxrb-note">
@@ -271,6 +280,7 @@ module Wx
     
     # @overload device_to_logical_rel(x, y)
     #   Converts device x, y coordinates to relative logical coordinates taking into account all applied transformations like the current mapping mode, scale factors, affine transformation.
+    #   
     #   Use this for converting distances like e.g. width and height.
     #   @param x [Integer] 
     #   @param y [Integer] 
@@ -294,6 +304,7 @@ module Wx
     
     # @overload logical_to_device_rel(x, y)
     #   Converts logical x, y coordinates to relative device coordinates taking into account all applied transformations like the current mapping mode, scale factors, affine transformation.
+    #   
     #   Use this for converting distances like e.g. width and height.
     #   @param x [Integer] 
     #   @param y [Integer] 
@@ -305,6 +316,7 @@ module Wx
     def logical_to_device_rel(*args) end
     
     # Clears the device context using the current background brush.
+    # 
     # Note that {Wx::DC#set_background} method must be used to set the brush used by {Wx::DC#clear}, the brush used for filling the shapes set by {Wx::DC#set_brush} is ignored by it.
     # If no background brush was set, solid white brush is used to clear the device context.
     # @return [void]
@@ -312,6 +324,7 @@ module Wx
     
     # @overload draw_arc(xStart, yStart, xEnd, yEnd, xc, yc)
     #   Draws an arc from the given start to the given end point.
+    #   
     #   <div class="wxrb-note">
     #   <b>Note:</b>
     #   <p>{Wx::DC#draw_elliptic_arc} has more clear semantics and it is recommended to use it instead of this function.
@@ -338,6 +351,7 @@ module Wx
     
     # @overload draw_bitmap(bitmap, x, y, useMask=false)
     #   Draw a bitmap on the device context at the specified point.
+    #   
     #   If useMask is true and the bitmap has a transparency mask, the bitmap will be drawn transparently.
     #   When drawing a mono-bitmap, the current text foreground colour will be used to draw the foreground of the bitmap (all bits set to 1), and the current text background colour to draw the background (all bits set to 0).
     #   @see Wx::DC#set_text_foreground
@@ -372,6 +386,7 @@ module Wx
     # @overload draw_circle(x, y, radius)
     #   Draws a circle with the given centre and radius.
     #   
+    #   
     #   @see Wx::DC#draw_ellipse 
     #   @param x [Integer] 
     #   @param y [Integer] 
@@ -386,6 +401,7 @@ module Wx
     
     # @overload draw_ellipse(x, y, width, height)
     #   Draws an ellipse contained in the rectangle specified either with the given top left corner and the given size or directly.
+    #   
     #   The current pen is used for the outline and the current brush for filling the shape.
     #   @see Wx::DC#draw_circle 
     #   @param x [Integer] 
@@ -406,6 +422,7 @@ module Wx
     
     # @overload draw_elliptic_arc(x, y, width, height, start, end_)
     #   Draws an arc of an ellipse.
+    #   
     #   The current pen is used for drawing the arc and the current brush is used for drawing the pie.
     #   x and y specify the x and y coordinates of the upper-left corner of the rectangle that contains the ellipse.
     #   width and height specify the width and height of the rectangle that contains the ellipse.
@@ -430,6 +447,7 @@ module Wx
     
     # @overload draw_icon(icon, x, y)
     #   Draw an icon on the display (does nothing if the device context is PostScript).
+    #   
     #   This can be the simplest way of drawing bitmaps on a window.
     #   @param icon [Wx::Icon] 
     #   @param x [Integer] 
@@ -462,6 +480,7 @@ module Wx
     
     # @overload draw_line(x1, y1, x2, y2)
     #   Draws a line from the first point to the second.
+    #   
     #   The current pen is used for drawing the line. Note that the point (x2, y2) is not part of the line and is not drawn by this function (this is consistent with the behaviour of many other toolkits).
     #   @param x1 [Integer] 
     #   @param y1 [Integer] 
@@ -476,6 +495,7 @@ module Wx
     def draw_line(*args) end
     
     # Draws lines using an array of points of size n adding the optional offset coordinate.
+    # 
     # The current pen is used for drawing the lines.
     # @param points [Array<Wx::Point>,Array<Array<Integer>>] 
     # @param xoffset [Integer] 
@@ -485,6 +505,7 @@ module Wx
     
     # @overload draw_point(x, y)
     #   Draws a point using the color of the current pen.
+    #   
     #   Note that the other properties of the pen are not used, such as width.
     #   @param x [Integer] 
     #   @param y [Integer] 
@@ -496,6 +517,7 @@ module Wx
     def draw_point(*args) end
     
     # Draws a filled polygon using an array of points of size n, adding the optional offset coordinate.
+    # 
     # The first and last points are automatically closed.
     # The last argument specifies the fill rule: <b>{Wx::PolygonFillMode::ODDEVEN_RULE}</b> (the default) or <b>{Wx::PolygonFillMode::WINDING_RULE}</b>.
     # The current pen is used for drawing the outline, and the current brush for filling the shape. Using a transparent brush suppresses filling.
@@ -507,6 +529,7 @@ module Wx
     def draw_polygon(points, xoffset=0, yoffset=0, fill_style=Wx::PolygonFillMode::ODDEVEN_RULE) end
     
     # Draws two or more filled polygons using an array of points, adding the optional offset coordinates.
+    # 
     # Notice that for the platforms providing a native implementation of this function (Windows and PostScript-based {Wx::DC} currently), this is more efficient than using {Wx::DC#draw_polygon} in a loop.
     # n specifies the number of polygons to draw, the array count of size n specifies the number of points in each of the polygons in the points array.
     # The last argument specifies the fill rule: <b>{Wx::PolygonFillMode::ODDEVEN_RULE}</b> (the default) or <b>{Wx::PolygonFillMode::WINDING_RULE}</b>.
@@ -521,6 +544,7 @@ module Wx
     
     # @overload draw_rectangle(x, y, width, height)
     #   Draws a rectangle with the given corner coordinate and size.
+    #   
     #   Normally, x and y specify the top left corner coordinates and both width and height are positive, however they are also allowed to be negative, in which case the corresponding corner coordinate refers to the right or bottom corner instead.
     #   The current pen is used for the outline and the current brush for filling the shape.
     #   @param x [Integer] 
@@ -541,6 +565,7 @@ module Wx
     
     # @overload draw_rotated_text(text, x, y, angle)
     #   Draws the text rotated by angle degrees (positive angles are counterclockwise; the full angle is 360 degrees).
+    #   
     #   Notice that, as with {Wx::DC#draw_text}, the text can contain multiple lines separated by the new line (<code>'\n'</code>) characters.
     #   
     #   <div class="wxrb-note">
@@ -564,6 +589,7 @@ module Wx
     
     # @overload draw_rounded_rectangle(x, y, width, height, radius)
     #   Draws a rectangle with the given top left corner, and with the given size.
+    #   
     #   The corners are quarter-circles using the given radius. The current pen is used for the outline and the current brush for filling the shape.
     #   If radius is positive, the value is assumed to be the radius of the rounded corner. If radius is negative, the absolute value is assumed to be the proportion of the smallest dimension of the rectangle. This means that the corner can be a sensible size relative to the size of the rectangle, and also avoids the strange effects X produces when the corners are too big for the rectangle.
     #   @param x [Integer] 
@@ -587,6 +613,7 @@ module Wx
     
     # @overload draw_spline(points)
     #   Draws a spline between all given points using the current pen.
+    #   
     #   The number of points must be at least 2 for the spline to be drawn.
     #   
     #   <div class="wxrb-note">
@@ -609,6 +636,7 @@ module Wx
     
     # @overload draw_text(text, x, y)
     #   Draws a text string at the specified point, using the current text font, and the current text foreground and background colours.
+    #   
     #   The coordinates refer to the top-left corner of the rectangle bounding the string. See {Wx::DC#get_text_extent} for how to get the dimensions of a text string, which can be used to position the text more precisely and {Wx::DC#draw_label} if you need to align the string differently.
     #   Starting from wxWidgets 2.9.2 text parameter can be a multi-line string, i.e. contain new line characters, and will be rendered correctly.
     #   
@@ -630,6 +658,7 @@ module Wx
     
     # @overload gradient_fill_concentric(rect, initialColour, destColour)
     #   Fill the area specified by rect with a radial gradient, starting from initialColour at the centre of the circle and fading to destColour on the circle outside.
+    #   
     #   The circle is placed at the centre of rect.
     #   
     #   <div class="wxrb-note">
@@ -643,6 +672,7 @@ module Wx
     #   @return [void]
     # @overload gradient_fill_concentric(rect, initialColour, destColour, circleCenter)
     #   Fill the area specified by rect with a radial gradient, starting from initialColour at the centre of the circle and fading to destColour on the circle outside.
+    #   
     #   circleCenter are the relative coordinates of centre of the circle in the specified rect.
     #   
     #   <div class="wxrb-note">
@@ -658,6 +688,7 @@ module Wx
     def gradient_fill_concentric(*args) end
     
     # Fill the area specified by rect with a linear gradient, starting from initialColour and eventually fading to destColour.
+    # 
     # The nDirection specifies the direction of the colour change, default is to use initialColour on the left part of the rectangle and destColour on the right one.
     # @param rect [Wx::Rect] 
     # @param initialColour [Wx::Colour,String,Symbol] 
@@ -668,6 +699,7 @@ module Wx
     
     # @overload flood_fill(x, y, colour, style=Wx::FloodFillStyle::FLOOD_SURFACE)
     #   Flood fills the device context starting from the given point, using the current brush colour, and using a style:
+    #   
     #   - {Wx::FloodFillStyle::FLOOD_SURFACE}: The flooding occurs until a colour other than the given colour is encountered.
     #   - {Wx::FloodFillStyle::FLOOD_BORDER}: The area to be flooded is bounded by the given colour.
     #   
@@ -700,6 +732,7 @@ module Wx
     
     # @overload cross_hair(x, y)
     #   Displays a cross hair using the current pen.
+    #   
     #   This is a vertical and horizontal line the height and width of the window, centred on the given point.
     #   @param x [Integer] 
     #   @param y [Integer] 
@@ -712,19 +745,21 @@ module Wx
     
     # Destroys the current clipping region so that none of the DC is clipped.
     # 
+    # 
     # @see Wx::DC#set_clipping_region 
     # @return [void]
     def destroy_clipping_region; end
     
     # @overload get_clipping_box(x, y)
     #   Gets the rectangle surrounding the current clipping region.
+    #   
     #   If no clipping region is set this function returns the extent of the device context.
     #   
     #   <div class="wxrb-remark">
     #   <b>Remark:</b>
     #   <p>Clipping region is given in logical coordinates.
     #   </p>
-    #   </div>>
+    #   </div>
     #   
     #   true if there is a clipping region or false if there is no active clipping region (note that this return value is available only since wxWidgets 3.1.2, this function didn't return anything in the previous versions).
     #   @param x [Integer]  If non-NULL, filled in with the logical horizontal coordinate of the top left corner of the clipping region if the function returns true or 0 otherwise.
@@ -739,6 +774,7 @@ module Wx
     
     # @overload set_clipping_region(x, y, width, height)
     #   Sets the clipping region for this device context to the intersection of the given region described by the parameters of this method and the previously set clipping region.
+    #   
     #   The clipping region is an area to which drawing is restricted. Possible uses for the clipping region are for clipping text or for speeding up window redraws when only a known area of the screen is damaged.
     #   
     #   <div class="wxrb-remark">
@@ -751,7 +787,7 @@ module Wx
     #   - If resulting clipping region is empty, then all drawing on the DC is clipped out (all changes made by drawing operations are masked out).
     #   
     #   </p>
-    #   </div>>
+    #   </div>
     #   @see Wx::DC#destroy_clipping_region
     #   @see  Wx::Region 
     #   @param x [Integer] 
@@ -772,6 +808,7 @@ module Wx
     alias_method :clipping_region=, :set_clipping_region
     
     # Sets the clipping region for this device context.
+    # 
     # Unlike {Wx::DC#set_clipping_region}, this function works with physical coordinates and not with the logical ones.
     # @param region [Wx::Region] 
     # @return [void]
@@ -789,6 +826,7 @@ module Wx
     alias_method :char_width, :get_char_width
     
     # Returns the various font characteristics.
+    # 
     # This method allows retrieving some of the font characteristics not returned by {Wx::DC#get_text_extent}, notably internal leading and average character width.
     # Currently this method returns correct results only under WXMSW, in the other ports the internal leading will always be 0 and the average character width will be computed as the width of the character 'x'.
     # @return [Wx::FontMetrics]
@@ -796,6 +834,7 @@ module Wx
     alias_method :font_metrics, :get_font_metrics
     
     # Gets the dimensions of the string using the currently selected font.
+    # 
     # string is the text string to measure, heightLine, if non NULL, is where to store the height of a single line.
     # The text extent is set in the given w and h pointers.
     # If the optional parameter font is specified and valid, then it is used for the text extent calculation, otherwise the currently selected font is used.
@@ -817,6 +856,7 @@ module Wx
     alias_method :multi_line_text_extent, :get_multi_line_text_extent
     
     # Gets the dimensions of the string using the currently selected font.
+    # 
     # string is the text string to measure.
     # The text extent as a {Wx::Size} object.
     # 
@@ -835,6 +875,7 @@ module Wx
     alias_method :multi_line_text_size, :get_multi_line_text_size
     
     # Gets the dimensions of the string using the currently selected font.
+    # 
     # string is the text string to measure, descent is the dimension from the baseline of the font to the bottom of the descender, and externalLeading is any extra vertical space added to the font by the font designer (usually is zero).
     # The text extent is returned in w and h pointers or as a {Wx::Size} object depending on which version of this function is used.
     # If the optional parameter font is specified and valid, then it is used for the text extent calculation. Otherwise the currently selected font is.
@@ -863,18 +904,21 @@ module Wx
     
     # Returns the current background mode: {Wx::BrushStyle::BRUSHSTYLE_SOLID} or {Wx::BrushStyle::BRUSHSTYLE_TRANSPARENT}.
     # 
+    # 
     # @see Wx::DC#set_background_mode 
     # @return [Integer]
     def get_background_mode; end
     alias_method :background_mode, :get_background_mode
     
     # Gets the current font.
+    # 
     # Notice that even although each device context object has some default font after creation, this method would return a {Wx::NULL_FONT} initially and only after calling {Wx::DC#set_font} a valid font is returned.
     # @return [Wx::Font,Wx::FontInfo]
     def get_font; end
     alias_method :font, :get_font
     
     # Gets the current layout direction of the device context.
+    # 
     # On platforms where RTL layout is supported, the return value will either be {Wx::LayoutDirection::Layout_LeftToRight} or {Wx::LayoutDirection::Layout_RightToLeft}. If RTL layout is not supported, the return value will be {Wx::LayoutDirection::Layout_Default}.
     # @see Wx::DC#set_layout_direction 
     # @return [Wx::LayoutDirection]
@@ -883,6 +927,7 @@ module Wx
     
     # Gets the current text background colour.
     # 
+    # 
     # @see Wx::DC#set_text_background 
     # @return [Wx::Colour,String,Symbol]
     def get_text_background; end
@@ -890,12 +935,14 @@ module Wx
     
     # Gets the current text foreground colour.
     # 
+    # 
     # @see Wx::DC#set_text_foreground 
     # @return [Wx::Colour,String,Symbol]
     def get_text_foreground; end
     alias_method :text_foreground, :get_text_foreground
     
     # Change the current background mode.
+    # 
     # This setting determines whether text will be drawn with a background colour or not.
     # Default is {Wx::BrushStyle::BRUSHSTYLE_TRANSPARENT}, i.e. text background is not drawn.
     # @param mode [Integer]  one of {Wx::BrushStyle::BRUSHSTYLE_SOLID} and {Wx::BrushStyle::BRUSHSTYLE_TRANSPARENT}.
@@ -904,6 +951,7 @@ module Wx
     alias_method :background_mode=, :set_background_mode
     
     # Sets the current font for the DC.
+    # 
     # The font parameter should be valid, although in WXMSW port (only) the argument {Wx::NULL_FONT} is also accepted and resets the device context font to the default value used by the system (which is not generally useful).
     # @see Wx::Font 
     # @param font [Wx::Font,Wx::FontInfo] 
@@ -919,6 +967,7 @@ module Wx
     
     # Sets the current text foreground colour for the DC.
     # 
+    # 
     # @see Wx::MemoryDC for the interpretation of colours when drawing into a monochrome bitmap. 
     # @param colour [Wx::Colour,String,Symbol] 
     # @return [void]
@@ -927,6 +976,7 @@ module Wx
     
     # Sets the current layout direction for the device context.
     # 
+    # 
     # @see Wx::DC#get_layout_direction 
     # @param dir [Wx::LayoutDirection]  May be either {Wx::LayoutDirection::Layout_Default}, {Wx::LayoutDirection::Layout_LeftToRight} or {Wx::LayoutDirection::Layout_RightToLeft}.
     # @return [void]
@@ -935,6 +985,7 @@ module Wx
     
     # Adds the specified point to the bounding box which can be retrieved with {Wx::DC#min_x}, {Wx::DC#max_x} and {Wx::DC#min_y}, {Wx::DC#max_y} functions.
     # 
+    # 
     # @see Wx::DC#reset_bounding_box 
     # @param x [Integer] 
     # @param y [Integer] 
@@ -959,11 +1010,13 @@ module Wx
     
     # Resets the bounding box: after a call to this function, the bounding box doesn't contain anything.
     # 
+    # 
     # @see Wx::DC#calc_bounding_box 
     # @return [void]
     def reset_bounding_box; end
     
     # Starts a document (only relevant when outputting to a printer).
+    # 
     # message is a message to show while printing.
     # @param message [String] 
     # @return [Boolean]
@@ -982,6 +1035,7 @@ module Wx
     def end_page; end
     
     # Copy from a source DC to this DC.
+    # 
     # With this method you can specify the destination coordinates and the size of area to copy which will be the same for both the source and target DCs. If you need to apply scaling while copying, use {Wx::DC#stretch_blit}.
     # Notice that source DC coordinates xsrc and ysrc are interpreted using the current source DC coordinate system, i.e. the scale, origin position and axis directions are taken into account when transforming them to physical (pixel) coordinates.
     # 
@@ -989,7 +1043,7 @@ module Wx
     # <b>Remark:</b>
     # <p>There is partial support for {Wx::DC#blit} in {Wx::PRT::PostScriptDC}, under X.
     # </p>
-    # </div>>
+    # </div>
     # @see Wx::DC#stretch_blit
     # @see  Wx::MemoryDC
     # @see  Wx::Bitmap
@@ -1031,6 +1085,7 @@ module Wx
     def blit(xdest, ydest, width, height, source, xsrc, ysrc, logicalFunc=Wx::RasterOperationMode::COPY, useMask=false, xsrcMask=Wx::DEFAULT_COORD, ysrcMask=Wx::DEFAULT_COORD) end
     
     # Copy from a source DC to this DC possibly changing the scale.
+    # 
     # Unlike {Wx::DC#blit}, this method allows specifying different source and destination region sizes, meaning that it can stretch or shrink it while copying. The same can be achieved by changing the scale of the source or target DC but calling this method is simpler and can also be more efficient if the platform provides a native implementation of it.
     # The meaning of its other parameters is the same as with {Wx::DC#blit}, in particular all source coordinates are interpreted using the source DC coordinate system, i.e. are affected by its scale, origin translation and axis direction.
     # 
@@ -1080,6 +1135,7 @@ module Wx
     
     # Gets the brush used for painting the background.
     # 
+    # 
     # @see Wx::DC#set_background 
     # @return [Wx::Brush]
     def get_background; end
@@ -1087,6 +1143,7 @@ module Wx
     
     # Gets the current brush.
     # 
+    # 
     # @see Wx::DC#set_brush 
     # @return [Wx::Brush]
     def get_brush; end
@@ -1094,6 +1151,7 @@ module Wx
     
     # Gets the current pen.
     # 
+    # 
     # @see Wx::DC#set_pen 
     # @return [Wx::Pen]
     def get_pen; end
@@ -1106,6 +1164,7 @@ module Wx
     alias_method :background=, :set_background
     
     # Sets the current brush for the DC.
+    # 
     # If the argument is {Wx::NULL_BRUSH} (or another invalid brush; see {Wx::Brush#is_ok}), the current brush is selected out of the device context (leaving {Wx::DC} without any valid brush), allowing the current brush to be destroyed safely.
     # @see Wx::Brush
     # @see  Wx::MemoryDC (for the interpretation of colours when drawing into a monochrome bitmap) 
@@ -1115,6 +1174,7 @@ module Wx
     alias_method :brush=, :set_brush
     
     # Sets the current pen for the DC.
+    # 
     # If the argument is {Wx::NULL_PEN} (or another invalid pen; see {Wx::Pen#is_ok}), the current pen is selected out of the device context (leaving {Wx::DC} without any valid pen), allowing the current pen to be destroyed safely.
     # @see Wx::MemoryDC for the interpretation of colours when drawing into a monochrome bitmap. 
     # @param pen [Wx::Pen] 
@@ -1134,12 +1194,14 @@ module Wx
     
     # Return the coordinates of the logical point (0, 0).
     # 
+    # 
     # @see Wx::DC#set_logical_origin 
     # @return [Wx::Point]
     def get_logical_origin; end
     alias_method :logical_origin, :get_logical_origin
     
     # Copy attributes from another DC.
+    # 
     # The copied attributes currently are:
     # 
     # - Font
@@ -1153,6 +1215,7 @@ module Wx
     def copy_attributes(dc) end
     
     # Returns the factor used for converting logical pixels to physical ones.
+    # 
     # Returns the same value as {Wx::Window#get_dpi_scale_factor} for the device contexts associated with a window and the same value as {Wx::Bitmap#get_scale_factor} for the associated bitmap for {Wx::MemoryDC}.
     # 
     # <div class="wxrb-note">
@@ -1166,6 +1229,7 @@ module Wx
     
     # Returns the depth (number of bits/pixel) of this DC.
     # 
+    # 
     # @see display_depth 
     # @return [Integer]
     def get_depth; end
@@ -1173,6 +1237,7 @@ module Wx
     
     # Returns the current device origin.
     # 
+    # 
     # @see Wx::DC#set_device_origin 
     # @return [Wx::Point]
     def get_device_origin; end
@@ -1180,6 +1245,7 @@ module Wx
     
     # Gets the current logical function.
     # 
+    # 
     # @see Wx::DC#set_logical_function 
     # @return [Wx::RasterOperationMode]
     def get_logical_function; end
@@ -1187,12 +1253,14 @@ module Wx
     
     # Gets the current mapping mode for the device context.
     # 
+    # 
     # @see Wx::DC#set_map_mode 
     # @return [Wx::MappingMode]
     def get_map_mode; end
     alias_method :map_mode, :get_map_mode
     
     # Gets in colour the colour at the specified location.
+    # 
     # This method isn't available for {Wx::PRT::PostScriptDC} or {Wx::MetafileDC} nor for any DC in WXOSX port and simply returns false there.
     # 
     # <div class="wxrb-note">
@@ -1220,6 +1288,7 @@ module Wx
     
     # @overload from_dip(sz)
     #   Convert DPI-independent pixel values to the value in pixels appropriate for the DC.
+    #   
     #   See {Wx::Window#from_dip(sz)} for more info about converting device independent pixel values.
     #   @param sz [Array(Integer, Integer), Wx::Size] 
     #   @return [Wx::Size]
@@ -1229,6 +1298,7 @@ module Wx
     #   @return [Wx::Point]
     # @overload from_dip(d)
     #   Convert DPI-independent value in pixels to the value in pixels appropriate for the DC.
+    #   
     #   This is the same as FromDIP(const {Wx::Size}& sz) overload, but assumes that the resolution is the same in horizontal and vertical directions.
     #   @param d [Integer] 
     #   @return [Integer]
@@ -1236,6 +1306,7 @@ module Wx
     
     # @overload to_dip(sz)
     #   Convert pixel values of the current DC to DPI-independent pixel values.
+    #   
     #   See {Wx::Window#to_dip(sz)} for more info about converting device independent pixel values.
     #   @param sz [Array(Integer, Integer), Wx::Size] 
     #   @return [Wx::Size]
@@ -1245,12 +1316,14 @@ module Wx
     #   @return [Wx::Point]
     # @overload to_dip(d)
     #   Convert pixel values of the current DC to DPI-independent pixel values.
+    #   
     #   This is the same as ToDIP(const {Wx::Size}& sz) overload, but assumes that the resolution is the same in horizontal and vertical directions.
     #   @param d [Integer] 
     #   @return [Integer]
     def to_dip(*args) end
     
     # Gets the horizontal and vertical extent of this device context in device units.
+    # 
     # It can be used to scale graphics to fit the page.
     # For example, if maxX and maxY represent the maximum horizontal and vertical 'pixel' values used in your application, the following code will scale the graphic to fit on the printer page:
     # 
@@ -1281,6 +1354,7 @@ module Wx
     
     # Gets the current user scale factor.
     # 
+    # 
     # @see Wx::DC#set_user_scale 
     # @return [Array(Float,Float)]
     def get_user_scale; end
@@ -1292,6 +1366,7 @@ module Wx
     alias_method :ok?, :is_ok
     
     # Sets the x and y axis orientation (i.e. the direction from lowest to highest values on the axis).
+    # 
     # The default orientation is x axis from left to right and y axis from top down.
     # @param xLeftRight [Boolean]  True to set the x axis orientation to the natural left to right orientation, false to invert it.
     # @param yBottomUp [Boolean]  True to set the y axis orientation to the natural bottom up orientation, false to invert it.
@@ -1299,6 +1374,7 @@ module Wx
     def set_axis_orientation(xLeftRight, yBottomUp) end
     
     # Sets the device origin (i.e. the origin in pixels after scaling has been applied).
+    # 
     # This function may be useful in Windows printing operations for placing a graphic on a page.
     # @param x [Integer] 
     # @param y [Integer] 
@@ -1306,6 +1382,7 @@ module Wx
     def set_device_origin(x, y) end
     
     # Sets the current logical function for the device context.
+    # 
     # <div class="wxrb-note">
     # <b>Note:</b>
     # <p>This function is not fully supported in all ports, due to the limitations of the underlying drawing model. Notably, {Wx::RasterOperationMode::INVERT} which was commonly used for drawing rubber bands or other moving outlines in the past, is not, and will not, be supported by WXGTK3 and WXOSX. The suggested alternative is to draw temporarily objects normally and refresh the (affected part of the) window to remove them later.
@@ -1321,6 +1398,7 @@ module Wx
     alias_method :logical_function=, :set_logical_function
     
     # The mapping mode of the device context defines the unit of measurement used to convert logical units to device units.
+    # 
     # Note that in X, text drawing isn't handled consistently with the mapping mode; a font is always specified in point size. However, setting the user scale (see {Wx::DC#set_user_scale}) scales the text appropriately. In Windows, scalable TrueType fonts are always used; in X, results depend on availability of fonts, but usually a reasonable match is found.
     # The coordinate origin is always at the top left of the screen/printer.
     # Drawing to a Windows printer device context uses the current mapping mode, but mapping mode is currently ignored for PostScript output.
@@ -1330,6 +1408,7 @@ module Wx
     alias_method :map_mode=, :set_map_mode
     
     # If this is a window DC or memory DC, assigns the given palette to the window or bitmap associated with the DC.
+    # 
     # If the argument is {Wx::NULL_PALETTE}, the current palette is selected out of the device context, and the original palette restored.
     # @see Wx::Palette 
     # @param palette [Wx::Palette] 
@@ -1350,6 +1429,7 @@ module Wx
     alias_method :as_bitmap, :get_as_bitmap
     
     # Set the scale to use for translating {Wx::DC} coordinates to the physical pixels.
+    # 
     # The effect of calling this function is similar to that of calling {Wx::DC#set_user_scale}.
     # @param x [Float] 
     # @param y [Float] 
@@ -1363,6 +1443,7 @@ module Wx
     
     # Change the offset used for translating {Wx::DC} coordinates.
     # 
+    # 
     # @see Wx::DC#set_logical_origin
     # @see  Wx::DC#set_device_origin 
     # @param x [Integer] 
@@ -1371,12 +1452,14 @@ module Wx
     def set_logical_origin(x, y) end
     
     # If supported by the platform and the {Wx::DC} implementation, this method will return the {Wx::GraphicsContext} associated with the DC.
+    # 
     # Otherwise NULL is returned.
     # @return [Wx::GraphicsContext]
     def get_graphics_context; end
     alias_method :graphics_context, :get_graphics_context
     
     # Associate a {Wx::GraphicsContext} with the DC.
+    # 
     # Ignored if not supported by the specific {Wx::DC} implementation. It is unlikely that this will need to be used in application code.
     # @param ctx [Wx::GraphicsContext] 
     # @return [void]
@@ -1386,6 +1469,7 @@ module Wx
   end # DC
   
   # Simple collection of various font metrics.
+  # 
   # This object is returned by {Wx::DC#get_font_metrics}.
   # 
   # Category:  Device Contexts, Graphics Device Interface (GDI)

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

@@ -13,6 +13,7 @@ module Wx
   EVT_DIALUP_DISCONNECTED = 10200
   
   # This is the event class for the dialup events sent by {Wx::DialUpManager}.
+  # 
   # Category:  {Wx::Events}
   # 
   # @wxrb_require USE_DIALUP_MANAGER
@@ -30,6 +31,7 @@ module Wx
     alias_method :connected_event?, :is_connected_event
     
     # Does this event come from {Wx::DialUpManager#dial} or from some external process (i.e.
+    # 
     # does it result from our own attempt to establish the connection)?
     # @return [Boolean]
     def is_own_event; end