X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/f6106dae23c334c30e5e1f2f0763468f61ecce55..3694bb76c11d1ed1518f20a42f8907c948e190bd:/docs/latex/wx/bmphand.tex diff --git a/docs/latex/wx/bmphand.tex b/docs/latex/wx/bmphand.tex index 3ba255350b..86aa92b95f 100644 --- a/docs/latex/wx/bmphand.tex +++ b/docs/latex/wx/bmphand.tex @@ -17,28 +17,32 @@ application initialisation. +\wxheading{Library} + +\helpref{wxCore}{librarieslist} + \wxheading{See also} \helpref{wxBitmap}{wxbitmap}, \helpref{wxIcon}{wxicon}, \helpref{wxCursor}{wxcursor} \latexignore{\rtfignore{\wxheading{Members}}} -\membersection{wxBitmapHandler::wxBitmapHandler}\label{wxbitmaphandlerconstr} +\membersection{wxBitmapHandler::wxBitmapHandler}\label{wxbitmaphandlerctor} \func{}{wxBitmapHandler}{\void} Default constructor. In your own default constructor, initialise the members m\_name, m\_extension and m\_type. -\membersection{wxBitmapHandler::\destruct{wxBitmapHandler}} +\membersection{wxBitmapHandler::\destruct{wxBitmapHandler}}\label{wxbitmaphandlerdtor} \func{}{\destruct{wxBitmapHandler}}{\void} Destroys the wxBitmapHandler object. -\membersection{wxBitmapHandler::Create} +\membersection{wxBitmapHandler::Create}\label{wxbitmaphandlercreate} -\func{virtual bool}{Create}{\param{wxBitmap* }{bitmap}, \param{void*}{ data}, \param{int}{ type}, \param{int}{ width}, \param{int}{ height}, \param{int}{ depth = -1}} +\func{virtual bool}{Create}{\param{wxBitmap* }{bitmap}, \param{const void*}{ data}, \param{int}{ type}, \param{int}{ width}, \param{int}{ height}, \param{int}{ depth = -1}} Creates a bitmap from the given data, which can be of arbitrary type. The wxBitmap object {\it bitmap} is manipulated by this function. @@ -55,26 +59,26 @@ manipulated by this function. \docparam{data}{Data whose type depends on the value of {\it type}.} -\docparam{type}{A bitmap type identifier - see \helpref{wxBitmapHandler::wxBitmapHandler}{wxbitmapconstr} for a list +\docparam{type}{A bitmap type identifier - see \helpref{wxBitmapHandler::wxBitmapHandler}{wxbitmapctor} for a list of possible values.} \wxheading{Return value} -TRUE if the call succeeded, FALSE otherwise (the default). +true if the call succeeded, false otherwise (the default). -\membersection{wxBitmapHandler::GetName} +\membersection{wxBitmapHandler::GetName}\label{wxbitmaphandlergetname} -\constfunc{wxString}{GetName}{\void} +\constfunc{const wxString\&}{ GetName}{\void} Gets the name of this handler. -\membersection{wxBitmapHandler::GetExtension} +\membersection{wxBitmapHandler::GetExtension}\label{wxbitmaphandlergetextension} -\constfunc{wxString}{GetExtension}{\void} +\constfunc{const wxString\&}{ GetExtension}{\void} Gets the file extension associated with this handler. -\membersection{wxBitmapHandler::GetType} +\membersection{wxBitmapHandler::GetType}\label{wxbitmaphandlergettype} \constfunc{long}{GetType}{\void} @@ -93,11 +97,11 @@ Loads a bitmap from a file or resource, putting the resulting data into {\it bit \docparam{name}{Either a filename or a Windows resource name. The meaning of {\it name} is determined by the {\it type} parameter.} -\docparam{type}{See \helpref{wxBitmap::wxBitmap}{wxbitmapconstr} for values this can take.} +\docparam{type}{See \helpref{wxBitmap::wxBitmap}{wxbitmapctor} for values this can take.} \wxheading{Return value} -TRUE if the operation succeeded, FALSE otherwise. +true if the operation succeeded, false otherwise. \wxheading{See also} @@ -117,13 +121,13 @@ Saves a bitmap in the named file. \docparam{name}{A filename. The meaning of {\it name} is determined by the {\it type} parameter.} -\docparam{type}{See \helpref{wxBitmap::wxBitmap}{wxbitmapconstr} for values this can take.} +\docparam{type}{See \helpref{wxBitmap::wxBitmap}{wxbitmapctor} for values this can take.} \docparam{palette}{An optional palette used for saving the bitmap.} \wxheading{Return value} -TRUE if the operation succeeded, FALSE otherwise. +true if the operation succeeded, false otherwise. \wxheading{See also} @@ -131,7 +135,7 @@ TRUE if the operation succeeded, FALSE otherwise. \helpref{wxBitmap::SaveFile}{wxbitmapsavefile}\\ \helpref{wxBitmapHandler::LoadFile}{wxbitmaphandlerloadfile} -\membersection{wxBitmapHandler::SetName} +\membersection{wxBitmapHandler::SetName}\label{wxbitmaphandlersetname} \func{void}{SetName}{\param{const wxString\& }{name}} @@ -141,7 +145,7 @@ Sets the handler name. \docparam{name}{Handler name.} -\membersection{wxBitmapHandler::SetExtension} +\membersection{wxBitmapHandler::SetExtension}\label{wxbitmaphandlersetextension} \func{void}{SetExtension}{\param{const wxString\& }{extension}} @@ -151,7 +155,7 @@ Sets the handler extension. \docparam{extension}{Handler extension.} -\membersection{wxBitmapHandler::SetType} +\membersection{wxBitmapHandler::SetType}\label{wxbitmaphandlersettype} \func{void}{SetType}{\param{long }{type}}