solemnwarning/wxwidgets
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 4

Add GetPanel(), GetPanelById() and GetPanelCount() to ribbon page

Browse source 
This provides parity with the ribbon bar's GetPage() set of functions,
and adds an easy way to find a panel and show/hide it.

Also, add example and discussion about showing/hiding panels on a
ribbon.

Closes #24319.
This commit is contained in:
Blake Madden 2024-02-14 06:25:56 -05:00 • committed by Vadim Zeitlin
parent 1864a49dd2
commit 3f7e1e8414
4 changed files with 98 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

25
interface/wx/ribbon/page.h
View file

@ -197,4 +197,29 @@ public:
@return wxHORIZONTAL or wxVERTICAL (never wxBOTH).
*/
wxOrientation GetMajorAxis() const;
/**
Get a panel by index.
@NULL will be returned if the given index is out of range.
@since 3.3.0
*/
wxRibbonPanel* GetPanel(int n);
/**
Get a panel by window ID.
@NULL will be returned if no panel with the ID is found.
@since 3.3.0
*/
wxRibbonPanel* GetPanelById(wxWindowID id);
/**
Get the number of panels in this page.
@since 3.3.0
*/
size_t GetPanelCount() const;
};

22
interface/wx/ribbon/panel.h
View file

@ -65,12 +65,28 @@ wxEventType wxEVT_RIBBONPANEL_EXTBUTTON_ACTIVATED;
A panel adds a border and label to a group of controls, and can be
minimised (either automatically to conserve space, or manually by the user).
Non ribbon controls can be placed on a panel using wxSizers to manage
Non-ribbon controls can be placed on a panel using wxSizers to manage
layout. Panel size is governed by the sizer's minimum calculated size and
the parent wxRibbonPage's dimensions. For functional and aesthetic reasons
it is recommended that ribbon and non ribbon controls are not mixed in one
the parent wxRibbonPage's dimensions. For functional and aesthetic reasons,
it is recommended that ribbon and non-ribbon controls are not mixed in one
panel.
A wxRibbonPage can show or hide its panels to offer a dynamic experience
for the end user. For example, a page can hide certain panels and show others
when the user interacts with other elements in the application. As an example
of toggling the visibility of a panel:
@code
wxRibbonPanel* panel = m_ribbon->GetPage(0)->GetPanelById(ID_EDITOR_PANEL);
if ( panel != nullptr )
{
panel->Show(!panel->IsShown());
}
// Update the UI
m_ribbon->Realise();
m_ribbon->Layout();
@endcode
@see wxRibbonPage
@beginStyleTable