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

wxDockHost Class Reference

#include <dockhost.h>

Collaboration diagram for wxDockHost:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 wxDockHost ()
 ~wxDockHost ()
void Init ()
 wxDockHost (wxWindow *parent, wxWindowID id, wxDirection dir, const wxString &name=wxT("dockhost"))
bool Create (wxWindow *parent, wxWindowID id, wxDirection dir, const wxString &name=wxT("dockhost"))
void SetLayoutManager (wxLayoutManager *pLayoutManager)
wxLayoutManager * GetLayoutManager ()
void SetAreaSize (int size)
int GetAreaSize ()
void SetPanelArea (int panelArea)
int GetPanelArea ()
void LockPanelValue (bool state)
DockWindowList & GetDockWindowList ()
void DockPanel (wxDockPanel *pDockPanel, wxHostInfo &hi)
void UndockPanel (wxDockPanel *pDockPanel)
wxRect GetScreenArea ()
wxRect GetScreenArea (wxHostInfo &hi)
wxRect GetClientArea ()
wxRect GetClientArea (wxRect availableArea)
wxOrientation GetOrientation ()
wxDirection GetDirection ()
wxExSplitter * GetSizingSplitter () const
wxRect CalcHostPlacement (bool hitTest=false)
bool IsEmpty ()
bool TestForPanel (int sx, int sy, wxHostInfo &hi)
wxRect RectToScreen (wxRect &rect)
void RecalcPanelAreas ()
void UpdateSize (bool useProportions=false)
void OnSize (wxSizeEvent &event)
void OnSplitterMoved (wxCommandEvent &event)
void OnCalculateLayout (wxCalculateLayoutEvent &event)
void SettingsChanged ()

Private Types

enum  eChildType { CT_NONE, CT_PANEL, CT_SPLITTER }

Private Member Functions

void calcPanelPlacement (bool useProportions=false)
void updateSplitters ()
int getAssetCount ()

Private Attributes

wxDirection dir_
int areaSize_
int panelArea_
bool lockPanelValue_
bool internalSizeEvent_
wxPoint pos_
wxSize size_
wxLayoutManager * pLayoutManager_
int numPanels_
int numSplitters_
SplitterList splitters_
unsigned int splitterFlags_
wxExSplitter * pSizingSplitter_
DockWindowList dockWindows_

Member Enumeration Documentation

enum wxDockHost::eChildType [private]
 

Enumeration values:
CT_NONE 
CT_PANEL 
CT_SPLITTER 

Definition at line 108 of file dockhost.h.

Constructor & Destructor Documentation

wxDockHost::wxDockHost (   )  [inline]
 

Definition at line 43 of file dockhost.h.

wxDockHost::~wxDockHost (   ) 
 

Definition at line 40 of file dockhost.cpp.

wxDockHost::wxDockHost (  wxWindow *  parent,
wxWindowID  id,
wxDirection  dir,
const wxString &  name = wxT("dockhost")
)  [inline]
 

Definition at line 50 of file dockhost.h.

Member Function Documentation

wxRect wxDockHost::CalcHostPlacement (  bool  hitTest = false  ) 
 

Definition at line 312 of file dockhost.cpp.

References areaSize_, dir_, wxLayoutManager::GetDockArea(), IsEmpty(), pLayoutManager_, pos_, and size_.

Referenced by GetClientArea(), and GetScreenArea().

void wxDockHost::calcPanelPlacement (  bool  useProportions = false  )  [private]
 

Definition at line 507 of file dockhost.cpp.

References dir_, wxDockPanel::GetArea(), GetOrientation(), IsEmpty(), lockPanelValue_, numPanels_, numSplitters_, panelArea_, pSizingSplitter_, RecalcPanelAreas(), updateSplitters(), and wxSPLITTER_SIZE.

Referenced by UpdateSize().

bool wxDockHost::Create (  wxWindow *  parent,
wxWindowID  id,
wxDirection  dir,
const wxString &  name = wxT("dockhost")
) 
 

Definition at line 63 of file dockhost.cpp.

References dir_, pos_, and size_.

void wxDockHost::DockPanel (  wxDockPanel *  pDockPanel,
wxHostInfo &  hi
) 
 

Definition at line 160 of file dockhost.cpp.

References getAssetCount(), wxHostInfo::placement, wxHostInfo::pPanel, RecalcPanelAreas(), wxDockPanel::SetDockedHost(), and wxHIP_BACK.

Referenced by wxLayoutManager::DockWindow().

int wxDockHost::GetAreaSize (   ) 
 

Definition at line 90 of file dockhost.cpp.

References areaSize_.

Referenced by wxLayoutManager::SaveToStream(), and wxLayoutManager::SaveToXML().

int wxDockHost::getAssetCount (   )  [private]
 

Definition at line 602 of file dockhost.cpp.

Referenced by DockPanel(), IsEmpty(), and UndockPanel().

wxRect wxDockHost::GetClientArea (  wxRect  availableArea  ) 
 

wxRect wxDockHost::GetClientArea (   ) 
 

Definition at line 285 of file dockhost.cpp.

References CalcHostPlacement().

Referenced by wxLayoutManager::TrimDockArea().

wxDirection wxDockHost::GetDirection (   ) 
 

Definition at line 308 of file dockhost.cpp.

References dir_.

Referenced by wxLayoutManager::AddDockHost(), OnCalculateLayout(), and wxLayoutManager::TrimDockArea().

DockWindowList & wxDockHost::GetDockWindowList (   ) 
 

Definition at line 94 of file dockhost.cpp.

References dockWindows_, and wxDockPanel::GetDockWindow().

Referenced by wxLayoutManager::SaveToStream(), and wxLayoutManager::SaveToXML().

wxLayoutManager * wxDockHost::GetLayoutManager (   ) 
 

Definition at line 82 of file dockhost.cpp.

References pLayoutManager_.

wxOrientation wxDockHost::GetOrientation (   ) 
 

Definition at line 290 of file dockhost.cpp.

References dir_.

Referenced by calcPanelPlacement(), wxDockPanel::GetOrientation(), OnSize(), RecalcPanelAreas(), SetLayoutManager(), and updateSplitters().

int wxDockHost::GetPanelArea (   )  [inline]
 

Definition at line 66 of file dockhost.h.

Referenced by wxLayoutManager::SaveToStream(), and wxLayoutManager::SaveToXML().

wxRect wxDockHost::GetScreenArea (  wxHostInfo &  hi  ) 
 

Definition at line 275 of file dockhost.cpp.

References GetScreenArea().

wxRect wxDockHost::GetScreenArea (   ) 
 

Definition at line 265 of file dockhost.cpp.

References CalcHostPlacement(), pLayoutManager_, wxLayoutManager::RectToScreen(), and wxLayoutManager::TrimDockArea().

Referenced by GetScreenArea(), wxDockWindowBase::OnMouseMove(), and TestForPanel().

wxExSplitter* wxDockHost::GetSizingSplitter (   )  const [inline]
 

Definition at line 81 of file dockhost.h.

void wxDockHost::Init (   ) 
 

Definition at line 44 of file dockhost.cpp.

References areaSize_, dir_, dockWindows_, internalSizeEvent_, lockPanelValue_, numPanels_, numSplitters_, panelArea_, pLayoutManager_, pos_, pSizingSplitter_, size_, splitterFlags_, splitters_, and wxINITIAL_HOST_SIZE.

bool wxDockHost::IsEmpty (   ) 
 

Definition at line 357 of file dockhost.cpp.

References getAssetCount().

Referenced by CalcHostPlacement(), calcPanelPlacement(), OnCalculateLayout(), OnSize(), TestForPanel(), and wxLayoutManager::TrimDockArea().

void wxDockHost::LockPanelValue (  bool  state  )  [inline]
 

Definition at line 67 of file dockhost.h.

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

void wxDockHost::OnCalculateLayout (  wxCalculateLayoutEvent &  event  ) 
 

Definition at line 438 of file dockhost.cpp.

References areaSize_, GetDirection(), internalSizeEvent_, IsEmpty(), wxLayoutManager::IsPrimaryDockHost(), pLayoutManager_, and wxLayoutManager::SetDockArea().

void wxDockHost::OnSize (  wxSizeEvent &  event  ) 
 

Definition at line 117 of file dockhost.cpp.

References areaSize_, GetOrientation(), internalSizeEvent_, IsEmpty(), pLayoutManager_, wxLayoutManager::UpdateAllHosts(), and UpdateSize().

void wxDockHost::OnSplitterMoved (  wxCommandEvent &  event  ) 
 

Definition at line 140 of file dockhost.cpp.

References pSizingSplitter_, and RecalcPanelAreas().

void wxDockHost::RecalcPanelAreas (   ) 
 

Definition at line 404 of file dockhost.cpp.

References GetOrientation(), lockPanelValue_, numSplitters_, panelArea_, wxDockPanel::SetArea(), and wxSPLITTER_SIZE.

Referenced by calcPanelPlacement(), DockPanel(), and OnSplitterMoved().

wxRect wxDockHost::RectToScreen (  wxRect &  rect  ) 
 

Definition at line 396 of file dockhost.cpp.

Referenced by wxDockPanel::GetScreenArea(), and TestForPanel().

void wxDockHost::SetAreaSize (  int  size  ) 
 

Definition at line 86 of file dockhost.cpp.

References areaSize_.

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

void wxDockHost::SetLayoutManager (  wxLayoutManager *  pLayoutManager  ) 
 

Definition at line 71 of file dockhost.cpp.

References dir_, GetOrientation(), pLayoutManager_, pSizingSplitter_, and SettingsChanged().

Referenced by wxLayoutManager::AddDockHost().

void wxDockHost::SetPanelArea (  int  panelArea  )  [inline]
 

Definition at line 65 of file dockhost.h.

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

void wxDockHost::SettingsChanged (   ) 
 

Definition at line 490 of file dockhost.cpp.

References wxLayoutManager::GetFlags(), pLayoutManager_, pSizingSplitter_, wxExSplitter::SetFlags(), splitterFlags_, splitters_, wxDWF_LIVE_UPDATE, wxDWF_SPLITTER_BORDERS, wxESF_DRAW_GRIPPER, and wxESF_LIVE_UPDATE.

Referenced by SetLayoutManager(), and wxLayoutManager::settingsChanged().

bool wxDockHost::TestForPanel (  int  sx,
int  sy,
wxHostInfo &  hi
) 
 

Definition at line 361 of file dockhost.cpp.

References GetScreenArea(), IsEmpty(), wxHostInfo::placement, wxHostInfo::pPanel, RectToScreen(), and wxDockPanel::TestForPlacement().

Referenced by wxLayoutManager::TestForHost().

void wxDockHost::UndockPanel (  wxDockPanel *  pDockPanel  ) 
 

Definition at line 221 of file dockhost.cpp.

References wxDockPanel::GetArea(), getAssetCount(), wxDockPanel::SetArea(), and wxSPLITTER_SIZE.

Referenced by wxLayoutManager::UndockWindow().

void wxDockHost::UpdateSize (  bool  useProportions = false  ) 
 

Definition at line 147 of file dockhost.cpp.

References calcPanelPlacement().

Referenced by OnSize(), and wxDockPanel::SetDockedHost().

void wxDockHost::updateSplitters (   )  [private]
 

Definition at line 610 of file dockhost.cpp.

References CT_NONE, CT_PANEL, CT_SPLITTER, GetOrientation(), numPanels_, numSplitters_, pSizingSplitter_, wxExSplitter::SetWindows(), splitterFlags_, and splitters_.

Referenced by calcPanelPlacement().

Member Data Documentation

int wxDockHost::areaSize_ [private]
 

Definition at line 115 of file dockhost.h.

Referenced by CalcHostPlacement(), GetAreaSize(), Init(), OnCalculateLayout(), OnSize(), and SetAreaSize().

wxDirection wxDockHost::dir_ [private]
 

Definition at line 114 of file dockhost.h.

Referenced by CalcHostPlacement(), calcPanelPlacement(), Create(), GetDirection(), GetOrientation(), Init(), and SetLayoutManager().

DockWindowList wxDockHost::dockWindows_ [private]
 

Definition at line 132 of file dockhost.h.

Referenced by GetDockWindowList(), and Init().

bool wxDockHost::internalSizeEvent_ [private]
 

Definition at line 118 of file dockhost.h.

Referenced by Init(), OnCalculateLayout(), and OnSize().

bool wxDockHost::lockPanelValue_ [private]
 

Definition at line 117 of file dockhost.h.

Referenced by calcPanelPlacement(), Init(), and RecalcPanelAreas().

int wxDockHost::numPanels_ [private]
 

Definition at line 125 of file dockhost.h.

Referenced by calcPanelPlacement(), Init(), and updateSplitters().

int wxDockHost::numSplitters_ [private]
 

Definition at line 126 of file dockhost.h.

Referenced by calcPanelPlacement(), Init(), RecalcPanelAreas(), and updateSplitters().

int wxDockHost::panelArea_ [private]
 

Definition at line 116 of file dockhost.h.

Referenced by calcPanelPlacement(), Init(), and RecalcPanelAreas().

wxLayoutManager* wxDockHost::pLayoutManager_ [private]
 

Definition at line 123 of file dockhost.h.

Referenced by CalcHostPlacement(), GetLayoutManager(), GetScreenArea(), Init(), OnCalculateLayout(), OnSize(), SetLayoutManager(), and SettingsChanged().

wxPoint wxDockHost::pos_ [private]
 

Definition at line 120 of file dockhost.h.

Referenced by CalcHostPlacement(), Create(), and Init().

wxExSplitter* wxDockHost::pSizingSplitter_ [private]
 

Definition at line 130 of file dockhost.h.

Referenced by calcPanelPlacement(), Init(), OnSplitterMoved(), SetLayoutManager(), SettingsChanged(), and updateSplitters().

wxSize wxDockHost::size_ [private]
 

Definition at line 121 of file dockhost.h.

Referenced by CalcHostPlacement(), Create(), and Init().

unsigned int wxDockHost::splitterFlags_ [private]
 

Definition at line 128 of file dockhost.h.

Referenced by Init(), SettingsChanged(), and updateSplitters().

SplitterList wxDockHost::splitters_ [private]
 

Definition at line 127 of file dockhost.h.

Referenced by Init(), SettingsChanged(), and updateSplitters().

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