wxRibbonPanel Class Reference

#include </home/zeitlin/src/wx/github/interface/wx/ribbon/panel.h>

Inheritance diagram for wxRibbonPanel:

---

Detailed Description

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 it is recommended that ribbon and non ribbon controls are not mixed in one panel.

参照:

wxRibbonPage

Styles

This class supports the following styles:

• wxRIBBON_PANEL_DEFAULT_STYLE:
  Defined as no other flags set.
• wxRIBBON_PANEL_NO_AUTO_MINIMISE:
  Prevents the panel from automatically minimising to conserve screen space.
• wxRIBBON_PANEL_EXT_BUTTON:
  Causes an extension button to be shown in the panel's chrome (if the bar in which it is contained has wxRIBBON_BAR_SHOW_PANEL_EXT_BUTTONS set). The behaviour of this button is application controlled, but typically will show an extended drop-down menu relating to the panel.
• wxRIBBON_PANEL_MINIMISE_BUTTON:
  Causes a (de)minimise button to be shown in the panel's chrome (if the bar in which it is contained has the wxRIBBON_BAR_SHOW_PANEL_MINIMISE_BUTTONS style set). This flag is typically combined with wxRIBBON_PANEL_NO_AUTO_MINIMISE to make a panel which the user always has manual control over when it minimises.
• wxRIBBON_PANEL_STRETCH:
  Stretches a single panel to fit the parent page.
• wxRIBBON_PANEL_FLEXIBLE:
  Allows the panel to size in both directions; currently only useful when a single wxRibbonToolBar is the child of the panel, particularly in vertical orientation where the number of rows is dependent on the amount of horizontal space available. Set the minimum and maximum toolbar rows to take full advantage of this wrapping behaviour.

Events emitted by this class

The following event handler macros redirect the events to member function handlers 'func' with prototypes like:

void handlerFuncName(wxRibbonPanelEvent& event)

Event macros for events emitted by this class:

• EVT_RIBBONPANEL_EXTBUTTON_ACTIVATED(id, func):
  Triggered when the user activate the panel extension button.

Library:  wxRibbon

Category:  Ribbon User Interface

Public Member Functions
	wxRibbonPanel ()
	Default constructor.
	wxRibbonPanel (wxWindow *parent, wxWindowID id=wxID_ANY, const wxString &label=wxEmptyString, const wxBitmap &minimised_icon=wxNullBitmap, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxRIBBON_PANEL_DEFAULT_STYLE)
	Constructs a ribbon panel.
bool	Create (wxWindow *parent, wxWindowID id=wxID_ANY, const wxString &label=wxEmptyString, const wxBitmap &icon=wxNullBitmap, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxRIBBON_PANEL_DEFAULT_STYLE)
	Create a ribbon panel in two-step ribbon panel construction.
virtual	~wxRibbonPanel ()
	Destructor.
wxBitmap &	GetMinimisedIcon ()
	Get the bitmap to be used in place of the panel children when it is minimised.
const wxBitmap &	GetMinimisedIcon () const
virtual bool	HasExtButton () const
	Test if the panel has an extension button.
bool	IsMinimised () const
	Query if the panel is currently minimised.
bool	IsMinimised (wxSize at_size) const
	Query if the panel would be minimised at a given size.
bool	IsHovered () const
	Query is the mouse is currently hovered over the panel.
bool	IsExtButtonHovered () const
	Query if the mouse is currently hovered over the extension button.
bool	CanAutoMinimise () const
	Query if the panel can automatically minimise itself at small sizes.
bool	ShowExpanded ()
	Show the panel externally expanded.
bool	HideExpanded ()
	Hide the panel's external expansion.
void	SetArtProvider (wxRibbonArtProvider *art)
	Set the art provider to be used.
bool	Realize ()
	Realize all children of the panel.
wxRibbonPanel *	GetExpandedDummy ()
	Get the dummy panel of an expanded panel.
wxRibbonPanel *	GetExpandedPanel ()
	Get the expanded panel of a dummy panel.

List of all members.

---

Constructor & Destructor Documentation

wxRibbonPanel::wxRibbonPanel

(

)

Default constructor.

With this constructor, Create() should be called in order to create the ribbon panel.

wxRibbonPanel::wxRibbonPanel	(	wxWindow *	parent,
		wxWindowID	id = wxID_ANY,
		const wxString &	label = wxEmptyString,
		const wxBitmap &	minimised_icon = wxNullBitmap,
		const wxPoint &	pos = wxDefaultPosition,
		const wxSize &	size = wxDefaultSize,
		long	style = wxRIBBON_PANEL_DEFAULT_STYLE
	)

Constructs a ribbon panel.

Parameters:

parent	Pointer to a parent window, which is typically a wxRibbonPage, though it can be any window.
id	Window identifier.
label	Label to be used in the wxRibbonPanel's chrome.
minimised_icon	Icon to be used in place of the panel's children when the panel is minimised.
pos	The initial position of the panel. Not relevant when the parent is a ribbon page, as the position and size of the panel will be dictated by the page.
size	The initial size of the panel. Not relevant when the parent is a ribbon page, as the position and size of the panel will be dictated by the page.
style	Style flags for the panel.

virtual wxRibbonPanel::~wxRibbonPanel

(

)

[virtual]

Destructor.

---

Member Function Documentation

bool wxRibbonPanel::CanAutoMinimise

(

)

const

Query if the panel can automatically minimise itself at small sizes.

bool wxRibbonPanel::Create	(	wxWindow *	parent,
		wxWindowID	id = wxID_ANY,
		const wxString &	label = wxEmptyString,
		const wxBitmap &	icon = wxNullBitmap,
		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 arguments have the same meaning as in the full constructor.

wxRibbonPanel* wxRibbonPanel::GetExpandedDummy

(

)

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.

参照:

ShowExpanded()

GetExpandedPanel()

wxRibbonPanel* wxRibbonPanel::GetExpandedPanel

(

)

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.

参照:

ShowExpanded()

GetExpandedDummy()

const wxBitmap& wxRibbonPanel::GetMinimisedIcon

(

)

const

wxBitmap& wxRibbonPanel::GetMinimisedIcon

(

)

Get the bitmap to be used in place of the panel children when it is minimised.

virtual bool wxRibbonPanel::HasExtButton

(

)

const [virtual]

Test if the panel has an extension button.

Such button is shown in the top right corner of the panel if wxRIBBON_PANEL_EXT_BUTTON style is used for it.

Since:

2.9.4

Returns:

true if the panel and its wxRibbonBar allow it in their styles.

bool wxRibbonPanel::HideExpanded

(

)

Hide the panel's external expansion.

Returns:

true if the panel was un-expanded, false if it was not (normally due to it not being expanded in the first place).

参照:

HideExpanded()

GetExpandedPanel()

bool wxRibbonPanel::IsExtButtonHovered

(

)

const

Query if the mouse is currently hovered over the extension button.

Extension button is only shown for panels with wxRIBBON_PANEL_EXT_BUTTON style.

Since:

2.9.4

bool wxRibbonPanel::IsHovered

(

)

const

Query is the mouse is currently hovered over the panel.

Returns:

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 wxRibbonPanel::IsMinimised

(

)

const

Query if the panel is currently minimised.

bool wxRibbonPanel::IsMinimised

(

wxSize

at_size

)

const

Query if the panel would be minimised at a given size.

bool wxRibbonPanel::Realize

(

)

[virtual]

Realize all children of the panel.

Reimplemented from wxRibbonControl.

void wxRibbonPanel::SetArtProvider

(

wxRibbonArtProvider *

art

)

[virtual]

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.

Reimplemented from wxRibbonControl.

bool wxRibbonPanel::ShowExpanded

(

)

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.

Returns:

true if the panel was expanded, false if it was not (possibly due to it not being minimised, or already being expanded).

参照:

HideExpanded()

GetExpandedPanel()