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

adjusted indentation with astyle; added Id keyword

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52383 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Francesco Montorsi
2008-03-08 14:43:31 +00:00
parent aa6ec1d787
commit 7c913512a4
269 changed files with 9052 additions and 9058 deletions
Download Patch File Download Diff File Expand all files Collapse all files

134
interface/toolbar.h
View File

@@ -9,15 +9,15 @@
/**
@class wxToolBar
@wxheader{toolbar.h}
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.
@beginStyleTable
@style{wxTB_FLAT}:
Gives the toolbar a flat look (Windows and GTK only).
@@ -51,10 +51,10 @@
@style{wxTB_RIGHT}:
Align the toolbar at the right side of parent window.
@endStyleTable
@library{wxbase}
@category{miscwnd}
@seealso
@ref overview_wxtoolbaroverview "Toolbar overview", wxScrolledWindow
*/
@@ -65,26 +65,26 @@ public:
/**
Constructs a toolbar.
@param parent
@param parent
Pointer to a parent window.
@param id
@param id
Window identifier. If -1, will automatically create an identifier.
@param pos
@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.
@param size
@param size
Window size. wxDefaultSize is (-1, -1) which indicates that wxWidgets
should generate a default size for the window.
@param style
@param style
Window style. See wxToolBar for details.
@param name
@param name
Window name.
@remarks After a toolbar is created, you use AddTool() and
@@ -93,11 +93,11 @@ public:
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);
wxToolBar(wxWindow* parent, wxWindowID id,
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
long style = wxTB_HORIZONTAL | wxBORDER_NONE,
const wxString& name = wxPanelNameStr);
//@}
/**
@@ -122,10 +122,10 @@ public:
/**
Adds any control to the toolbar, typically e.g. a combobox.
@param control
@param control
The control to be added.
@param label
@param label
Text to be displayed near the control.
@remarks wxMSW: the label is only displayed if there is enough space
@@ -167,37 +167,37 @@ public:
specify some of the more rarely used button features. The last version allows
you to add an existing tool.
@param toolId
@param toolId
An integer by which
the tool may be identified in subsequent operations.
@param kind
@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
@param bitmap1
@param bitmap1
The primary tool bitmap.
@param bitmap2
@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.
@param shortHelpString
@param shortHelpString
This string is used for the tools tooltip
@param longHelpString
@param longHelpString
This string is shown in the statusbar (if any) of the
parent frame when the mouse pointer is inside the tool
@param clientData
@param clientData
An optional pointer to client data which can be
retrieved later using GetToolClientData().
@param tool
@param tool
The tool to be added.
@remarks After you have added tools to a toolbar, you must call
@@ -210,14 +210,14 @@ public:
const wxBitmap& bitmap1,
const wxString& shortHelpString = "",
wxItemKind kind = wxITEM_NORMAL);
wxToolBarToolBase* AddTool(int toolId, const wxString& label,
const wxBitmap& bitmap1,
const wxBitmap& bitmap2 = wxNullBitmap,
wxItemKind kind = wxITEM_NORMAL,
const wxString& shortHelpString = "",
const wxString& longHelpString = "",
wxObject* clientData = @NULL);
wxToolBarToolBase* AddTool(wxToolBarToolBase* tool);
wxToolBarToolBase* AddTool(int toolId, const wxString& label,
const wxBitmap& bitmap1,
const wxBitmap& bitmap2 = wxNullBitmap,
wxItemKind kind = wxITEM_NORMAL,
const wxString& shortHelpString = "",
const wxString& longHelpString = "",
wxObject* clientData = @NULL);
wxToolBarToolBase* AddTool(wxToolBarToolBase* tool);
//@}
/**
@@ -248,10 +248,10 @@ public:
/**
Enables or disables the tool.
@param toolId
@param toolId
Tool to enable or disable.
@param enable
@param enable
If @true, enables the tool, otherwise disables it.
@remarks Some implementations will change the visible state of the tool
@@ -268,7 +268,7 @@ public:
wxToolBarToolBase* FindById(int id);
/**
Returns a pointer to the control identified by @e id or
Returns a pointer to the control identified by @e id or
@NULL if no corresponding control is found.
*/
wxControl* FindControl(int id);
@@ -276,10 +276,10 @@ public:
/**
Finds a tool for the given mouse position.
@param x
@param x
X position.
@param y
@param y
Y position.
@returns A pointer to a tool if a tool is found, or @NULL otherwise.
@@ -311,7 +311,7 @@ public:
/**
Get any client data associated with the tool.
@param toolId
@param toolId
Id of the tool, as passed to AddTool().
@returns Client data, or @NULL if there is none.
@@ -321,7 +321,7 @@ public:
/**
Called to determine whether a tool is enabled (responds to user input).
@param toolId
@param toolId
Id of the tool in question.
@returns @true if the tool is enabled, @false otherwise.
@@ -333,7 +333,7 @@ public:
/**
Returns the long help for the given tool.
@param toolId
@param toolId
The tool in question.
@sa SetToolLongHelp(), SetToolShortHelp()
@@ -363,7 +363,7 @@ public:
/**
Returns the short help for the given tool.
@param toolId
@param toolId
The tool in question.
@sa GetToolLongHelp(), SetToolShortHelp()
@@ -382,7 +382,7 @@ public:
/**
Gets the on/off state of a toggle tool.
@param toolId
@param toolId
The tool in question.
@returns @true if the tool is toggled on, @false otherwise.
@@ -431,8 +431,8 @@ public:
wxObject* clientData = @NULL,
const wxString& shortHelpString = "",
const wxString& longHelpString = "");
wxToolBarToolBase * InsertTool(size_t pos,
wxToolBarToolBase* tool);
wxToolBarToolBase * InsertTool(size_t pos,
wxToolBarToolBase* tool);
//@}
/**
@@ -441,10 +441,10 @@ public:
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
@param toolId
The identifier passed to AddTool().
@param toggleDown
@param toggleDown
@true if the tool is a toggle and the toggle is down, otherwise is @false.
@returns If the tool is a toggle and this function returns @false, the
@@ -465,7 +465,7 @@ public:
work,
you should use the EVT_TOOL_ENTER macro instead.
@param toolId
@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,
@@ -485,13 +485,13 @@ public:
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
@param toolId
The identifier passed to AddTool().
@param x
@param x
The x position of the mouse cursor.
@param y
@param y
The y position of the mouse cursor.
@remarks A typical use of this member might be to pop up a menu.
@@ -526,7 +526,7 @@ public:
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
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);
@@ -535,13 +535,13 @@ public:
/**
Set the values to be used as margins for the toolbar.
@param size
@param size
Margin size.
@param x
@param x
Left margin, right margin and inter-tool separation value.
@param y
@param y
Top margin, bottom margin and inter-tool separation value.
@remarks This must be called before the tools are added if absolute
@@ -551,14 +551,14 @@ public:
@sa GetMargins(), wxSize
*/
void SetMargins(const wxSize& size);
void SetMargins(int x, int y);
void SetMargins(int x, int y);
//@}
/**
Sets the default size of each tool bitmap. The default bitmap size is 16 by 15
pixels.
@param size
@param size
The size of the bitmaps in the toolbar.
@remarks This should be called to tell the toolbar what the tool bitmap
@@ -585,10 +585,10 @@ public:
/**
Sets the long help for the given tool.
@param toolId
@param toolId
The tool in question.
@param helpString
@param helpString
A string for the long help.
@remarks You might use the long help for displaying the tool purpose on
@@ -607,7 +607,7 @@ public:
/**
Sets the value used for spacing tools. The default value is 1.
@param packing
@param packing
The value for packing.
@remarks The packing is used for spacing in the vertical direction if the
@@ -621,7 +621,7 @@ public:
/**
Sets the default separator size. The default value is 5.
@param separation
@param separation
The separator size.
@sa AddSeparator()
@@ -631,10 +631,10 @@ public:
/**
Sets the short help for the given tool.
@param toolId
@param toolId
The tool in question.
@param helpString
@param helpString
The string for the short help.
@remarks An application might use short help for identifying the tool
@@ -647,10 +647,10 @@ public:
/**
Toggles a tool on or off. This does not cause any event to get emitted.
@param toolId
@param toolId
Tool in question.
@param toggle
@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.