DnD feedback

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

\section{\class{wxToolBar}}\label{wxtoolbar}

The name wxToolBar is defined to be a synonym for one of the following classes:

\begin{itemize}\itemsep=0pt
\item {\bf wxToolBar95} The native Windows 95 toolbar. Used on Windows 95, NT 4 and above.
\item {\bf wxToolBarMSW} A Windows implementation. Used on 16-bit Windows.
\item {\bf wxToolBarGTK} The GTK toolbar.
\item {\bf wxToolBarSimple} A simple implementation, with scrolling.
Used on platforms with no native toolbar control, or where scrolling is required.
\end{itemize}

Note that the base class {\bf wxToolBarBase} defines
automatic scrolling management functionality which is identical
to \helpref{wxScrolledWindow}{wxscrolledwindow}, so please refer to this class also.
Not all toolbars support scrolling, but wxToolBarSimple does.

\wxheading{Derived from}

wxToolBarBase\\
\helpref{wxControl}{wxcontrol}\\
\helpref{wxWindow}{wxwindow}\\
\helpref{wxEvtHandler}{wxevthandler}\\
\helpref{wxObject}{wxobject}

\wxheading{Remarks}

You may also create a toolbar that is managed by the frame, by
calling \helpref{wxFrame::CreateToolBar}{wxframecreatetoolbar}.

{\bf wxToolBar95:} Note that this toolbar paints tools to reflect user-selected colours.
The toolbar orientation must always be {\bf wxVERTICAL}.

\wxheading{Window styles}

\twocolwidtha{5cm}
\begin{twocollist}\itemsep=0pt
\twocolitem{\windowstyle{wxTB\_FLAT}}{Gives the toolbar a flat look ('coolbar' or 'flatbar' style). Windows 95 only.}
\twocolitem{\windowstyle{wxTB\_HORIZONTAL}}{Specifies horizontal layout.}
\twocolitem{\windowstyle{wxTB\_VERTICAL}}{Specifies vertical layout (not available for the Windows 95
toolbar).}
\twocolitem{\windowstyle{wxTB\_3DBUTTONS}}{Gives wxToolBarSimple a mild 3D look to its buttons.}
\end{twocollist}

See also \helpref{window styles overview}{windowstyles}.

\wxheading{Event handling}

The toolbar class emits menu commands in the same was 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
window is passed and the tool id is retrieved from the wxCommandEvent.
This is because the id may be -1 when the mouse moves off a tool, and -1 is not
allowed as an identifier in the event system.

\twocolwidtha{7cm}
\begin{twocollist}\itemsep=0pt
\twocolitem{{\bf EVT\_TOOL(id, func)}}{Process a wxEVT\_COMMAND\_TOOL\_CLICKED event
(a synonym for wxEVT\_COMMAND\_MENU\_SELECTED). Pass the id of the tool.}
\twocolitem{{\bf EVT\_MENU(id, func)}}{The same as EVT\_TOOL.}
\twocolitem{{\bf EVT\_TOOL\_RANGE(id1, id2, func)}}{Process a wxEVT\_COMMAND\_TOOL\_CLICKED event
for a range id identifiers. Pass the ids of the tools.}
\twocolitem{{\bf EVT\_MENU\_RANGE(id1, id2, func)}}{The same as EVT\_TOOL\_RANGE.}

\twocolitem{{\bf EVT\_TOOL\_RCLICKED(id, func)}}{Process a wxEVT\_COMMAND\_TOOL\_RCLICKED event.
Pass the id of the tool.}
\twocolitem{{\bf EVT\_TOOL\_RCLICKED\_RANGE(id1, id2, func)}}{Process a wxEVT\_COMMAND\_TOOL\_RCLICKED event
for a range of ids. Pass the ids of the tools.}
\twocolitem{{\bf EVT\_TOOL\_ENTER(id, func)}}{Process a wxEVT\_COMMAND\_TOOL\_ENTER event.
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.}
\end{twocollist}

\wxheading{See also}

\overview{Toolbar overview}{wxtoolbaroverview},\rtfsp
\helpref{wxScrolledWindow}{wxscrolledwindow}

\latexignore{\rtfignore{\wxheading{Members}}}

\membersection{wxToolBar::wxToolBar}\label{wxtoolbarconstr}

\func{}{wxToolBar}{\void}

Default constructor.

\func{}{wxToolBar}{\param{wxWindow*}{ parent}, \param{wxWindowID }{id},
 \param{const wxPoint\& }{pos = wxDefaultPosition},
 \param{const wxSize\& }{size = wxDefaultSize},
 \param{long }{style = wxTB\_HORIZONTAL \pipe wxNO\_BORDER},
 \param{const wxString\& }{name = wxPanelNameStr}}

Constructs a toolbar.

\wxheading{Parameters}

\docparam{parent}{Pointer to a parent window.}

\docparam{id}{Window identifier. If -1, will automatically create an identifier.}

\docparam{pos}{Window position. wxDefaultPosition is (-1, -1) which indicates that wxWindows
should generate a default position for the window. If using the wxWindow class directly, supply
an actual position.}

\docparam{size}{Window size. wxDefaultSize is (-1, -1) which indicates that wxWindows
should generate a default size for the window.}

\docparam{style}{Window style. See \helpref{wxToolBar}{wxtoolbar} for details.}

\docparam{name}{Window name.}

\wxheading{Remarks}

After a toolbar is created, you use \helpref{wxToolBar::AddTool}{wxtoolbaraddtool} and
perhaps \helpref{wxToolBar::AddSeparator}{wxtoolbaraddseparator}, and then you
must call \helpref{wxToolBar::Realize}{wxtoolbarrealize} to construct and display the toolbar
tools.

You may also create a toolbar that is managed by the frame, by
calling \helpref{wxFrame::CreateToolBar}{wxframecreatetoolbar}.

\membersection{wxToolBar::\destruct{wxToolBar}}

\func{void}{\destruct{wxToolBar}}{\void}

Toolbar destructor.

\membersection{wxToolBar::AddSeparator}\label{wxtoolbaraddseparator}

\func{void}{AddSeparator}{\void}

Adds a separator for spacing groups of tools.

\wxheading{See also}

\helpref{wxToolBar::AddTool}{wxtoolbaraddtool}, \helpref{wxToolBar::SetToolSeparation}{wxtoolbarsettoolseparation}

\membersection{wxToolBar::AddTool}\label{wxtoolbaraddtool}

\func{wxToolBarTool*}{AddTool}{\param{int}{ toolIndex}, \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.

\wxheading{Parameters}

\docparam{toolIndex}{An integer by which
the tool may be identified in subsequent operations.}

\docparam{isToggle}{Specifies whether the tool is a toggle or not: a toggle tool may be in
two states, whereas a non-toggle tool is just a button.}

\docparam{bitmap1}{The primary tool bitmap for toggle and button tools.}

\docparam{bitmap2}{The second bitmap specifies the on-state bitmap for a toggle
tool. If this is NULL, either an inverted version of the primary bitmap is
used for the on-state of a toggle tool (monochrome displays) or a black
border is drawn around the tool (colour displays). Note that to pass a NULL value,
you need to cast it to (wxBitmap *) so that C++ can construct an appropriate temporary
wxBitmap object.}

\docparam{xPos}{Specifies the x position of the tool if automatic layout is not suitable.}

\docparam{yPos}{Specifies the y position of the tool if automatic layout is not suitable.}

\docparam{clientData}{An optional pointer to client data which can be
retrieved later using \helpref{wxToolBar::GetToolClientData}{wxtoolbargettoolclientdata}.}

\docparam{shortHelpString}{Used for displaying a tooltip for the tool in the
Windows 95 implementation of wxButtonBar. Pass the empty string if this is not required.}

\docparam{longHelpString}{Used to displayer longer help, such as status line help.
Pass the empty string if this is not required.}

\wxheading{Remarks}

After you have added tools to a toolbar, you must call \helpref{wxToolBar::Realize}{wxtoolbarrealize} in
order to have the tools appear.

\wxheading{See also}

\helpref{wxToolBar::AddSeparator}{wxtoolbaraddseparator},
\helpref{wxToolBar::Realize}{wxtoolbarrealize},

\membersection{wxToolBar::CreateTools}\label{wxtoolbarcreatetools}

\func{bool}{CreateTools}{\void}

This function is implemented for some toolbar classes to create the tools and display them.
The portable way of calling it is to call \helpref{wxToolBar::Realize}{wxtoolbarrealize} after
you have added tools and separators.

\wxheading{See also}

\helpref{wxToolBar::AddTool}{wxtoolbaraddtool}, \helpref{wxToolBar::Realize}{wxtoolbarrealize}

\membersection{wxToolBar::DrawTool}\label{wxtoolbardrawtool}

\func{void}{DrawTool}{\param{wxMemoryDC\& }{memDC}, \param{wxToolBarTool* }{tool}}

Draws the specified tool onto the window using the given memory device context.

\wxheading{Parameters}

\docparam{memDC}{A memory DC to be used for drawing the tool.}

\docparam{tool}{Tool to be drawn.}

\wxheading{Remarks}

For internal use only.

\membersection{wxToolBar::EnableTool}\label{wxtoolbarenabletool}

\func{void}{EnableTool}{\param{int }{toolIndex}, \param{const bool}{ enable}}

Enables or disables the tool.

\wxheading{Parameters}

\docparam{toolIndex}{Tool to enable or disable.}

\docparam{enable}{If TRUE, enables the tool, otherwise disables it.}

\wxheading{Remarks}

For wxToolBarSimple, does nothing. Some other implementations
will change the visible state of the tool to indicate that it is disabled.

\wxheading{See also}

\helpref{wxToolBar::GetToolEnabled}{wxtoolbargettoolenabled},\rtfsp
%\helpref{wxToolBar::SetToolState}{wxtoolbarsettoolstate},\rtfsp
\helpref{wxToolBar::ToggleTool}{wxtoolbartoggletool}

\membersection{wxToolBar::FindToolForPosition}\label{wxtoolbarfindtoolforposition}

\constfunc{wxToolBarTool*}{FindToolForPosition}{\param{const float}{ x}, \param{const float}{ y}}

Finds a tool for the given mouse position.

\wxheading{Parameters}

\docparam{x}{X position.}

\docparam{y}{Y position.}

\wxheading{Return value}

A pointer to a tool if a tool is found, or NULL otherwise.

\wxheading{Remarks}

Used internally, and should not need to be used by the programmer.

\membersection{wxToolBar::GetToolSize}\label{wxtoolbargettoolsize}

\func{wxSize}{GetToolSize}{\void}

Returns the size of a whole button, which is usually larger than a tool bitmap because
of added 3D effects.

\wxheading{See also}

\helpref{wxToolBar::SetToolBitmapSize}{wxtoolbarsettoolbitmapsize},\rtfsp
\helpref{wxToolBar::GetToolBitmapSize}{wxtoolbargettoolbitmapsize}

\membersection{wxToolBar::GetToolBitmapSize}\label{wxtoolbargettoolbitmapsize}

\func{wxSize}{GetToolBitmapSize}{\void}

Returns the size of bitmap that the toolbar expects to have. The default bitmap size is 16 by 15 pixels.

\wxheading{Remarks}

Note that this is the size of the bitmap you pass to \helpref{wxToolBar::AddTool}{wxtoolbaraddtool},
and not the eventual size of the tool button.

\wxheading{See also}

\helpref{wxToolBar::SetToolBitmapSize}{wxtoolbarsettoolbitmapsize},\rtfsp
\helpref{wxToolBar::GetToolSize}{wxtoolbargettoolsize}

\membersection{wxToolBar::GetMargins}\label{wxtoolbargetmargins}

\constfunc{wxSize}{GetMargins}{\void}

Returns the left/right and top/bottom margins, which are also used for inter-toolspacing.

\wxheading{See also}

\helpref{wxToolBar::SetMargins}{wxtoolbarsetmargins}

\membersection{wxToolBar::GetMaxSize}\label{wxtoolbargetmaxsize}

\constfunc{void}{GetMaxSize}{\param{float*}{ w}, \param{float*}{ h}}

Gets the maximum size taken up by the tools after layout, including margins.
This can be used to size a frame around the toolbar window.

\wxheading{Parameters}

\docparam{w}{Receives the maximum horizontal size.}

\docparam{h}{Receives the maximum vertical size.}

\membersection{wxToolBar::GetToolClientData}\label{wxtoolbargettoolclientdata}

\constfunc{wxObject*}{GetToolClientData}{\param{int }{toolIndex}}

Get any client data associated with the tool.

\wxheading{Parameters}

\docparam{toolIndex}{Index of the tool, as passed to \helpref{wxToolBar::AddTool}{wxtoolbaraddtool}.}

\wxheading{Return value}

Client data, or NULL if there is none.

\membersection{wxToolBar::GetToolEnabled}\label{wxtoolbargettoolenabled}

\constfunc{bool}{GetToolEnabled}{\param{int }{toolIndex}}

Called to determine whether a tool is enabled (responds to user input).

\wxheading{Parameters}

\docparam{toolIndex}{Index of the tool in question.}

\wxheading{Return value}

TRUE if the tool is enabled, FALSE otherwise.

%\wxheading{See also}
%
%\helpref{wxToolBar::SetToolEnabled}{wxtoolbarsettoolenabled}
%
\membersection{wxToolBar::GetToolLongHelp}\label{wxtoolbargettoollonghelp}

\constfunc{wxString}{GetToolLongHelp}{\param{int }{toolIndex}}

Returns the long help for the given tool.

\wxheading{Parameters}

\docparam{toolIndex}{The tool in question.}

\wxheading{See also}

\helpref{wxToolBar::SetToolLongHelp}{wxtoolbarsettoollonghelp},\rtfsp
\helpref{wxToolBar::SetToolShortHelp}{wxtoolbarsettoolshorthelp}\rtfsp

\membersection{wxToolBar::GetToolPacking}\label{wxtoolbargettoolpacking}

\constfunc{int}{GetToolPacking}{\void}

Returns the value used for packing tools.

\wxheading{See also}

\helpref{wxToolBar::SetToolPacking}{wxtoolbarsettoolpacking}

\membersection{wxToolBar::GetToolSeparation}\label{wxtoolbargettoolseparation}

\constfunc{int}{GetToolSeparation}{\void}

Returns the default separator size.

\wxheading{See also}

\helpref{wxToolBar::SetToolSeparation}{wxtoolbarsettoolseparation}

\membersection{wxToolBar::GetToolShortHelp}\label{wxtoolbargettoolshorthelp}

\constfunc{wxString}{GetToolShortHelp}{\param{int }{toolIndex}}

Returns the short help for the given tool.

Returns the long help for the given tool.

\wxheading{Parameters}

\docparam{toolIndex}{The tool in question.}

\wxheading{See also}

\helpref{wxToolBar::GetToolLongHelp}{wxtoolbargettoollonghelp},\rtfsp
\helpref{wxToolBar::SetToolShortHelp}{wxtoolbarsettoolshorthelp}\rtfsp

\membersection{wxToolBar::GetToolState}\label{wxtoolbargettoolstate}

\constfunc{bool}{GetToolState}{\param{int }{toolIndex}}

Gets the on/off state of a toggle tool.

\wxheading{Parameters}

\docparam{toolIndex}{The tool in question.}

\wxheading{Return value}

TRUE if the tool is toggled on, FALSE otherwise.

%\wxheading{See also}
%
%\helpref{wxToolBar::SetToolState}{wxtoolbarsettoolstate}
%
\membersection{wxToolBar::Layout}\label{wxtoolbarlayout}

\func{void}{Layout}{\void}

Called by the application after the tools have been added to
automatically lay the tools out on the window. If you have given
absolute positions when adding the tools, do not call this.

This function is only implemented for some toolbar classes.
The portable way of calling it is to call \helpref{wxToolBar::Realize}{wxtoolbarrealize} after
you have added tools and separators.

\wxheading{See also}

\helpref{wxToolBar::AddTool}{wxtoolbaraddtool}, \helpref{wxToolBar::Realize}{wxtoolbarrealize}

\membersection{wxToolBar::OnLeftClick}\label{wxtoolbaronleftclick}

\func{bool}{OnLeftClick}{\param{int}{ toolIndex}, \param{bool}{ toggleDown}}

Called when the user clicks on a tool with the left mouse button.

This is the old way of detecting tool clicks; although it will still work,
you should use the EVT\_MENU or EVT\_TOOL macro instead.

\wxheading{Parameters}

\docparam{toolIndex}{The identifier passed to \helpref{wxToolBar::AddTool}{wxtoolbaraddtool}.}

\docparam{toggleDown}{TRUE if the tool is a toggle and the toggle is down, otherwise is FALSE.}

\wxheading{Return value}

If the tool is a toggle and this function returns FALSE, the toggle
toggle state (internal and visual) will not be changed. This provides a way of
specifying that toggle operations are not permitted in some circumstances.

\wxheading{See also}

\helpref{wxToolBar::OnMouseEnter}{wxtoolbaronmouseenter},\rtfsp
\helpref{wxToolBar::OnRightClick}{wxtoolbaronrightclick}

\membersection{wxToolBar::OnMouseEnter}\label{wxtoolbaronmouseenter}

\func{void}{OnMouseEnter}{\param{int}{ toolIndex}}

This is called when the mouse cursor moves into a tool or out of
the toolbar.

This is the old way of detecting mouse enter events; although it will still work,
you should use the EVT\_TOOL\_ENTER macro instead.

\wxheading{Parameters}

\docparam{toolIndex}{Greater than -1 if the mouse cursor has moved into the tool,
or -1 if the mouse cursor has moved. The
programmer can override this to provide extra information about the tool,
such as a short description on the status line.}

\wxheading{Remarks}

With some derived toolbar classes, if the mouse moves quickly out of the toolbar, wxWindows may not be able to
detect it. Therefore this function may not always be called when expected.

\membersection{wxToolBar::OnRightClick}\label{wxtoolbaronrightclick}

\func{void}{OnRightClick}{\param{int}{ toolIndex}, \param{float}{ x}, \param{float}{ y}}

Called when the user clicks on a tool with the right mouse button. The
programmer should override this function to detect right tool clicks.

This is the old way of detecting tool right clicks; although it will still work,
you should use the EVT\_TOOL\_RCLICKED macro instead.

\wxheading{Parameters}

\docparam{toolIndex}{The identifier passed to \helpref{wxToolBar::AddTool}{wxtoolbaraddtool}.}

\docparam{x}{The x position of the mouse cursor.}

\docparam{y}{The y position of the mouse cursor.}

\wxheading{Remarks}

A typical use of this member might be to pop up a menu.

\wxheading{See also}

\helpref{wxToolBar::OnMouseEnter}{wxtoolbaronmouseenter},\rtfsp
\helpref{wxToolBar::OnLeftClick}{wxtoolbaronleftclick}

\membersection{wxToolBar::Realize}\label{wxtoolbarrealize}

\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}.

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.

\membersection{wxToolBar::SetToolBitmapSize}\label{wxtoolbarsettoolbitmapsize}

\func{void}{SetToolBitmapSize}{\param{const wxSize\&}{ size}}

Sets the default size of each tool bitmap. The default bitmap size is 16 by 15 pixels.

\wxheading{Parameters}

\docparam{size}{The size of the bitmaps in the toolbar.}

\wxheading{Remarks}

This should be called to tell the toolbar what the tool bitmap size is. Call
it before you add tools.

Note that this is the size of the bitmap you pass to \helpref{wxToolBar::AddTool}{wxtoolbaraddtool},
and not the eventual size of the tool button.

\wxheading{See also}

\helpref{wxToolBar::GetToolBitmapSize}{wxtoolbargettoolbitmapsize},\rtfsp
\helpref{wxToolBar::GetToolSize}{wxtoolbargettoolsize}

\membersection{wxToolBar::SetMargins}\label{wxtoolbarsetmargins}

\func{void}{SetMargins}{\param{const wxSize\&}{ size}}

\func{void}{SetMargins}{\param{int}{ x}, \param{int}{ y}}

Set the values to be used as margins for the toolbar.

\wxheading{Parameters}

\docparam{size}{Margin size.}

\docparam{x}{Left margin, right margin and inter-tool separation value.}

\docparam{y}{Top margin, bottom margin and inter-tool separation value.}

\wxheading{Remarks}

This must be called before the tools are added if absolute positioning is to be used, and the
default (zero-size) margins are to be overridden.

\wxheading{See also}

\helpref{wxToolBar::GetMargins}{wxtoolbargetmargins}, \helpref{wxSize}{wxsize}

\membersection{wxToolBar::SetToolLongHelp}\label{wxtoolbarsettoollonghelp}

\func{void}{SetToolLongHelp}{\param{int }{toolIndex}, \param{const wxString\& }{helpString}}

Sets the long help for the given tool.

\wxheading{Parameters}

\docparam{toolIndex}{The tool in question.}

\docparam{helpString}{A string for the long help.}

\wxheading{Remarks}

You might use the long help for displaying the tool purpose on the status line.

\wxheading{See also}

\helpref{wxToolBar::GetToolLongHelp}{wxtoolbargettoollonghelp},\rtfsp
\helpref{wxToolBar::SetToolShortHelp}{wxtoolbarsettoolshorthelp},\rtfsp

\membersection{wxToolBar::SetToolPacking}\label{wxtoolbarsettoolpacking}

\func{void}{SetToolPacking}{\param{int}{ packing}}

Sets the value used for spacing tools. The default value is 1.

\wxheading{Parameters}

\docparam{packing}{The value for packing.}

\wxheading{Remarks}

The packing is used for spacing in the vertical direction if the toolbar is horizontal,
and for spacing in the horizontal direction if the toolbar is vertical.

\wxheading{See also}

\helpref{wxToolBar::GetToolPacking}{wxtoolbargettoolpacking}

\membersection{wxToolBar::SetToolShortHelp}\label{wxtoolbarsettoolshorthelp}

\func{void}{SetToolShortHelp}{\param{int }{toolIndex}, \param{const wxString\& }{helpString}}

Sets the short help for the given tool.

\wxheading{Parameters}

\docparam{toolIndex}{The tool in question.}

\docparam{helpString}{The string for the short help.}

\wxheading{Remarks}

An application might use short help for identifying the tool purpose in a tooltip.

\wxheading{See also}

\helpref{wxToolBar::GetToolShortHelp}{wxtoolbargettoolshorthelp}, \helpref{wxToolBar::SetToolLongHelp}{wxtoolbarsettoollonghelp}

\membersection{wxToolBar::SetToolSeparation}\label{wxtoolbarsettoolseparation}

\func{void}{SetToolSeparation}{\param{int}{ separation}}

Sets the default separator size. The default value is 5.

\wxheading{Parameters}

\docparam{separation}{The separator size.}

\wxheading{See also}

\helpref{wxToolBar::AddSeparator}{wxtoolbaraddseparator}

\membersection{wxToolBar::ToggleTool}\label{wxtoolbartoggletool}

\func{void}{ToggleTool}{\param{int }{toolIndex}, \param{const bool}{ toggle}}

Toggles a tool on or off.

\wxheading{Parameters}

\docparam{toolIndex}{Tool in question.}

\docparam{toggle}{If TRUE, toggles the tool on, otherwise toggles it off.}

\wxheading{Remarks}

Only applies to a tool that has been specified as a toggle tool.

\wxheading{See also}

\helpref{wxToolBar::GetToolState}{wxtoolbargettoolstate}