summaryrefslogtreecommitdiff
path: root/lib/wx/doc/src/wxPaintDC.xml
blob: e9feedb718f4bf8b0da07fce6678418f88a222f4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE erlref SYSTEM "erlref.dtd">

<!-- THIS FILE IS GENERATED DO NOT EDIT -->


<erlref>
<header>
  <copyright>
    <year>2020</year><year>2021</year>
    <holder>wxWidgets team.</holder></copyright>
  <legalnotice>Licensed under the wxWindows Free Documentation Licence, Version 3
  </legalnotice>
  <title>wxPaintDC</title>
</header>
<module>wxPaintDC</module>
<modulesummary>Functions for wxPaintDC class</modulesummary>
<description><p>A <seeerl marker="wxPaintDC"><c>wxPaintDC</c></seeerl> 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 <seeerl marker="wxPaintDC"><c>wxPaintDC</c></seeerl> object. If you have an EVT_PAINT() handler, you <c>must</c> create a <seeerl marker="wxPaintDC"><c>wxPaintDC</c></seeerl> object within it even if you don't actually use it.
      </p><p>Using <seeerl marker="wxPaintDC"><c>wxPaintDC</c></seeerl> 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.
      </p><p>A <seeerl marker="wxPaintDC"><c>wxPaintDC</c></seeerl> object is initialized to use the same font and colours as the window it is associated with.
      </p><p>See: <seeerl marker="wxDC"><c>wxDC</c></seeerl>, <seeerl marker="wxClientDC"><c>wxClientDC</c></seeerl>, <seeerl marker="wxMemoryDC"><c>wxMemoryDC</c></seeerl>, <seeerl marker="wxWindowDC"><c>wxWindowDC</c></seeerl>, <seeerl marker="wxScreenDC"><c>wxScreenDC</c></seeerl>
      </p>
  <p>This class is derived (and can use functions) from: 
    <seeerl marker="wxWindowDC"><c>wxWindowDC</c></seeerl> <seeerl marker="wxDC"><c>wxDC</c></seeerl></p>
  
  <p>wxWidgets docs: <url href="https://docs.wxwidgets.org/3.1/classwx_paint_d_c.html">wxPaintDC</url></p>
  </description>
<datatypes><datatype><name name="wxPaintDC"/></datatype></datatypes>

<funcs>
  <func>
    <name name="new" arity="1" clause_i="1" since=""/>
    <fsummary>Constructor. </fsummary>
    <desc><p>Constructor. 
      </p><p>Pass a pointer to the window on which you wish to paint. 
      </p></desc>
  </func>
  
  <func>
    <name name="destroy" arity="1" clause_i="1" since=""/>
    <fsummary>Destructor</fsummary>
    <desc><p>Destroys the object.</p></desc>
  </func>
  </funcs>
</erlref>