]>
git.saurik.com Git - wxWidgets.git/blob - interface/metafile.h
1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: interface of wxMetafileDC
4 // Author: wxWidgets team
6 // Licence: wxWindows license
7 /////////////////////////////////////////////////////////////////////////////
13 This is a type of device context that allows a metafile object to be
14 created (Windows only), and has most of the characteristics of a normal
15 @b wxDC. The wxMetafileDC::Close member must be called after drawing into the
16 device context, to return a metafile. The only purpose for this at
17 present is to allow the metafile to be copied to the clipboard (see wxMetafile).
19 Adding metafile capability to an application should be easy if you
20 already write to a wxDC; simply pass the wxMetafileDC to your drawing
21 function instead. You may wish to conditionally compile this code so it
22 is not compiled under X (although no harm will result if you leave it
25 Note that a metafile saved to disk is in standard Windows metafile format,
26 and cannot be imported into most applications. To make it importable,
27 call the function ::wxMakeMetafilePlaceable after
28 closing your disk-based metafile device context.
35 class wxMetafileDC
: public wxDC
39 Constructor. If no filename is passed, the metafile is created
42 wxMetafileDC(const wxString
& filename
= "");
50 This must be called after the device context is finished with. A
51 metafile is returned, and ownership of it passes to the calling
52 application (so it should be destroyed explicitly).
63 A @b wxMetafile represents the MS Windows metafile object, so metafile
64 operations have no effect in X. In wxWidgets, only sufficient functionality
65 has been provided for copying a graphic to the clipboard; this may be extended
66 in a future version. Presently, the only way of creating a metafile
67 is to use a wxMetafileDC.
74 class wxMetafile
: public wxObject
78 Constructor. If a filename is given, the Windows disk metafile is
79 read in. Check whether this was performed successfully by
80 using the @ref isok() wxMetafile:IsOk member.
82 wxMetafile(const wxString
& filename
= "");
86 See @ref overview_refcountdestruct "reference-counted object destruction" for
92 Returns @true if the metafile is valid.
97 Plays the metafile into the given device context, returning
103 Passes the metafile data to the clipboard. The metafile can no longer be
104 used for anything, but the wxMetafile object must still be destroyed by
106 Below is a example of metafile, metafile device context and clipboard use
107 from the @c hello.cpp example. Note the way the metafile dimensions
108 are passed to the clipboard, making use of the device context's ability
109 to keep track of the maximum extent of drawing commands.
111 bool SetClipboard(int width
= 0, int height
= 0);
116 // ============================================================================
117 // Global functions/macros
118 // ============================================================================
120 /** @addtogroup group_gdi */
124 @header{wx/metafile.h}
126 Given a filename for an existing, valid metafile (as constructed using
127 wxMetafileDC) makes it into a placeable metafile by prepending a header
128 containing the given bounding box. The bounding box may be obtained from a
129 device context after drawing into it, using the functions wxDC::MinX(),
130 wxDC::MinY(), wxDC::MaxX() and wxDC::MaxY(). In addition to adding the
131 placeable metafile header, this function adds the equivalent of the
132 following code to the start of the metafile data:
135 SetMapMode(dc, MM_ANISOTROPIC);
136 SetWindowOrg(dc, minX, minY);
137 SetWindowExt(dc, maxX - minX, maxY - minY);
140 This simulates the wxMM_TEXT mapping mode, which wxWidgets assumes.
141 Placeable metafiles may be imported by many Windows applications, and can
142 be used in RTF (Rich Text Format) files. @a scale allows the specification
143 of scale for the metafile. This function is only available under Windows.
145 bool wxMakeMetafilePlaceable(const wxString
& filename
, int minX
,