Struct MirrorDCIsOwned

pub struct MirrorDCIsOwned<const OWNED: bool>(/* private fields */);

wxMirrorDC is a simple wrapper class which is always associated with a real wxDC object and either forwards all of its operations to it without changes (no mirroring takes place) or exchanges x and y coordinates which makes it possible to reuse the same code to draw a figure and its mirror i.e.

• MirrorDC represents a C++ wxMirrorDC class instance which your code has ownership, MirrorDCIsOwned<false> represents one which don’t own.
• Use MirrorDC’s new() or Buildable::builder() (if available) to create an instance of this class.
• See C++ wxMirrorDC class’s documentation for more details.

Implementations

impl<const OWNED: bool> MirrorDCIsOwned<OWNED>

pub fn new<D: DCMethods>(dc: &D, mirror: bool) -> MirrorDCIsOwned<OWNED>

Creates a (maybe) mirrored DC associated with the real dc.

See C++ wxMirrorDC::wxMirrorDC()’s documentation.

pub fn none() -> Option<&'static Self>

Trait Implementations

impl Clone for MirrorDCIsOwned<false>

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<const OWNED: bool> DCMethods for MirrorDCIsOwned<OWNED>

fn device_to_logical_x(&self, x: c_int) -> c_int

Convert device X coordinate to logical coordinate, using the current mapping mode, user scale factor, device origin and axis orientation.

fn device_to_logical_x_rel(&self, x: c_int) -> c_int

Convert device X coordinate to relative logical coordinate, using the current mapping mode and user scale factor but ignoring the axis orientation.

fn device_to_logical_y(&self, y: c_int) -> c_int

Converts device Y coordinate to logical coordinate, using the current mapping mode, user scale factor, device origin and axis orientation.

fn device_to_logical_y_rel(&self, y: c_int) -> c_int

Convert device Y coordinate to relative logical coordinate, using the current mapping mode and user scale factor but ignoring the axis orientation.

fn logical_to_device_x(&self, x: c_int) -> c_int

Converts logical X coordinate to device coordinate, using the current mapping mode, user scale factor, device origin and axis orientation.

fn logical_to_device_x_rel(&self, x: c_int) -> c_int

Converts logical X coordinate to relative device coordinate, using the current mapping mode and user scale factor but ignoring the axis orientation.

fn logical_to_device_y(&self, y: c_int) -> c_int

Converts logical Y coordinate to device coordinate, using the current mapping mode, user scale factor, device origin and axis orientation.

fn logical_to_device_y_rel(&self, y: c_int) -> c_int

Converts logical Y coordinate to relative device coordinate, using the current mapping mode and user scale factor but ignoring the axis orientation.

fn device_to_logical_coord(&self, x: c_int, y: c_int) -> Point

Converts device (x, y) coordinates to logical coordinates taking into account all applied transformations like the current mapping mode, scale factors, device origin, axes orientation, affine transformation.

fn device_to_logical_point<P: PointMethods>(&self, pt: &P) -> Point

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

fn device_to_logical_rel_int(&self, x: c_int, y: c_int) -> Size

Converts device x, y coordinates to relative logical coordinates taking into account all applied transformations like the current mapping mode, scale factors, affine transformation.

fn device_to_logical_rel_size<S: SizeMethods>(&self, dim: &S) -> Size

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

fn logical_to_device_coord(&self, x: c_int, y: c_int) -> Point

Converts logical (x, y) coordinates to device coordinates taking into account all applied transformations like the current mapping mode, scale factors, device origin, axes orientation, affine transformation.

fn logical_to_device_point<P: PointMethods>(&self, pt: &P) -> Point

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

fn logical_to_device_rel_int(&self, x: c_int, y: c_int) -> Size

Converts logical x, y coordinates to relative device coordinates taking into account all applied transformations like the current mapping mode, scale factors, affine transformation.

fn logical_to_device_rel_size<S: SizeMethods>(&self, dim: &S) -> Size

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

fn clear(&self)

Clears the device context using the current background brush.

fn draw_arc_coord( &self, x_start: c_int, y_start: c_int, x_end: c_int, y_end: c_int, xc: c_int, yc: c_int, )

Draws an arc from the given start to the given end point.

fn draw_arc_point<P: PointMethods, P2: PointMethods, P3: PointMethods>( &self, pt_start: &P, pt_end: &P2, centre: &P3, )

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

fn draw_bitmap_coord<B: BitmapMethods>( &self, bitmap: &B, x: c_int, y: c_int, use_mask: bool, )

Draw a bitmap on the device context at the specified point.

fn draw_bitmap_point<B: BitmapMethods, P: PointMethods>( &self, bmp: &B, pt: &P, use_mask: bool, )

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

fn draw_check_mark_coord(&self, x: c_int, y: c_int, width: c_int, height: c_int)

Draws a check mark inside the given rectangle.

fn draw_check_mark_rect<R: RectMethods>(&self, rect: &R)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

fn draw_circle_coord(&self, x: c_int, y: c_int, radius: c_int)

Draws a circle with the given centre and radius.

fn draw_circle_point<P: PointMethods>(&self, pt: &P, radius: c_int)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

fn draw_ellipse_coord(&self, x: c_int, y: c_int, width: c_int, height: c_int)

Draws an ellipse contained in the rectangle specified either with the given top left corner and the given size or directly.

fn draw_ellipse_point<P: PointMethods, S: SizeMethods>(&self, pt: &P, size: &S)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

fn draw_ellipse_rect<R: RectMethods>(&self, rect: &R)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

fn draw_elliptic_arc_coord( &self, x: c_int, y: c_int, width: c_int, height: c_int, start: c_double, end: c_double, )

Draws an arc of an ellipse.

fn draw_elliptic_arc_point<P: PointMethods, S: SizeMethods>( &self, pt: &P, sz: &S, sa: c_double, ea: c_double, )

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

fn draw_icon_coord<I: IconMethods>(&self, icon: &I, x: c_int, y: c_int)

Draw an icon on the display (does nothing if the device context is PostScript).

fn draw_icon_point<I: IconMethods, P: PointMethods>(&self, icon: &I, pt: &P)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

fn draw_label_bitmap<B: BitmapMethods, R: RectMethods, R2: RectMethods>( &self, text: &str, bitmap: &B, rect: &R, alignment: c_int, index_accel: c_int, rect_bounding: Option<&R2>, )

Draw optional bitmap and the text into the given rectangle and aligns it as specified by alignment parameter; it also will emphasize the character with the given index if it is != -1 and return the bounding rectangle if required.

fn draw_label_rect<R: RectMethods>( &self, text: &str, rect: &R, alignment: c_int, index_accel: c_int, )

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

fn draw_line_coord(&self, x1: c_int, y1: c_int, x2: c_int, y2: c_int)

Draws a line from the first point to the second.

fn draw_line_point<P: PointMethods, P2: PointMethods>(&self, pt1: &P, pt2: &P2)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

fn draw_lines(&self, points: *const c_void, xoffset: c_int, yoffset: c_int)

This method uses a list of wxPoints, adding the optional offset coordinate.

fn draw_point_coord(&self, x: c_int, y: c_int)

Draws a point using the color of the current pen.

fn draw_point_point<P: PointMethods>(&self, pt: &P)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

fn draw_rectangle_coord(&self, x: c_int, y: c_int, width: c_int, height: c_int)

Draws a rectangle with the given corner coordinate and size.

fn draw_rectangle_point<P: PointMethods, S: SizeMethods>(&self, pt: &P, sz: &S)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

fn draw_rectangle_rect<R: RectMethods>(&self, rect: &R)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

fn draw_rotated_text_coord( &self, text: &str, x: c_int, y: c_int, angle: c_double, )

Draws the text rotated by angle degrees (positive angles are counterclockwise; the full angle is 360 degrees).

fn draw_rotated_text_point<P: PointMethods>( &self, text: &str, point: &P, angle: c_double, )

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

fn draw_rounded_rectangle_coord( &self, x: c_int, y: c_int, width: c_int, height: c_int, radius: c_double, )

Draws a rectangle with the given top left corner, and with the given size.

fn draw_rounded_rectangle_point<P: PointMethods, S: SizeMethods>( &self, pt: &P, sz: &S, radius: c_double, )

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

fn draw_rounded_rectangle_rect<R: RectMethods>( &self, rect: &R, radius: c_double, )

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

fn draw_spline_pointlist(&self, points: *const c_void)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

fn draw_spline_coord( &self, x1: c_int, y1: c_int, x2: c_int, y2: c_int, x3: c_int, y3: c_int, )

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

fn draw_text_coord(&self, text: &str, x: c_int, y: c_int)

Draws a text string at the specified point, using the current text font, and the current text foreground and background colours.

fn draw_text_point<P: PointMethods>(&self, text: &str, pt: &P)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

fn gradient_fill_concentric<R: RectMethods, C: ColourMethods, C2: ColourMethods>( &self, rect: &R, initial_colour: &C, dest_colour: &C2, )

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.

fn gradient_fill_concentric_point<R: RectMethods, C: ColourMethods, C2: ColourMethods, P: PointMethods>( &self, rect: &R, initial_colour: &C, dest_colour: &C2, circle_center: &P, )

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.

fn gradient_fill_linear<R: RectMethods, C: ColourMethods, C2: ColourMethods>( &self, rect: &R, initial_colour: &C, dest_colour: &C2, n_direction: c_int, )

Fill the area specified by rect with a linear gradient, starting from initialColour and eventually fading to destColour.

fn cross_hair_coord(&self, x: c_int, y: c_int)

Displays a cross hair using the current pen.

fn cross_hair_point<P: PointMethods>(&self, pt: &P)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

fn destroy_clipping_region(&self)

Destroys the current clipping region so that none of the DC is clipped.

fn get_clipping_box_coord( &self, x: *mut c_void, y: *mut c_void, width: *mut c_void, height: *mut c_void, ) -> bool

Gets the rectangle surrounding the current clipping region.

fn get_clipping_box_rect<R: RectMethods>(&self, rect: &R) -> bool

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

fn set_clipping_region_coord( &self, x: c_int, y: c_int, width: c_int, height: c_int, )

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.

fn set_clipping_region_point<P: PointMethods, S: SizeMethods>( &self, pt: &P, sz: &S, )

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

fn set_clipping_region_rect<R: RectMethods>(&self, rect: &R)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

fn set_device_clipping_region<R: RegionMethods>(&self, region: &R)

Sets the clipping region for this device context.

fn get_char_height(&self) -> c_int

Gets the character height of the currently set font.

fn get_char_width(&self) -> c_int

Gets the average character width of the currently set font.

fn get_multi_line_text_extent_coord<F: FontMethods>( &self, string: &str, w: *mut c_void, h: *mut c_void, height_line: *mut c_void, font: Option<&F>, )

Gets the dimensions of the string using the currently selected font.

fn get_multi_line_text_extent(&self, string: &str) -> Size

Gets the dimensions of the string using the currently selected font.

fn get_partial_text_extents<A: ArrayIntMethods>( &self, text: &str, widths: &A, ) -> bool

Fills the widths array with the widths from the beginning of text to the corresponding character of text.

fn get_text_extent_coord<F: FontMethods>( &self, string: &str, w: *mut c_void, h: *mut c_void, descent: *mut c_void, external_leading: *mut c_void, font: Option<&F>, )

Gets the dimensions of the string using the currently selected font.

fn get_text_extent(&self, string: &str) -> Size

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

fn get_background_mode(&self) -> c_int

Returns the current background mode: wxBRUSHSTYLE_SOLID or wxBRUSHSTYLE_TRANSPARENT.

fn get_font(&self) -> FontIsOwned<false>

Gets the current font.

fn get_layout_direction(&self) -> c_int

Gets the current layout direction of the device context.

fn get_text_background(&self) -> ColourIsOwned<false>

Gets the current text background colour.

fn get_text_foreground(&self) -> ColourIsOwned<false>

Gets the current text foreground colour.

fn set_background_mode(&self, mode: c_int)

Change the current background mode.

fn set_font<F: FontMethods>(&self, font: &F)

Sets the current font for the DC.

fn set_text_background<C: ColourMethods>(&self, colour: &C)

Sets the current text background colour for the DC.

fn set_text_foreground<C: ColourMethods>(&self, colour: &C)

Sets the current text foreground colour for the DC.

fn set_layout_direction(&self, dir: c_int)

Sets the current layout direction for the device context.

fn calc_bounding_box(&self, x: c_int, y: c_int)

Adds the specified point to the bounding box which can be retrieved with MinX(), MaxX() and MinY(), MaxY() functions.

fn max_x(&self) -> c_int

Gets the maximum horizontal extent used in drawing commands so far.

fn max_y(&self) -> c_int

Gets the maximum vertical extent used in drawing commands so far.

fn min_x(&self) -> c_int

Gets the minimum horizontal extent used in drawing commands so far.

fn min_y(&self) -> c_int

Gets the minimum vertical extent used in drawing commands so far.

fn reset_bounding_box(&self)

Resets the bounding box: after a call to this function, the bounding box doesn’t contain anything.

fn start_doc(&self, message: &str) -> bool

Starts a document (only relevant when outputting to a printer).

fn start_page(&self)

Starts a document page (only relevant when outputting to a printer).

fn end_doc(&self)

Ends a document (only relevant when outputting to a printer).

fn end_page(&self)

Ends a document page (only relevant when outputting to a printer).

fn get_background(&self) -> BrushIsOwned<false>

Gets the brush used for painting the background.

fn get_brush(&self) -> BrushIsOwned<false>

Gets the current brush.

fn set_background<B: BrushMethods>(&self, brush: &B)

Sets the current background brush for the DC.

fn set_brush<B: BrushMethods>(&self, brush: &B)

Sets the current brush for the DC.

fn set_pen<P: PenMethods>(&self, pen: &P)

Sets the current pen for the DC.

fn copy_attributes<D: DCMethods>(&self, dc: &D)

Copy attributes from another DC.

fn get_content_scale_factor(&self) -> c_double

Returns the factor used for converting logical pixels to physical ones.

fn get_depth(&self) -> c_int

Returns the depth (number of bits/pixel) of this DC.

fn get_device_origin(&self) -> Point

Returns the current device origin.

fn get_pixel<C: ColourMethods>( &self, x: c_int, y: c_int, colour: Option<&C>, ) -> bool

Gets in colour the colour at the specified location.

fn get_ppi(&self) -> Size

Returns the resolution of the device in pixels per inch.

fn from_dip_size<S: SizeMethods>(&self, sz: &S) -> Size

Convert DPI-independent pixel values to the value in pixels appropriate for the DC.

fn from_dip_point<P: PointMethods>(&self, pt: &P) -> Point

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

fn from_dip_int(&self, d: c_int) -> c_int

Convert DPI-independent value in pixels to the value in pixels appropriate for the DC.

fn to_dip_size<S: SizeMethods>(&self, sz: &S) -> Size

Convert pixel values of the current DC to DPI-independent pixel values.

fn to_dip_point<P: PointMethods>(&self, pt: &P) -> Point

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

fn to_dip_int(&self, d: c_int) -> c_int

Convert pixel values of the current DC to DPI-independent pixel values.

fn get_size_coord(&self, width: *mut c_void, height: *mut c_void)

Gets the horizontal and vertical extent of this device context in device units.

fn get_size(&self) -> Size

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

fn get_size_mm_coord(&self, width: *mut c_void, height: *mut c_void)

Returns the horizontal and vertical resolution in millimetres.

fn get_size_mm(&self) -> Size

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

fn get_user_scale(&self, x: *mut c_void, y: *mut c_void)

Gets the current user scale factor.

fn is_ok(&self) -> bool

Returns true if the DC is ok to use.

fn set_axis_orientation(&self, x_left_right: bool, y_bottom_up: bool)

Sets the x and y axis orientation (i.e. the direction from lowest to highest values on the axis).

fn set_device_origin(&self, x: c_int, y: c_int)

Sets the device origin (i.e. the origin in pixels after scaling has been applied).

fn set_palette<P: PaletteMethods>(&self, palette: &P)

If this is a window DC or memory DC, assigns the given palette to the window or bitmap associated with the DC.

fn set_user_scale(&self, x_scale: c_double, y_scale: c_double)

Sets the user scaling factor, useful for applications which require ‘zooming’.

fn can_use_transform_matrix(&self) -> bool

Check if the use of transformation matrix is supported by the current system.

fn set_transform_matrix<A: AffineMatrix2DMethods>(&self, matrix: &A) -> bool

Set the transformation matrix.

fn get_transform_matrix(&self) -> AffineMatrix2D

Return the transformation matrix used by this device context.

fn reset_transform_matrix(&self)

Revert the transformation matrix to identity matrix.

fn can_draw_bitmap(&self) -> bool

Does the DC support drawing bitmaps?

fn can_get_text_extent(&self) -> bool

Does the DC support calculating the size required to draw text?

fn get_handle(&self) -> *mut c_void

Returns a value that can be used as a handle to the native drawing context, if this wxDC has something that could be thought of in that way.

fn get_as_bitmap<R: RectMethods>(&self, subrect: Option<&R>) -> Bitmap

If supported by the platform and the type of DC, fetch the contents of the DC, or a subset of it, as a bitmap.

fn set_logical_scale(&self, x: c_double, y: c_double)

Set the scale to use for translating wxDC coordinates to the physical pixels.

fn get_logical_scale(&self, x: *mut c_void, y: *mut c_void)

Return the scale set by the last call to SetLogicalScale().

fn set_logical_origin(&self, x: c_int, y: c_int)

Change the offset used for translating wxDC coordinates.

fn get_logical_origin_coord(&self, x: *mut c_void, y: *mut c_void)

Return the coordinates of the logical point (0, 0).

fn get_logical_origin(&self) -> Point

Does the DC support drawing bitmaps?

fn get_graphics_context(&self) -> Option<GraphicsContextIsOwned<false>>

If supported by the platform and the wxDC implementation, this method will return the wxGraphicsContext associated with the DC.

fn set_graphics_context<G: GraphicsContextMethods>(&self, ctx: Option<&G>)

Associate a wxGraphicsContext with the DC.

impl<const OWNED: bool> Drop for MirrorDCIsOwned<OWNED>

fn drop(&mut self)

Executes the destructor for this type.

impl<const OWNED: bool> DynamicCast for MirrorDCIsOwned<OWNED>

fn class_info() -> ClassInfoIsOwned<false>

fn as_unowned<T>(&self) -> Option<<T as WxRustMethods>::Unowned>

where T: DynamicCast,

impl<const OWNED: bool> From<MirrorDCIsOwned<OWNED>> for DCIsOwned<OWNED>

fn from(o: MirrorDCIsOwned<OWNED>) -> Self

Converts to this type from the input type.

impl<const OWNED: bool> From<MirrorDCIsOwned<OWNED>> for ObjectIsOwned<OWNED>

fn from(o: MirrorDCIsOwned<OWNED>) -> Self

Converts to this type from the input type.

impl<const OWNED: bool> ObjectMethods for MirrorDCIsOwned<OWNED>

fn get_class_info(&self) -> Option<ClassInfoIsOwned<false>>

This virtual function is redefined for every class that requires run-time type information, when using the wxDECLARE_CLASS macro (or similar).

fn get_ref_data(&self) -> Option<ObjectRefDataIsOwned<false>>

Returns the wxObject::m_refData pointer, i.e. the data referenced by this object.

fn is_kind_of<C>(&self, info: Option<&C>) -> bool

where C: ClassInfoMethods,

Determines whether this class is a subclass of (or the same class as) the given class.

fn is_same_as<O>(&self, obj: &O) -> bool

where O: ObjectMethods,

Returns true if this object has the same data pointer as obj.

fn ref_<O>(&self, clone: &O)

where O: ObjectMethods,

Makes this object refer to the data in clone.

fn set_ref_data<O>(&self, data: Option<&O>)

where O: ObjectRefDataMethods,

Sets the wxObject::m_refData pointer.

fn un_ref(&self)

Decrements the reference count in the associated data, and if it is zero, deletes the data.

fn un_share(&self)

This is the same of AllocExclusive() but this method is public.

impl<const OWNED: bool> WxRustMethods for MirrorDCIsOwned<OWNED>

type Unowned = MirrorDCIsOwned<false>

unsafe fn as_ptr(&self) -> *mut c_void

unsafe fn from_ptr(ptr: *mut c_void) -> Self

unsafe fn from_unowned_ptr(ptr: *mut c_void) -> Self::Unowned

unsafe fn with_ptr<F: Fn(&Self)>(ptr: *mut c_void, closure: F)

unsafe fn option_from(ptr: *mut c_void) -> Option<Self::Unowned>

where Self: Sized,

impl<const OWNED: bool> MirrorDCMethods for MirrorDCIsOwned<OWNED>