X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/e54c96f187f46c06bd36be8cd52b35c19884aa2b..7c0d297a1f761de31d3a4ac924fa2080b5bbaf41:/interface/metafile.h diff --git a/interface/metafile.h b/interface/metafile.h index 78b060ed68..f994f22cec 100644 --- a/interface/metafile.h +++ b/interface/metafile.h @@ -117,31 +117,40 @@ public: // Global functions/macros // ============================================================================ +/** @ingroup group_funcmacro_gdi */ +//@{ + /** Given a filename for an existing, valid metafile (as constructed using - wxMetafileDC) - makes it into a placeable metafile by prepending a header containing the given - bounding box. The bounding box may be obtained from a device context after - drawing - into it, using the functions wxDC::MinX, wxDC::MinY, wxDC::MaxX and wxDC::MaxY. - In addition to adding the placeable metafile header, this function adds - the equivalent of the following code to the start of the metafile data: + wxMetafileDC) makes it into a placeable metafile by prepending a header + containing the given bounding box. The bounding box may be obtained from a + device context after drawing into it, using the functions wxDC::MinX(), + wxDC::MinY(), wxDC::MaxX() and wxDC::MaxY(). + + In addition to adding the placeable metafile header, this function adds the + equivalent of the following code to the start of the metafile data: @code SetMapMode(dc, MM_ANISOTROPIC); - SetWindowOrg(dc, minX, minY); - SetWindowExt(dc, maxX - minX, maxY - minY); + SetWindowOrg(dc, minX, minY); + SetWindowExt(dc, maxX - minX, maxY - minY); @endcode This simulates the wxMM_TEXT mapping mode, which wxWidgets assumes. - Placeable metafiles may be imported by many Windows applications, and can be - used in RTF (Rich Text Format) files. + + Placeable metafiles may be imported by many Windows applications, and can + be used in RTF (Rich Text Format) files. + @a scale allows the specification of scale for the metafile. + This function is only available under Windows. + + @header{wx/metafile.h} */ -bool wxMakeMetafilePlaceable(const wxString& filename, int minX, - int minY, - int maxX, - int maxY, - float scale = 1.0); +bool wxMakeMetafilePlaceable(const wxString& filename, + int minX, int minY, + int maxX, int maxY, + float scale = 1.0); + +//@}