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

Document styles for the AUI toolbar

Browse Source
This commit is contained in:
Ian McInerney
2020-09-14 21:33:27 +01:00
parent b4a50b1ea7
commit 5e73cf3612
1 changed files with 25 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
interface/wx/aui/auibar.h
View File

@@ -617,26 +617,34 @@ public:
@beginStyleTable @beginStyleTable
@style{wxAUI_TB_TEXT} @style{wxAUI_TB_TEXT}
Display the label strings on the toolbar buttons.
@style{wxAUI_TB_NO_TOOLTIPS} @style{wxAUI_TB_NO_TOOLTIPS}
Do not show tooltips for the toolbar items.
@style{wxAUI_TB_NO_AUTORESIZE} @style{wxAUI_TB_NO_AUTORESIZE}
Do not automatically resize the toolbar when new tools are added.
@style{wxAUI_TB_GRIPPER} @style{wxAUI_TB_GRIPPER}
Show the toolbar's gripper control. If the toolbar is added to
an AUI pane that contains a gripper, this style will be automatically
set.
@style{wxAUI_TB_OVERFLOW} @style{wxAUI_TB_OVERFLOW}
Show an overflow menu containing toolbar items that can't fit on the
toolbar if it is too small.
@style{wxAUI_TB_VERTICAL} @style{wxAUI_TB_VERTICAL}
using this style forces the toolbar to be vertical and Using this style forces the toolbar to be vertical and
be only dockable to the left or right sides of the window be only dockable to the left or right sides of the window
whereas by default it can be horizontal or vertical and whereas by default it can be horizontal or vertical and
be docked anywhere be docked anywhere.
@style{wxAUI_TB_HORZ_LAYOUT} @style{wxAUI_TB_HORZ_LAYOUT}
@style{wxAUI_TB_HORIZONTAL} @style{wxAUI_TB_HORIZONTAL}
analogous to wxAUI_TB_VERTICAL, but forces the toolbar Analogous to wxAUI_TB_VERTICAL, but forces the toolbar
to be horizontal to be horizontal.
@style{wxAUI_TB_PLAIN_BACKGROUND} @style{wxAUI_TB_PLAIN_BACKGROUND}
Draw a plain background (based on parent) instead of the Draw a plain background (based on parent) instead of the
default gradient background. default gradient background.
@style{wxAUI_TB_HORZ_TEXT} @style{wxAUI_TB_HORZ_TEXT}
Equivalent to wxAUI_TB_HORZ_LAYOUT | wxAUI_TB_TEXT Equivalent to wxAUI_TB_HORZ_LAYOUT | wxAUI_TB_TEXT
@style{wxAUI_TB_DEFAULT_STYLE} @style{wxAUI_TB_DEFAULT_STYLE}
The default is to have no styles The default is to have no styles.
@endStyleTable @endStyleTable
@beginEventEmissionTable{wxAuiToolBarEvent} @beginEventEmissionTable{wxAuiToolBarEvent}
@@ -861,6 +869,18 @@ public:
wxString GetToolLongHelp(int toolId) const; wxString GetToolLongHelp(int toolId) const;
void SetToolLongHelp(int toolId, const wxString& help_string); void SetToolLongHelp(int toolId, const wxString& help_string);
/**
Add toolbar items that are always displayed in the overflow menu.
If there are custom items set, then the overflow menu will be
displayed even if there are no items from the main toolbar that
overflow.
@param prepend are the items to show before any overflow items
@param append are the items to show after any overflow items
@note The toolbar must have the @c wxAUI_TB_OVERFLOW style.
*/
void SetCustomOverflowItems(const wxAuiToolBarItemArray& prepend, void SetCustomOverflowItems(const wxAuiToolBarItemArray& prepend,
const wxAuiToolBarItemArray& append); const wxAuiToolBarItemArray& append);