A better wxCollapsiblePane that. More...

#include <collapsible_pane.h>

Inheritance diagram for WX_COLLAPSIBLE_PANE:

Public Member Functions
	WX_COLLAPSIBLE_PANE ()

	WX_COLLAPSIBLE_PANE (wxWindow *aParent, wxWindowID aId, const wxString &aLabel, const wxPoint &aPos=wxDefaultPosition, const wxSize &aSize=wxDefaultSize, long aStyle=wxBORDER_NONE, const wxValidator &aValidator=wxDefaultValidator, const wxString &aName=wxT("COLLAPSIBLE_PANE_HEADER"))

	~WX_COLLAPSIBLE_PANE ()

bool	Create (wxWindow *aParent, wxWindowID aId, const wxString &aLabel, const wxPoint &aPos=wxDefaultPosition, const wxSize &aSize=wxDefaultSize, long aStyle=wxBORDER_NONE, const wxValidator &aValidator=wxDefaultValidator, const wxString &aName=wxT("COLLAPSIBLE_PANE_HEADER"))

void	Collapse (bool aCollapse=true)

void	Expand ()

bool	IsCollapsed () const

bool	IsExpanded () const

wxWindow *	GetPane ()

wxString	GetLabel () const override

void	SetLabel (const wxString &aLabel) override

bool	SetBackgroundColour (const wxColour &aColor) override

bool	InformFirstDirection (int aDirection, int aSize, int aAvailableOtherDir) override

wxSize	DoGetBestClientSize () const override

bool	Layout () override

Private Member Functions
void	init ()

int	getBorder () const

void	onSize (wxSizeEvent &aEvent)

void	onHeaderClicked (wxCommandEvent &aEvent)

Private Attributes
wxWindow *	m_pane

wxSizer *	m_sizer

WX_COLLAPSIBLE_PANE_HEADER *	m_header

Detailed Description

A better wxCollapsiblePane that.

Looks the same on all platforms
Doesn't have the same sizer bugs
Uses proper window colors

Definition at line 101 of file collapsible_pane.h.

Constructor & Destructor Documentation

◆ WX_COLLAPSIBLE_PANE() [1/2]

WX_COLLAPSIBLE_PANE::WX_COLLAPSIBLE_PANE ( )

inline

Definition at line 104 of file collapsible_pane.h.

     {
         init();
     }

References init().

◆ WX_COLLAPSIBLE_PANE() [2/2]

WX_COLLAPSIBLE_PANE::WX_COLLAPSIBLE_PANE	(	wxWindow *	aParent,
		wxWindowID	aId,
		const wxString &	aLabel,
		const wxPoint &	aPos = `wxDefaultPosition`,
		const wxSize &	aSize = `wxDefaultSize`,
		long	aStyle = `wxBORDER_NONE`,
		const wxValidator &	aValidator = `wxDefaultValidator`,
		const wxString &	aName = `wxT( "COLLAPSIBLE_PANE_HEADER" )`
	)

inline

Definition at line 109 of file collapsible_pane.h.

     {
         init();
 
         Create( aParent, aId, aLabel, aPos, aSize, aStyle, aValidator, aName );
     }

References Create(), and init().

◆ ~WX_COLLAPSIBLE_PANE()

WX_COLLAPSIBLE_PANE::~WX_COLLAPSIBLE_PANE ( )

Definition at line 67 of file collapsible_pane.cpp.

 {
     if( m_sizer )
         m_sizer->SetContainingWindow( nullptr );
 
     // Not owned by wxWindow
     delete m_sizer;
 }

References m_sizer.

Member Function Documentation

◆ Collapse()

void WX_COLLAPSIBLE_PANE::Collapse ( bool aCollapse = true )

Definition at line 77 of file collapsible_pane.cpp.

 {
     if( IsCollapsed() == aCollapse )
         return;
 
     InvalidateBestSize();
 
     m_pane->Show( !aCollapse );
     m_header->SetCollapsed( aCollapse );
 
     SetSize( GetBestSize() );
 }

References IsCollapsed(), m_header, m_pane, and WX_COLLAPSIBLE_PANE_HEADER::SetCollapsed().

Referenced by APPEARANCE_CONTROLS::createControls(), Expand(), and onHeaderClicked().

◆ Create()

bool WX_COLLAPSIBLE_PANE::Create	(	wxWindow *	aParent,
		wxWindowID	aId,
		const wxString &	aLabel,
		const wxPoint &	aPos = `wxDefaultPosition`,
		const wxSize &	aSize = `wxDefaultSize`,
		long	aStyle = `wxBORDER_NONE`,
		const wxValidator &	aValidator = `wxDefaultValidator`,
		const wxString &	aName = `wxT( "COLLAPSIBLE_PANE_HEADER" )`
	)

Definition at line 33 of file collapsible_pane.cpp.

 {
     if( !wxControl::Create( aParent, aId, aPos, aSize, aStyle, aValidator, aName ) )
         return false;
 
     m_sizer = new wxBoxSizer( wxVERTICAL );
 
     m_header = new WX_COLLAPSIBLE_PANE_HEADER( this, wxID_ANY, aLabel, wxPoint( 0, 0 ),
                                                wxDefaultSize );
 
     m_sizer->Add( m_header, wxSizerFlags().Border( wxBOTTOM, getBorder() ) );
 
     m_pane = new wxPanel( this, wxID_ANY, wxDefaultPosition, wxDefaultSize,
                           wxTAB_TRAVERSAL | wxNO_BORDER, wxT( "COLLAPSIBLE_PANE_PANE" ) );
 
     m_pane->Hide();
 
     Bind( wxEVT_SIZE, &WX_COLLAPSIBLE_PANE::onSize, this );
     Bind( WX_COLLAPSIBLE_PANE_HEADER_CHANGED, &WX_COLLAPSIBLE_PANE::onHeaderClicked, this );
 
     return true;
 }

References getBorder(), m_header, m_pane, m_sizer, onHeaderClicked(), and onSize().

Referenced by WX_COLLAPSIBLE_PANE().

◆ DoGetBestClientSize()

wxSize WX_COLLAPSIBLE_PANE::DoGetBestClientSize ( ) const

override

Definition at line 129 of file collapsible_pane.cpp.

 {
     wxSize size = m_sizer->GetMinSize();
 
     if( IsExpanded() )
     {
         wxSize paneSize = m_pane->GetBestSize();
 
         size.SetWidth( std::max( size.GetWidth(), paneSize.x ) );
         size.SetHeight( size.y +  getBorder() + paneSize.y );
     }
 
     return size;
 }

References getBorder(), IsExpanded(), m_pane, and m_sizer.

◆ Expand()

void WX_COLLAPSIBLE_PANE::Expand ( )

inline

Definition at line 130 of file collapsible_pane.h.

     {
         Collapse( false );
     }

References Collapse().

◆ getBorder()

int WX_COLLAPSIBLE_PANE::getBorder ( ) const

private

Definition at line 166 of file collapsible_pane.cpp.

 {
 #if defined( __WXMSW__ )
     wxASSERT( m_header );
     return m_header->ConvertDialogToPixels( wxSize( 2, 0 ) ).x;
 #else
     return 3;
 #endif
 }

References m_header.

Referenced by Create(), DoGetBestClientSize(), and Layout().

◆ GetLabel()

wxString WX_COLLAPSIBLE_PANE::GetLabel ( ) const

inlineoverride

Definition at line 144 of file collapsible_pane.h.

     {
         return m_header->GetLabel();
     }

References m_header.

◆ GetPane()

wxWindow* WX_COLLAPSIBLE_PANE::GetPane ( )

inline

Definition at line 139 of file collapsible_pane.h.

     {
         return m_pane;
     }

References m_pane.

Referenced by APPEARANCE_CONTROLS::createControls(), and InformFirstDirection().

◆ InformFirstDirection()

bool WX_COLLAPSIBLE_PANE::InformFirstDirection	(	int	aDirection,
		int	aSize,
		int	aAvailableOtherDir
	)

override

Definition at line 113 of file collapsible_pane.cpp.

 {
     wxWindow* const pane = GetPane();
 
     if( !pane )
         return false;
 
     if( !pane->InformFirstDirection( aDirection, aSize, aAvailableOtherDir ) )
         return false;
 
     InvalidateBestSize();
 
     return true;
 }

References GetPane().

◆ init()

void WX_COLLAPSIBLE_PANE::init ( )

private

Definition at line 59 of file collapsible_pane.cpp.

 {
     m_pane   = nullptr;
     m_sizer  = nullptr;
     m_header = nullptr;
 }

References m_header, m_pane, and m_sizer.

Referenced by WX_COLLAPSIBLE_PANE().

◆ IsCollapsed()

bool WX_COLLAPSIBLE_PANE::IsCollapsed ( ) const

Definition at line 91 of file collapsible_pane.cpp.

 {
     return !m_pane || !m_pane->IsShown();
 }

References m_pane.

Referenced by Collapse(), IsExpanded(), and onHeaderClicked().

◆ IsExpanded()

bool WX_COLLAPSIBLE_PANE::IsExpanded ( ) const

inline

Definition at line 137 of file collapsible_pane.h.

137 { return !IsCollapsed(); }

WX_COLLAPSIBLE_PANE::IsCollapsed

bool IsCollapsed() const

Definition: collapsible_pane.cpp:91

References IsCollapsed().

Referenced by DoGetBestClientSize(), and Layout().

◆ Layout()

bool WX_COLLAPSIBLE_PANE::Layout ( )

override

Definition at line 145 of file collapsible_pane.cpp.

 {
     if( !m_sizer || !m_pane || !m_header )
         return false;
 
     wxSize size( GetSize() );
 
     m_sizer->SetDimension( 0, 0, size.x, m_sizer->GetMinSize().y );
     m_sizer->Layout();
 
     if( IsExpanded() )
     {
         int yoffset = m_sizer->GetSize().y + getBorder();
         m_pane->SetSize( 0, yoffset, size.x, size.y - yoffset );
         m_pane->Layout();
     }
 
     return true;
 }

References getBorder(), IsExpanded(), m_header, m_pane, and m_sizer.

Referenced by onSize(), and SetLabel().

◆ onHeaderClicked()

void WX_COLLAPSIBLE_PANE::onHeaderClicked ( wxCommandEvent & aEvent )

private

Definition at line 184 of file collapsible_pane.cpp.

 {
     if( aEvent.GetEventObject() != m_header )
     {
         aEvent.Skip();
         return;
     }
 
     Collapse( !IsCollapsed() );
 
     wxCommandEvent evt( WX_COLLAPSIBLE_PANE_CHANGED, GetId() );
     evt.SetEventObject( this );
     ProcessEvent( evt );
 }

References Collapse(), IsCollapsed(), and m_header.

Referenced by Create().

◆ onSize()

void WX_COLLAPSIBLE_PANE::onSize ( wxSizeEvent & aEvent )

private

Definition at line 177 of file collapsible_pane.cpp.

 {
     Layout();
     aEvent.Skip();
 }

References Layout().

Referenced by Create().

◆ SetBackgroundColour()

bool WX_COLLAPSIBLE_PANE::SetBackgroundColour ( const wxColour & aColor )

override

Definition at line 106 of file collapsible_pane.cpp.

 {
     m_header->SetBackgroundColour( aColor );
     return wxWindow::SetBackgroundColour( aColor );
 }

References m_header.

Referenced by APPEARANCE_CONTROLS::createControls().

◆ SetLabel()

void WX_COLLAPSIBLE_PANE::SetLabel ( const wxString & aLabel )

override

Definition at line 97 of file collapsible_pane.cpp.

 {
     m_header->SetLabel( aLabel );
     m_header->SetInitialSize();
 
     Layout();
 }

References Layout(), and m_header.

Member Data Documentation

◆ m_header

WX_COLLAPSIBLE_PANE_HEADER* WX_COLLAPSIBLE_PANE::m_header

private

Definition at line 162 of file collapsible_pane.h.

Referenced by Collapse(), Create(), getBorder(), GetLabel(), init(), Layout(), onHeaderClicked(), SetBackgroundColour(), and SetLabel().

◆ m_pane

wxWindow* WX_COLLAPSIBLE_PANE::m_pane

private

Definition at line 160 of file collapsible_pane.h.

Referenced by Collapse(), Create(), DoGetBestClientSize(), GetPane(), init(), IsCollapsed(), and Layout().

◆ m_sizer

wxSizer* WX_COLLAPSIBLE_PANE::m_sizer

private

Definition at line 161 of file collapsible_pane.h.

Referenced by Create(), DoGetBestClientSize(), init(), Layout(), and ~WX_COLLAPSIBLE_PANE().

The documentation for this class was generated from the following files:

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ WX_COLLAPSIBLE_PANE() [1/2]

◆ WX_COLLAPSIBLE_PANE() [2/2]

◆ ~WX_COLLAPSIBLE_PANE()

Member Function Documentation

◆ Collapse()

◆ Create()

◆ DoGetBestClientSize()

◆ Expand()

◆ getBorder()

◆ GetLabel()

◆ GetPane()

◆ InformFirstDirection()

◆ init()

◆ IsCollapsed()

◆ IsExpanded()

◆ Layout()

◆ onHeaderClicked()

◆ onSize()

◆ SetBackgroundColour()

◆ SetLabel()

Member Data Documentation

◆ m_header

◆ m_pane

◆ m_sizer