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

wxDockWindowBase Class Reference

#include <dockwindow.h>

Collaboration diagram for wxDockWindowBase:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 wxDockWindowBase ()
 ~wxDockWindowBase ()
void Init ()
 wxDockWindowBase (wxWindow *parent, wxWindowID id, const wxString &title, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, const wxString &name=wxT("dockwindow"), unsigned int flags=wxDWC_DEFAULT)
bool Create (wxWindow *parent, wxWindowID id, const wxString &title, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, const wxString &name=wxT("dockwindow"), unsigned int flags=wxDWC_DEFAULT)
void Appear ()
void Remove ()
void SetDockingManager (wxLayoutManager *pLayoutManager)
wxLayoutManager * GetLayoutManager ()
void SetClient (wxWindow *pClient, bool autoPane=false)
wxWindow * GetClient ()
wxWindow * RemoveClient (wxWindow *pNewParent=NULL)
void AutoFitSingleChild ()
wxDockPanel * GetDockPanel ()
void SetDocked (bool state)
bool IsDocked ()
bool IsVisible ()
wxString GetTitle ()
void SetDockingInfo (wxHostInfo &hi)
void ClearDockingInfo ()
wxHostInfo & GetDockingInfo ()
bool ActualShow (bool show=true)
void DisableShowOverride ()
void RepeatLastMouseEvent ()
virtual bool Show (bool show=true)
virtual void StartDragging (int x, int y, bool needMouseCapture=true)
virtual void StopDragging (bool needMouseRelease=true)
virtual bool BlockDocking ()
void OnMouseMove (wxMouseEvent &e)
void OnClose (wxCloseEvent &e)

Protected Member Functions

void createClient ()
bool applyLastDock (bool noShowOperation=false)

Protected Attributes

unsigned int flags_
bool disableShowOverride_
wxString title_
bool dragging_
bool haveMoved_
wxMouseEvent lastMouseEvent_
wxDockRect startRect_
wxDockRect prevRect_
wxDockRect dragRect_
wxPoint startPoint_
wxLayoutManager * pLayoutManager_
wxDockPanel * pClientPanel_
wxBoxSizer * pClientSizer_
wxHostInfo newHost_
wxHostInfo prevHost_
bool docked_
bool visible_

Constructor & Destructor Documentation

wxDockWindowBase::wxDockWindowBase (   )  [inline]
 

Definition at line 71 of file dockwindow.h.

wxDockWindowBase::~wxDockWindowBase (   )  [inline]
 

Definition at line 74 of file dockwindow.h.

wxDockWindowBase::wxDockWindowBase (  wxWindow *  parent,
wxWindowID  id,
const wxString &  title,
const wxPoint &  pos = wxDefaultPosition,
const wxSize &  size = wxDefaultSize,
const wxString &  name = wxT("dockwindow"),
unsigned int  flags = wxDWC_DEFAULT
)  [inline]
 

Definition at line 78 of file dockwindow.h.

Member Function Documentation

bool wxDockWindowBase::ActualShow (  bool  show = true  ) 
 

Definition at line 164 of file dockwindow.cpp.

References pClientPanel_, wxDockPanel::UpdateSize(), and visible_.

Referenced by Appear(), wxLayoutManager::DockWindow(), Remove(), Show(), and wxLayoutManager::UndockWindow().

void wxDockWindowBase::Appear (   ) 
 

Definition at line 79 of file dockwindow.cpp.

References ActualShow(), applyLastDock(), wxDockPanel::IsDocked(), IsDocked(), pClientPanel_, and visible_.

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

bool wxDockWindowBase::applyLastDock (  bool  noShowOperation = false  )  [protected]
 

Definition at line 352 of file dockwindow.cpp.

References wxLayoutManager::DockWindow(), pLayoutManager_, prevHost_, and wxHostInfo::valid.

Referenced by Appear().

void wxDockWindowBase::AutoFitSingleChild (   ) 
 

Definition at line 117 of file dockwindow.cpp.

References wxDockPanel::AutoFitSingleChild(), and pClientPanel_.

bool wxDockWindowBase::BlockDocking (   )  [virtual]
 

Definition at line 261 of file dockwindow.cpp.

Referenced by OnMouseMove().

void wxDockWindowBase::ClearDockingInfo (   ) 
 

Definition at line 156 of file dockwindow.cpp.

References prevHost_, and wxHostInfo::Reset().

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

bool wxDockWindowBase::Create (  wxWindow *  parent,
wxWindowID  id,
const wxString &  title,
const wxPoint &  pos = wxDefaultPosition,
const wxSize &  size = wxDefaultSize,
const wxString &  name = wxT("dockwindow"),
unsigned int  flags = wxDWC_DEFAULT
) 
 

Definition at line 55 of file dockwindow.cpp.

References createClient(), dockWindowStyle, flags_, title_, and visible_.

void wxDockWindowBase::createClient (   )  [protected]
 

Definition at line 335 of file dockwindow.cpp.

References flags_, pClientPanel_, pClientSizer_, wxDockPanel::SetDockWindow(), wxDPC_NO_CONTROLS, and wxDWC_NO_CONTROLS.

Referenced by Create().

void wxDockWindowBase::DisableShowOverride (   ) 
 

Definition at line 174 of file dockwindow.cpp.

References disableShowOverride_.

wxWindow * wxDockWindowBase::GetClient (   ) 
 

Definition at line 128 of file dockwindow.cpp.

References wxDockPanel::GetClient(), and pClientPanel_.

Referenced by RemoveClient().

wxHostInfo & wxDockWindowBase::GetDockingInfo (   ) 
 

Definition at line 160 of file dockwindow.cpp.

References prevHost_.

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

wxDockPanel * wxDockWindowBase::GetDockPanel (   ) 
 

Definition at line 147 of file dockwindow.cpp.

References pClientPanel_.

Referenced by wxLayoutManager::DockWindow(), wxLayoutManager::LoadFromStream(), wxLayoutManager::LoadFromXML(), wxLayoutManager::SaveToStream(), wxLayoutManager::SaveToXML(), and wxLayoutManager::UndockWindow().

wxLayoutManager * wxDockWindowBase::GetLayoutManager (   ) 
 

Definition at line 75 of file dockwindow.cpp.

References pLayoutManager_.

Referenced by wxDockPanel::OnPaneClose(), and Remove().

wxString wxDockWindowBase::GetTitle (   )  [inline]
 

Definition at line 113 of file dockwindow.h.

Referenced by wxLayoutManager::OnMenuToggle(), wxDockPanel::SetClient(), and wxLayoutManager::UpdateAllHosts().

void wxDockWindowBase::Init (   ) 
 

Definition at line 38 of file dockwindow.cpp.

bool wxDockWindowBase::IsDocked (   ) 
 

Definition at line 366 of file dockwindow.cpp.

References docked_.

Referenced by Appear(), Remove(), wxLayoutManager::SaveToStream(), wxLayoutManager::SaveToXML(), and wxLayoutManager::UndockWindow().

bool wxDockWindowBase::IsVisible (   ) 
 

Definition at line 370 of file dockwindow.cpp.

References visible_.

Referenced by wxLayoutManager::UpdateAllHosts().

void wxDockWindowBase::OnClose (  wxCloseEvent &  e  ) 
 

Definition at line 328 of file dockwindow.cpp.

References Remove().

void wxDockWindowBase::OnMouseMove (  wxMouseEvent &  e  ) 
 

Definition at line 272 of file dockwindow.cpp.

References BlockDocking(), dragging_, dragRect_, wxDockHost::GetScreenArea(), haveMoved_, lastMouseEvent_, newHost_, wxHostInfo::pHost, pLayoutManager_, wxLayoutManager::PointFromScreen(), prevRect_, wxDockRect::rect, wxLayoutManager::RectToScreen(), wxHostInfo::Reset(), startPoint_, wxLayoutManager::TestForHost(), wxDockRect::valid, and wxHostInfo::valid.

Referenced by RepeatLastMouseEvent().

void wxDockWindowBase::Remove (   ) 
 

Definition at line 98 of file dockwindow.cpp.

References ActualShow(), GetLayoutManager(), wxDockPanel::IsDocked(), IsDocked(), pClientPanel_, wxLayoutManager::UndockWindow(), and visible_.

Referenced by wxLayoutManager::LoadFromStream(), wxLayoutManager::LoadFromXML(), OnClose(), wxDockPanel::OnPaneClose(), and Show().

wxWindow * wxDockWindowBase::RemoveClient (  wxWindow *  pNewParent = NULL  ) 
 

Definition at line 133 of file dockwindow.cpp.

References GetClient(), pClientPanel_, and wxDockPanel::SetClient().

void wxDockWindowBase::RepeatLastMouseEvent (   ) 
 

Definition at line 266 of file dockwindow.cpp.

References haveMoved_, lastMouseEvent_, and OnMouseMove().

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

Definition at line 123 of file dockwindow.cpp.

References pClientPanel_, and wxDockPanel::SetClient().

void wxDockWindowBase::SetDocked (  bool  state  ) 
 

Definition at line 362 of file dockwindow.cpp.

References docked_.

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

void wxDockWindowBase::SetDockingInfo (  wxHostInfo &  hi  ) 
 

Definition at line 152 of file dockwindow.cpp.

References prevHost_.

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

void wxDockWindowBase::SetDockingManager (  wxLayoutManager *  pLayoutManager  ) 
 

Definition at line 71 of file dockwindow.cpp.

References pLayoutManager_.

bool wxDockWindowBase::Show (  bool  show = true  )  [virtual]
 

Definition at line 179 of file dockwindow.cpp.

References ActualShow(), Appear(), disableShowOverride_, and Remove().

Referenced by wxLayoutManager::OnMenuToggle().

void wxDockWindowBase::StartDragging (  int  x,
int  y,
bool  needMouseCapture = true
)  [virtual]
 

Definition at line 194 of file dockwindow.cpp.

References dragging_, haveMoved_, prevRect_, wxDockRect::rect, startPoint_, and startRect_.

void wxDockWindowBase::StopDragging (  bool  needMouseRelease = true  )  [virtual]
 

Definition at line 221 of file dockwindow.cpp.

References wxLayoutManager::DockWindow(), dragging_, dragRect_, haveMoved_, newHost_, pLayoutManager_, prevRect_, wxDockRect::rect, wxHostInfo::Reset(), wxDockRect::Reset(), startRect_, wxLayoutManager::UndockWindow(), wxHostInfo::valid, and wxDockRect::valid.

Referenced by wxDockPanel::OnGripLeftUp().

Member Data Documentation

bool wxDockWindowBase::disableShowOverride_ [protected]
 

Definition at line 143 of file dockwindow.h.

Referenced by DisableShowOverride(), and Show().

bool wxDockWindowBase::docked_ [protected]
 

Definition at line 165 of file dockwindow.h.

Referenced by IsDocked(), and SetDocked().

bool wxDockWindowBase::dragging_ [protected]
 

Definition at line 147 of file dockwindow.h.

Referenced by OnMouseMove(), StartDragging(), and StopDragging().

wxDockRect wxDockWindowBase::dragRect_ [protected]
 

Definition at line 153 of file dockwindow.h.

Referenced by OnMouseMove(), and StopDragging().

unsigned int wxDockWindowBase::flags_ [protected]
 

Definition at line 142 of file dockwindow.h.

Referenced by Create(), and createClient().

bool wxDockWindowBase::haveMoved_ [protected]
 

Definition at line 148 of file dockwindow.h.

Referenced by OnMouseMove(), RepeatLastMouseEvent(), StartDragging(), and StopDragging().

wxMouseEvent wxDockWindowBase::lastMouseEvent_ [protected]
 

Definition at line 149 of file dockwindow.h.

Referenced by OnMouseMove(), and RepeatLastMouseEvent().

wxHostInfo wxDockWindowBase::newHost_ [protected]
 

Definition at line 162 of file dockwindow.h.

Referenced by OnMouseMove(), and StopDragging().

wxDockPanel* wxDockWindowBase::pClientPanel_ [protected]
 

Definition at line 159 of file dockwindow.h.

Referenced by ActualShow(), Appear(), AutoFitSingleChild(), createClient(), GetClient(), GetDockPanel(), Remove(), RemoveClient(), and SetClient().

wxBoxSizer* wxDockWindowBase::pClientSizer_ [protected]
 

Definition at line 160 of file dockwindow.h.

Referenced by createClient().

wxLayoutManager* wxDockWindowBase::pLayoutManager_ [protected]
 

Definition at line 157 of file dockwindow.h.

Referenced by applyLastDock(), GetLayoutManager(), OnMouseMove(), SetDockingManager(), and StopDragging().

wxHostInfo wxDockWindowBase::prevHost_ [protected]
 

Definition at line 163 of file dockwindow.h.

Referenced by applyLastDock(), ClearDockingInfo(), GetDockingInfo(), and SetDockingInfo().

wxDockRect wxDockWindowBase::prevRect_ [protected]
 

Definition at line 152 of file dockwindow.h.

Referenced by OnMouseMove(), StartDragging(), and StopDragging().

wxPoint wxDockWindowBase::startPoint_ [protected]
 

Definition at line 155 of file dockwindow.h.

Referenced by OnMouseMove(), and StartDragging().

wxDockRect wxDockWindowBase::startRect_ [protected]
 

Definition at line 151 of file dockwindow.h.

Referenced by StartDragging(), and StopDragging().

wxString wxDockWindowBase::title_ [protected]
 

Definition at line 145 of file dockwindow.h.

Referenced by Create().

bool wxDockWindowBase::visible_ [protected]
 

Definition at line 166 of file dockwindow.h.

Referenced by ActualShow(), Appear(), Create(), IsVisible(), and Remove().

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