X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/fc2171bd4c660b8554dae2a1cbf34ff09f3032a6..905372991fb9872a7ea82991055a34e161ea29c3:/docs/latex/wx/toolbar.tex diff --git a/docs/latex/wx/toolbar.tex b/docs/latex/wx/toolbar.tex index 94f6b18bad..f9ed017eba 100644 --- a/docs/latex/wx/toolbar.tex +++ b/docs/latex/wx/toolbar.tex @@ -51,6 +51,20 @@ before creating the toolbar: wxSystemOptions::SetOption(wxT("msw.remap"), 0); \end{verbatim} +If you wish to use 32-bit images (which include an alpha channel for transparency) +use: + +\begin{verbatim} + wxSystemOptions::SetOption(wxT("msw.remap"), 2); +\end{verbatim} + +then colour remapping is switched off, and a transparent background used. But only +use this option under Windows XP with true colour: + +\begin{verbatim} + (wxTheApp->GetComCtl32Version() >= 600 && ::wxDisplayDepth() >= 32) +\end{verbatim} + \wxheading{Window styles} \twocolwidtha{5cm} @@ -74,7 +88,7 @@ native toolbar ignores {\tt wxTB\_NOICONS} style. Also, toggling the \wxheading{Event handling} -The toolbar class emits menu commands in the same was that a frame menubar does, +The toolbar class emits menu commands in the same way that a frame menubar does, so you can use one EVT\_MENU macro for both a menu item and a toolbar button. The event handler functions take a wxCommandEvent argument. For most event macros, the identifier of the tool is passed, but for EVT\_TOOL\_ENTER the toolbar @@ -146,7 +160,7 @@ tools. You may also create a toolbar that is managed by the frame, by calling \helpref{wxFrame::CreateToolBar}{wxframecreatetoolbar}. -\membersection{wxToolBar::\destruct{wxToolBar}} +\membersection{wxToolBar::\destruct{wxToolBar}}\label{wxtoolbardtor} \func{void}{\destruct{wxToolBar}}{\void} @@ -172,13 +186,13 @@ Adds a separator for spacing groups of tools. \membersection{wxToolBar::AddTool}\label{wxtoolbaraddtool} -\func{wxToolBarTool*}{AddTool}{\param{int}{ toolId},\rtfsp +\func{wxToolBarToolBase*}{AddTool}{\param{int}{ toolId},\rtfsp \param{const wxString\&}{ label},\rtfsp \param{const wxBitmap\&}{ bitmap1},\rtfsp \param{const wxString\& }{shortHelpString = ""},\rtfsp \param{wxItemKind}{ kind = wxITEM\_NORMAL}} -\func{wxToolBarTool*}{AddTool}{\param{int}{ toolId},\rtfsp +\func{wxToolBarToolBase*}{AddTool}{\param{int}{ toolId},\rtfsp \param{const wxString\&}{ label},\rtfsp \param{const wxBitmap\&}{ bitmap1},\rtfsp \param{const wxBitmap\&}{ bitmap2 = wxNullBitmap},\rtfsp @@ -187,7 +201,7 @@ Adds a separator for spacing groups of tools. \param{const wxString\& }{longHelpString = ""},\rtfsp \param{wxObject* }{clientData = NULL}} -\func{wxToolBarTool*}{AddTool}{\param{wxToolBarTool* }{tool}} +\func{wxToolBarToolBase*}{AddTool}{\param{wxToolBarToolBase* }{tool}} Adds a tool to the toolbar. The first (short and most commonly used) version has fewer parameters than the full version at the price of not being able to @@ -239,7 +253,7 @@ order to have the tools appear. \membersection{wxToolBar::AddCheckTool}\label{wxtoolbaraddchecktool} -\func{wxToolBarTool*}{AddCheckTool}{\param{int}{ toolId},\rtfsp +\func{wxToolBarToolBase*}{AddCheckTool}{\param{int}{ toolId},\rtfsp \param{const wxString\&}{ label},\rtfsp \param{const wxBitmap\&}{ bitmap1},\rtfsp \param{const wxBitmap\&}{ bitmap2},\rtfsp @@ -256,7 +270,7 @@ as in \helpref{wxToolBar::AddTool}{wxtoolbaraddtool}. \membersection{wxToolBar::AddRadioTool}\label{wxtoolbaraddradiotool} -\func{wxToolBarTool*}{AddRadioTool}{\param{int}{ toolId},\rtfsp +\func{wxToolBarToolBase*}{AddRadioTool}{\param{int}{ toolId},\rtfsp \param{const wxString\&}{ label},\rtfsp \param{const wxBitmap\&}{ bitmap1},\rtfsp \param{const wxBitmap\&}{ bitmap2},\rtfsp @@ -328,7 +342,7 @@ will change the visible state of the tool to indicate that it is disabled. \membersection{wxToolBar::FindById}\label{wxtoolbarfindbyid} -\func{wxToolBarTool*}{FindById}{\param{int }{id}} +\func{wxToolBarToolBase*}{FindById}{\param{int }{id}} Returns a pointer to the tool identified by {\it id} or NULL if no corresponding tool is found. @@ -342,7 +356,7 @@ NULL if no corresponding control is found. \membersection{wxToolBar::FindToolForPosition}\label{wxtoolbarfindtoolforposition} -\constfunc{wxToolBarTool*}{FindToolForPosition}{\param{const float}{ x}, \param{const float}{ y}} +\constfunc{wxToolBarToolBase*}{FindToolForPosition}{\param{const float}{ x}, \param{const float}{ y}} Finds a tool for the given mouse position. @@ -459,7 +473,7 @@ Returns the value used for packing tools. \constfunc{int}{GetToolPos}{\param{int }{toolId}} -Returns the tool position in the toolbar, or wxNOT\_FOUND if the tool is not found. +Returns the tool position in the toolbar, or {\tt wxNOT\_FOUND} if the tool is not found. \membersection{wxToolBar::GetToolSeparation}\label{wxtoolbargettoolseparation} @@ -506,7 +520,7 @@ true if the tool is toggled on, false otherwise. \membersection{wxToolBar::InsertControl}\label{wxtoolbarinsertcontrol} -\func{wxToolBarTool *}{InsertControl}{\param{size\_t }{pos}, \param{wxControl *}{control}} +\func{wxToolBarToolBase *}{InsertControl}{\param{size\_t }{pos}, \param{wxControl *}{control}} Inserts the control into the toolbar at the given position. @@ -519,7 +533,7 @@ You must call \helpref{Realize}{wxtoolbarrealize} for the change to take place. \membersection{wxToolBar::InsertSeparator}\label{wxtoolbarinsertseparator} -\func{wxToolBarTool *}{InsertSeparator}{\param{size\_t }{pos}} +\func{wxToolBarToolBase *}{InsertSeparator}{\param{size\_t }{pos}} Inserts the separator into the toolbar at the given position. @@ -532,13 +546,13 @@ You must call \helpref{Realize}{wxtoolbarrealize} for the change to take place. \membersection{wxToolBar::InsertTool}\label{wxtoolbarinserttool} -\func{wxToolBarTool *}{InsertTool}{\param{size\_t }{pos},\rtfsp +\func{wxToolBarToolBase *}{InsertTool}{\param{size\_t }{pos},\rtfsp \param{int}{ toolId}, \param{const wxBitmap\&}{ bitmap1},\rtfsp \param{const wxBitmap\&}{ bitmap2 = wxNullBitmap}, \param{bool}{ isToggle = false},\rtfsp \param{wxObject* }{clientData = NULL}, \param{const wxString\& }{shortHelpString = ""}, \param{const wxString\& }{longHelpString = ""}} -\func{wxToolBarTool *}{InsertTool}{\param{size\_t }{pos},\rtfsp -\param{wxToolBarTool* }{tool}} +\func{wxToolBarToolBase *}{InsertTool}{\param{size\_t }{pos},\rtfsp +\param{wxToolBarToolBase* }{tool}} Inserts the tool with the specified attributes into the toolbar at the given position. @@ -634,7 +648,7 @@ This function should be called after you have added tools. \membersection{wxToolBar::RemoveTool}\label{wxtoolbarremovetool} -\func{wxToolBarTool *}{RemoveTool}{\param{int }{id}} +\func{wxToolBarToolBase *}{RemoveTool}{\param{int }{id}} Removes the given tool from the toolbar but doesn't delete it. This allows to insert/add this tool back to this (or another) toolbar later.