Class: Wx::OverlayDC

Inherits:
DC show all
Defined in:
lib/wx/doc/gen/dc_overlay.rb

Overview

A device context allowing to draw on an overlay associated with a window.

Assuming MyWindow as a Window-derived object with Wx::Overlay m_overlay as a member variable, this class could be used in the following way:

void MyWindow::OnDrawSomethingTemporary()
  {
      wxOverlayDC dc(m_overlay, this);
      dc.Clear(); // Usually required, unless the entire DC is filled.
  
      // Use wxDC functions as usual.
      dc.DrawText("Hello, world!", 10, 10);
  }
  
  void MyWindow::OnClearTemporaryDrawing()
  {
      m_overlay.Reset();
  }

Note that while OverlayDC currently actually inherits from ClientDC, this is an implementation detail and shouldn’t be relied upon, it is only guaranteed to derive from DC as documented here.

See Also:

Method Summary

Methods inherited from DC

#blit, #calc_bounding_box, #clear, #copy_attributes, #cross_hair, #destroy_clipping_region, #draw_arc, #draw_bitmap, #draw_check_mark, #draw_circle, #draw_ellipse, #draw_elliptic_arc, #draw_icon, #draw_label, #draw_line, #draw_lines, #draw_point, #draw_poly_polygon, #draw_polygon, #draw_rectangle, #draw_rotated_text, #draw_rounded_rectangle, #draw_spline, #draw_text, #end_doc, #end_page, #flood_fill, #get_as_bitmap, #get_background, #get_background_mode, #get_brush, #get_clipping_box, #get_graphics_context, #get_logical_function, #get_pen, #get_pixel, #get_text_background, #get_text_foreground, #gradient_fill_concentric, #gradient_fill_linear, #max_x, #max_y, #min_x, #min_y, #reset_bounding_box, #set_background, #set_background_mode, #set_brush, #set_clipping_region, #set_device_clipping_region, #set_graphics_context, #set_logical_function, #set_palette, #set_pen, #set_text_background, #set_text_foreground, #start_doc, #start_page, #stretch_blit, #with_background_mode, #with_brush, #with_font, #with_pen, #with_text_background, #with_text_foreground

Methods inherited from ReadOnlyDC

#can_draw_bitmap, #can_get_text_extent, #can_use_transform_matrix, #device_to_logical, #device_to_logical_rel, #device_to_logical_x, #device_to_logical_x_rel, #device_to_logical_y, #device_to_logical_y_rel, #from_dip, #get_char_height, #get_char_width, #get_content_scale_factor, #get_depth, #get_device_origin, #get_dimensions, #get_dimensions_mm, #get_font, #get_font_metrics, #get_layout_direction, #get_logical_origin, #get_logical_scale, #get_map_mode, #get_multi_line_text_extent, #get_multi_line_text_size, #get_ppi, #get_size, #get_size_mm, #get_text_extent, #get_text_size, #get_transform_matrix, #get_user_scale, #is_ok, #logical_to_device, #logical_to_device_rel, #logical_to_device_x, #logical_to_device_x_rel, #logical_to_device_y, #logical_to_device_y_rel, #reset_transform_matrix, #set_axis_orientation, #set_device_origin, #set_font, #set_layout_direction, #set_logical_origin, #set_logical_scale, #set_map_mode, #set_transform_matrix, #set_user_scale, #to_dip

Methods inherited from Object

#clone, #dup, #initialize, #is_same_as, #un_share

Constructor Details

This class inherits a constructor from Wx::Object