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

Remove all trailing spaces

Browse Source 
No real changes, just clean up sources by removing trailing spaces from
all the non-generated files.

This should hopefully avoid future commits mixing significant changes
with insignificant whitespace ones.
This commit is contained in:
Vadim Zeitlin
2019-01-30 17:28:08 +01:00
parent ae94f4da9c
commit 8fbca5cb70
320 changed files with 1611 additions and 1611 deletions
Download Patch File Download Diff File Expand all files Collapse all files

126
interface/wx/ribbon/art.h
View File

@@ -8,7 +8,7 @@
/**
Identifiers for common settings on ribbon art providers which can be used
to tweak the appearance of the art provider.
@see wxRibbonArtProvider::GetColour()
@see wxRibbonArtProvider::GetFont()
@see wxRibbonArtProvider::GetMetric()
@@ -127,7 +127,7 @@ enum wxRibbonArtSetting
/**
Flags used to describe the direction, state, and/or purpose of a
ribbon-style scroll button.
@see wxRibbonArtProvider::DrawScrollButton()
@see wxRibbonArtProvider::GetScrollButtonMinimumSize()
*/
@@ -167,19 +167,19 @@ enum wxRibbonButtonKind
action.
*/
wxRIBBON_BUTTON_NORMAL = 1 << 0,
/**
Dropdown button or tool with a clickable area which typically causes a
dropdown menu.
*/
wxRIBBON_BUTTON_DROPDOWN = 1 << 1,
/**
Button or tool with two clickable areas - one which causes a dropdown
menu, and one which causes a generic action.
*/
wxRIBBON_BUTTON_HYBRID = wxRIBBON_BUTTON_NORMAL | wxRIBBON_BUTTON_DROPDOWN,
/**
Normal button or tool with a clickable area which toggles the button
between a pressed and unpressed state.
@@ -216,7 +216,7 @@ public:
Constructor.
*/
wxRibbonArtProvider();
/**
Destructor.
*/
@@ -226,16 +226,16 @@ public:
Create a new art provider which is a clone of this one.
*/
virtual wxRibbonArtProvider* Clone() const = 0;
/**
Set the style flags.
Normally called automatically by wxRibbonBar::SetArtProvider with the ribbon
bar's style flags, so that the art provider has the same flags as the bar which
it is serving.
*/
virtual void SetFlags(long flags) = 0;
/**
Get the previously set style flags.
*/
@@ -246,53 +246,53 @@ public:
@a id can be one of the size values of @ref wxRibbonArtSetting.
*/
virtual int GetMetric(int id) const = 0;
/**
Set the value of a certain integer setting to the value @e new_val.
@a id can be one of the size values of @ref wxRibbonArtSetting.
*/
virtual void SetMetric(int id, int new_val) = 0;
/**
Set the value of a certain font setting to the value @e font.
@a id can be one of the font values of @ref wxRibbonArtSetting.
*/
virtual void SetFont(int id, const wxFont& font) = 0;
/**
Get the value of a certain font setting.
@a id can be one of the font values of @ref wxRibbonArtSetting.
*/
virtual wxFont GetFont(int id) const = 0;
/**
Get the value of a certain colour setting.
@a id can be one of the colour values of @ref wxRibbonArtSetting.
*/
virtual wxColour GetColour(int id) const = 0;
/**
Set the value of a certain colour setting to the value @e colour.
@a id can be one of the colour values of @ref wxRibbonArtSetting, though
not all colour settings will have an effect on every art provider.
@see SetColourScheme()
*/
virtual void SetColour(int id, const wxColour& colour) = 0;
/**
@see wxRibbonArtProvider::GetColour()
*/
wxColour GetColor(int id) const;
/**
@see wxRibbonArtProvider::SetColour()
*/
void SetColor(int id, const wxColour& color);
/**
Get the current colour scheme.
Returns three colours such that if SetColourScheme() were called with
them, the colour scheme would be restored to what it was when
SetColourScheme() was last called. In practice, this usually means that
@@ -308,7 +308,7 @@ public:
and return a colour scheme similar to colours being used - it's return
values are dependent upon the last values given to SetColourScheme(),
as described above.
@param[out] primary
Pointer to a location to store the primary colour, or NULL.
@param[out] secondary
@@ -319,26 +319,26 @@ public:
virtual void GetColourScheme(wxColour* primary,
wxColour* secondary,
wxColour* tertiary) const = 0;
/**
Set all applicable colour settings from a few base colours.
Uses any or all of the three given colours to create a colour scheme,
and then sets all colour settings which are relevant to the art
provider using that scheme.
Note that some art providers may not use the tertiary colour for
anything, and some may not use the secondary colour either.
@see SetColour()
@see GetColourScheme()
*/
*/
virtual void SetColourScheme(const wxColour& primary,
const wxColour& secondary,
const wxColour& tertiary) = 0;
/**
Draw the background of the tab region of a ribbon bar.
@param dc
The device context to draw onto.
@param wnd
@@ -353,7 +353,7 @@ public:
/**
Draw a single tab in the tab region of a ribbon bar.
@param dc
The device context to draw onto.
@param wnd
@@ -373,7 +373,7 @@ public:
/**
Draw a separator between two tabs in a ribbon bar.
@param dc
The device context to draw onto.
@param wnd
@@ -393,7 +393,7 @@ public:
/**
Draw the background of a ribbon page.
@param dc
The device context to draw onto.
@param wnd
@@ -401,7 +401,7 @@ public:
whose background is being drawn, but doesn't have to be).
@param rect
The rectangle within which to draw.
@sa GetPageBackgroundRedrawArea
*/
virtual void DrawPageBackground(
@@ -411,7 +411,7 @@ public:
/**
Draw a ribbon-style scroll button.
@param dc
The device context to draw onto.
@param wnd
@@ -439,11 +439,11 @@ public:
Draw the background and chrome for a ribbon panel. This should draw
the border, background, label, and any other items of a panel which
are outside the client area of a panel.
Note that when a panel is minimised, this function is not called - only
DrawMinimisedPanel() is called, so a background should be explicitly
painted by that if required.
@param dc
The device context to draw onto.
@param wnd
@@ -457,13 +457,13 @@ public:
wxDC& dc,
wxRibbonPanel* wnd,
const wxRect& rect) = 0;
/**
Draw the background and chrome for a wxRibbonGallery control. This
should draw the border, background, scroll buttons, extension button,
and any other UI elements which are not attached to a specific gallery
item.
@param dc
The device context to draw onto.
@param wnd
@@ -488,7 +488,7 @@ public:
is painted on top of a gallery background, and behind the items bitmap.
Unlike DrawButtonBarButton() and DrawTool(), it is not expected to draw
the item bitmap - that is done by the gallery control itself.
@param dc
The device context to draw onto.
@param wnd
@@ -515,10 +515,10 @@ public:
wxRibbonGallery* wnd,
const wxRect& rect,
wxRibbonGalleryItem* item) = 0;
/**
Draw a minimised ribbon panel.
@param dc
The device context to draw onto.
@param wnd
@@ -539,10 +539,10 @@ public:
wxRibbonPanel* wnd,
const wxRect& rect,
wxBitmap& bitmap) = 0;
/**
Draw the background for a wxRibbonButtonBar control.
@param dc
The device context to draw onto.
@param wnd
@@ -558,7 +558,7 @@ public:
/**
Draw a single button for a wxRibbonButtonBar control.
@param dc
The device context to draw onto.
@param wnd
@@ -591,10 +591,10 @@ public:
const wxString& label,
const wxBitmap& bitmap_large,
const wxBitmap& bitmap_small) = 0;
/**
Draw the background for a wxRibbonToolBar control.
@param dc
The device context to draw onto.
@param wnd
@@ -613,7 +613,7 @@ public:
/**
Draw the background for a group of tools on a wxRibbonToolBar control.
@param dc
The device context to draw onto.
@param wnd
@@ -636,7 +636,7 @@ public:
/**
Draw a single tool (for a wxRibbonToolBar control).
@param dc
The device context to draw onto.
@param wnd
@@ -710,7 +710,7 @@ public:
/**
Calculate the ideal and minimum width (in pixels) of a tab in a ribbon
bar.
@param dc
A device context to use when one is required for size calculations.
@param wnd
@@ -746,7 +746,7 @@ public:
Note that as the tab region can contain scroll buttons, the height
should be greater than or equal to the minimum height for a tab scroll
button.
@param dc
A device context to use when one is required for size calculations.
@param wnd
@@ -761,7 +761,7 @@ public:
/**
Calculate the minimum size (in pixels) of a scroll button.
@param dc
A device context to use when one is required for size calculations.
@param wnd
@@ -781,7 +781,7 @@ public:
Calculate the size of a panel for a given client size. This should
increment the given size by enough to fit the panel label and other
chrome.
@param dc
A device context to use if one is required for size calculations.
@param wnd
@@ -791,7 +791,7 @@ public:
@param[out] client_offset
The offset where the client rectangle begins within the panel (may
be NULL).
@sa GetPanelClientSize()
*/
virtual wxSize GetPanelSize(
@@ -799,12 +799,12 @@ public:
const wxRibbonPanel* wnd,
wxSize client_size,
wxPoint* client_offset) = 0;
/**
Calculate the client size of a panel for a given overall size. This
should act as the inverse to GetPanelSize(), and decrement the given
size by enough to fit the panel label and other chrome.
@param dc
A device context to use if one is required for size calculations.
@param wnd
@@ -814,7 +814,7 @@ public:
@param[out] client_offset
The offset where the returned client size begins within the given
@a size (may be NULL).
@sa GetPanelSize()
*/
virtual wxSize GetPanelClientSize(
@@ -844,14 +844,14 @@ public:
Calculate the size of a wxRibbonGallery control for a given client
size. This should increment the given size by enough to fit the gallery
border, buttons, and any other chrome.
@param dc
A device context to use if one is required for size calculations.
@param wnd
The gallery in question.
@param client_size
The client size.
@sa GetGalleryClientSize()
*/
virtual wxSize GetGallerySize(
@@ -864,7 +864,7 @@ public:
size. This should act as the inverse to GetGallerySize(), and decrement
the given size by enough to fit the gallery border, buttons, and other
chrome.
@param dc
A device context to use if one is required for size calculations.
@param wnd
@@ -899,7 +899,7 @@ public:
small an area as possible should be returned. Of course, if the way in
which a background is drawn means that the entire background needs to
be repainted on resize, then the entire new size should be returned.
@param dc
A device context to use when one is required for size calculations.
@param wnd
@@ -915,10 +915,10 @@ public:
const wxRibbonPage* wnd,
wxSize page_old_size,
wxSize page_new_size) = 0;
/**
Calculate the size of a button within a wxRibbonButtonBar.
@param dc
A device context to use when one is required for size calculations.
@param wnd
@@ -947,7 +947,7 @@ public:
The region of the button which constitutes the normal button.
@param[out] dropdown_region
The region of the button which constitutes the dropdown button.
@return @true if a size exists for the button, @false otherwise.
*/
virtual bool GetButtonBarButtonSize(
@@ -990,10 +990,10 @@ public:
wxDC& dc, const wxString& label,
wxRibbonButtonKind kind,
wxRibbonButtonBarButtonState size) = 0;
/**
Calculate the size of a minimised ribbon panel.
@param dc
A device context to use when one is required for size calculations.
@param wnd
@@ -1011,10 +1011,10 @@ public:
const wxRibbonPanel* wnd,
wxSize* desired_bitmap_size,
wxDirection* expanded_panel_direction) = 0;
/**
Calculate the size of a tool within a wxRibbonToolBar.
@param dc
A device context to use when one is required for size calculations.
@param wnd

38
interface/wx/ribbon/bar.h
View File

@@ -77,7 +77,7 @@ public:
Returns the page being changed to, or being clicked on.
*/
wxRibbonPage* GetPage();
/**
Sets the page relating to this event.
*/
@@ -120,7 +120,7 @@ public:
for wxRibbonPage - a ribbon user interface typically has a ribbon bar,
which contains one or more wxRibbonPages, which in turn each contain one
or more wxRibbonPanels, which in turn contain controls.
While a wxRibbonBar has tabs similar to a wxNotebook, it does not follow
the same API for adding pages. Containers like wxNotebook can contain any
type of window as a page, hence the normal procedure is to create the
@@ -128,13 +128,13 @@ public:
have wxRibbonPage as children (and a wxRibbonPage can only have a
wxRibbonBar as parent), when a page is created, it is automatically added
to the bar - there is no AddPage equivalent to call.
After all pages have been created, and all controls and panels placed on
those pages, Realize() must be called.
@sa wxRibbonPage
@sa wxRibbonPanel
@beginStyleTable
@style{wxRIBBON_BAR_DEFAULT_STYLE}
Defined as wxRIBBON_BAR_FLOW_HORIZONTAL |
@@ -213,7 +213,7 @@ public:
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
long style = wxRIBBON_BAR_DEFAULT_STYLE);
/**
Create a ribbon bar in two-step ribbon bar construction.
Should only be called when the default constructor is used, and
@@ -235,7 +235,7 @@ public:
tab bar region of the ribbon bar. These margins will be painted with
the tab background, but tabs and scroll buttons will never be painted
in the margins.
The left margin could be used for rendering something equivalent to the
"Office Button", though this is not currently implemented. The right
margin could be used for rendering a help button, and/or MDI buttons,
@@ -247,7 +247,7 @@ public:
Set the art provider to be used be the ribbon bar. Also sets the art
provider on all current wxRibbonPage children, and any wxRibbonPage
children added in the future.
Note that unlike most other ribbon controls, the ribbon bar creates a
default art provider when initialised, so an explicit call to
SetArtProvider() is not required if the default art provider is
@@ -260,17 +260,17 @@ public:
/**
Set the active page by index, without triggering any events.
@param page
The zero-based index of the page to activate.
@return @true if the specified page is now active, @false if it could
not be activated (for example because the page index is invalid).
*/
bool SetActivePage(size_t page);
/**
Set the active page, without triggering any events.
@param page
The page to activate.
@return @true if the specified page is now active, @false if it could
@@ -278,21 +278,21 @@ public:
of the ribbon bar).
*/
bool SetActivePage(wxRibbonPage* page);
/**
Get the index of the active page.
In the rare case of no page being active, -1 is returned.
*/
int GetActivePage() const;
/**
Get a page by index.
NULL will be returned if the given index is out of range.
*/
wxRibbonPage* GetPage(int n);
/**
Get the number of pages in this bar.
@@ -302,7 +302,7 @@ public:
/**
Dismiss the expanded panel of the currently active page.
Calls and returns the value from wxRibbonPage::DismissExpandedPanel()
for the currently active page, or @false if there is no active page.
*/
@@ -433,7 +433,7 @@ public:
@since 2.9.2
*/
bool ArePanelsShown() const;
/**
Returns the current display mode of the panel area.
@@ -449,7 +449,7 @@ public:
children. This must be called after all of the bar's children have been
created (and their children created, etc.) - if it is not, then windows
may not be laid out or sized correctly.
Also calls wxRibbonPage::Realize() on each child page.
*/
virtual bool Realize();

66
interface/wx/ribbon/buttonbar.h
View File

@@ -7,12 +7,12 @@
/**
Flags for button bar button size and state.
Buttons on a ribbon button bar can each come in three sizes: small, medium,
and large. In some places this is called the size class, and the term size
used for the pixel width and height associated with a particular size
class.
A button can also be in zero or more hovered or active states, or in the
disabled state.
*/
@@ -23,19 +23,19 @@ enum wxRibbonButtonBarButtonState
provider, but it will be smaller than medium).
*/
wxRIBBON_BUTTONBAR_BUTTON_SMALL = 0 << 0,
/**
Button is medium sized (the interpretation of medium is dependent upon
the art provider, but it will be between small and large).
*/
wxRIBBON_BUTTONBAR_BUTTON_MEDIUM = 1 << 0,
/**
Button is large (the interpretation of large is dependent upon the art
provider, but it will be larger than medium).
*/
wxRIBBON_BUTTONBAR_BUTTON_LARGE = 2 << 0,
/**
A mask to extract button size from a combination of flags.
*/
@@ -46,24 +46,24 @@ enum wxRibbonButtonBarButtonState
the mouse cursor. Only applicable to normal and hybrid buttons.
*/
wxRIBBON_BUTTONBAR_BUTTON_NORMAL_HOVERED = 1 << 3,
/**
The dropdown region of the button is being hovered over by the mouse
cursor. Only applicable to dropdown and hybrid buttons.
*/
wxRIBBON_BUTTONBAR_BUTTON_DROPDOWN_HOVERED = 1 << 4,
/**
A mask to extract button hover state from a combination of flags.
*/
wxRIBBON_BUTTONBAR_BUTTON_HOVER_MASK = wxRIBBON_BUTTONBAR_BUTTON_NORMAL_HOVERED | wxRIBBON_BUTTONBAR_BUTTON_DROPDOWN_HOVERED,
/**
The normal (non-dropdown) region of the button is being pressed.
Only applicable to normal and hybrid buttons.
*/
wxRIBBON_BUTTONBAR_BUTTON_NORMAL_ACTIVE = 1 << 5,
/**
The dropdown region of the button is being pressed.
Only applicable to dropdown and hybrid buttons.
@@ -81,12 +81,12 @@ enum wxRibbonButtonBarButtonState
disabled.
*/
wxRIBBON_BUTTONBAR_BUTTON_DISABLED = 1 << 7,
/**
The button is a toggle button which is currently in the toggled state.
*/
wxRIBBON_BUTTONBAR_BUTTON_TOGGLED = 1 << 8,
/**
A mask to extract button state from a combination of flags.
*/
@@ -95,7 +95,7 @@ enum wxRibbonButtonBarButtonState
/**
@class wxRibbonButtonBar
A ribbon button bar is similar to a traditional toolbar. It contains one or
more buttons (button bar buttons, not wxButtons), each of which has a label
and an icon. It differs from a wxRibbonToolBar in several ways:
@@ -106,7 +106,7 @@ enum wxRibbonButtonBarButtonState
@li There is no grouping of buttons on a button bar
@li A button bar typically has a border around each individual button,
whereas a tool bar typically has a border around each group of buttons.
@beginEventEmissionTable{wxRibbonButtonBarEvent}
@event{EVT_RIBBONBUTTONBAR_CLICKED(id, func)}
Triggered when the normal (non-dropdown) region of a button on the
@@ -117,7 +117,7 @@ enum wxRibbonButtonBarButtonState
event handler if it wants to display a popup menu (which is what most
dropdown buttons should be doing).
@endEventTable
@library{wxribbon}
@category{ribbon}
*/
@@ -133,7 +133,7 @@ public:
/**
Construct a ribbon button bar with the given parameters.
@param parent
Parent window for the button bar (typically a wxRibbonPanel).
@param id
@@ -179,7 +179,7 @@ public:
/**
Add a dropdown button to the button bar (simple version).
@see AddButton()
*/
virtual wxRibbonButtonBarButtonBase* AddDropdownButton(
@@ -190,7 +190,7 @@ public:
/**
Add a hybrid button to the button bar (simple version).
@see AddButton()
*/
virtual wxRibbonButtonBarButtonBase* AddHybridButton(
@@ -198,10 +198,10 @@ public:
const wxString& label,
const wxBitmap& bitmap,
const wxString& help_string = wxEmptyString);
/**
Add a toggle button to the button bar (simple version).
@see AddButton()
*/
virtual wxRibbonButtonBarButtonBase* AddToggleButton(
@@ -209,10 +209,10 @@ public:
const wxString& label,
const wxBitmap& bitmap,
const wxString& help_string = wxEmptyString);
/**
Add a button to the button bar.
@param button_id
ID of the new button (used for event callbacks).
@param label
@@ -235,10 +235,10 @@ public:
The kind of button to add.
@param help_string
The UI help string to associate with the new button.
@return An opaque pointer which can be used only with other button bar
methods.
@see AddDropdownButton()
@see AddHybridButton()
@see AddToggleButton()
@@ -431,20 +431,20 @@ public:
/**
Calculate button layouts and positions.
Must be called after buttons are added to the button bar, as otherwise
the newly added buttons will not be displayed. In normal situations, it
will be called automatically when wxRibbonBar::Realize() is called.
*/
virtual bool Realize();
/**
Delete all buttons from the button bar.
@see DeleteButton()
*/
virtual void ClearButtons();
/**
Delete a single button from the button bar.
@@ -454,20 +454,20 @@ public:
@see ClearButtons()
*/
virtual bool DeleteButton(int button_id);
/**
Enable or disable a single button on the bar.
@param button_id
ID of the button to enable or disable.
@param enable
@true to enable the button, @false to disable it.
*/
virtual void EnableButton(int button_id, bool enable = true);
/**
Set a toggle button to the checked or unchecked state.
@param button_id
ID of the toggle button to manipulate.
@param checked
@@ -678,12 +678,12 @@ public:
Returns the bar which contains the button which the event relates to.
*/
wxRibbonButtonBar* GetBar();
/**
Sets the button bar relating to this event.
*/
void SetBar(wxRibbonButtonBar* bar);
/**
Returns the button which the event relates to.

2
interface/wx/ribbon/gallery.h
View File

@@ -238,7 +238,7 @@ public:
direction, @false if it did not scroll.
*/
virtual bool ScrollLines(int lines);
/**
Scroll the gallery contents by some fine-grained amount.

48
interface/wx/ribbon/page.h
View File

@@ -9,7 +9,7 @@
@class wxRibbonPage
Container for related ribbon panels, and a tab within a ribbon bar.
@see wxRibbonBar
@see wxRibbonPanel
@@ -28,7 +28,7 @@ public:
/**
Constructs a ribbon page, which must be a child of a ribbon bar.
@param parent
Pointer to a parent wxRibbonBar (unlike most controls, a wxRibbonPage
can only have wxRibbonBar as a parent).
@@ -53,7 +53,7 @@ public:
Destructor.
*/
virtual ~wxRibbonPage();
/**
Create a ribbon page in two-step ribbon page construction.
Should only be called when the default constructor is used, and
@@ -69,7 +69,7 @@ public:
Set the art provider to be used. Normally called automatically by
wxRibbonBar when the page is created, or the art provider changed on the
bar.
The new art provider will be propagated to the children of the page.
*/
void SetArtProvider(wxRibbonArtProvider* art);
@@ -79,10 +79,10 @@ public:
displayed if the ribbon bar is actually showing icons).
*/
wxBitmap& GetIcon();
/**
Set the size of the page and the external scroll buttons (if any).
When a page is too small to display all of its children, scroll buttons
will appear (and if the page is sized up enough, they will disappear again).
Slightly counter-intuitively, these buttons are created as siblings of the
@@ -91,78 +91,78 @@ public:
buttons, this function behaves the same as SetSize(), however when there
are scroll buttons, it positions them at the edges of the given area, and
then calls SetSize() with the remaining area.
This is provided as a separate function to SetSize() rather than within
the implementation of SetSize(), as interacting algorithms may not expect
SetSize() to also set the size of siblings.
*/
void SetSizeWithScrollButtonAdjustment(int x, int y, int width, int height);
/**
Expand a rectangle of the page to include external scroll buttons (if
any). When no scroll buttons are shown, has no effect.
@param[in,out] rect
The rectangle to adjust. The width and height will not be reduced,
and the x and y will not be increased.
*/
void AdjustRectToIncludeScrollButtons(wxRect* rect) const;
/**
Dismiss the current externally expanded panel, if there is one.
When a ribbon panel automatically minimises, it can be externally
expanded into a floating window. When the user clicks a button in such
a panel, the panel should generally re-minimise. Event handlers for
buttons on ribbon panels should call this method to achieve this
behaviour.
@return @true if a panel was minimised, @false otherwise.
*/
bool DismissExpandedPanel();
/**
Perform a full re-layout of all panels on the page.
Should be called after panels are added to the page, or the sizing
behaviour of a panel on the page changes (i.e. due to children being
added to it). Usually called automatically when wxRibbonBar::Realize()
is called.
Will invoke wxRibbonPanel::Realize() for all child panels.
*/
virtual bool Realize();
/**
Scroll the page by some amount up / down / left / right.
When the page's children are too big to fit in the onscreen area given to
the page, scroll buttons will appear, and the page can be programmatically
scrolled. Positive values of @a lines will scroll right or down, while
negative values will scroll up or left (depending on the direction in which
panels are stacked). A line is equivalent to a constant number of pixels.
@return @true if the page scrolled at least one pixel in the given
direction, @false if it did not scroll.
@see GetMajorAxis()
@see ScrollPixels()
@see ScrollSections()
*/
virtual bool ScrollLines(int lines);
/**
Scroll the page by a set number of pixels up / down / left / right.
When the page's children are too big to fit in the onscreen area given to
the page, scroll buttons will appear, and the page can be programmatically
scrolled. Positive values of @a lines will scroll right or down, while
negative values will scroll up or left (depending on the direction in which
panels are stacked).
@return @true if the page scrolled at least one pixel in the given
direction, @false if it did not scroll.
@see GetMajorAxis()
@see ScrollLines()
@see ScrollSections()
@@ -188,12 +188,12 @@ public:
/**
Get the direction in which ribbon panels are stacked within the page.
This is controlled by the style of the containing wxRibbonBar, meaning
that all pages within a bar will have the same major axis. As well as
being the direction in which panels are stacked, it is also the axis in
which scrolling will occur (when required).
@return wxHORIZONTAL or wxVERTICAL (never wxBOTH).
*/
wxOrientation GetMajorAxis() const;

24
interface/wx/ribbon/toolbar.h
View File

@@ -8,11 +8,11 @@
/**
@class wxRibbonToolBar
A ribbon tool bar is similar to a traditional toolbar which has no labels.
It contains one or more tool groups, each of which contains one or more
tools. Each tool is represented by a (generally small, i.e. 16x15) bitmap.
@beginEventEmissionTable{wxRibbonToolBarEvent}
@event{EVT_RIBBONTOOLBAR_CLICKED(id, func)}
Triggered when the normal (non-dropdown) region of a tool on the tool
@@ -23,7 +23,7 @@
event handler if it wants to display a popup menu (which is what most
dropdown tools should be doing).
@endEventTable
@library{wxribbon}
@category{ribbon}
*/
@@ -39,7 +39,7 @@ public:
/**
Construct a ribbon tool bar with the given parameters.
@param parent
Parent window for the tool bar (typically a wxRibbonPanel).
@param id
@@ -84,7 +84,7 @@ public:
/**
Add a dropdown tool to the tool bar (simple version).
@see AddTool()
*/
virtual wxRibbonToolBarToolBase* AddDropdownTool(
@@ -94,7 +94,7 @@ public:
/**
Add a hybrid tool to the tool bar (simple version).
@see AddTool()
*/
virtual wxRibbonToolBarToolBase* AddHybridTool(
@@ -116,7 +116,7 @@ public:
/**
Add a tool to the tool bar.
@param tool_id
ID of the new tool (used for event callbacks).
@param bitmap
@@ -132,10 +132,10 @@ public:
The kind of tool to add.
@param client_data
Client data to associate with the new tool.
@return An opaque pointer which can be used only with other tool bar
methods.
@see AddDropdownTool(), AddHybridTool(), AddSeparator(), InsertTool()
*/
virtual wxRibbonToolBarToolBase* AddTool(
@@ -148,7 +148,7 @@ public:
/**
Add a separator to the tool bar.
Separators are used to separate tools into groups. As such, a separator
is not explicitly drawn, but is visually seen as the gap between tool
groups.
@@ -404,12 +404,12 @@ public:
/**
Set the number of rows to distribute tool groups over.
Tool groups can be distributed over a variable number of rows. The way
in which groups are assigned to rows is not specified, and the order
of groups may change, but they will be distributed in such a way as to
minimise the overall size of the tool bar.
@param nMin
The minimum number of rows to use.
@param nMax