X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/6fd5fa4fcc83bfc4be401e0d4e752f48ae0a38bf..afbe906abdf9aa69a56571b8b20b095351dd8f34:/docs/latex/wx/toolbar.tex?ds=sidebyside diff --git a/docs/latex/wx/toolbar.tex b/docs/latex/wx/toolbar.tex index 97e8e580a8..d5c0824faa 100644 --- a/docs/latex/wx/toolbar.tex +++ b/docs/latex/wx/toolbar.tex @@ -168,12 +168,16 @@ Adds a separator for spacing groups of tools. \membersection{wxToolBar::AddTool}\label{wxtoolbaraddtool} +\func{wxToolBarTool*}{AddTool}{\param{int}{ toolId}, \param{const wxBitmap\&}{ bitmap1},\rtfsp +\param{const wxString\& }{shortHelpString = ""}, \param{const wxString\& }{longHelpString = ""}} + \func{wxToolBarTool*}{AddTool}{\param{int}{ toolId}, \param{const wxBitmap\&}{ bitmap1},\rtfsp \param{const wxBitmap\&}{ bitmap2 = wxNullBitmap}, \param{bool}{ isToggle = FALSE},\rtfsp \param{long}{ xPos = -1}, \param{long}{ yPos = -1},\rtfsp \param{wxObject* }{clientData = NULL}, \param{const wxString\& }{shortHelpString = ""}, \param{const wxString\& }{longHelpString = ""}} -Adds a tool to the toolbar. +Adds a tool to the toolbar. The first (short and most commonly used) version +adds a normal (and not a togglable) button without any associated client data. \wxheading{Parameters} @@ -251,6 +255,9 @@ Enables or disables the tool. \docparam{enable}{If TRUE, enables the tool, otherwise disables it.} +{\bf NB:} This function should only be called after +\helpref{Realize}{wxtoolbarrealize}. + \wxheading{Remarks} For wxToolBarSimple, does nothing. Some other implementations @@ -392,8 +399,6 @@ Returns the default separator size. Returns the short help for the given tool. -Returns the long help for the given tool. - \wxheading{Parameters} \docparam{toolId}{The tool in question.} @@ -450,7 +455,7 @@ 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 -{\param{int}{ toolId}, \param{const wxBitmap\&}{ bitmap1},\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 = ""}} @@ -544,10 +549,7 @@ A typical use of this member might be to pop up a menu. \func{bool}{Realize}{\void} -This function should be called after you have added tools. It -calls, according to the implementation, -either \helpref{wxToolBar::CreateTools}{wxtoolbarcreatetools} or - \helpref{wxToolBar::Layout}{wxtoolbarlayout}. +This function should be called after you have added tools. If you are using absolute positions for your tools when using a wxToolBarSimple object, do not call this function. You must call it at all other times.