summaryrefslogtreecommitdiff
path: root/lib/wx/doc/src/wxWindowDC.xml
blob: 6f6c2f57eea7d1440c307c2458135ba469a86da9 (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
46
47
48
49
50
51
52
53
54
55
56
57
58
<?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>wxWindowDC</title>
</header>
<module>wxWindowDC</module>
<modulesummary>Functions for wxWindowDC class</modulesummary>
<description><p>A <seeerl marker="wxWindowDC"><c>wxWindowDC</c></seeerl> must be constructed if an application wishes to paint on the whole area of a window (client and decorations). This should normally be constructed as a temporary stack object; don't store a <seeerl marker="wxWindowDC"><c>wxWindowDC</c></seeerl> object.
      </p><p>To draw on a window from inside an EVT_PAINT() handler, construct a <seeerl marker="wxPaintDC"><c>wxPaintDC</c></seeerl> object instead.
      </p><p>To draw on the client area of a window from outside an EVT_PAINT() handler, construct a <seeerl marker="wxClientDC"><c>wxClientDC</c></seeerl> object.
      </p><p>A <seeerl marker="wxWindowDC"><c>wxWindowDC</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="wxMemoryDC"><c>wxMemoryDC</c></seeerl>, <seeerl marker="wxPaintDC"><c>wxPaintDC</c></seeerl>, <seeerl marker="wxClientDC"><c>wxClientDC</c></seeerl>, <seeerl marker="wxScreenDC"><c>wxScreenDC</c></seeerl>
      </p>
  <p>This class is derived (and can use functions) from: 
    <seeerl marker="wxDC"><c>wxDC</c></seeerl></p>
  
  <p>wxWidgets docs: <url href="https://docs.wxwidgets.org/3.1/classwx_window_d_c.html">wxWindowDC</url></p>
  </description>
<datatypes><datatype><name name="wxWindowDC"/></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>