accordion.h File Reference

The include file for the wxAccordion class. More...

#include <wx/bookctrl.h>
#include <wx/graphics.h>

Classes
class	wxAccordionStyle
class	wxAccordion

Macros
#define	WXDLLIMPEXP_ACCORDION
#define	EVT_ACCORDION_COLLAPSED(winid, fn)   wx__DECLARE_EVT1(wxEVT_ACCORDION_COLLAPSED, winid, wxBookCtrlEventHandler(fn))
#define	EVT_ACCORDION_COLLAPSING(winid, fn)   wx__DECLARE_EVT1(wxEVT_ACCORDION_COLLAPSING, winid, wxBookCtrlEventHandler(fn))
#define	EVT_ACCORDION_EXPANDED(winid, fn)   wx__DECLARE_EVT1(wxEVT_ACCORDION_EXPANDED, winid, wxBookCtrlEventHandler(fn))
#define	EVT_ACCORDION_EXPANDING(winid, fn)   wx__DECLARE_EVT1(wxEVT_ACCORDION_EXPANDING, winid, wxBookCtrlEventHandler(fn))

Enumerations
enum	{   wxAC_DEFAULT_STYLE = 0, wxAC_BUTTON_LEFT = 1 << 0, wxAC_SINGLE_FOLD = 1 << 1, wxAC_COLLAPSE_TO_BOTTOM = 1 << 2,   wxAC_FLOAT_TO_TOP = 1 << 3 }
enum	wxAccordionToggleStyle { wxAC_TOGGLE_ONLY_ON_BUTTON_CLICKS, wxAC_TOGGLE_ON_ANY_CLICK }
	The behavior of the accordion in response to mouse clicks on the caption bar. More...
enum	wxAccordionBorderStyle { wxAC_BORDERS_FULL, wxAC_BORDERS_NO_BOTTOM_WHEN_EXPANDED }
	The border style options for the accordion's caption bars. More...
enum	wxAccordionHighlighting { wxAC_HIGHLIGHTING_NONE, wxAC_HIGHLIGHTING_MOUSEOVER }
	The behavior of the accordion when the mouse is over a caption bar. More...
enum	wxAccordionDisabledState { wxAC_DISABLED_STATE_DEFAULT, wxAC_DISABLED_STATE_CUSTOM }
	The style options of a caption bar in the disabled state. More...

Functions
	wxDECLARE_EXPORTED_EVENT (WXDLLIMPEXP_ACCORDION, wxEVT_ACCORDION_COLLAPSED, wxBookCtrlEvent)
	wxDECLARE_EXPORTED_EVENT (WXDLLIMPEXP_ACCORDION, wxEVT_ACCORDION_COLLAPSING, wxBookCtrlEvent)
	wxDECLARE_EXPORTED_EVENT (WXDLLIMPEXP_ACCORDION, wxEVT_ACCORDION_EXPANDED, wxBookCtrlEvent)
	wxDECLARE_EXPORTED_EVENT (WXDLLIMPEXP_ACCORDION, wxEVT_ACCORDION_EXPANDING, wxBookCtrlEvent)

Detailed Description

The include file for the wxAccordion class.

Enumeration Type Documentation

enum wxAccordionBorderStyle

The border style options for the accordion's caption bars.

Enumerator:

wxAC_BORDERS_FULL	The caption bars are always drawn with all borders. This is the default behaviour.
wxAC_BORDERS_NO_BOTTOM_WHEN_EXPANDED	When a page is expanded, the bottom border of the caption bar is not shown.

enum wxAccordionDisabledState

The style options of a caption bar in the disabled state.

Enumerator:

wxAC_DISABLED_STATE_DEFAULT	A disables caption bar is drawn as a grayed version of the collapsed state.
wxAC_DISABLED_STATE_CUSTOM	The user can specify style options for the disabled caption bar as with all the other states.

enum wxAccordionHighlighting

The behavior of the accordion when the mouse is over a caption bar.

Enumerator:

wxAC_HIGHLIGHTING_NONE	No highlighting is done.
wxAC_HIGHLIGHTING_MOUSEOVER	A caption bar changes to a highlighted state when the mouse is over it.

enum wxAccordionToggleStyle

The behavior of the accordion in response to mouse clicks on the caption bar.

These values are only used if an expand or collapse button is shown. If no button is visible, the accordion will always toggle for any click on a caption bar.

Enumerator:

wxAC_TOGGLE_ONLY_ON_BUTTON_CLICKS	Toggle only if the click was on the button. This is the default behaviour.
wxAC_TOGGLE_ON_ANY_CLICK	Toggle on any click even in a button is visible.