Go to main content

man pages section 3: Extended Library Functions, Volume 1

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

wxPaintDC (3erl)

Name

wxPaintDC - Functions for wxPaintDC class

Synopsis

Please see following description for synopsis

Description

wxPaintDC(3)               Erlang Module Definition               wxPaintDC(3)



NAME
       wxPaintDC - Functions for wxPaintDC class

DESCRIPTION
       A  wxPaintDC  must  be constructed if an application wishes to paint on
       the client area of a window from within an EVT_PAINT()  event  handler.
       This  should normally be constructed as a temporary stack object; don't
       store a wxPaintDC object. If you have an EVT_PAINT() handler, you  must
       create a wxPaintDC object within it even if you don't actually use it.

       Using wxPaintDC within your EVT_PAINT() handler is important because it
       automatically sets the clipping area to the damaged area of the window.
       Attempts to draw outside this area do not appear.

       A  wxPaintDC  object is initialized to use the same font and colours as
       the window it is associated with.

       See: wxDC, wxClientDC, wxMemoryDC, wxWindowDC, wxScreenDC

       This class is derived (and can use functions) from: wxWindowDC wxDC

       wxWidgets docs: wxPaintDC

DATA TYPES
       wxPaintDC() = wx:wx_object()

EXPORTS
       new(Window) -> wxPaintDC()

              Types:

                 Window = wxWindow:wxWindow()

              Constructor.

              Pass a pointer to the window on which you wish to paint.

       destroy(This :: wxPaintDC()) -> ok

              Destroys the object.



wxWidgets team.                    wx 2.1.1                       wxPaintDC(3)