<?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>
    <holder>Ericsson AB. All Rights Reserved.</holder></copyright>
  <legalnotice>
      Licensed under the Apache License, Version 2.0 (the "License");
      you may not use this file except in compliance with the License.
      You may obtain a copy of the License at

          http://www.apache.org/licenses/LICENSE-2.0

      Unless required by applicable law or agreed to in writing, software
      distributed under the License is distributed on an "AS IS" BASIS,
      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
      See the License for the specific language governing permissions and
      limitations under the License.

  </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>
