latex/wx/toolbar.tex

36 If you use more than 16 colours in your tool bitmaps, you may wish to suppress
88 the identifier of the tool is passed, but for EVT\_TOOL\_ENTER the toolbar
89 window identifier is passed and the tool identifier is retrieved from the wxCommandEvent.
90 This is because the identifier may be -1 when the mouse moves off a tool, and -1 is not
96 (a synonym for wxEVT\_COMMAND\_MENU\_SELECTED). Pass the id of the tool.}
102 Pass the id of the tool.}
106 Pass the id of the toolbar itself. The value of wxCommandEvent::GetSelection is the tool id, or -1 if the mouse cursor has moved off a tool.}
203 \func{wxToolBarToolBase*}{AddTool}{\param{wxToolBarToolBase* }{tool}}
205 Adds a tool to the toolbar. The first (short and most commonly used) version
208 you to add an existing tool.
213 the tool may be identified in subsequent operations.}
216 wxITEM\_CHECK for a checkable tool (such tool stays pressed after it had been
217 toggled) or wxITEM\_RADIO for a checkable tool which makes part of a radio
221 \docparam{bitmap1}{The primary tool bitmap.}
223 \docparam{bitmap2}{The bitmap used when the tool is disabled. If it is equal to
230 parent frame when the mouse pointer is inside the tool}
235 \docparam{tool}{The tool to be added.}
262 Adds a new check (or toggle) tool to the toolbar. The parameters are the same
280 Adds a new radio tool to the toolbar. Consecutive radio tools form a radio
303 Removes the specified tool from the toolbar and deletes it. If you don't want
304 to delete the tool, but just to remove it from the toolbar (to possibly add it
310 Returns true if the tool was deleted, false otherwise.
322 deletes the tool at the specified position and not the one with the given id.
329 Enables or disables the tool.
335 \docparam{enable}{If true, enables the tool, otherwise disables it.}
342 Some implementations will change the visible state of the tool to indicate that it is disabled.
354 Returns a pointer to the tool identified by \arg{id} or
355 \NULL if no corresponding tool is found.
370 Finds a tool for the given mouse position.
380 A pointer to a tool if a tool is found, or \NULL otherwise.
398 Returns the size of a whole button, which is usually larger than a tool bitmap because
416 and not the eventual size of the tool button.
439 Get any client data associated with the tool.
443 \docparam{toolId}{Id of the tool, as passed to \helpref{wxToolBar::AddTool}{wxtoolbaraddtool}.}
454 Called to determine whether a tool is enabled (responds to user input).
458 \docparam{toolId}{Id of the tool in question.}
462 true if the tool is enabled, false otherwise.
473 Returns the long help for the given tool.
477 \docparam{toolId}{The tool in question.}
500 Returns the tool position in the toolbar, or {\tt wxNOT\_FOUND} if the tool is not found.
518 Returns the short help for the given tool.
522 \docparam{toolId}{The tool in question.}
534 Gets the on/off state of a toggle tool.
538 \docparam{toolId}{The tool in question.}
542 true if the tool is toggled on, false otherwise.
585 \param{wxToolBarToolBase* }{tool}}
587 Inserts the tool with the specified attributes into the toolbar at the given
603 Called when the user clicks on a tool with the left mouse button.
605 This is the old way of detecting tool clicks; although it will still work,
612 \docparam{toggleDown}{true if the tool is a toggle and the toggle is down, otherwise is false.}
616 If the tool is a toggle and this function returns false, the toggle
630 This is called when the mouse cursor moves into a tool or out of
638 \docparam{toolId}{Greater than -1 if the mouse cursor has moved into the tool,
640 programmer can override this to provide extra information about the tool,
653 Called when the user clicks on a tool with the right mouse button. The
654 programmer should override this function to detect right tool clicks.
656 This is the old way of detecting tool right clicks; although it will still work,
688 Removes the given tool from the toolbar but doesn't delete it. This allows to
689 insert/add this tool back to this (or another) toolbar later.
703 Sets the bitmap resource identifier for specifying tool bitmaps as indices
719 \docparam{x}{Left margin, right margin and inter-tool separation value.}
721 \docparam{y}{Top margin, bottom margin and inter-tool separation value.}
737 Sets the default size of each tool bitmap. The default bitmap size is 16 by 15 pixels.
745 This should be called to tell the toolbar what the tool bitmap size is. Call
749 and not the eventual size of the tool button.
761 Sets the client data associated with the tool.
768 Sets the bitmap to be used by the tool with the given ID when the tool
779 Sets the long help for the given tool.
783 \docparam{toolId}{The tool in question.}
789 You might use the long help for displaying the tool purpose on the status line.
821 Sets the short help for the given tool.
825 \docparam{toolId}{The tool in question.}
831 An application might use short help for identifying the tool purpose in a tooltip.
842 Sets the bitmap to be used by the tool with the given ID.  This can
866 Toggles a tool on or off. This does not cause any event to get emitted.
872 \docparam{toggle}{If true, toggles the tool on, otherwise toggles it off.}
876 Only applies to a tool that has been specified as a toggle tool.