changed wxDC::GetTextExtent() and related methods to take const wxFont pointer, for...
[wxWidgets.git] / src / msw / metafile.cpp
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: src/msw/metafile.cpp
3 // Purpose: wxMetafileDC etc.
4 // Author: Julian Smart
5 // Modified by: VZ 07.01.00: implemented wxMetaFileDataObject
6 // Created: 04/01/98
7 // RCS-ID: $Id$
8 // Copyright: (c) Julian Smart
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
11
12 // ============================================================================
13 // declarations
14 // ============================================================================
15
16 // ----------------------------------------------------------------------------
17 // headers
18 // ----------------------------------------------------------------------------
19
20 // For compilers that support precompilation, includes "wx.h".
21 #include "wx/wxprec.h"
22
23 #ifdef __BORLANDC__
24 #pragma hdrstop
25 #endif
26
27 #ifndef WX_PRECOMP
28 #include "wx/utils.h"
29 #include "wx/app.h"
30 #endif
31
32 #include "wx/metafile.h"
33
34 #if wxUSE_METAFILE && !defined(wxMETAFILE_IS_ENH)
35
36 #include "wx/clipbrd.h"
37 #include "wx/msw/private.h"
38
39 #include <stdio.h>
40 #include <string.h>
41
42 // ----------------------------------------------------------------------------
43 // wxWin macros
44 // ----------------------------------------------------------------------------
45
46 IMPLEMENT_DYNAMIC_CLASS(wxMetafile, wxObject)
47 IMPLEMENT_ABSTRACT_CLASS(wxMetafileDC, wxDC)
48
49 // ============================================================================
50 // implementation
51 // ============================================================================
52
53 // ----------------------------------------------------------------------------
54 // wxMetafileRefData
55 // ----------------------------------------------------------------------------
56
57 /*
58 * Metafiles
59 * Currently, the only purpose for making a metafile is to put
60 * it on the clipboard.
61 */
62
63 wxMetafileRefData::wxMetafileRefData()
64 {
65 m_metafile = 0;
66 m_windowsMappingMode = wxMM_ANISOTROPIC;
67 m_width = m_height = 0;
68 }
69
70 wxMetafileRefData::~wxMetafileRefData()
71 {
72 if (m_metafile)
73 {
74 DeleteMetaFile((HMETAFILE) m_metafile);
75 m_metafile = 0;
76 }
77 }
78
79 // ----------------------------------------------------------------------------
80 // wxMetafile
81 // ----------------------------------------------------------------------------
82
83 wxMetafile::wxMetafile(const wxString& file)
84 {
85 m_refData = new wxMetafileRefData;
86
87 M_METAFILEDATA->m_windowsMappingMode = wxMM_ANISOTROPIC;
88 M_METAFILEDATA->m_metafile = 0;
89 if (!file.empty())
90 M_METAFILEDATA->m_metafile = (WXHANDLE) GetMetaFile(file);
91 }
92
93 wxMetafile::~wxMetafile()
94 {
95 }
96
97 bool wxMetafile::SetClipboard(int width, int height)
98 {
99 #if !wxUSE_CLIPBOARD
100 return false;
101 #else
102 if (!m_refData)
103 return false;
104
105 bool alreadyOpen = wxClipboardOpen();
106 if (!alreadyOpen)
107 {
108 wxOpenClipboard();
109 if (!wxEmptyClipboard())
110 return false;
111 }
112 bool success = wxSetClipboardData(wxDF_METAFILE, this, width,height);
113 if (!alreadyOpen)
114 wxCloseClipboard();
115
116 return success;
117 #endif
118 }
119
120 bool wxMetafile::Play(wxDC *dc)
121 {
122 if (!m_refData)
123 return false;
124
125 if (dc->GetHDC() && M_METAFILEDATA->m_metafile)
126 {
127 if ( !::PlayMetaFile(GetHdcOf(*dc), (HMETAFILE)
128 M_METAFILEDATA->m_metafile) )
129 {
130 wxLogLastError(_T("PlayMetaFile"));
131 }
132 }
133
134 return true;
135 }
136
137 void wxMetafile::SetHMETAFILE(WXHANDLE mf)
138 {
139 if (!m_refData)
140 m_refData = new wxMetafileRefData;
141
142 M_METAFILEDATA->m_metafile = mf;
143 }
144
145 void wxMetafile::SetWindowsMappingMode(int mm)
146 {
147 if (!m_refData)
148 m_refData = new wxMetafileRefData;
149
150 M_METAFILEDATA->m_windowsMappingMode = mm;
151 }
152
153 // ----------------------------------------------------------------------------
154 // Metafile device context
155 // ----------------------------------------------------------------------------
156
157 // Original constructor that does not takes origin and extent. If you use this,
158 // *DO* give origin/extent arguments to wxMakeMetafilePlaceable.
159 wxMetafileDC::wxMetafileDC(const wxString& file)
160 {
161 m_metaFile = NULL;
162 m_minX = 10000;
163 m_minY = 10000;
164 m_maxX = -10000;
165 m_maxY = -10000;
166 // m_title = NULL;
167
168 if (!file.IsNull() && wxFileExists(file))
169 wxRemoveFile(file);
170
171 if (!file.IsNull() && (file != wxEmptyString))
172 m_hDC = (WXHDC) CreateMetaFile(file);
173 else
174 m_hDC = (WXHDC) CreateMetaFile(NULL);
175
176 m_ok = (m_hDC != (WXHDC) 0) ;
177
178 // Actual Windows mapping mode, for future reference.
179 m_windowsMappingMode = wxMM_TEXT;
180
181 SetMapMode(wxMM_TEXT); // NOTE: does not set HDC mapmode (this is correct)
182 }
183
184 // New constructor that takes origin and extent. If you use this, don't
185 // give origin/extent arguments to wxMakeMetafilePlaceable.
186 wxMetafileDC::wxMetafileDC(const wxString& file, int xext, int yext, int xorg, int yorg)
187 {
188 m_minX = 10000;
189 m_minY = 10000;
190 m_maxX = -10000;
191 m_maxY = -10000;
192 if ( !file.empty() && wxFileExists(file) )
193 wxRemoveFile(file);
194 m_hDC = (WXHDC) CreateMetaFile(file.empty() ? NULL : file.c_str());
195
196 m_ok = true;
197
198 ::SetWindowOrgEx((HDC) m_hDC,xorg,yorg, NULL);
199 ::SetWindowExtEx((HDC) m_hDC,xext,yext, NULL);
200
201 // Actual Windows mapping mode, for future reference.
202 m_windowsMappingMode = wxMM_ANISOTROPIC;
203
204 SetMapMode(wxMM_TEXT); // NOTE: does not set HDC mapmode (this is correct)
205 }
206
207 wxMetafileDC::~wxMetafileDC()
208 {
209 m_hDC = 0;
210 }
211
212 void wxMetafileDC::GetTextExtent(const wxString& string, long *x, long *y,
213 long *descent, long *externalLeading,
214 const wxFont *theFont,
215 bool WXUNUSED(use16bit)) const
216 {
217 const wxFont *fontToUse = theFont;
218 if (!fontToUse)
219 fontToUse = &m_font;
220
221 HDC dc = GetDC(NULL);
222
223 SIZE sizeRect;
224 TEXTMETRIC tm;
225 ::GetTextExtentPoint32(dc, WXSTRINGCAST string, wxStrlen(WXSTRINGCAST string), &sizeRect);
226 GetTextMetrics(dc, &tm);
227
228 ReleaseDC(NULL, dc);
229
230 if ( x )
231 *x = sizeRect.cx;
232 if ( y )
233 *y = sizeRect.cy;
234 if ( descent )
235 *descent = tm.tmDescent;
236 if ( externalLeading )
237 *externalLeading = tm.tmExternalLeading;
238 }
239
240 void wxMetafileDC::DoGetSize(int *width, int *height) const
241 {
242 wxCHECK_RET( m_refData, _T("invalid wxMetafileDC") );
243
244 if ( width )
245 *width = M_METAFILEDATA->m_width;
246 if ( height )
247 *height = M_METAFILEDATA->m_height;
248 }
249
250 wxMetafile *wxMetafileDC::Close()
251 {
252 SelectOldObjects(m_hDC);
253 HANDLE mf = CloseMetaFile((HDC) m_hDC);
254 m_hDC = 0;
255 if (mf)
256 {
257 wxMetafile *wx_mf = new wxMetafile;
258 wx_mf->SetHMETAFILE((WXHANDLE) mf);
259 wx_mf->SetWindowsMappingMode(m_windowsMappingMode);
260 return wx_mf;
261 }
262 return NULL;
263 }
264
265 void wxMetafileDC::SetMapMode(int mode)
266 {
267 m_mappingMode = mode;
268
269 // int pixel_width = 0;
270 // int pixel_height = 0;
271 // int mm_width = 0;
272 // int mm_height = 0;
273
274 float mm2pixelsX = 10.0;
275 float mm2pixelsY = 10.0;
276
277 switch (mode)
278 {
279 case wxMM_TWIPS:
280 {
281 m_logicalScaleX = (float)(twips2mm * mm2pixelsX);
282 m_logicalScaleY = (float)(twips2mm * mm2pixelsY);
283 break;
284 }
285 case wxMM_POINTS:
286 {
287 m_logicalScaleX = (float)(pt2mm * mm2pixelsX);
288 m_logicalScaleY = (float)(pt2mm * mm2pixelsY);
289 break;
290 }
291 case wxMM_METRIC:
292 {
293 m_logicalScaleX = mm2pixelsX;
294 m_logicalScaleY = mm2pixelsY;
295 break;
296 }
297 case wxMM_LOMETRIC:
298 {
299 m_logicalScaleX = (float)(mm2pixelsX/10.0);
300 m_logicalScaleY = (float)(mm2pixelsY/10.0);
301 break;
302 }
303 default:
304 case wxMM_TEXT:
305 {
306 m_logicalScaleX = 1.0;
307 m_logicalScaleY = 1.0;
308 break;
309 }
310 }
311 }
312
313 // ----------------------------------------------------------------------------
314 // wxMakeMetafilePlaceable
315 // ----------------------------------------------------------------------------
316
317 #ifdef __WIN32__
318 struct RECT32
319 {
320 short left;
321 short top;
322 short right;
323 short bottom;
324 };
325
326 struct mfPLACEABLEHEADER {
327 DWORD key;
328 short hmf;
329 RECT32 bbox;
330 WORD inch;
331 DWORD reserved;
332 WORD checksum;
333 };
334 #else
335 struct mfPLACEABLEHEADER {
336 DWORD key;
337 HANDLE hmf;
338 RECT bbox;
339 WORD inch;
340 DWORD reserved;
341 WORD checksum;
342 };
343 #endif
344
345 /*
346 * Pass filename of existing non-placeable metafile, and bounding box.
347 * Adds a placeable metafile header, sets the mapping mode to anisotropic,
348 * and sets the window origin and extent to mimic the wxMM_TEXT mapping mode.
349 *
350 */
351
352 bool wxMakeMetafilePlaceable(const wxString& filename, float scale)
353 {
354 return wxMakeMetafilePlaceable(filename, 0, 0, 0, 0, scale, false);
355 }
356
357 bool wxMakeMetafilePlaceable(const wxString& filename, int x1, int y1, int x2, int y2, float scale, bool useOriginAndExtent)
358 {
359 // I'm not sure if this is the correct way of suggesting a scale
360 // to the client application, but it's the only way I can find.
361 int unitsPerInch = (int)(576/scale);
362
363 mfPLACEABLEHEADER header;
364 header.key = 0x9AC6CDD7L;
365 header.hmf = 0;
366 header.bbox.left = (int)(x1);
367 header.bbox.top = (int)(y1);
368 header.bbox.right = (int)(x2);
369 header.bbox.bottom = (int)(y2);
370 header.inch = unitsPerInch;
371 header.reserved = 0;
372
373 // Calculate checksum
374 WORD *p;
375 mfPLACEABLEHEADER *pMFHead = &header;
376 for (p =(WORD *)pMFHead,pMFHead -> checksum = 0;
377 p < (WORD *)&pMFHead ->checksum; ++p)
378 pMFHead ->checksum ^= *p;
379
380 FILE *fd = wxFopen(filename.fn_str(), _T("rb"));
381 if (!fd) return false;
382
383 wxChar tempFileBuf[256];
384 wxGetTempFileName(wxT("mf"), tempFileBuf);
385 FILE *fHandle = wxFopen(wxFNCONV(tempFileBuf), _T("wb"));
386 if (!fHandle)
387 return false;
388 fwrite((void *)&header, sizeof(unsigned char), sizeof(mfPLACEABLEHEADER), fHandle);
389
390 // Calculate origin and extent
391 int originX = x1;
392 int originY = y1;
393 int extentX = x2 - x1;
394 int extentY = (y2 - y1);
395
396 // Read metafile header and write
397 METAHEADER metaHeader;
398 fread((void *)&metaHeader, sizeof(unsigned char), sizeof(metaHeader), fd);
399
400 if (useOriginAndExtent)
401 metaHeader.mtSize += 15;
402 else
403 metaHeader.mtSize += 5;
404
405 fwrite((void *)&metaHeader, sizeof(unsigned char), sizeof(metaHeader), fHandle);
406
407 // Write SetMapMode, SetWindowOrigin and SetWindowExt records
408 char modeBuffer[8];
409 char originBuffer[10];
410 char extentBuffer[10];
411 METARECORD *modeRecord = (METARECORD *)&modeBuffer;
412
413 METARECORD *originRecord = (METARECORD *)&originBuffer;
414 METARECORD *extentRecord = (METARECORD *)&extentBuffer;
415
416 modeRecord->rdSize = 4;
417 modeRecord->rdFunction = META_SETMAPMODE;
418 modeRecord->rdParm[0] = MM_ANISOTROPIC;
419
420 originRecord->rdSize = 5;
421 originRecord->rdFunction = META_SETWINDOWORG;
422 originRecord->rdParm[0] = originY;
423 originRecord->rdParm[1] = originX;
424
425 extentRecord->rdSize = 5;
426 extentRecord->rdFunction = META_SETWINDOWEXT;
427 extentRecord->rdParm[0] = extentY;
428 extentRecord->rdParm[1] = extentX;
429
430 fwrite((void *)modeBuffer, sizeof(char), 8, fHandle);
431
432 if (useOriginAndExtent)
433 {
434 fwrite((void *)originBuffer, sizeof(char), 10, fHandle);
435 fwrite((void *)extentBuffer, sizeof(char), 10, fHandle);
436 }
437
438 int ch = -2;
439 while (ch != EOF)
440 {
441 ch = getc(fd);
442 if (ch != EOF)
443 {
444 putc(ch, fHandle);
445 }
446 }
447 fclose(fHandle);
448 fclose(fd);
449 wxRemoveFile(filename);
450 wxCopyFile(tempFileBuf, filename);
451 wxRemoveFile(tempFileBuf);
452 return true;
453 }
454
455
456 #if wxUSE_DRAG_AND_DROP
457
458 // ----------------------------------------------------------------------------
459 // wxMetafileDataObject
460 // ----------------------------------------------------------------------------
461
462 size_t wxMetafileDataObject::GetDataSize() const
463 {
464 return sizeof(METAFILEPICT);
465 }
466
467 bool wxMetafileDataObject::GetDataHere(void *buf) const
468 {
469 METAFILEPICT *mfpict = (METAFILEPICT *)buf;
470 const wxMetafile& mf = GetMetafile();
471
472 wxCHECK_MSG( mf.GetHMETAFILE(), false, _T("copying invalid metafile") );
473
474 // doesn't seem to work with any other mapping mode...
475 mfpict->mm = MM_ANISOTROPIC; //mf.GetWindowsMappingMode();
476 mfpict->xExt = mf.GetWidth();
477 mfpict->yExt = mf.GetHeight();
478
479 // transform the picture size to HIMETRIC units (0.01mm) - as we don't know
480 // what DC the picture will be rendered to, use the default display one
481 PixelToHIMETRIC(&mfpict->xExt, &mfpict->yExt);
482
483 mfpict->hMF = CopyMetaFile((HMETAFILE)mf.GetHMETAFILE(), NULL);
484
485 return true;
486 }
487
488 bool wxMetafileDataObject::SetData(size_t WXUNUSED(len), const void *buf)
489 {
490 const METAFILEPICT *mfpict = (const METAFILEPICT *)buf;
491
492 wxMetafile mf;
493 mf.SetWindowsMappingMode(mfpict->mm);
494
495 LONG w = mfpict->xExt,
496 h = mfpict->yExt;
497 if ( mfpict->mm == MM_ANISOTROPIC )
498 {
499 // in this case xExt and yExt contain suggested size in HIMETRIC units
500 // (0.01 mm) - transform this to something more reasonable (pixels)
501 HIMETRICToPixel(&w, &h);
502 }
503
504 mf.SetWidth(w);
505 mf.SetHeight(h);
506 mf.SetHMETAFILE((WXHANDLE)mfpict->hMF);
507
508 wxCHECK_MSG( mfpict->hMF, false, _T("pasting invalid metafile") );
509
510 SetMetafile(mf);
511
512 return true;
513 }
514
515 #endif // wxUSE_DRAG_AND_DROP
516
517 #endif // wxUSE_METAFILE