]> git.saurik.com Git - wxWidgets.git/blobdiff - interface/metafile.h
Mention default constr
[wxWidgets.git] / interface / metafile.h
index 78b060ed68c7eaa240973d786982d3ad219e3f5a..f994f22cecfb055d25a0737a66fa1d46c6828b88 100644 (file)
@@ -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);
+
+//@}