MF_BYCOMMAND is zero so don't try to test it

[wxWidgets.git] / docs / latex / wx / tbitmap.tex

diff --git a/docs/latex/wx/tbitmap.tex b/docs/latex/wx/tbitmap.tex
index 856b8df22045c166e04b26d2d509372b7bd68bdd..48db4af4e466ceda0ed6ef0ee42558f1c23a61ec 100644 (file)
--- a/docs/latex/wx/tbitmap.tex
+++ b/docs/latex/wx/tbitmap.tex
@@ -11,25 +11,20 @@ required.
 A bitmap created dynamically or loaded from a file can be selected
 into a memory device context (instance of \helpref{wxMemoryDC}{wxmemorydc}). This
 enables the bitmap to be copied to a window or memory device context
 A bitmap created dynamically or loaded from a file can be selected
 into a memory device context (instance of \helpref{wxMemoryDC}{wxmemorydc}). This
 enables the bitmap to be copied to a window or memory device context

-using \helpref{wxDC::Blit}{wxdcblit}, or to be used as a drawing surface.  The {\bf
-wxToolBarSimple} class is implemented using bitmaps, and the toolbar demo
-shows one of the toolbar bitmaps being used for drawing a miniature
-version of the graphic which appears on the main window.
+using \helpref{wxDC::Blit}{wxdcblit}, or to be used as a drawing surface.

 
 See \helpref{wxMemoryDC}{wxmemorydc} for an example of drawing onto a bitmap.
 
 
 See \helpref{wxMemoryDC}{wxmemorydc} for an example of drawing onto a bitmap.
 

-The following shows the conditional compilation required to load a
-bitmap under Unix and in Windows. The alternative is to use the string
-version of the bitmap constructor, which loads a file under Unix and a
-resource or file under Windows, but has the disadvantage of requiring the
-XPM icon file to be available at run-time.
+All wxWidgets platforms support XPMs for small bitmaps and icons.
+You may include the XPM inline as below, since it's C code, or you
+can load it at run-time.

 
 \begin{verbatim}
 
 \begin{verbatim}

-#if defined(__WXGTK__) || defined(__WXMOTIF__)

 #include "mondrian.xpm"
 #include "mondrian.xpm"

-#endif

 \end{verbatim}
 
 \end{verbatim}
 

+Sometimes you wish to use a .ico resource on Windows, and XPMs on
+other platforms (for example to take advantage of Windows' support for multiple icon resolutions).

 A macro, \helpref{wxICON}{wxiconmacro}, is available which creates an icon using an XPM
 on the appropriate platform, or an icon resource on Windows.
 
 A macro, \helpref{wxICON}{wxiconmacro}, is available which creates an icon using an XPM
 on the appropriate platform, or an icon resource on Windows.
 


@@ -68,8 +63,9 @@ wxBitmap bmp(wxBITMAP(bmpname));
 \end{verbatim}
 
 You should always use wxICON and wxBITMAP macros because they work for any
 \end{verbatim}
 
 You should always use wxICON and wxBITMAP macros because they work for any

-platform (unlike the code above which doesn't deal with wxMac, wxBe, ...) and
-are more short and clear than versions with {\tt \#ifdef}s.
+platform (unlike the code above which doesn't deal with wxMac, wxX11, ...) and
+are more short and clear than versions with {\tt \#ifdef}s. Even better,
+use the same XPMs on all platforms.

 
 \subsection{Supported bitmap file formats}\label{supportedbitmapformats}
 
 
 \subsection{Supported bitmap file formats}\label{supportedbitmapformats}
 


@@ -77,10 +73,10 @@ The following lists the formats handled on different platforms. Note
 that missing or partially-implemented formats are automatically supplemented
 by the \helpref{wxImage}{wximage} to load the data, and then converting
 it to wxBitmap form. Note that using wxImage is the preferred way to
 that missing or partially-implemented formats are automatically supplemented
 by the \helpref{wxImage}{wximage} to load the data, and then converting
 it to wxBitmap form. Note that using wxImage is the preferred way to

-load images in wxWindows, with the exception of resources (XPM-files or
+load images in wxWidgets, with the exception of resources (XPM-files or

 native Windows resources). Writing an image format handler for wxImage
 is also far easier than writing one for wxBitmap, because wxImage has
 native Windows resources). Writing an image format handler for wxImage
 is also far easier than writing one for wxBitmap, because wxImage has

-exactly one format on all platforms wheras wxBitmap can store pixel data
+exactly one format on all platforms whereas wxBitmap can store pixel data

 very differently, depending on colour depths and platform.
 
 \wxheading{wxBitmap}
 very differently, depending on colour depths and platform.
 
 \wxheading{wxBitmap}


@@ -101,7 +97,7 @@ Under wxGTK, wxBitmap may load the following formats:
 \item All formats that are supported by the \helpref{wxImage}{wximage} class.
 \end{itemize}
 
 \item All formats that are supported by the \helpref{wxImage}{wximage} class.
 \end{itemize}
 

-Under wxMotif, wxBitmap may load the following formats:
+Under wxMotif and wxX11, wxBitmap may load the following formats:

 
 \begin{itemize}\itemsep=0pt
 \item XBM data and file (wxBITMAP\_TYPE\_XBM)
 
 \begin{itemize}\itemsep=0pt
 \item XBM data and file (wxBITMAP\_TYPE\_XBM)


@@ -126,12 +122,12 @@ Under wxGTK, wxIcon may load the following formats:
 \item All formats that are supported by the \helpref{wxImage}{wximage} class.
 \end{itemize}
 
 \item All formats that are supported by the \helpref{wxImage}{wximage} class.
 \end{itemize}
 

-Under wxMotif, wxIcon may load the following formats:
+Under wxMotif and wxX11, wxIcon may load the following formats:

 
 \begin{itemize}\itemsep=0pt
 \item XBM data and file (wxBITMAP\_TYPE\_XBM)
 \item XPM data and file (wxBITMAP\_TYPE\_XPM)
 
 \begin{itemize}\itemsep=0pt
 \item XBM data and file (wxBITMAP\_TYPE\_XBM)
 \item XPM data and file (wxBITMAP\_TYPE\_XPM)

-\item All formats that are supported by the \helpref{wxImage}{wximage} class (?).
+\item All formats that are supported by the \helpref{wxImage}{wximage} class.

 \end{itemize}
 
 \wxheading{wxCursor}
 \end{itemize}
 
 \wxheading{wxCursor}


@@ -152,7 +148,7 @@ to stock cursors):
 \item None (stock cursors only).
 \end{itemize}
 
 \item None (stock cursors only).
 \end{itemize}
 

-Under wxMotif, wxCursor may load the following formats:
+Under wxMotif and wxX11, wxCursor may load the following formats:

 
 \begin{itemize}\itemsep=0pt
 \item XBM data and file (wxBITMAP\_TYPE\_XBM)
 
 \begin{itemize}\itemsep=0pt
 \item XBM data and file (wxBITMAP\_TYPE\_XBM)


@@ -168,25 +164,8 @@ have special requirements, you may wish to initialise the wxBitmap class with
 some extra handlers which you write yourself or receive from a third party.
 
 To add a handler object to wxBitmap, your application needs to include the header which implements it, and
 some extra handlers which you write yourself or receive from a third party.
 
 To add a handler object to wxBitmap, your application needs to include the header which implements it, and

-then call the static function \helpref{wxBitmap::AddHandler}{wxbitmapaddhandler}. For example:
-
-{\small
-\begin{verbatim}
-  #include <wx/pnghand.h>
-  #include <wx/xpmhand.h>
-  ...
-  // Initialisation
-  wxBitmap::AddHandler(new wxPNGFileHandler);
-  wxBitmap::AddHandler(new wxXPMFileHandler);
-  wxBitmap::AddHandler(new wxXPMDataHandler);
-  ...
-\end{verbatim}
-}
-
-Assuming the handlers have been written correctly, you should now be able to load and save PNG files
-and XPM files using the usual wxBitmap API.
+then call the static function \helpref{wxBitmap::AddHandler}{wxbitmapaddhandler}.

 
 

-{\bf Note:} bitmap handlers are not implemented on all platforms. Currently, the above is only necessary on
-Windows, to save the extra overhead of formats that may not be necessary (if you don't use them, they
-are not linked into the executable). Unix platforms have PNG and XPM capability built-in (where supported).
+{\bf Note:} bitmap handlers are not implemented on all platforms, and new ones rarely need
+to be implemented since wxImage can be used for loading most formats, as noted earlier.