]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/metafile.tex
Added font setting and ability to determine AUI notebook height for a given page...
[wxWidgets.git] / docs / latex / wx / metafile.tex
index 338d410ab5babd293ad3aca0d88c7cff1131dab9..26c0c472029ca2e3aa03821d175b96b4069f910d 100644 (file)
@@ -1,7 +1,7 @@
 \section{\class{wxMetafile}}\label{wxmetafile}
 
 A {\bf wxMetafile} represents the MS Windows metafile object, so metafile
-operations have no effect in X. In wxWindows, only sufficient functionality
+operations have no effect in X. In wxWidgets, only sufficient functionality
 has been provided for copying a graphic to the clipboard; this may be extended
 in a future version. Presently, the only way of creating a metafile
 is to use a wxMetafileDC.
@@ -10,40 +10,45 @@ is to use a wxMetafileDC.
 
 \helpref{wxObject}{wxobject}
 
+\wxheading{Include files}
+
+<wx/metafile.h>
+
 \wxheading{See also}
 
 \helpref{wxMetafileDC}{wxmetafiledc}
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
-\membersection{wxMetafile::wxMetafile}
+\membersection{wxMetafile::wxMetafile}\label{wxmetafilector}
 
 \func{}{wxMetafile}{\param{const wxString\& }{filename = ""}}
 
 Constructor. If a filename is given, the Windows disk metafile is
 read in. Check whether this was performed successfully by
-using the \helpref{wxMetafile::Ok}{wxmetafileok} member.
+using the \helpref{wxMetafile:IsOk}{wxmetafileisok} member.
 
-\membersection{wxMetafile::\destruct{wxMetafile}}
+\membersection{wxMetafile::\destruct{wxMetafile}}\label{wxmetafiledtor}
 
 \func{}{\destruct{wxMetafile}}{\void}
 
 Destructor.
+See \helpref{reference-counted object destruction}{refcountdestruct} for more info.
 
-\membersection{wxMetafile::Ok}\label{wxmetafileok}
+\membersection{wxMetafile::IsOk}\label{wxmetafileisok}
 
 \func{bool}{Ok}{\void}
 
-Returns TRUE if the metafile is valid.
+Returns true if the metafile is valid.
 
 \membersection{wxMetafile::Play}\label{wxmetafileplay}
 
 \func{bool}{Play}{\param{wxDC *}{dc}}
 
 Plays the metafile into the given device context, returning
-TRUE if successful.
+true if successful.
 
-\membersection{wxMetafile::SetClipboard}
+\membersection{wxMetafile::SetClipboard}\label{wxmetafilesetclipboard}
 
 \func{bool}{SetClipboard}{\param{int}{ width = 0}, \param{int}{ height = 0}}
 
@@ -51,7 +56,7 @@ Passes the metafile data to the clipboard. The metafile can no longer be
 used for anything, but the wxMetafile object must still be destroyed by
 the application.
 
-Below is a example of metafle, metafile device context and clipboard use
+Below is a example of metafile, metafile device context and clipboard use
 from the {\tt hello.cpp} example. Note the way the metafile dimensions
 are passed to the clipboard, making use of the device context's ability
 to keep track of the maximum extent of drawing commands.
@@ -60,7 +65,7 @@ to keep track of the maximum extent of drawing commands.
   wxMetafileDC dc;
   if (dc.Ok())
   {
-    Draw(dc, FALSE);
+    Draw(dc, false);
     wxMetafile *mf = dc.Close();
     if (mf)
     {
@@ -94,20 +99,24 @@ closing your disk-based metafile device context.
 \helpref{wxDC}{wxdc}\\
 \helpref{wxObject}{wxobject}
 
+\wxheading{Include files}
+
+<wx/metafile.h>
+
 \wxheading{See also}
 
 \helpref{wxMetafile}{wxmetafile}, \helpref{wxDC}{wxdc}
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
-\membersection{wxMetafileDC::wxMetafileDC}
+\membersection{wxMetafileDC::wxMetafileDC}\label{wxmetafiledcctor}
 
 \func{}{wxMetafileDC}{\param{const wxString\& }{filename = ""}}
 
 Constructor. If no filename is passed, the metafile is created
 in memory.
 
-\membersection{wxMetafileDC::\destruct{wxMetafileDC}}
+\membersection{wxMetafileDC::\destruct{wxMetafileDC}}\label{wxmetafiledcdtor}
 
 \func{}{\destruct{wxMetafileDC}}{\void}