Amebis/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

More interface header reviews by Azriel Fasten, and added skeleton docs for wxBookCtrlBase (still needs docs though).

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@53665 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Bryan Petty
2008-05-20 07:48:30 +00:00
parent 79996663e2
commit 7977b62ae2
7 changed files with 991 additions and 680 deletions
Download Patch File Download Diff File Expand all files Collapse all files

388
interface/toolbar.h
View File

@@ -10,49 +10,123 @@
@class wxToolBar
@wxheader{toolbar.h}
The name wxToolBar is defined to be a synonym for one of the following classes:
The name wxToolBar is defined to be a synonym for one of the following
classes:
@b wxToolBar95 The native Windows 95 toolbar. Used on Windows 95, NT 4 and
above.
@b wxToolBarMSW A Windows implementation. Used on 16-bit Windows.
@b wxToolBarGTK The GTK toolbar.
- @b wxToolBar95 - The native Windows 95 toolbar. Used on Windows 95, NT 4
and above.
- @b wxToolBarMSW - A Windows implementation. Used on 16-bit Windows.
- @b wxToolBarGTK - The GTK toolbar.
You may also create a toolbar that is managed by the frame, by calling
wxFrame::CreateToolBar(). Under Pocket PC, you should always use this
function for creating the toolbar to be managed by the frame, so that
wxWidgets can use a combined menubar and toolbar. Where you manage your
own toolbars, create a wxToolBar as usual.
The meaning of a "separator" is a vertical line under Windows and simple
space under GTK+.
@b wxToolBar95: Note that this toolbar paints tools to reflect
system-wide colours. If you use more than 16 colours in your tool
bitmaps, you may wish to suppress this behaviour, otherwise system
colours in your bitmaps will inadvertently be mapped to system colours.
To do this, set the msw.remap system option before creating the toolbar:
@code
wxSystemOptions::SetOption(wxT("msw.remap"), 0);
@endcode
If you wish to use 32-bit images (which include an alpha channel for
transparency) use:
@code
wxSystemOptions::SetOption(wxT("msw.remap"), 2);
@endcode
Then colour remapping is switched off, and a transparent background
used. But only use this option under Windows XP with true colour:
@code
if (wxTheApp->GetComCtl32Version() >= 600 && ::wxDisplayDepth() >= 32)
@endcode
There are several different types of tools you can add to a toolbar. These
types are controlled by the ::wxItemKind enumeration.
@beginStyleTable
@style{wxTB_FLAT}
Gives the toolbar a flat look (Windows and GTK only).
Gives the toolbar a flat look (Windows and GTK only).
@style{wxTB_DOCKABLE}
Makes the toolbar floatable and dockable (GTK only).
Makes the toolbar floatable and dockable (GTK only).
@style{wxTB_HORIZONTAL}
Specifies horizontal layout (default).
Specifies horizontal layout (default).
@style{wxTB_VERTICAL}
Specifies vertical layout.
Specifies vertical layout.
@style{wxTB_TEXT}
Shows the text in the toolbar buttons; by default only icons are
shown.
Shows the text in the toolbar buttons; by default only icons are shown.
@style{wxTB_NOICONS}
Specifies no icons in the toolbar buttons; by default they are
shown.
Specifies no icons in the toolbar buttons; by default they are shown.
@style{wxTB_NODIVIDER}
Specifies no divider (border) above the toolbar (Windows only).
Specifies no divider (border) above the toolbar (Windows only)
@style{wxTB_NOALIGN}
Specifies no alignment with the parent window (Windows only, not
very useful).
Specifies no alignment with the parent window (Windows only, not very
useful).
@style{wxTB_HORZ_LAYOUT}
Shows the text and the icons alongside, not vertically stacked
(Windows and GTK 2 only). This style must be used with wxTB_TEXT.
Shows the text and the icons alongside, not vertically stacked (Windows
and GTK 2 only). This style must be used with @c wxTB_TEXT.
@style{wxTB_HORZ_TEXT}
Combination of wxTB_HORZ_LAYOUT and wxTB_TEXT.
Combination of @c wxTB_HORZ_LAYOUT and @c wxTB_TEXT.
@style{wxTB_NO_TOOLTIPS}
Don't show the short help tooltips for the tools when the mouse
hovers over them.
Don't show the short help tooltips for the tools when the mouse hovers
over them.
@style{wxTB_BOTTOM}
Align the toolbar at the bottom of parent window.
Align the toolbar at the bottom of parent window.
@style{wxTB_RIGHT}
Align the toolbar at the right side of parent window.
Align the toolbar at the right side of parent window.
@endStyleTable
@library{wxbase}
See also @ref overview_windowstyles. Note that the Win32 native toolbar
ignores @c wxTB_NOICONS style. Also, toggling the @c wxTB_TEXT works only
if the style was initially on.
@beginEventTable{wxCommandEvent}
@event{EVT_TOOL(id, func)}
Process a @c wxEVT_COMMAND_TOOL_CLICKED event (a synonym for @c
wxEVT_COMMAND_MENU_SELECTED). Pass the id of the tool.
@event{EVT_MENU(id, func)}
The same as EVT_TOOL().
@event{EVT_TOOL_RANGE(id1, id2, func)}
Process a @c wxEVT_COMMAND_TOOL_CLICKED event for a range of
identifiers. Pass the ids of the tools.
@event{EVT_MENU_RANGE(id1, id2, func)}
The same as EVT_TOOL_RANGE().
@event{EVT_TOOL_RCLICKED(id, func)}
Process a @c wxEVT_COMMAND_TOOL_RCLICKED event. Pass the id of the
tool.
@event{EVT_TOOL_RCLICKED_RANGE(id1, id2, func)}
Process a @c wxEVT_COMMAND_TOOL_RCLICKED event for a range of ids. Pass
the ids of the tools.
@event{EVT_TOOL_ENTER(id, func)}
Process a @c 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.
@event{EVT_TOOL_DROPDOWN(id, func)}
Process a @c wxEVT_COMMAND_TOOL_DROPDOWN_CLICKED event. If unhandled,
displays the default dropdown menu set using
wxToolBar::SetDropdownMenu().
@endEventTable
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 window identifier is passed and the tool identifier is retrieved
from the wxCommandEvent. This is because the identifier may be -1 when the
mouse moves off a tool, and -1 is not allowed as an identifier in the event
system.
@library{wxcore}
@category{miscwnd}
@see @ref overview_toolbar
@@ -60,7 +134,11 @@
class wxToolBar : public wxControl
{
public:
//@{
/**
Default constructor.
*/
wxToolBar();
/**
Constructs a toolbar.
@@ -69,31 +147,26 @@ public:
@param id
Window identifier. If -1, will automatically create an identifier.
@param pos
Window position. wxDefaultPosition is (-1, -1) which indicates that
wxWidgets
should generate a default position for the window. If using the wxWindow
class directly, supply
an actual position.
Window position. ::wxDefaultPosition is (-1, -1) which indicates that
wxWidgets should generate a default position for the window. If
using the wxWindow class directly, supply an actual position.
@param size
Window size. wxDefaultSize is (-1, -1) which indicates that wxWidgets
should generate a default size for the window.
Window size. ::wxDefaultSize is (-1, -1) which indicates that
wxWidgets should generate a default size for the window.
@param style
Window style. See wxToolBar for details.
@param name
Window name.
@remarks After a toolbar is created, you use AddTool() and
perhaps AddSeparator(), and then you must call
Realize() to construct and display the toolbar
tools.
@remarks After a toolbar is created, you use AddTool() and perhaps
AddSeparator(), and then you must call Realize() to construct and
display the toolbar tools.
*/
wxToolBar();
wxToolBar(wxWindow* parent, wxWindowID id,
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
long style = wxTB_HORIZONTAL | wxBORDER_NONE,
const wxString& name = wxPanelNameStr);
//@}
/**
Toolbar destructor.
@@ -101,8 +174,8 @@ public:
~wxToolBar();
/**
Adds a new check (or toggle) tool to the toolbar. The parameters are the same
as in AddTool().
Adds a new check (or toggle) tool to the toolbar. The parameters are the
same as in AddTool().
@see AddTool()
*/
@@ -115,26 +188,34 @@ public:
wxObject* clientData = NULL);
/**
Adds any control to the toolbar, typically e.g. a combobox.
Adds any control to the toolbar, typically e.g. a wxComboBox.
@param control
The control to be added.
@param label
Text to be displayed near the control.
@remarks wxMSW: the label is only displayed if there is enough space
available below the embedded control.
@remarks
wxMSW: the label is only displayed if there is enough space
available below the embedded control.
@remarks
wxMac: labels are only displayed if wxWidgets is built with @c
wxMAC_USE_NATIVE_TOOLBAR set to 1
*/
bool AddControl(wxControl* control, const wxString label = "");
/**
Adds a new radio tool to the toolbar. Consecutive radio tools form a radio
group such that exactly one button in the group is pressed at any moment, in
other words whenever a button in the group is pressed the previously pressed
button is automatically released. You should avoid having the radio groups of
only one element as it would be impossible for the user to use such button.
By default, the first button in the radio group is initially pressed, the
others are not.
Adds a new radio tool to the toolbar. Consecutive radio tools form a
radio group such that exactly one button in the group is pressed at any
moment, in other words whenever a button in the group is pressed the
previously pressed button is automatically released. You should avoid
having the radio groups of only one element as it would be impossible
for the user to use such button.
By default, the first button in the radio group is initially pressed,
the others are not.
@see AddTool()
*/
@@ -155,40 +236,39 @@ public:
//@{
/**
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
specify some of the more rarely used button features. The last version allows
you to add an existing 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 specify some of the more rarely used button features. The
last version allows you to add an existing tool.
@param toolId
An integer by which
the tool may be identified in subsequent operations.
An integer by which the tool may be identified in subsequent
operations.
@param kind
May be wxITEM_NORMAL for a normal button (default),
wxITEM_CHECK for a checkable tool (such tool stays pressed after it had been
toggled) or wxITEM_RADIO for a checkable tool which makes part of a radio
group of tools each of which is automatically unchecked whenever another
button
in the group is checked
May be ::wxITEM_NORMAL for a normal button (default), ::wxITEM_CHECK
for a checkable tool (such tool stays pressed after it had been
toggled) or ::wxITEM_RADIO for a checkable tool which makes part of
a radio group of tools each of which is automatically unchecked
whenever another button in the group is checked.
@param bitmap1
The primary tool bitmap.
@param bitmap2
The bitmap used when the tool is disabled. If it is equal to
wxNullBitmap, the disabled bitmap is automatically generated by greing the
normal one.
::wxNullBitmap, the disabled bitmap is automatically generated by
greying the normal one.
@param shortHelpString
This string is used for the tools tooltip
This string is used for the tools tooltip.
@param longHelpString
This string is shown in the statusbar (if any) of the
parent frame when the mouse pointer is inside the tool
This string is shown in the statusbar (if any) of the parent frame
when the mouse pointer is inside the tool.
@param clientData
An optional pointer to client data which can be
retrieved later using GetToolClientData().
An optional pointer to client data which can be retrieved later
using GetToolClientData().
@param tool
The tool to be added.
@remarks After you have added tools to a toolbar, you must call
Realize() in order to have the tools appear.
Realize() in order to have the tools appear.
@see AddSeparator(), AddCheckTool(), AddRadioTool(),
InsertTool(), DeleteTool(), Realize()
@@ -213,20 +293,22 @@ public:
void ClearTools();
/**
Removes the specified tool from the toolbar and deletes it. If you don't want
to delete the tool, but just to remove it from the toolbar (to possibly add it
back later), you may use RemoveTool() instead.
Note that it is unnecessary to call Realize() for the
change to take place, it will happen immediately.
Returns @true if the tool was deleted, @false otherwise.
Removes the specified tool from the toolbar and deletes it. If you don't
want to delete the tool, but just to remove it from the toolbar (to
possibly add it back later), you may use RemoveTool() instead.
@note It is unnecessary to call Realize() for the change to take
place, it will happen immediately.
@returns @true if the tool was deleted, @false otherwise.
@see DeleteToolByPos()
*/
bool DeleteTool(int toolId);
/**
This function behaves like DeleteTool() but it
deletes the tool at the specified position and not the one with the given id.
This function behaves like DeleteTool() but it deletes the tool at the
specified position and not the one with the given id.
*/
bool DeleteToolByPos(size_t pos);
@@ -239,21 +321,22 @@ public:
If @true, enables the tool, otherwise disables it.
@remarks Some implementations will change the visible state of the tool
to indicate that it is disabled.
to indicate that it is disabled.
@see GetToolEnabled(), ToggleTool()
*/
void EnableTool(int toolId, bool enable);
/**
Returns a pointer to the tool identified by @a id or
@NULL if no corresponding tool is found.
Returns a pointer to the tool identified by @a id or @NULL if no
corresponding tool is found.
*/
wxToolBarToolBase* FindById(int id);
/**
Returns a pointer to the control identified by @a id or
@NULL if no corresponding control is found.
Returns a pointer to the control identified by @a id or @NULL if no
corresponding control is found.
*/
wxControl* FindControl(int id);
@@ -267,7 +350,8 @@ public:
@return A pointer to a tool if a tool is found, or @NULL otherwise.
@remarks Currently not implemented in wxGTK (always returns @NULL there).
@remarks Currently not implemented in wxGTK (always returns @NULL
there).
*/
wxToolBarToolBase* FindToolForPosition(wxCoord x, wxCoord y) const;
@@ -280,12 +364,11 @@ public:
wxSize GetMargins() const;
/**
Returns the size of bitmap that the toolbar expects to have. The default bitmap
size is 16 by 15 pixels.
Returns the size of bitmap that the toolbar expects to have. The default
bitmap size is 16 by 15 pixels.
@remarks Note that this is the size of the bitmap you pass to
AddTool(), and not the eventual size of the
tool button.
@remarks Note that this is the size of the bitmap you pass to AddTool(),
and not the eventual size of the tool button.
@see SetToolBitmapSize(), GetToolSize()
*/
@@ -331,8 +414,8 @@ public:
int GetToolPacking() const;
/**
Returns the tool position in the toolbar, or @c wxNOT_FOUND if the tool is not
found.
Returns the tool position in the toolbar, or @c wxNOT_FOUND if the tool
is not found.
*/
int GetToolPos(int toolId) const;
@@ -354,9 +437,8 @@ public:
wxString GetToolShortHelp(int toolId) const;
/**
Returns the size of a whole button, which is usually larger than a tool bitmap
because
of added 3D effects.
Returns the size of a whole button, which is usually larger than a tool
bitmap because of added 3D effects.
@see SetToolBitmapSize(), GetToolBitmapSize()
*/
@@ -380,16 +462,16 @@ public:
int GetToolsCount() const;
/**
Inserts the control into the toolbar at the given position.
You must call Realize() for the change to take place.
Inserts the control into the toolbar at the given position. You must
call Realize() for the change to take place.
@see AddControl(), InsertTool()
*/
wxToolBarToolBase* InsertControl(size_t pos, wxControl* control);
/**
Inserts the separator into the toolbar at the given position.
You must call Realize() for the change to take place.
Inserts the separator into the toolbar at the given position. You must
call Realize() for the change to take place.
@see AddSeparator(), InsertTool()
*/
@@ -397,8 +479,9 @@ public:
//@{
/**
Inserts the tool with the specified attributes into the toolbar at the given
position.
Inserts the tool with the specified attributes into the toolbar at the
given position.
You must call Realize() for the change to take place.
@see AddTool(), InsertControl(), InsertSeparator()
@@ -415,49 +498,50 @@ public:
//@}
/**
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.
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.
@param toolId
The identifier passed to AddTool().
@param toggleDown
@true if the tool is a toggle and the toggle is down, otherwise is @false.
@true if the tool is a toggle and the toggle is down, otherwise is
@false.
@return 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.
toggle state (internal and visual) will not be changed. This
provides a way of specifying that toggle operations are not
permitted in some circumstances.
@see OnMouseEnter(), OnRightClick()
*/
bool OnLeftClick(int toolId, bool toggleDown);
/**
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.
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.
@param toolId
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.
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.
@remarks With some derived toolbar classes, if the mouse moves quickly
out of the toolbar, wxWidgets may not be able to detect
it. Therefore this function may not always be called
when expected.
out of the toolbar, wxWidgets may not be able to detect it.
Therefore this function may not always be called when expected.
*/
void OnMouseEnter(int toolId);
/**
@deprecated This is the old way of detecting tool right clicks;
although it will still work, you should use the
EVT_TOOL_RCLICKED() macro instead.
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.
@param toolId
The identifier passed to AddTool().
@@ -478,26 +562,29 @@ public:
bool Realize();
/**
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.
Note that it is unnecessary to call Realize() for the
change to take place, it will happen immediately.
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.
@note It is unnecessary to call Realize() for the change to take place,
it will happen immediately.
@see DeleteTool()
*/
wxToolBarToolBase* RemoveTool(int id);
/**
Sets the bitmap resource identifier for specifying tool bitmaps as indices
into a custom bitmap. Windows CE only.
Sets the bitmap resource identifier for specifying tool bitmaps as
indices into a custom bitmap. Windows CE only.
*/
void SetBitmapResource(int resourceId);
/**
Sets the dropdown menu for the tool given by its @e id. The tool itself will
delete the menu when it's no longer needed.
If you define a EVT_TOOL_DROPDOWN handler in your program, you must call
wxEvent::Skip from it or the menu won't be displayed.
Sets the dropdown menu for the tool given by its @e id. The tool itself
will delete the menu when it's no longer needed.
If you define a EVT_TOOL_DROPDOWN() handler in your program, you must
call wxEvent::Skip() from it or the menu won't be displayed.
*/
bool SetDropdownMenu(int id, wxMenu* menu);
@@ -513,8 +600,8 @@ public:
Top margin, bottom margin and inter-tool separation value.
@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.
positioning is to be used, and the default (zero-size) margins are
to be overridden.
@see GetMargins(), wxSize
*/
@@ -523,14 +610,14 @@ public:
//@}
/**
Sets the default size of each tool bitmap. The default bitmap size is 16 by 15
pixels.
Sets the default size of each tool bitmap. The default bitmap size is 16
by 15 pixels.
@param size
The size of the bitmaps in the toolbar.
@remarks This should be called to tell the toolbar what the tool bitmap
size is. Call it before you add tools.
size is. Call it before you add tools.
@see GetToolBitmapSize(), GetToolSize()
*/
@@ -543,10 +630,13 @@ public:
/**
Sets the bitmap to be used by the tool with the given ID when the tool
is in a disabled state. This can only be used on Button tools, not
controls. NOTE: The native toolbar classes on the main platforms all
synthesize the disabled bitmap from the normal bitmap, so this
function will have no effect on those platforms.
is in a disabled state. This can only be used on Button tools, not
controls.
@note The native toolbar classes on the main platforms all synthesize
the disabled bitmap from the normal bitmap, so this function will
have no effect on those platforms.
*/
void SetToolDisabledBitmap(int id, const wxBitmap& bitmap);
@@ -559,15 +649,15 @@ public:
A string for the long help.
@remarks You might use the long help for displaying the tool purpose on
the status line.
the status line.
@see GetToolLongHelp(), SetToolShortHelp(),
*/
void SetToolLongHelp(int toolId, const wxString& helpString);
/**
Sets the bitmap to be used by the tool with the given ID. This can
only be used on Button tools, not controls.
Sets the bitmap to be used by the tool with the given ID. This can only
be used on Button tools, not controls.
*/
void SetToolNormalBitmap(int id, const wxBitmap& bitmap);
@@ -577,9 +667,9 @@ public:
@param packing
The value for packing.
@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.
@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.
@see GetToolPacking()
*/
@@ -604,7 +694,8 @@ public:
The string for the short help.
@remarks An application might use short help for identifying the tool
purpose in a tooltip.
purpose in a tooltip.
@see GetToolShortHelp(), SetToolLongHelp()
*/
@@ -618,7 +709,8 @@ public:
@param toggle
If @true, toggles the tool on, otherwise toggles it off.
@remarks Only applies to a tool that has been specified as a toggle tool.
@remarks Only applies to a tool that has been specified as a toggle
tool.
*/
void ToggleTool(int toolId, bool toggle);
};