CDockNotebook Class Reference

Search Toolkit Book for CDockNotebook

CDockNotebook - an extended version of wxAuiNotebook capable of working with Dock Manager and Window Manager. More...

#include <gui/widgets/wx/dock_notebook.hpp>

Inheritance diagram for CDockNotebook:

Collaboration diagram for CDockNotebook:

Public Member Functions
	CDockNotebook (CDockContainer &container)
virtual	~CDockNotebook ()
void	InsertPageAtHitPoint (wxWindow *page, const wxString &caption)
void	RefreshPageByWindow (wxWindow *page)
virtual EDockEffect	DropTest (const wxPoint &screen_pt, wxWindow *&target)
void	OnPageClose (wxAuiNotebookEvent &event)
void	OnPageChanged (wxAuiNotebookEvent &event)
void	OnPageChanging (wxAuiNotebookEvent &event)
void	OnTabBeginDrag (wxAuiNotebookEvent &event)
void	OnTabEndDrag (wxAuiNotebookEvent &event)
void	OnTabDragMotion (wxAuiNotebookEvent &event)
void	MakeSelectionVisible ()
IDockableWindow implementation
@(
virtual CDockContainer *	GetDockContainer ()
virtual void	SetDockContainer (CDockContainer *cont)
IDockContWindow implementation
virtual void	Cont_Remove (wxWindow *child)
virtual void	Cont_Replace (wxWindow *old_child, wxWindow *new_child)
Public Member Functions inherited from IDockableWindow
virtual	~IDockableWindow ()
Public Member Functions inherited from IDockContWindow
virtual	~IDockContWindow ()
Public Member Functions inherited from IDockDropTarget
virtual	~IDockDropTarget ()

Public Attributes
CDockContainer *	m_DockContainer
bool	m_OutsideDrag
int	m_HitTabIndex

Protected Member Functions
string	x_GetPageNameByWindow (wxWindow *window)

Private Member Functions
	DECLARE_EVENT_TABLE ()

Detailed Description

CDockNotebook - an extended version of wxAuiNotebook capable of working with Dock Manager and Window Manager.

Definition at line 51 of file dock_notebook.hpp.

Constructor & Destructor Documentation

CDockNotebook()

CDockNotebook::CDockNotebook

(

CDockContainer &

container

)

Definition at line 80 of file dock_notebook.cpp.

References wxT.

~CDockNotebook()

CDockNotebook::~CDockNotebook ( )

virtual

Definition at line 98 of file dock_notebook.cpp.

Member Function Documentation

Cont_Remove()

void CDockNotebook::Cont_Remove ( wxWindow *  child )

virtual

Implements IDockContWindow.

Definition at line 115 of file dock_notebook.cpp.

References m_DockContainer.

Cont_Replace()

void CDockNotebook::Cont_Replace ( wxWindow *  old_child, wxWindow *  new_child  )

virtual

Implements IDockContWindow.

Definition at line 134 of file dock_notebook.cpp.

References label, m_DockContainer, ToWxString(), and x_GetPageNameByWindow().

DECLARE_EVENT_TABLE()

CDockNotebook::DECLARE_EVENT_TABLE ( )

private

DropTest()

EDockEffect CDockNotebook::DropTest ( const wxPoint &  screen_pt, wxWindow *&  target  )

virtual

Implements IDockDropTarget.

Definition at line 211 of file dock_notebook.cpp.

References eNoEffect, ePutInTab, m_HitTabIndex, and NULL.

GetDockContainer()

CDockContainer * CDockNotebook::GetDockContainer ( )

virtual

Implements IDockableWindow.

Definition at line 104 of file dock_notebook.cpp.

References m_DockContainer.

InsertPageAtHitPoint()

void CDockNotebook::InsertPageAtHitPoint	(	wxWindow *	page,
		const wxString &	caption
	)

Definition at line 198 of file dock_notebook.cpp.

References m_HitTabIndex.

Referenced by CDockContainer::x_Visible_AddChildToContainer().

MakeSelectionVisible()

void CDockNotebook::MakeSelectionVisible

(

)

Definition at line 437 of file dock_notebook.cpp.

References NULL.

Referenced by CDockContainer::x_Visible_AddChildToContainer().

OnPageChanged()

void CDockNotebook::OnPageChanged

(

wxAuiNotebookEvent &

event

)

Definition at line 287 of file dock_notebook.cpp.

References BroadcastCommandToChildWindows(), eCmdParentHide, eCmdParentShow, CDockContainer::GetClientsInWindow(), IWMClient::GetWindow(), and m_DockContainer.

OnPageChanging()

void CDockNotebook::OnPageChanging

(

wxAuiNotebookEvent &

event

)

Definition at line 256 of file dock_notebook.cpp.

References CDockContainer::GetClientsInWindow(), IWMClient::GetWindow(), and m_DockContainer.

OnPageClose()

void CDockNotebook::OnPageClose

(

wxAuiNotebookEvent &

event

)

Definition at line 245 of file dock_notebook.cpp.

References m_DockContainer, and CDockContainer::OnTabClosePressed().

OnTabBeginDrag()

void CDockNotebook::OnTabBeginDrag

(

wxAuiNotebookEvent &

event

)

Definition at line 326 of file dock_notebook.cpp.

References m_OutsideDrag.

OnTabDragMotion()

void CDockNotebook::OnTabDragMotion

(

wxAuiNotebookEvent &

event

)

Definition at line 343 of file dock_notebook.cpp.

References _ASSERT, m_DockContainer, and m_OutsideDrag.

OnTabEndDrag()

void CDockNotebook::OnTabEndDrag

(

wxAuiNotebookEvent &

event

)

Definition at line 430 of file dock_notebook.cpp.

References m_DockContainer, and CDockContainer::OnUpdateTabOrder().

RefreshPageByWindow()

void CDockNotebook::RefreshPageByWindow

(

wxWindow *

page

)

Definition at line 150 of file dock_notebook.cpp.

References label, ToWxString(), and x_GetPageNameByWindow().

Referenced by CWindowManager::RefreshClient().

SetDockContainer()

void CDockNotebook::SetDockContainer ( CDockContainer *  cont )

virtual

Implements IDockableWindow.

Definition at line 110 of file dock_notebook.cpp.

References m_DockContainer.

x_GetPageNameByWindow()

string CDockNotebook::x_GetPageNameByWindow ( wxWindow *  window )

protected

Definition at line 167 of file dock_notebook.cpp.

References IWMClient::eContent, IWMClient::eDefault, IWMClient::eDetailed, IWMClient::eTypeAndContent, CDockPanel::GetClient(), IWMClient::GetClientLabel(), CGuiRegistry::GetInstance(), CGuiRegistry::GetInt(), and l().

Referenced by Cont_Replace(), and RefreshPageByWindow().

Member Data Documentation

m_DockContainer

CDockContainer* CDockNotebook::m_DockContainer

Definition at line 95 of file dock_notebook.hpp.

Referenced by Cont_Remove(), Cont_Replace(), GetDockContainer(), OnPageChanged(), OnPageChanging(), OnPageClose(), OnTabDragMotion(), OnTabEndDrag(), and SetDockContainer().

m_HitTabIndex

int CDockNotebook::m_HitTabIndex

Definition at line 98 of file dock_notebook.hpp.

Referenced by DropTest(), and InsertPageAtHitPoint().

m_OutsideDrag

bool CDockNotebook::m_OutsideDrag

Definition at line 97 of file dock_notebook.hpp.

Referenced by OnTabBeginDrag(), and OnTabDragMotion().

---

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

• include/gui/widgets/wx/dock_notebook.hpp
• src/gui/widgets/wx/dock_notebook.cpp