Main Page | Namespace List | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages

wxDockPanel Class Reference

#include <dockpanel.h>

Collaboration diagram for wxDockPanel:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 wxDockPanel ()
void Init ()
 wxDockPanel (wxWindow *parent, wxWindowID id, const wxString &name=wxT("dockpanel"), unsigned int flags=wxDPC_DEFAULT)
bool Create (wxWindow *parent, wxWindowID id, const wxString &name=wxT("dockpanel"), unsigned int flags=wxDPC_DEFAULT)
void UpdateSize ()
void SetDockWindow (wxDockWindowBase *pOwner)
wxDockWindowBase * GetDockWindow ()
void SetDockedHost (wxDockHost *pDockHost)
wxDockHost * GetDockedHost ()
void SetClient (wxWindow *pClient, bool autoPane=false)
wxWindow * GetClient ()
void AutoFitSingleChild ()
wxOrientation GetOrientation ()
wxRect GetScreenArea ()
wxRect GetScreenArea (wxHostInfo &hi)
wxPlacement TestForPlacement (int sx, int sy)
int GetArea ()
void SetArea (int area)
void LockAreaValue (bool state)
bool IsDocked ()
void OnSize (wxSizeEvent &event)
void OnPaneClose (wxCommandEvent &event)
void OnGripDblClick (wxMouseEvent &event)
void OnGripLeftDown (wxMouseEvent &event)
void OnGripLeftUp (wxMouseEvent &event)

Private Member Functions

void childUpdate ()

Private Attributes

unsigned int flags_
bool docked_
bool mouseCaptured_
wxGripWindow * pGripWindow_
wxToolButton * pCloseButton_
wxWindow * pClient_
wxWindow * pStockClient_
wxPane * pPane_
wxBoxSizer * pClientSizer_
wxDockWindowBase * pDockWindow_
wxDockHost * pDockHost_
int area_
bool lockAreaValue_

Constructor & Destructor Documentation

wxDockPanel::wxDockPanel (   )  [inline]
 

Definition at line 48 of file dockpanel.h.

wxDockPanel::wxDockPanel (  wxWindow *  parent,
wxWindowID  id,
const wxString &  name = wxT("dockpanel"),
unsigned int  flags = wxDPC_DEFAULT
)  [inline]
 

Definition at line 53 of file dockpanel.h.

Member Function Documentation

void wxDockPanel::AutoFitSingleChild (   ) 
 

Definition at line 298 of file dockpanel.cpp.

References pClient_, and pClientSizer_.

Referenced by wxDockWindowBase::AutoFitSingleChild().

void wxDockPanel::childUpdate (   )  [private]
 

Definition at line 396 of file dockpanel.cpp.

References docked_, GetOrientation(), and pPane_.

Referenced by SetClient(), and SetDockedHost().

bool wxDockPanel::Create (  wxWindow *  parent,
wxWindowID  id,
const wxString &  name = wxT("dockpanel"),
unsigned int  flags = wxDPC_DEFAULT
) 
 

Definition at line 67 of file dockpanel.cpp.

References flags_, GetOrientation(), pClient_, pCloseButton_, pGripWindow_, pStockClient_, wxGripWindow::SetLabel(), and wxFULL_REPAINT_ON_RESIZE.

int wxDockPanel::GetArea (   ) 
 

Definition at line 377 of file dockpanel.cpp.

References area_.

Referenced by wxDockHost::calcPanelPlacement(), wxLayoutManager::SaveToXML(), and wxDockHost::UndockPanel().

wxWindow * wxDockPanel::GetClient (   ) 
 

Definition at line 293 of file dockpanel.cpp.

References pClient_.

Referenced by wxDockWindowBase::GetClient().

wxDockHost * wxDockPanel::GetDockedHost (   ) 
 

Definition at line 118 of file dockpanel.cpp.

References pDockHost_.

Referenced by wxLayoutManager::DockWindow(), and wxLayoutManager::UndockWindow().

wxDockWindowBase * wxDockPanel::GetDockWindow (   ) 
 

Definition at line 96 of file dockpanel.cpp.

References pDockWindow_.

Referenced by wxDockHost::GetDockWindowList(), OnGripDblClick(), OnGripLeftDown(), and OnGripLeftUp().

wxOrientation wxDockPanel::GetOrientation (   ) 
 

Definition at line 319 of file dockpanel.cpp.

References wxDockHost::GetOrientation(), and pDockHost_.

Referenced by childUpdate(), Create(), GetScreenArea(), TestForPlacement(), and UpdateSize().

wxRect wxDockPanel::GetScreenArea (  wxHostInfo &  hi  ) 
 

Definition at line 337 of file dockpanel.cpp.

References GetOrientation(), GetScreenArea(), wxHIP_BACK, and wxHIP_NONE.

wxRect wxDockPanel::GetScreenArea (   ) 
 

Definition at line 329 of file dockpanel.cpp.

References pDockHost_, and wxDockHost::RectToScreen().

Referenced by GetScreenArea(), and TestForPlacement().

void wxDockPanel::Init (   ) 
 

Definition at line 51 of file dockpanel.cpp.

bool wxDockPanel::IsDocked (   ) 
 

Definition at line 392 of file dockpanel.cpp.

References docked_.

Referenced by wxDockWindowBase::Appear(), and wxDockWindowBase::Remove().

void wxDockPanel::LockAreaValue (  bool  state  ) 
 

Definition at line 388 of file dockpanel.cpp.

References lockAreaValue_.

Referenced by wxLayoutManager::LoadFromStream(), and wxLayoutManager::LoadFromXML().

void wxDockPanel::OnGripDblClick (  wxMouseEvent &  event  ) 
 

Definition at line 136 of file dockpanel.cpp.

References GetDockWindow(), and wxLayoutManager::UndockWindow().

void wxDockPanel::OnGripLeftDown (  wxMouseEvent &  event  ) 
 

Definition at line 147 of file dockpanel.cpp.

References docked_, and GetDockWindow().

void wxDockPanel::OnGripLeftUp (  wxMouseEvent &  event  ) 
 

Definition at line 164 of file dockpanel.cpp.

References docked_, GetDockWindow(), and wxDockWindowBase::StopDragging().

void wxDockPanel::OnPaneClose (  wxCommandEvent &  event  ) 
 

Definition at line 126 of file dockpanel.cpp.

References wxDockWindowBase::GetLayoutManager(), pDockWindow_, wxDockWindowBase::Remove(), and wxLayoutManager::UpdateAllHosts().

void wxDockPanel::OnSize (  wxSizeEvent &  event  ) 
 

Definition at line 122 of file dockpanel.cpp.

References UpdateSize().

void wxDockPanel::SetArea (  int  area  ) 
 

Definition at line 381 of file dockpanel.cpp.

References area_, and lockAreaValue_.

Referenced by wxDockHost::RecalcPanelAreas(), and wxDockHost::UndockPanel().

void wxDockPanel::SetClient (  wxWindow *  pClient,
bool  autoPane = false
) 
 

Definition at line 244 of file dockpanel.cpp.

References childUpdate(), wxDockWindowBase::GetTitle(), pClient_, pDockWindow_, pPane_, pStockClient_, and UpdateSize().

Referenced by wxDockWindowBase::RemoveClient(), and wxDockWindowBase::SetClient().

void wxDockPanel::SetDockedHost (  wxDockHost *  pDockHost  ) 
 

Definition at line 100 of file dockpanel.cpp.

References childUpdate(), docked_, pDockHost_, and wxDockHost::UpdateSize().

Referenced by wxDockHost::DockPanel().

void wxDockPanel::SetDockWindow (  wxDockWindowBase *  pOwner  ) 
 

Definition at line 89 of file dockpanel.cpp.

References pDockWindow_, and pGripWindow_.

Referenced by wxDockWindowBase::createClient().

wxPlacement wxDockPanel::TestForPlacement (  int  sx,
int  sy
) 
 

Definition at line 361 of file dockpanel.cpp.

References GetOrientation(), GetScreenArea(), wxHIP_BACK, wxHIP_FRONT, and wxHIP_NONE.

Referenced by wxDockHost::TestForPanel().

void wxDockPanel::UpdateSize (   ) 
 

Definition at line 193 of file dockpanel.cpp.

References closeBorder, closeSize, docked_, flags_, GetOrientation(), gripperSize, pClient_, pCloseButton_, pGripWindow_, pPane_, wxGripWindow::SetOrientation(), and wxDPC_NO_CONTROLS.

Referenced by wxDockWindowBase::ActualShow(), OnSize(), and SetClient().

Member Data Documentation

int wxDockPanel::area_ [private]
 

Definition at line 122 of file dockpanel.h.

Referenced by GetArea(), and SetArea().

bool wxDockPanel::docked_ [private]
 

Definition at line 108 of file dockpanel.h.

Referenced by childUpdate(), IsDocked(), OnGripLeftDown(), OnGripLeftUp(), SetDockedHost(), and UpdateSize().

unsigned int wxDockPanel::flags_ [private]
 

Definition at line 106 of file dockpanel.h.

Referenced by Create(), and UpdateSize().

bool wxDockPanel::lockAreaValue_ [private]
 

Definition at line 123 of file dockpanel.h.

Referenced by LockAreaValue(), and SetArea().

bool wxDockPanel::mouseCaptured_ [private]
 

Definition at line 109 of file dockpanel.h.

wxWindow* wxDockPanel::pClient_ [private]
 

Definition at line 114 of file dockpanel.h.

Referenced by AutoFitSingleChild(), Create(), GetClient(), SetClient(), and UpdateSize().

wxBoxSizer* wxDockPanel::pClientSizer_ [private]
 

Definition at line 117 of file dockpanel.h.

Referenced by AutoFitSingleChild().

wxToolButton* wxDockPanel::pCloseButton_ [private]
 

Definition at line 112 of file dockpanel.h.

Referenced by Create(), and UpdateSize().

wxDockHost* wxDockPanel::pDockHost_ [private]
 

Definition at line 120 of file dockpanel.h.

Referenced by GetDockedHost(), GetOrientation(), GetScreenArea(), and SetDockedHost().

wxDockWindowBase* wxDockPanel::pDockWindow_ [private]
 

Definition at line 119 of file dockpanel.h.

Referenced by GetDockWindow(), OnPaneClose(), SetClient(), and SetDockWindow().

wxGripWindow* wxDockPanel::pGripWindow_ [private]
 

Definition at line 111 of file dockpanel.h.

Referenced by Create(), SetDockWindow(), and UpdateSize().

wxPane* wxDockPanel::pPane_ [private]
 

Definition at line 116 of file dockpanel.h.

Referenced by childUpdate(), SetClient(), and UpdateSize().

wxWindow* wxDockPanel::pStockClient_ [private]
 

Definition at line 115 of file dockpanel.h.

Referenced by Create(), and SetClient().

The documentation for this class was generated from the following files:
Generated on Sat May 14 14:54:39 2005 for wxDockIt by  doxygen 1.4.2