File: wx.MetafileDC.txt

package info (click to toggle)
wxpython4.0 4.0.4%2Bdfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 211,112 kB
  • sloc: cpp: 888,355; python: 223,130; makefile: 52,087; ansic: 45,780; sh: 3,012; xml: 1,534; perl: 264
file content (126 lines) | stat: -rw-r--r-- 4,226 bytes parent folder | download
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
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
.. wxPython Phoenix documentation

   This file was generated by Phoenix's sphinx generator and associated
   tools, do not edit by hand.

   Copyright: (c) 2011-2018 by Total Control Software
   License:   wxWindows License

.. include:: headings.inc



.. _wx.MetafileDC:

==========================================================================================================================================
|phoenix_title|  **wx.MetafileDC**
==========================================================================================================================================

This is a type of device context that allows a metafile object to be created (Windows only), and has most of the characteristics of a normal  ** :ref:`wx.DC` ** .          

The :meth:`wx.MetafileDC.Close`   member must be called after drawing into the device context, to return a metafile. The only purpose for this at present is to allow the metafile to be copied to the clipboard (see :ref:`wx.Metafile`). 

Adding metafile capability to an application should be easy if you already write to a :ref:`wx.DC`; simply pass the :ref:`wx.MetafileDC`  to your drawing function instead. You may wish to conditionally compile this code so it is not compiled under X (although no harm will result if you leave it in). 

Note that a metafile saved to disk is in standard Windows metafile format, and cannot be imported into most applications. To make it importable, call the function :ref:`wx.MakeMetafilePlaceable`  after closing your disk-based metafile device context. 







         



.. seealso:: :ref:`wx.Metafile`, :ref:`wx.DC`    







|

|class_hierarchy| Class Hierarchy
=================================

.. raw:: html

   <div id="toggleBlock" onclick="return toggleVisibility(this)" class="closed" style="cursor:pointer;">
   <img id="toggleBlock-trigger" src="_static/images/closed.png"/>
   Inheritance diagram for class <strong>MetafileDC</strong>:
   </div>
   <div id="toggleBlock-summary" style="display:block;"></div>
   <div id="toggleBlock-content" style="display:none;">
   <p class="graphviz">
   <center><img src="_static/images/inheritance/wx.MetafileDC_inheritance.png" alt="Inheritance diagram of MetafileDC" usemap="#dummy" class="inheritance"/></center>
   </div>
   <script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.Object.html" title="wx.Object" alt="" coords="19,5,100,35"/> <area shape="rect" id="node2" href="wx.DC.html" title="wx.DC" alt="" coords="24,83,96,112"/> <area shape="rect" id="node3" href="wx.MetafileDC.html" title="wx.MetafileDC" alt="" coords="5,160,115,189"/> </map> 
   </p>

|


|method_summary| Methods Summary
================================

================================================================================ ================================================================================
:meth:`~wx.MetafileDC.__init__`                                                  Constructor.
:meth:`~wx.MetafileDC.Close`                                                     This must be called after the device context is finished with.
================================================================================ ================================================================================


|


|api| Class API
===============


.. class:: wx.MetafileDC(DC)

   **Possible constructors**::

       MetafileDC(filename=EmptyString)
       
   
   This is a type of device context that allows a metafile object to be
   created (Windows only), and has most of the characteristics of a
   normal DC.



   .. method:: __init__(self, filename=EmptyString)

      Constructor.                  

      If no filename is passed, the metafile is created in memory.                  


      :param `filename`: 
      :type `filename`: string







   .. method:: Close(self)

      This must be called after the device context is finished with.                  

      A metafile is returned, and ownership of it passes to the calling application (so it should be destroyed explicitly).                  

      :rtype: :ref:`wx.Metafile`