summaryrefslogtreecommitdiff
path: root/lib/wx/doc/src/wxDCOverlay.xml
blob: 0164a0d1bdbd3bf4743ad62e20090f8c7426e5a6 (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
<?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>wxDCOverlay</title>
</header>
<module>wxDCOverlay</module>
<modulesummary>Functions for wxDCOverlay class</modulesummary>
<description><p>Connects an overlay with a drawing DC.
      </p><p>See: <seeerl marker="wxOverlay"><c>wxOverlay</c></seeerl>, <seeerl marker="wxDC"><c>wxDC</c></seeerl>
      </p>
  <p>wxWidgets docs: <url href="https://docs.wxwidgets.org/3.1/classwx_d_c_overlay.html">wxDCOverlay</url></p>
  </description>
<datatypes><datatype><name name="wxDCOverlay"/></datatype></datatypes>

<funcs>
  <func>
    <name name="new" arity="2" clause_i="1" since=""/>
    <fsummary>Convenience wrapper that behaves the same using the entire area of the dc. </fsummary>
    <desc><p>Convenience wrapper that behaves the same using the entire area of the dc. 
      </p></desc>
  </func>
  
  <func>
    <name name="new" arity="6" clause_i="1" since=""/>
    <fsummary>Connects this overlay to the corresponding drawing dc, if the overlay is not initialized yet this call will do so. </fsummary>
    <desc><p>Connects this overlay to the corresponding drawing dc, if the overlay is not initialized yet this call will do so. 
      </p></desc>
  </func>
  
  <func>
    <name name="destroy" arity="1" clause_i="1" since=""/>
    <fsummary>Removes the connection between the overlay and the dc. </fsummary>
    <desc><p>Removes the connection between the overlay and the dc. 
      </p></desc>
  </func>
  
  <func>
    <name name="clear" arity="1" clause_i="1" since=""/>
    <fsummary>Clears the layer, restoring the state at the last init. </fsummary>
    <desc><p>Clears the layer, restoring the state at the last init. 
      </p></desc>
  </func>
  </funcs>
</erlref>