X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/954b8ae60391d18b87a604e7919c87c0c6ae208b..097119648b492237f16acdf484eff8900c7c94d2:/docs/latex/wx/metafile.tex diff --git a/docs/latex/wx/metafile.tex b/docs/latex/wx/metafile.tex index 394496c3b4..90d9181fe7 100644 --- a/docs/latex/wx/metafile.tex +++ b/docs/latex/wx/metafile.tex @@ -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. @@ -14,40 +14,45 @@ is to use a wxMetafileDC. +\wxheading{Library} + +\helpref{wxCore}{librarieslist} + \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}} @@ -55,7 +60,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. @@ -64,7 +69,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) { @@ -102,20 +107,24 @@ closing your disk-based metafile device context. +\wxheading{Library} + +\helpref{wxCore}{librarieslist} + \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}