]> git.saurik.com Git - wxWidgets.git/blob - include/wx/msw/metafile.h
Add doc for wxCliboard::Get
[wxWidgets.git] / include / wx / msw / metafile.h
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: wx/msw/metafile.h
3 // Purpose: wxMetaFile, wxMetaFileDC and wxMetaFileDataObject classes
4 // Author: Julian Smart
5 // Modified by: VZ 07.01.00: implemented wxMetaFileDataObject
6 // Created: 01/02/97
7 // RCS-ID: $Id$
8 // Copyright: (c) Julian Smart
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
11
12 #ifndef _WX_METAFIILE_H_
13 #define _WX_METAFIILE_H_
14
15 #include "wx/dc.h"
16 #include "wx/gdiobj.h"
17
18 #if wxUSE_DRAG_AND_DROP
19 #include "wx/dataobj.h"
20 #endif
21
22 // ----------------------------------------------------------------------------
23 // Metafile and metafile device context classes
24 // ----------------------------------------------------------------------------
25
26 class WXDLLIMPEXP_FWD_CORE wxMetafile;
27
28 class WXDLLIMPEXP_CORE wxMetafileRefData: public wxGDIRefData
29 {
30 public:
31 wxMetafileRefData();
32 virtual ~wxMetafileRefData();
33
34 virtual bool IsOk() const { return m_metafile != 0; }
35
36 public:
37 WXHANDLE m_metafile;
38 int m_windowsMappingMode;
39 int m_width, m_height;
40
41 friend class WXDLLIMPEXP_FWD_CORE wxMetafile;
42 };
43
44 #define M_METAFILEDATA ((wxMetafileRefData *)m_refData)
45
46 class WXDLLIMPEXP_CORE wxMetafile: public wxGDIObject
47 {
48 public:
49 wxMetafile(const wxString& file = wxEmptyString);
50 virtual ~wxMetafile();
51
52 // After this is called, the metafile cannot be used for anything
53 // since it is now owned by the clipboard.
54 virtual bool SetClipboard(int width = 0, int height = 0);
55
56 virtual bool Play(wxDC *dc);
57
58 // set/get the size of metafile for clipboard operations
59 wxSize GetSize() const { return wxSize(GetWidth(), GetHeight()); }
60 int GetWidth() const { return M_METAFILEDATA->m_width; }
61 int GetHeight() const { return M_METAFILEDATA->m_height; }
62
63 void SetWidth(int width) { M_METAFILEDATA->m_width = width; }
64 void SetHeight(int height) { M_METAFILEDATA->m_height = height; }
65
66 // Implementation
67 WXHANDLE GetHMETAFILE() const { return M_METAFILEDATA->m_metafile; }
68 void SetHMETAFILE(WXHANDLE mf) ;
69 int GetWindowsMappingMode() const { return M_METAFILEDATA->m_windowsMappingMode; }
70 void SetWindowsMappingMode(int mm);
71
72 protected:
73 virtual wxGDIRefData *CreateGDIRefData() const;
74 virtual wxGDIRefData *CloneGDIRefData(const wxGDIRefData *data) const;
75
76 private:
77 DECLARE_DYNAMIC_CLASS(wxMetafile)
78 };
79
80 class WXDLLIMPEXP_CORE wxMetafileDCImpl: public wxMSWDCImpl
81 {
82 public:
83 wxMetafileDCImpl(wxDC *owner, const wxString& file = wxEmptyString);
84 wxMetafileDCImpl(wxDC *owner, const wxString& file,
85 int xext, int yext, int xorg, int yorg);
86 virtual ~wxMetafileDCImpl();
87
88 virtual wxMetafile *Close();
89 virtual void SetMapMode(wxMappingMode mode);
90 virtual void DoGetTextExtent(const wxString& string,
91 wxCoord *x, wxCoord *y,
92 wxCoord *descent = NULL,
93 wxCoord *externalLeading = NULL,
94 const wxFont *theFont = NULL) const;
95
96 // Implementation
97 wxMetafile *GetMetaFile() const { return m_metaFile; }
98 void SetMetaFile(wxMetafile *mf) { m_metaFile = mf; }
99 int GetWindowsMappingMode() const { return m_windowsMappingMode; }
100 void SetWindowsMappingMode(int mm) { m_windowsMappingMode = mm; }
101
102 protected:
103 virtual void DoGetSize(int *width, int *height) const;
104
105 int m_windowsMappingMode;
106 wxMetafile* m_metaFile;
107
108 private:
109 DECLARE_CLASS(wxMetafileDCImpl)
110 wxDECLARE_NO_COPY_CLASS(wxMetafileDCImpl);
111 };
112
113 class WXDLLIMPEXP_CORE wxMetafileDC: public wxDC
114 {
115 public:
116 // Don't supply origin and extent
117 // Supply them to wxMakeMetaFilePlaceable instead.
118 wxMetafileDC(const wxString& file)
119 : wxDC(new wxMetafileDCImpl( this, file ))
120 { }
121
122 // Supply origin and extent (recommended).
123 // Then don't need to supply them to wxMakeMetaFilePlaceable.
124 wxMetafileDC(const wxString& file, int xext, int yext, int xorg, int yorg)
125 : wxDC(new wxMetafileDCImpl( this, file, xext, yext, xorg, yorg ))
126 { }
127
128 wxMetafile *GetMetafile() const
129 { return ((wxMetafileDCImpl*)m_pimpl)->GetMetaFile(); }
130
131 wxMetafile *Close()
132 { return ((wxMetafileDCImpl*)m_pimpl)->Close(); }
133
134 private:
135 DECLARE_CLASS(wxMetafileDC)
136 wxDECLARE_NO_COPY_CLASS(wxMetafileDC);
137 };
138
139
140
141
142 /*
143 * Pass filename of existing non-placeable metafile, and bounding box.
144 * Adds a placeable metafile header, sets the mapping mode to anisotropic,
145 * and sets the window origin and extent to mimic the wxMM_TEXT mapping mode.
146 *
147 */
148
149 // No origin or extent
150 bool WXDLLIMPEXP_CORE wxMakeMetafilePlaceable(const wxString& filename, float scale = 1.0);
151
152 // Optional origin and extent
153 bool WXDLLIMPEXP_CORE wxMakeMetaFilePlaceable(const wxString& filename, int x1, int y1, int x2, int y2, float scale = 1.0, bool useOriginAndExtent = true);
154
155 // ----------------------------------------------------------------------------
156 // wxMetafileDataObject is a specialization of wxDataObject for metafile data
157 // ----------------------------------------------------------------------------
158
159 #if wxUSE_DRAG_AND_DROP
160
161 class WXDLLIMPEXP_CORE wxMetafileDataObject : public wxDataObjectSimple
162 {
163 public:
164 // ctors
165 wxMetafileDataObject() : wxDataObjectSimple(wxDF_METAFILE)
166 { }
167 wxMetafileDataObject(const wxMetafile& metafile)
168 : wxDataObjectSimple(wxDF_METAFILE), m_metafile(metafile) { }
169
170 // virtual functions which you may override if you want to provide data on
171 // demand only - otherwise, the trivial default versions will be used
172 virtual void SetMetafile(const wxMetafile& metafile)
173 { m_metafile = metafile; }
174 virtual wxMetafile GetMetafile() const
175 { return m_metafile; }
176
177 // implement base class pure virtuals
178 virtual size_t GetDataSize() const;
179 virtual bool GetDataHere(void *buf) const;
180 virtual bool SetData(size_t len, const void *buf);
181
182 protected:
183 wxMetafile m_metafile;
184 };
185
186 #endif // wxUSE_DRAG_AND_DROP
187
188 #endif
189 // _WX_METAFIILE_H_
190