Added wxRIBBON_PANEL_STRETCH to allow a single panel to stretch to fill the parent page.
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@70852 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
@@ -12,18 +12,18 @@
|
||||
Serves as a container for a group of (ribbon) controls. A wxRibbonPage will
|
||||
typically have panels for children, with the controls for that page placed
|
||||
on the panels.
|
||||
|
||||
|
||||
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
|
||||
layout. Panel size is governed by the sizer's minimum calculated size and
|
||||
the parent wxRibbonPage's dimensions. For functional and aesthetic reasons
|
||||
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
|
||||
panel.
|
||||
|
||||
|
||||
@sa wxRibbonPage
|
||||
|
||||
|
||||
@beginStyleTable
|
||||
@style{wxRIBBON_PANEL_DEFAULT_STYLE}
|
||||
Defined as no other flags set.
|
||||
@@ -43,6 +43,8 @@
|
||||
typically combined with wxRIBBON_PANEL_NO_AUTO_MINIMISE to make a
|
||||
panel which the user always has manual control over when it
|
||||
minimises.
|
||||
@style{wxRIBBON_PANEL_STRETCH}
|
||||
Stretches a single panel to fit the parent page.
|
||||
@endStyleTable
|
||||
|
||||
@library{wxribbon}
|
||||
@@ -52,7 +54,7 @@ class wxRibbonPanel : public wxRibbonControl
|
||||
{
|
||||
public:
|
||||
/**
|
||||
Default constructor.
|
||||
Default constructor.
|
||||
With this constructor, Create() should be called in order to create
|
||||
the ribbon panel.
|
||||
*/
|
||||
@@ -60,7 +62,7 @@ public:
|
||||
|
||||
/**
|
||||
Constructs a ribbon panel.
|
||||
|
||||
|
||||
@param parent
|
||||
Pointer to a parent window, which is typically a wxRibbonPage,
|
||||
though it can be any window.
|
||||
@@ -89,7 +91,7 @@ public:
|
||||
const wxPoint& pos = wxDefaultPosition,
|
||||
const wxSize& size = wxDefaultSize,
|
||||
long style = wxRIBBON_PANEL_DEFAULT_STYLE);
|
||||
|
||||
|
||||
/**
|
||||
Create a ribbon panel in two-step ribbon panel construction.
|
||||
Should only be called when the default constructor is used, and
|
||||
@@ -114,53 +116,53 @@ public:
|
||||
*/
|
||||
wxBitmap& GetMinimisedIcon();
|
||||
const wxBitmap& GetMinimisedIcon() const;
|
||||
|
||||
|
||||
/**
|
||||
Query if the panel is currently minimised.
|
||||
*/
|
||||
bool IsMinimised() const;
|
||||
|
||||
|
||||
/**
|
||||
Query if the panel would be minimised at a given size.
|
||||
*/
|
||||
bool IsMinimised(wxSize at_size) const;
|
||||
|
||||
|
||||
/**
|
||||
Query is the mouse is currently hovered over the panel.
|
||||
@return @true if the cursor is within the bounds of the panel (i.e.
|
||||
hovered over the panel or one of its children), @false otherwise.
|
||||
*/
|
||||
bool IsHovered() const;
|
||||
|
||||
|
||||
/**
|
||||
Query if the panel can automatically minimise itself at small sizes.
|
||||
*/
|
||||
bool CanAutoMinimise() const;
|
||||
|
||||
|
||||
/**
|
||||
Show the panel externally expanded.
|
||||
|
||||
|
||||
When a panel is minimised, it can be shown full-size in a pop-out
|
||||
window, which is referred to as being (externally) expanded. Note that
|
||||
when a panel is expanded, there exist two panels - the original panel
|
||||
(which is referred to as the dummy panel) and the expanded panel. The
|
||||
original is termed a dummy as it sits in the ribbon bar doing nothing,
|
||||
while the expanded panel holds the panel children.
|
||||
|
||||
|
||||
@return @true if the panel was expanded, @false if it was not (possibly
|
||||
due to it not being minimised, or already being expanded).
|
||||
|
||||
|
||||
@see HideExpanded()
|
||||
@see GetExpandedPanel()
|
||||
*/
|
||||
bool ShowExpanded();
|
||||
|
||||
|
||||
/**
|
||||
Hide the panel's external expansion.
|
||||
|
||||
|
||||
@return @true if the panel was un-expanded, @false if it was not
|
||||
(normally due to it not being expanded in the first place).
|
||||
|
||||
|
||||
@see HideExpanded()
|
||||
@see GetExpandedPanel()
|
||||
*/
|
||||
@@ -170,35 +172,35 @@ public:
|
||||
Set the art provider to be used. Normally called automatically by
|
||||
wxRibbonPage when the panel is created, or the art provider changed on the
|
||||
page.
|
||||
|
||||
|
||||
The new art provider will be propagated to the children of the panel.
|
||||
*/
|
||||
void SetArtProvider(wxRibbonArtProvider* art);
|
||||
|
||||
|
||||
/**
|
||||
Realize all children of the panel.
|
||||
*/
|
||||
bool Realize();
|
||||
|
||||
|
||||
/**
|
||||
Get the dummy panel of an expanded panel.
|
||||
|
||||
|
||||
Note that this should be called on an expanded panel to get the dummy
|
||||
associated with it - it will return NULL when called on the dummy
|
||||
itself.
|
||||
|
||||
|
||||
@see ShowExpanded()
|
||||
@see GetExpandedPanel()
|
||||
*/
|
||||
wxRibbonPanel* GetExpandedDummy();
|
||||
|
||||
|
||||
/**
|
||||
Get the expanded panel of a dummy panel.
|
||||
|
||||
|
||||
Note that this should be called on a dummy panel to get the expanded
|
||||
panel associated with it - it will return NULL when called on the
|
||||
expanded panel itself.
|
||||
|
||||
|
||||
@see ShowExpanded()
|
||||
@see GetExpandedDummy()
|
||||
*/
|
||||
|
Reference in New Issue
Block a user