1 \section{\class{wxToolBarBase
}}\label{wxtoolbarbase
}
3 {\bf wxToolBarBase
} is the base class for a number of toolbar classes. The most portable
4 one of these is the generic
\helpref{wxToolBarSimple
}{wxtoolbarsimple
} class.
{\bf wxToolBarBase
} defines
5 automatic scrolling management functionality which is identical to
\helpref{wxScrolledWindow
}{wxscrolledwindow
},
6 so please refer to this class also.
8 \wxheading{Derived from
}
10 \helpref{wxControl
}{wxcontrol
}\\
11 \helpref{wxWindow
}{wxwindow
}\\
12 \helpref{wxEvtHandler
}{wxevthandler
}\\
13 \helpref{wxObject
}{wxobject
}
17 Because there is a variety of toolbar classes, you may wish to choose which class
18 is best for your application on each platform, and define
{\bf wxToolBar
} appropriately. For example:
22 class wxToolBar: public wxToolBar95
24 class wxToolBar: public wxToolBarMSW
26 class wxToolBar: public wxToolBarSimple
32 TODO: maybe change the confusing names: GetDefaultSize becomes GetToolBitmapSize, and
33 GetDefaultButtonSize becomes GetToolSize. Document SetRows for wxToolBar95, and make it
36 \wxheading{Event handling
}
38 Derive a new class from an existing toolbar class, and override appropriate virtual functions.
40 TODO: make consistent with other event handling; have wxToolBarEvent and appropriate macros.
44 \overview{Toolbar overview
}{wxtoolbaroverview
},
\rtfsp
45 \helpref{wxToolBarSimple
}{wxtoolbarsimple
},
\rtfsp
46 \helpref{wxToolBarMSW
}{wxtoolbarmsw
},
\rtfsp
47 \helpref{wxToolBar95
}{wxtoolbar95
},
\rtfsp
48 \helpref{wxScrolledWindow
}{wxscrolledwindow
}
50 \latexignore{\rtfignore{\wxheading{Members
}}}
52 \membersection{wxToolBarBase::wxToolBarBase
}\label{wxtoolbarbaseconstr
}
54 \func{}{wxToolBarBase
}{\void}
60 %\helpref{wxToolBarBase::Create}{wxtoolbarbasecreate}
62 \membersection{wxToolBarBase::
\destruct{wxToolBarBase
}}
64 \func{void
}{\destruct{wxToolBarBase
}}{\void}
68 \membersection{wxToolBarBase::AddSeparator
}\label{wxtoolbarbaseaddseparator
}
70 \func{void
}{AddSeparator
}{\void}
72 Adds a separator for spacing groups of tools.
76 \helpref{wxToolBarBase::AddTool
}{wxtoolbarbaseaddtool
},
\helpref{wxToolBarBase::SetToolSeparation
}{wxtoolbarbasesettoolseparation
}
78 \membersection{wxToolBarBase::AddTool
}\label{wxtoolbarbaseaddtool
}
80 \func{wxToolBarBaseTool*
}{AddTool
}{\param{int
}{ toolIndex
},
\param{const wxBitmap\&
}{ bitmap1
},
\rtfsp
81 \param{const wxBitmap\&
}{ bitmap2 = (wxBitmap *)NULL
},
\param{const bool
}{ isToggle = FALSE
},
\rtfsp
82 \param{const float
}{ xPos = -
1},
\param{const float
}{ yPos = -
1},
\rtfsp
83 \param{wxObject *
}{clientData = NULL
},
\param{const wxString\&
}{shortHelpString = ""
},
\param{const wxString\&
}{longHelpString = ""
}}
85 Adds a tool to the toolbar.
87 \wxheading{Parameters
}
89 \docparam{toolIndex
}{An integer by which
90 the tool may be identified in subsequent operations.
}
92 \docparam{isToggle
}{Specifies whether the tool is a toggle or not: a toggle tool may be in
93 two states, whereas a non-toggle tool is just a button.
}
95 \docparam{bitmap1
}{The primary tool bitmap for toggle and button tools.
}
97 \docparam{bitmap2
}{The second bitmap specifies the on-state bitmap for a toggle
98 tool. If this is NULL, either an inverted version of the primary bitmap is
99 used for the on-state of a toggle tool (monochrome displays) or a black
100 border is drawn around the tool (colour displays). Note that to pass a NULL value,
101 you need to cast it to (wxBitmap *) so that C++ can construct an appropriate temporary
104 \docparam{xPos
}{Specifies the x position of the tool if automatic layout is not suitable.
}
106 \docparam{yPos
}{Specifies the y position of the tool if automatic layout is not suitable.
}
108 \docparam{clientData
}{An optional pointer to client data which can be
109 retrieved later using
\helpref{wxToolBarBase::GetToolClientData
}{wxtoolbarbasegettoolclientdata
}.
}
111 \docparam{shortHelpString
}{Used for displaying a tooltip for the tool in the
112 Windows
95 implementation of wxButtonBar. Pass the empty string if this is not required.
}
114 \docparam{longHelpString
}{Used to displayer longer help, such as status line help.
115 Pass the empty string if this is not required.
}
119 \helpref{wxToolBarBase::AddSeparator
}{wxtoolbarbaseaddseparator
}
121 \membersection{wxToolBarBase::CreateTools
}\label{wxtoolbarbasecreatetools
}
123 \func{bool
}{CreateTools
}{\void}
125 Call this function after all tools have been added to the toolbar, to actually
130 Strictly speaking, this is required only for the Windows
95 version of wxButtonBar,
131 but for portability it should be called anyway.
135 \helpref{wxToolBarBase::AddTool
}{wxtoolbarbaseaddtool
}
137 \membersection{wxToolBarBase::DrawTool
}\label{wxtoolbarbasedrawtool
}
139 \func{void
}{DrawTool
}{\param{wxMemoryDC\&
}{memDC
},
\param{wxToolBarBaseTool*
}{tool
}}
141 Draws the specified tool onto the canvas using the given memory device context.
143 \wxheading{Parameters
}
145 \docparam{memDC
}{A memory DC to be used for drawing the tool.
}
147 \docparam{tool
}{Tool to be drawn.
}
151 For internal use only.
153 \membersection{wxToolBarBase::EnableTool
}\label{wxtoolbarbaseenabletool
}
155 \func{void
}{EnableTool
}{\param{int
}{toolIndex
},
\param{const bool
}{ enable
}}
157 Enables or disables the tool.
159 \wxheading{Parameters
}
161 \docparam{toolIndex
}{Tool to enable or disable.
}
163 \docparam{enable
}{If TRUE, enables the tool, otherwise disables it.
}
167 For
\helpref{wxToolBarSimple
}{wxtoolbarsimple
}, does nothing. Some other implementations
168 will change the visible state of the tool to indicate that it is disabled.
172 \helpref{wxToolBarBase::GetToolEnabled
}{wxtoolbarbasegettoolenabled
},
\rtfsp
173 %\helpref{wxToolBarBase::SetToolState}{wxtoolbarbasesettoolstate},\rtfsp
174 \helpref{wxToolBarBase::ToggleTool
}{wxtoolbarbasetoggletool
}
176 \membersection{wxToolBarBase::FindToolForPosition
}\label{wxtoolbarbasefindtoolforposition
}
178 \constfunc{wxToolBarBaseTool*
}{FindToolForPosition
}{\param{const float
}{ x
},
\param{const float
}{ y
}}
180 Finds a tool for the given mouse position.
182 \wxheading{Parameters
}
184 \docparam{x
}{X position.
}
186 \docparam{y
}{Y position.
}
188 \wxheading{Return value
}
190 A pointer to a tool if a tool is found, or NULL otherwise.
194 Used internally, and should not need to be used by the programmer.
196 \membersection{wxToolBarBase::GetDefaultButtonSize
}\label{wxtoolbarbasegetdefaultbuttonsize
}
198 \func{wxSize
}{GetDefaultButtonSize
}{\void}
200 Returns the size of a whole button, which is usually larger than a tool bitmap because
205 \helpref{wxToolBarBase::SetDefaultSize
}{wxtoolbarbasesetdefaultsize
},
\rtfsp
206 \helpref{wxToolBarBase::GetDefaultSize
}{wxtoolbarbasegetdefaultsize
}
208 \membersection{wxToolBarBase::GetDefaultSize
}\label{wxtoolbarbasegetdefaultsize
}
210 \func{wxSize
}{GetDefaultSize
}{\void}
212 Returns the size of bitmap that the toolbar expects to have. The default bitmap size is
16 by
15 pixels.
216 Note that this is the size of the bitmap you pass to
\helpref{wxToolBarBase::AddTool
}{wxtoolbarbaseaddtool
},
217 and not the eventual size of the tool button.
221 \helpref{wxToolBarBase::SetDefaultSize
}{wxtoolbarbasesetdefaultsize
},
\rtfsp
222 \helpref{wxToolBarBase::GetDefaultButtonSize
}{wxtoolbarbasegetdefaultbuttonsize
}
224 \membersection{wxToolBarBase::GetMargins
}\label{wxtoolbarbasegetmargins
}
226 \constfunc{wxSize
}{GetMargins
}{\void}
228 Returns the left/right and top/bottom margins, which are also used for inter-toolspacing.
232 \helpref{wxToolBarBase::SetMargins
}{wxtoolbarbasesetmargins
}
234 \membersection{wxToolBarBase::GetMaxSize
}\label{wxtoolbarbasegetmaxsize
}
236 \constfunc{void
}{GetMaxSize
}{\param{float*
}{ w
},
\param{float*
}{ h
}}
238 Gets the maximum size taken up by the tools after layout, including margins.
239 This can be used to size a frame around the toolbar canvas.
241 \wxheading{Parameters
}
243 \docparam{w
}{Receives the maximum horizontal size.
}
245 \docparam{h
}{Receives the maximum vertical size.
}
247 \membersection{wxToolBarBase::GetToolClientData
}\label{wxtoolbarbasegettoolclientdata
}
249 \constfunc{wxObject*
}{GetToolClientData
}{\param{int
}{toolIndex
}}
251 Get any client data associated with the tool.
253 \wxheading{Parameters
}
255 \docparam{toolIndex
}{Index of the tool, as passed to
\helpref{wxToolBarBase::AddTool
}{wxtoolbarbaseaddtool
}.
}
257 \wxheading{Return value
}
259 Client data, or NULL if there is none.
261 \membersection{wxToolBarBase::GetToolEnabled
}\label{wxtoolbarbasegettoolenabled
}
263 \constfunc{bool
}{GetToolEnabled
}{\param{int
}{toolIndex
}}
265 Called to determine whether a tool is enabled (responds to user input).
267 \wxheading{Parameters
}
269 \docparam{toolIndex
}{Index of the tool in question.
}
271 \wxheading{Return value
}
273 TRUE if the tool is enabled, FALSE otherwise.
275 %\wxheading{See also}
277 %\helpref{wxToolBarBase::SetToolEnabled}{wxtoolbarbasesettoolenabled}
279 \membersection{wxToolBarBase::GetToolLongHelp
}\label{wxtoolbarbasegettoollonghelp
}
281 \constfunc{wxString
}{GetToolLongHelp
}{\param{int
}{toolIndex
}}
283 Returns the long help for the given tool.
285 \wxheading{Parameters
}
287 \docparam{toolIndex
}{The tool in question.
}
291 \helpref{wxToolBarBase::SetToolLongHelp
}{wxtoolbarbasesettoollonghelp
},
\rtfsp
292 \helpref{wxToolBarBase::SetToolShortHelp
}{wxtoolbarbasesettoolshorthelp
}\rtfsp
294 \membersection{wxToolBarBase::GetToolPacking
}\label{wxtoolbarbasegettoolpacking
}
296 \constfunc{int
}{GetToolPacking
}{\void}
298 Returns the value used for packing tools.
302 \helpref{wxToolBarBase::SetToolPacking
}{wxtoolbarbasesettoolpacking
}
304 \membersection{wxToolBarBase::GetToolSeparation
}\label{wxtoolbarbasegettoolseparation
}
306 \constfunc{int
}{GetToolSeparation
}{\void}
308 Returns the default separator size.
312 \helpref{wxToolBarBase::SetToolSeparation
}{wxtoolbarbasesettoolseparation
}
314 \membersection{wxToolBarBase::GetToolShortHelp
}\label{wxtoolbarbasegettoolshorthelp
}
316 \constfunc{wxString
}{GetToolShortHelp
}{\param{int
}{toolIndex
}}
318 Returns the short help for the given tool.
320 Returns the long help for the given tool.
322 \wxheading{Parameters
}
324 \docparam{toolIndex
}{The tool in question.
}
328 \helpref{wxToolBarBase::GetToolLongHelp
}{wxtoolbarbasegettoollonghelp
},
\rtfsp
329 \helpref{wxToolBarBase::SetToolShortHelp
}{wxtoolbarbasesettoolshorthelp
}\rtfsp
331 \membersection{wxToolBarBase::GetToolState
}\label{wxtoolbarbasegettoolstate
}
333 \constfunc{bool
}{GetToolState
}{\param{int
}{toolIndex
}}
335 Gets the on/off state of a toggle tool.
337 \wxheading{Parameters
}
339 \docparam{toolIndex
}{The tool in question.
}
341 \wxheading{Return value
}
343 TRUE if the tool is toggled on, FALSE otherwise.
345 %\wxheading{See also}
347 %\helpref{wxToolBarBase::SetToolState}{wxtoolbarbasesettoolstate}
349 \membersection{wxToolBarBase::Layout
}\label{wxtoolbarbaselayout
}
351 \func{void
}{Layout
}{\void}
353 Called by the application after the tools have been added to
354 automatically lay the tools out on the canvas. If you have given
355 absolute positions when adding the tools, do not call this.
357 \membersection{wxToolBarBase::OnLeftClick
}\label{wxtoolbarbaseonleftclick
}
359 \func{bool
}{OnLeftClick
}{\param{int
}{ toolIndex
},
\param{bool
}{ toggleDown
}}
361 Called when the user clicks on a tool with the left mouse button. The
362 programmer should override this function to detect left tool clicks.
364 \wxheading{Parameters
}
366 \docparam{toolIndex
}{The identifier passed to
\helpref{wxToolBarBase::AddTool
}{wxtoolbarbaseaddtool
}.
}
368 \docparam{toggleDown
}{TRUE if the tool is a toggle and the toggle is down, otherwise is FALSE.
}
370 \wxheading{Return value
}
372 If the tool is a toggle and this function returns FALSE, the toggle
373 toggle state (internal and visual) will not be changed. This provides a way of
374 specifying that toggle operations are not permitted in some circumstances.
378 \helpref{wxToolBarBase::OnMouseEnter
}{wxtoolbarbaseonmouseenter
},
\rtfsp
379 \helpref{wxToolBarBase::OnRightClick
}{wxtoolbarbaseonrightclick
}
381 \membersection{wxToolBarBase::OnMouseEnter
}\label{wxtoolbarbaseonmouseenter
}
383 \func{void
}{OnMouseEnter
}{\param{int
}{ toolIndex
}}
385 This is called when the mouse cursor moves into a tool or out of
388 \wxheading{Parameters
}
390 \docparam{toolIndex
}{Greater than -
1 if the mouse cursor has moved into the tool,
391 or -
1 if the mouse cursor has moved. The
392 programmer can override this to provide extra information about the tool,
393 such as a short description on the status line.
}
397 With some derived toolbar classes, if the mouse moves quickly out of the toolbar, wxWindows may not be able to
398 detect it. Therefore this function may not always be called when expected.
400 \membersection{wxToolBarBase::OnRightClick
}\label{wxtoolbarbaseonrightclick
}
402 \func{void
}{OnRightClick
}{\param{int
}{ toolIndex
},
\param{float
}{ x
},
\param{float
}{ y
}}
404 Called when the user clicks on a tool with the right mouse button. The
405 programmer should override this function to detect right tool clicks.
407 \wxheading{Parameters
}
409 \docparam{toolIndex
}{The identifier passed to
\helpref{wxToolBarBase::AddTool
}{wxtoolbarbaseaddtool
}.
}
411 \docparam{x
}{The x position of the mouse cursor.
}
413 \docparam{y
}{The y position of the mouse cursor.
}
417 A typical use of this member might be to pop up a menu.
421 \helpref{wxToolBarBase::OnMouseEnter
}{wxtoolbarbaseonmouseenter
},
\rtfsp
422 \helpref{wxToolBarBase::OnLeftClick
}{wxtoolbarbaseonleftclick
}
424 \membersection{wxToolBarBase::SetDefaultSize
}\label{wxtoolbarbasesetdefaultsize
}
426 \func{void
}{SetDefaultSize
}{\param{const wxSize\&
}{ size
}}
428 Sets the default size of each tool bitmap. The default bitmap size is
16 by
15 pixels.
430 \wxheading{Parameters
}
432 \docparam{size
}{The size of the bitmaps in the toolbar.
}
436 This should be called to tell the toolbar what the tool bitmap size is. Call
437 it before you add tools.
439 Note that this is the size of the bitmap you pass to
\helpref{wxToolBarBase::AddTool
}{wxtoolbarbaseaddtool
},
440 and not the eventual size of the tool button.
444 \helpref{wxToolBarBase::GetDefaultSize
}{wxtoolbarbasegetdefaultsize
},
\rtfsp
445 \helpref{wxToolBarBase::GetDefaultButtonSize
}{wxtoolbarbasegetdefaultbuttonsize
}
447 \membersection{wxToolBarBase::SetMargins
}\label{wxtoolbarbasesetmargins
}
449 \func{void
}{SetMargins
}{\param{const wxSize\&
}{ size
}}
451 \func{void
}{SetMargins
}{\param{int
}{ x
},
\param{int
}{ y
}}
453 Set the values to be used as margins for the toolbar.
455 \wxheading{Parameters
}
457 \docparam{size
}{Margin size.
}
459 \docparam{x
}{Left margin, right margin and inter-tool separation value.
}
461 \docparam{y
}{Top margin, bottom margin and inter-tool separation value.
}
465 This must be called before the tools are added if absolute positioning is to be used, and the
466 default (zero-size) margins are to be overridden.
470 \helpref{wxToolBarBase::GetMargins
}{wxtoolbarbasegetmargins
},
\helpref{wxSize
}{wxsize
}
472 \membersection{wxToolBarBase::SetToolLongHelp
}\label{wxtoolbarbasesettoollonghelp
}
474 \func{void
}{SetToolLongHelp
}{\param{int
}{toolIndex
},
\param{const wxString\&
}{helpString
}}
476 Sets the long help for the given tool.
478 \wxheading{Parameters
}
480 \docparam{toolIndex
}{The tool in question.
}
482 \docparam{helpString
}{A string for the long help.
}
486 You might use the long help for displaying the tool purpose on the status line.
490 \helpref{wxToolBarBase::GetToolLongHelp
}{wxtoolbarbasegettoollonghelp
},
\rtfsp
491 \helpref{wxToolBarBase::SetToolShortHelp
}{wxtoolbarbasesettoolshorthelp
},
\rtfsp
493 \membersection{wxToolBarBase::SetToolPacking
}\label{wxtoolbarbasesettoolpacking
}
495 \func{void
}{SetToolPacking
}{\param{int
}{ packing
}}
497 Sets the value used for spacing tools. The default value is
1.
499 \wxheading{Parameters
}
501 \docparam{packing
}{The value for packing.
}
505 The packing is used for spacing in the vertical direction if the toolbar is horizontal,
506 and for spacing in the horizontal direction if the toolbar is vertical.
510 \helpref{wxToolBarBase::GetToolPacking
}{wxtoolbarbasegettoolpacking
}
512 \membersection{wxToolBarBase::SetToolShortHelp
}\label{wxtoolbarbasesettoolshorthelp
}
514 \func{void
}{SetToolShortHelp
}{\param{int
}{toolIndex
},
\param{const wxString\&
}{helpString
}}
516 Sets the short help for the given tool.
518 \wxheading{Parameters
}
520 \docparam{toolIndex
}{The tool in question.
}
522 \docparam{helpString
}{The string for the short help.
}
526 An application might use short help for identifying the tool purpose in a tooltip.
530 \helpref{wxToolBarBase::GetToolShortHelp
}{wxtoolbarbasegettoolshorthelp
},
\helpref{wxToolBarBase::SetToolLongHelp
}{wxtoolbarbasesettoollonghelp
}
532 \membersection{wxToolBarBase::SetToolSeparation
}\label{wxtoolbarbasesettoolseparation
}
534 \func{void
}{SetToolSeparation
}{\param{int
}{ separation
}}
536 Sets the default separator size. The default value is
5.
538 \wxheading{Parameters
}
540 \docparam{separation
}{The separator size.
}
544 \helpref{wxToolBarBase::AddSeparator
}{wxtoolbarbaseaddseparator
}
546 \membersection{wxToolBarBase::ToggleTool
}\label{wxtoolbarbasetoggletool
}
548 \func{void
}{ToggleTool
}{\param{int
}{toolIndex
},
\param{const bool
}{ toggle
}}
550 Toggles a tool on or off.
552 \wxheading{Parameters
}
554 \docparam{toolIndex
}{Tool in question.
}
556 \docparam{toggle
}{If TRUE, toggles the tool on, otherwise toggles it off.
}
560 Only applies to a tool that has been specified as a toggle tool.
564 \helpref{wxToolBarBase::GetToolState
}{wxtoolbarbasegettoolstate
}
566 \section{\class{wxToolBar95
}}\label{wxtoolbar95
}
568 This class should be used when a
3D-effect toolbar is required under Windows
95.
569 It uses the native toolbar control.
571 \wxheading{Derived from
}
573 \helpref{wxToolBarBase
}{wxtoolbarbase
}\\
574 \helpref{wxControl
}{wxcontrol
}\\
575 \helpref{wxWindow
}{wxwindow
}\\
576 \helpref{wxEvtHandler
}{wxevthandler
}\\
577 \helpref{wxObject
}{wxobject
}
579 \wxheading{Window styles
}
581 There are no specific styles for this class.
583 See also
\helpref{window styles overview
}{windowstyles
}.
587 Note that this toolbar paints tools to reflect user-selected colours.
588 The toolbar orientation must always be
{\bf wxVERTICAL
}.
590 For member functions, see the documentation for
\helpref{wxToolBarBase
}{wxtoolbarbase
}.
594 \overview{Toolbar overview
}{wxtoolbaroverview
},
\rtfsp
595 \helpref{wxToolBarBase
}{wxtoolbarbase
},
\rtfsp
596 \helpref{wxToolBarSimple
}{wxtoolbarsimple
},
\rtfsp
597 \helpref{wxToolBarMSW
}{wxtoolbarmsw
}
599 \latexignore{\rtfignore{\wxheading{Members
}}}
601 \membersection{wxToolBar95::wxToolBar95
}\label{wxtoolbar95constr
}
603 \func{}{wxToolBar95
}{\param{wxWindow*
}{ parent
},
\param{wxWindowID
}{id
},
\rtfsp
604 \param{const wxPoint\&
}{pos = wxDefaultPosition
},
\param{const wxSize\&
}{size = wxDefaultSize
},
\rtfsp
605 \param{long
}{style =
0},
\param{int
}{orientation = wxVERTICAL
},
\rtfsp
606 \param{int
}{nRowsOrColumns =
1},
\param{const wxString\&
}{name = ``toolBar"
}}
608 Constructs a toolbar.
610 \wxheading{Parameters
}
612 \docparam{parent
}{Parent window. Must not be NULL.
}
614 \docparam{id
}{Window identifier. A value of -
1 indicates a default value.
}
616 \docparam{pos
}{Window position. If the position (-
1, -
1) is specified then a default position is chosen.
}
618 \docparam{size
}{Window size. If the default size (-
1, -
1) is specified then a default size is chosen.
}
620 \docparam{orientation
}{Specifies a wxVERTICAL or wxHORIZONTAL orientation for laying out
623 \docparam{nRowsOrColumns
}{Specifies the number of rows or
624 columns, whose meaning depends on
{\it orientation
}. If laid out
625 vertically,
{\it nRowsOrColumns
} specifies the number of rows to draw
626 before the next column is started; if horizontal, it refers to the
627 number of columns to draw before the next row is started.
}
629 \docparam{style
}{Window style. See
\helpref{wxToolBar95
}{wxtoolbar95
}.
}
631 \docparam{name
}{Window name.
}
633 \section{\class{wxToolBarMSW
}}\label{wxtoolbarmsw
}
635 This class should be used when a
3D-effect toolbar is required for Windows versions earlier
638 \wxheading{Derived from
}
640 \helpref{wxToolBarBase
}{wxtoolbarbase
}\\
641 \helpref{wxControl
}{wxcontrol
}\\
642 \helpref{wxWindow
}{wxwindow
}\\
643 \helpref{wxEvtHandler
}{wxevthandler
}\\
644 \helpref{wxObject
}{wxobject
}
646 \wxheading{Window styles
}
648 There are no specific styles for this class.
650 See also
\helpref{window styles overview
}{windowstyles
}.
654 Note that this toolbar does not paint tools to reflect user-selected colours: grey shading is used.
656 For member functions, see the documentation for
\helpref{wxToolBarBase
}{wxtoolbarbase
}.
660 \overview{Toolbar overview
}{wxtoolbaroverview
},
\rtfsp
661 \helpref{wxToolBarBase
}{wxtoolbarbase
},
\rtfsp
662 \helpref{wxToolBarSimple
}{wxtoolbarsimple
},
\rtfsp
663 \helpref{wxToolBar95
}{wxtoolbar95
}
665 \latexignore{\rtfignore{\wxheading{Members
}}}
667 \membersection{wxToolBarMSW::wxToolBarMSW
}\label{wxtoolbarmswconstr
}
669 \func{}{wxToolBarMSW
}{\param{wxWindow*
}{ parent
},
\param{wxWindowID
}{id
},
\rtfsp
670 \param{const wxPoint\&
}{pos = wxDefaultPosition
},
\param{const wxSize\&
}{size = wxDefaultSize
},
\rtfsp
671 \param{long
}{style =
0},
\param{int
}{orientation = wxVERTICAL
},
\rtfsp
672 \param{int
}{nRowsOrColumns =
1},
\param{const wxString\&
}{name = ``toolBar"
}}
674 Constructs a toolbar.
676 \wxheading{Parameters
}
678 \docparam{parent
}{Parent window. Must not be NULL.
}
680 \docparam{id
}{Window identifier. A value of -
1 indicates a default value.
}
682 \docparam{pos
}{Window position. If the position (-
1, -
1) is specified then a default position is chosen.
}
684 \docparam{size
}{Window size. If the default size (-
1, -
1) is specified then a default size is chosen.
}
686 \docparam{orientation
}{Specifies a wxVERTICAL or wxHORIZONTAL orientation for laying out
689 \docparam{nRowsOrColumns
}{Specifies the number of rows or
690 columns, whose meaning depends on
{\it orientation
}. If laid out
691 vertically,
{\it nRowsOrColumns
} specifies the number of rows to draw
692 before the next column is started; if horizontal, it refers to the
693 number of columns to draw before the next row is started.
}
695 \docparam{style
}{Window style. See
\helpref{wxToolBarMSW
}{wxtoolbarmsw
}.
}
697 \docparam{name
}{Window name.
}
700 \section{\class{wxToolBarSimple
}}\label{wxtoolbarsimple
}
702 This is the generic toolbar class which has an identical appearance
705 \wxheading{Derived from
}
707 \helpref{wxToolBarBase
}{wxtoolbarbase
}\\
708 \helpref{wxControl
}{wxcontrol
}\\
709 \helpref{wxWindow
}{wxwindow
}\\
710 \helpref{wxEvtHandler
}{wxevthandler
}\\
711 \helpref{wxObject
}{wxobject
}
713 \wxheading{Window styles
}
716 \begin{twocollist
}\itemsep=
0pt
717 \twocolitem{\windowstyle{wxTB
\_3DBUTTONS}}{Gives the simple toolbar a mild
3D look to its buttons.
}
720 See also
\helpref{window styles overview
}{windowstyles
}.
724 In this class, disabling a toolbar tool does not change its appearance.
726 For member functions, see the documentation for
\helpref{wxToolBarBase
}{wxtoolbarbase
}.
730 \overview{Toolbar overview
}{wxtoolbaroverview
},
\rtfsp
731 \helpref{wxToolBarBase
}{wxtoolbarbase
},
\rtfsp
732 \helpref{wxToolBarSimple
}{wxtoolbarsimple
},
\rtfsp
733 \helpref{wxToolBar95
}{wxtoolbar95
}
735 \latexignore{\rtfignore{\wxheading{Members
}}}
737 \membersection{wxToolBarSimple::wxToolBarSimple
}\label{wxtoolbarsimpleconstr
}
739 \func{}{wxToolBarSimple
}{\param{wxWindow*
}{ parent
},
\param{wxWindowID
}{id
},
\rtfsp
740 \param{const wxPoint\&
}{pos = wxDefaultPosition
},
\param{const wxSize\&
}{size = wxDefaultSize
},
\rtfsp
741 \param{long
}{style =
0},
\param{int
}{orientation = wxVERTICAL
},
\rtfsp
742 \param{int
}{nRowsOrColumns =
1},
\param{const wxString\&
}{name = ``toolBar"
}}
744 Constructs a toolbar.
746 \wxheading{Parameters
}
748 \docparam{parent
}{Parent window. Must not be NULL.
}
750 \docparam{id
}{Window identifier. A value of -
1 indicates a default value.
}
752 \docparam{pos
}{Window position. If the position (-
1, -
1) is specified then a default position is chosen.
}
754 \docparam{size
}{Window size. If the default size (-
1, -
1) is specified then a default size is chosen.
}
756 \docparam{orientation
}{Specifies a wxVERTICAL or wxHORIZONTAL orientation for laying out
759 \docparam{nRowsOrColumns
}{Specifies the number of rows or
760 columns, whose meaning depends on
{\it orientation
}. If laid out
761 vertically,
{\it nRowsOrColumns
} specifies the number of rows to draw
762 before the next column is started; if horizontal, it refers to the
763 number of columns to draw before the next row is started.
}
765 \docparam{style
}{Window style. See
\helpref{wxToolBarSimple
}{wxtoolbarsimple
}.
}
767 \docparam{name
}{Window name.
}