CPseudoTransparentFrame Class Reference

Search Toolkit Book for CPseudoTransparentFrame

CPseudoTransparentFrame - this is a transparent window that is used as a visual hint during D&D docking. More...

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

Inheritance diagram for CPseudoTransparentFrame:

Collaboration diagram for CPseudoTransparentFrame:

Public Member Functions
	CPseudoTransparentFrame (wxWindow *parent, CDockManager &manager)
virtual bool	SetTransparent (wxByte alpha)
void	OnKeyUp (wxKeyEvent &event)
	Define functions that are the same for all platforms. More...
void	OnKeyDown (wxKeyEvent &event)

Protected Member Functions
void	OnPaint (wxPaintEvent &event)
	for all platforms except for GTK 20 adding the code below More...
void	OnSize (wxSizeEvent &event)
	Define OnWindowCreate() only for __WXGTK__. More...

Protected Attributes
CDockManager &	m_DockManager
wxByte	m_Amount
int	m_MaxWidth
int	m_MaxHeight
bool	m_CanSetShape
int	m_LastWidth
int	m_LastHeight
wxRegion	m_Region

Detailed Description

CPseudoTransparentFrame - this is a transparent window that is used as a visual hint during D&D docking.

The frame is displayed as a transparent overlay on top of the Window Manager.

Definition at line 55 of file dock_hint_frame.hpp.

Constructor & Destructor Documentation

CPseudoTransparentFrame()

CPseudoTransparentFrame::CPseudoTransparentFrame	(	wxWindow *	parent,
		CDockManager &	manager
	)

Definition at line 122 of file dock_hint_frame.cpp.

References m_Amount, m_CanSetShape, m_LastHeight, m_LastWidth, m_MaxHeight, m_MaxWidth, m_Region, and SetTransparent().

Member Function Documentation

OnKeyDown()

void CPseudoTransparentFrame::OnKeyDown

(

wxKeyEvent &

event

)

Definition at line 240 of file dock_hint_frame.cpp.

References m_DockManager, and CDockManager::OnKeyDown().

OnKeyUp()

void CPseudoTransparentFrame::OnKeyUp

(

wxKeyEvent &

event

)

Define functions that are the same for all platforms.

Definition at line 234 of file dock_hint_frame.cpp.

References m_DockManager, and CDockManager::OnKeyUp().

OnPaint()

void CPseudoTransparentFrame::OnPaint ( wxPaintEvent &  event )

protected

for all platforms except for GTK 20 adding the code below

Definition at line 172 of file dock_hint_frame.cpp.

References m_Region.

OnSize()

void CPseudoTransparentFrame::OnSize ( wxSizeEvent &  event )

protected

Define OnWindowCreate() only for __WXGTK__.

Definition at line 207 of file dock_hint_frame.cpp.

References m_Amount, m_LastHeight, m_LastWidth, m_Region, and SetTransparent().

SetTransparent()

bool CPseudoTransparentFrame::SetTransparent ( wxByte  alpha )

virtual

Definition at line 146 of file dock_hint_frame.cpp.

References m_Amount, m_CanSetShape, m_MaxHeight, m_MaxWidth, and m_Region.

Referenced by CPseudoTransparentFrame(), and OnSize().

Member Data Documentation

m_Amount

wxByte CPseudoTransparentFrame::m_Amount

protected

Definition at line 79 of file dock_hint_frame.hpp.

Referenced by CPseudoTransparentFrame(), OnSize(), and SetTransparent().

m_CanSetShape

bool CPseudoTransparentFrame::m_CanSetShape

protected

Definition at line 82 of file dock_hint_frame.hpp.

Referenced by CPseudoTransparentFrame(), and SetTransparent().

m_DockManager

CDockManager& CPseudoTransparentFrame::m_DockManager

protected

Definition at line 66 of file dock_hint_frame.hpp.

Referenced by OnKeyDown(), and OnKeyUp().

m_LastHeight

int CPseudoTransparentFrame::m_LastHeight

protected

Definition at line 84 of file dock_hint_frame.hpp.

Referenced by CPseudoTransparentFrame(), and OnSize().

m_LastWidth

int CPseudoTransparentFrame::m_LastWidth

protected

Definition at line 83 of file dock_hint_frame.hpp.

Referenced by CPseudoTransparentFrame(), and OnSize().

m_MaxHeight

int CPseudoTransparentFrame::m_MaxHeight

protected

Definition at line 81 of file dock_hint_frame.hpp.

Referenced by CPseudoTransparentFrame(), and SetTransparent().

m_MaxWidth

int CPseudoTransparentFrame::m_MaxWidth

protected

Definition at line 80 of file dock_hint_frame.hpp.

Referenced by CPseudoTransparentFrame(), and SetTransparent().

m_Region

wxRegion CPseudoTransparentFrame::m_Region

protected

Definition at line 86 of file dock_hint_frame.hpp.

Referenced by CPseudoTransparentFrame(), OnPaint(), OnSize(), and SetTransparent().

---

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

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