Table of Contents

Graphics

Drawing, Text, Fonts


include file: wxGraphics.e

This section details functions and classes that are used to draw on windows. This includes drawing text (when a wxTextCtrl or wxStaticText don't do what you need).

  • proc begin_drawing( atom dc )   
  • proc blit( atom dstDC, integer dstX, integer dstY, atom srcDC, integer srcX, integer srcY, integer height, integer width, integer operation )   
  • proc clear_dc( atom dc )   
  • proc draw_bitmap( atom dc, atom bitmap, integer x, integer y, integer trans )   
  • proc draw_icon( atom dc, atom icon, atom x, atom y)   
  • proc draw_line( atom dc, sequence points )   
  • proc draw_polygon( atom dc, sequence points, atom x, atom y, atom style )   
  • proc end_drawing( atom dc )   
  • func get_dc_size( atom dc )   
  • func get_dc_text_extent( atom dc, sequence text )   
  • func get_first_region( atom iter )   
  • func get_next_region( atom iter )   
  • func get_regions( atom window )   
  • func get_text_extent( atom win, sequence text, atom font )   
  • func get_user_scale( atom dc, atom x, atom y )   
  • proc init_image_handlers()   
  • proc set_background_mode( atom dc, atom mode )   
  • proc set_back_brush( atom dc, atom brush )   
  • proc set_brush( atom dc, atom brush )   
  • proc set_default_font( atom win, atom font )   
  • proc set_font( atom dc, atom font )   
  • proc set_pen( atom dc, atom pen )   
  • proc set_text_back_color( atom dc, object color )   
  • proc set_text_color( atom dc, object color )   
  • proc set_user_scale( atom dc, atom x, atom y )   
  • proc wx_printf( object win, sequence text, object format )   
  • proc wx_puts( object win, sequence text )     
     
    Subtopics:
  • wxBitmap
  • wxBrush
  • wxColourDialog
  • wxFont
  • wxFontEnumerator
  • wxIcon
  • wxImageList
  • wxMemoryDC
  • wxPaintDC
  • wxPen


    Table of Contents

    [proc]
    begin_drawing
    ( atom dc )

    Category: Graphics

    This must be called before you begin drawing to any window (i.e., not to a wxMemoryDC), and must be followed with a call to end_drawing() when finished.

    See Also: blit, clear_dc, draw_bitmap, draw_icon, draw_line, draw_polygon, end_drawing, get_dc_size, get_dc_text_extent, get_first_region, get_next_region, get_regions, get_text_extent, get_user_scale, init_image_handlers, set_background_mode, set_back_brush, set_brush, set_default_font, set_font, set_pen, set_text_back_color, set_text_color, set_user_scale, wx_printf, wx_puts



    Table of Contents

    [proc]
    blit
    ( atom dstDC, integer dstX, integer dstY, atom srcDC, integer srcX, integer srcY, integer height, integer width, integer operation )

    Category: Graphics

    Copy a bitmap from one DC to another.

    See Also: begin_drawing, clear_dc, draw_bitmap, draw_icon, draw_line, draw_polygon, end_drawing, get_dc_size, get_dc_text_extent, get_first_region, get_next_region, get_regions, get_text_extent, get_user_scale, init_image_handlers, set_background_mode, set_back_brush, set_brush, set_default_font, set_font, set_pen, set_text_back_color, set_text_color, set_user_scale, wx_printf, wx_puts



    Table of Contents

    [proc]
    clear_dc
    ( atom dc )

    Category: Graphics

    Clears the image currently in the dc.

    See Also: begin_drawing, blit, draw_bitmap, draw_icon, draw_line, draw_polygon, end_drawing, get_dc_size, get_dc_text_extent, get_first_region, get_next_region, get_regions, get_text_extent, get_user_scale, init_image_handlers, set_background_mode, set_back_brush, set_brush, set_default_font, set_font, set_pen, set_text_back_color, set_text_color, set_user_scale, wx_printf, wx_puts



    Table of Contents

    [proc]
    draw_bitmap
    ( atom dc, atom bitmap, integer x, integer y, integer trans )

    Category: Graphics

    Draw a wxBitmap onto dc dest. Set trans to 1 if it has an associated mask, and should be drawn with transparency.

    See Also: begin_drawing, blit, clear_dc, draw_icon, draw_line, draw_polygon, end_drawing, get_dc_size, get_dc_text_extent, get_first_region, get_next_region, get_regions, get_text_extent, get_user_scale, init_image_handlers, set_background_mode, set_back_brush, set_brush, set_default_font, set_font, set_pen, set_text_back_color, set_text_color, set_user_scale, wx_printf, wx_puts



    Table of Contents

    [proc]
    draw_icon
    ( atom dc, atom icon, atom x, atom y)

    Category: Graphics

    Draws a wxIcon to the DC dc.

    See Also: begin_drawing, blit, clear_dc, draw_bitmap, draw_line, draw_polygon, end_drawing, get_dc_size, get_dc_text_extent, get_first_region, get_next_region, get_regions, get_text_extent, get_user_scale, init_image_handlers, set_background_mode, set_back_brush, set_brush, set_default_font, set_font, set_pen, set_text_back_color, set_text_color, set_user_scale, wx_printf, wx_puts



    Table of Contents

    [proc]
    draw_line
    ( atom dc, sequence points )

    Category: Graphics

    Draws a line using the current wxPen. points should be a 4-element sequence:

      draw_line( dc, {x1, y1, x2, y2})
    

    See Also: begin_drawing, blit, clear_dc, draw_bitmap, draw_icon, draw_polygon, end_drawing, get_dc_size, get_dc_text_extent, get_first_region, get_next_region, get_regions, get_text_extent, get_user_scale, init_image_handlers, set_background_mode, set_back_brush, set_brush, set_default_font, set_font, set_pen, set_text_back_color, set_text_color, set_user_scale, wx_printf, wx_puts



    Table of Contents

    [proc]
    draw_polygon
    ( atom dc, sequence points, atom x, atom y, atom style )

    Category: Graphics

    Draws a polygon in the specified dc. points is a sequence containing all of the points to be drawn. It should be of the form {x1,y1,x2,y2,...,xn,yn}. x and y are offset coordinates. The last argument specifies the fill rule:

    The current pen is used for drawing the outline, and the current brush for filling the shape. Using a transparent brush suppresses filling.

    Note that wxWidgets automatically closes the first and last points.

    See Also: begin_drawing, blit, clear_dc, draw_bitmap, draw_icon, draw_line, end_drawing, get_dc_size, get_dc_text_extent, get_first_region, get_next_region, get_regions, get_text_extent, get_user_scale, init_image_handlers, set_background_mode, set_back_brush, set_brush, set_default_font, set_font, set_pen, set_text_back_color, set_text_color, set_user_scale, wx_printf, wx_puts



    Table of Contents

    [proc]
    end_drawing
    ( atom dc )

    Category: Graphics

    See Also: begin_drawing, blit, clear_dc, draw_bitmap, draw_icon, draw_line, draw_polygon, get_dc_size, get_dc_text_extent, get_first_region, get_next_region, get_regions, get_text_extent, get_user_scale, init_image_handlers, set_background_mode, set_back_brush, set_brush, set_default_font, set_font, set_pen, set_text_back_color, set_text_color, set_user_scale, wx_printf, wx_puts



    Table of Contents

    [func]
    get_dc_size
    ( atom dc )

    Category: Graphics

    Returns the width and height of the dc in pixels.

    See Also: begin_drawing, blit, clear_dc, draw_bitmap, draw_icon, draw_line, draw_polygon, end_drawing, get_dc_text_extent, get_first_region, get_next_region, get_regions, get_text_extent, get_user_scale, init_image_handlers, set_background_mode, set_back_brush, set_brush, set_default_font, set_font, set_pen, set_text_back_color, set_text_color, set_user_scale, wx_printf, wx_puts



    Table of Contents

    [func]
    get_dc_text_extent
    ( atom dc, sequence text )

    Category: Graphics

    See Also: begin_drawing, blit, clear_dc, draw_bitmap, draw_icon, draw_line, draw_polygon, end_drawing, get_dc_size, get_first_region, get_next_region, get_regions, get_text_extent, get_user_scale, init_image_handlers, set_background_mode, set_back_brush, set_brush, set_default_font, set_font, set_pen, set_text_back_color, set_text_color, set_user_scale, wx_printf, wx_puts



    Table of Contents

    [func]
    get_first_region
    ( atom iter )

    Category: Graphics

    See Also: begin_drawing, blit, clear_dc, draw_bitmap, draw_icon, draw_line, draw_polygon, end_drawing, get_dc_size, get_dc_text_extent, get_next_region, get_regions, get_text_extent, get_user_scale, init_image_handlers, set_background_mode, set_back_brush, set_brush, set_default_font, set_font, set_pen, set_text_back_color, set_text_color, set_user_scale, wx_printf, wx_puts



    Table of Contents

    [func]
    get_next_region
    ( atom iter )

    Category: Graphics

    Returns a sequence with the x, y and width and height of the next region, or an empty sequence if the last region has already been accessed.

    See Also: begin_drawing, blit, clear_dc, draw_bitmap, draw_icon, draw_line, draw_polygon, end_drawing, get_dc_size, get_dc_text_extent, get_first_region, get_regions, get_text_extent, get_user_scale, init_image_handlers, set_background_mode, set_back_brush, set_brush, set_default_font, set_font, set_pen, set_text_back_color, set_text_color, set_user_scale, wx_printf, wx_puts



    Table of Contents

    [func]
    get_regions
    ( atom window )

    Category: Graphics

    Returns a wxRegionIterator, which can be used in conjunction with get_next_region() to get all of the regions to be updated in an on paint event. This should only be called from within an on paint event.

    See Also: begin_drawing, blit, clear_dc, draw_bitmap, draw_icon, draw_line, draw_polygon, end_drawing, get_dc_size, get_dc_text_extent, get_first_region, get_next_region, get_text_extent, get_user_scale, init_image_handlers, set_background_mode, set_back_brush, set_brush, set_default_font, set_font, set_pen, set_text_back_color, set_text_color, set_user_scale, wx_printf, wx_puts



    Table of Contents

    [func]
    get_text_extent
    ( atom win, sequence text, atom font )

    Category: Graphics

    See Also: begin_drawing, blit, clear_dc, draw_bitmap, draw_icon, draw_line, draw_polygon, end_drawing, get_dc_size, get_dc_text_extent, get_first_region, get_next_region, get_regions, get_user_scale, init_image_handlers, set_background_mode, set_back_brush, set_brush, set_default_font, set_font, set_pen, set_text_back_color, set_text_color, set_user_scale, wx_printf, wx_puts



    Table of Contents

    [func]
    get_user_scale
    ( atom dc, atom x, atom y )

    Category: Graphics

    Returns the scaling factors for the DC.

    See Also: begin_drawing, blit, clear_dc, draw_bitmap, draw_icon, draw_line, draw_polygon, end_drawing, get_dc_size, get_dc_text_extent, get_first_region, get_next_region, get_regions, get_text_extent, init_image_handlers, set_background_mode, set_back_brush, set_brush, set_default_font, set_font, set_pen, set_text_back_color, set_text_color, set_user_scale, wx_printf, wx_puts



    Table of Contents

    [proc]
    init_image_handlers
    ()

    Category: Graphics

    Initializes all image handlers for later use.

    See Also: begin_drawing, blit, clear_dc, draw_bitmap, draw_icon, draw_line, draw_polygon, end_drawing, get_dc_size, get_dc_text_extent, get_first_region, get_next_region, get_regions, get_text_extent, get_user_scale, set_background_mode, set_back_brush, set_brush, set_default_font, set_font, set_pen, set_text_back_color, set_text_color, set_user_scale, wx_printf, wx_puts



    Table of Contents

    [proc]
    set_background_mode
    ( atom dc, atom mode )

    Category: Graphics

    mode may be either wxSOLID (text is drawn with a background color) or wxTRANSPARENT (text is drawn without a background color).

    See Also: begin_drawing, blit, clear_dc, draw_bitmap, draw_icon, draw_line, draw_polygon, end_drawing, get_dc_size, get_dc_text_extent, get_first_region, get_next_region, get_regions, get_text_extent, get_user_scale, init_image_handlers, set_back_brush, set_brush, set_default_font, set_font, set_pen, set_text_back_color, set_text_color, set_user_scale, wx_printf, wx_puts



    Table of Contents

    [proc]
    set_back_brush
    ( atom dc, atom brush )

    Category: Graphics

    Sets background brush to be the current wxBrush for dc wxDC.

    See Also: begin_drawing, blit, clear_dc, draw_bitmap, draw_icon, draw_line, draw_polygon, end_drawing, get_dc_size, get_dc_text_extent, get_first_region, get_next_region, get_regions, get_text_extent, get_user_scale, init_image_handlers, set_background_mode, set_brush, set_default_font, set_font, set_pen, set_text_back_color, set_text_color, set_user_scale, wx_printf, wx_puts



    Table of Contents

    [proc]
    set_brush
    ( atom dc, atom brush )

    Category: Graphics

    Sets brush to be the current wxBrush for dc wxDC.

    See Also: begin_drawing, blit, clear_dc, draw_bitmap, draw_icon, draw_line, draw_polygon, end_drawing, get_dc_size, get_dc_text_extent, get_first_region, get_next_region, get_regions, get_text_extent, get_user_scale, init_image_handlers, set_background_mode, set_back_brush, set_default_font, set_font, set_pen, set_text_back_color, set_text_color, set_user_scale, wx_printf, wx_puts



    Table of Contents

    [proc]
    set_default_font
    ( atom win, atom font )

    Category: Graphics

    Sets the default font for a window.

    See Also: begin_drawing, blit, clear_dc, draw_bitmap, draw_icon, draw_line, draw_polygon, end_drawing, get_dc_size, get_dc_text_extent, get_first_region, get_next_region, get_regions, get_text_extent, get_user_scale, init_image_handlers, set_background_mode, set_back_brush, set_brush, set_font, set_pen, set_text_back_color, set_text_color, set_user_scale, wx_printf, wx_puts



    Table of Contents

    [proc]
    set_font
    ( atom dc, atom font )

    Category: Graphics

    Sets the font for a specified wxDC or wxPaintDC assiciated with a window. To set the default font for a window or control, you should use set_default_font().

    See Also: begin_drawing, blit, clear_dc, draw_bitmap, draw_icon, draw_line, draw_polygon, end_drawing, get_dc_size, get_dc_text_extent, get_first_region, get_next_region, get_regions, get_text_extent, get_user_scale, init_image_handlers, set_background_mode, set_back_brush, set_brush, set_default_font, set_pen, set_text_back_color, set_text_color, set_user_scale, wx_printf, wx_puts



    Table of Contents

    [proc]
    set_pen
    ( atom dc, atom pen )

    Category: Graphics

    Sets pen to be the current wxPen for dc wxDC.

    See Also: begin_drawing, blit, clear_dc, draw_bitmap, draw_icon, draw_line, draw_polygon, end_drawing, get_dc_size, get_dc_text_extent, get_first_region, get_next_region, get_regions, get_text_extent, get_user_scale, init_image_handlers, set_background_mode, set_back_brush, set_brush, set_default_font, set_font, set_text_back_color, set_text_color, set_user_scale, wx_printf, wx_puts



    Table of Contents

    [proc]
    set_text_back_color
    ( atom dc, object color )

    Category: Graphics

    See Also: begin_drawing, blit, clear_dc, draw_bitmap, draw_icon, draw_line, draw_polygon, end_drawing, get_dc_size, get_dc_text_extent, get_first_region, get_next_region, get_regions, get_text_extent, get_user_scale, init_image_handlers, set_background_mode, set_back_brush, set_brush, set_default_font, set_font, set_pen, set_text_color, set_user_scale, wx_printf, wx_puts



    Table of Contents

    [proc]
    set_text_color
    ( atom dc, object color )

    Category: Graphics

    Set the current text foreground color. color can be either an RGB sequence, or a pointer to a wxColour object.

    See Also: begin_drawing, blit, clear_dc, draw_bitmap, draw_icon, draw_line, draw_polygon, end_drawing, get_dc_size, get_dc_text_extent, get_first_region, get_next_region, get_regions, get_text_extent, get_user_scale, init_image_handlers, set_background_mode, set_back_brush, set_brush, set_default_font, set_font, set_pen, set_text_back_color, set_user_scale, wx_printf, wx_puts



    Table of Contents

    [proc]
    set_user_scale
    ( atom dc, atom x, atom y )

    Category: Graphics

    Sets the scaling factors for the DC.

    See Also: begin_drawing, blit, clear_dc, draw_bitmap, draw_icon, draw_line, draw_polygon, end_drawing, get_dc_size, get_dc_text_extent, get_first_region, get_next_region, get_regions, get_text_extent, get_user_scale, init_image_handlers, set_background_mode, set_back_brush, set_brush, set_default_font, set_font, set_pen, set_text_back_color, set_text_color, wx_printf, wx_puts



    Table of Contents

    [proc]
    wx_printf
    ( object win, sequence text, object format )

    Category: Graphics

    Works similar to printf().

    win can take several forms:

    See Also: begin_drawing, blit, clear_dc, draw_bitmap, draw_icon, draw_line, draw_polygon, end_drawing, get_dc_size, get_dc_text_extent, get_first_region, get_next_region, get_regions, get_text_extent, get_user_scale, init_image_handlers, set_background_mode, set_back_brush, set_brush, set_default_font, set_font, set_pen, set_text_back_color, set_text_color, set_user_scale, wx_puts



    Table of Contents

    [proc]
    wx_puts
    ( object win, sequence text )

    Category: Graphics

    Works similar to puts().

    See Also: begin_drawing, blit, clear_dc, draw_bitmap, draw_icon, draw_line, draw_polygon, end_drawing, get_dc_size, get_dc_text_extent, get_first_region, get_next_region, get_regions, get_text_extent, get_user_scale, init_image_handlers, set_background_mode, set_back_brush, set_brush, set_default_font, set_font, set_pen, set_text_back_color, set_text_color, set_user_scale, wx_printf