wxIFMDockEvent Class Reference

Event to dock a component into another component. More...

#include <events.h>

Inherited by wxIFMDockEventEx.

Inheritance diagram for wxIFMDockEvent:

[legend]Collaboration diagram for wxIFMDockEvent:

[legend]List of all members.

Public Member Functions
	wxIFMDockEvent (wxIFMComponent *component, wxIFMComponent *destination, int index)
	wxIFMDockEvent (const wxIFMDockEvent &event)
virtual wxEvent *	Clone () const
wxIFMComponent *	GetDestination () const
void	SetDestination (wxIFMComponent *destination)
int	GetDestinationType () const
int	GetIndex () const
Protected Attributes
wxIFMComponent *	m_destination
	destination component to dock into
int	m_destinationType
	type of destination component
int	m_index
	position of component within its destination in index mode

---

Detailed Description

Event to dock a component into another component.

Components can be docked in two ways: position or index mode.

Position mode means that the destination component is provided with the requested (x,y) position of the component, and the destination decides where the component will end up.

Index mode means that the destination component is told that the component should be in the first, second, or nth position.

See also:

wxIFMUndockEvent

Definition at line 340 of file events.h.

---

Constructor & Destructor Documentation

wxIFMDockEvent::wxIFMDockEvent (  wxIFMComponent *  component, wxIFMComponent *  destination, int  index )

Definition at line 126 of file events.cpp. References wxIFMComponent::GetType(), and m_destinationType. Referenced by Clone().

wxIFMDockEvent::wxIFMDockEvent (  const wxIFMDockEvent &  event  )  [inline]

Definition at line 351 of file events.h.

---

Member Function Documentation

virtual wxEvent* wxIFMDockEvent::Clone (   )  const [inline, virtual]

Reimplemented in wxIFMDockEventEx. Definition at line 358 of file events.h. References wxIFMDockEvent().

wxIFMComponent* wxIFMDockEvent::GetDestination (   )  const [inline]

Returns: Destination component to dock into Definition at line 363 of file events.h. References m_destination. Referenced by wxIFMDefaultResizePlugin::OnDock(), wxIFMDefaultDockingPlugin::OnDock(), wxIFMDefaultPlugin::OnDock(), and wxIFMDefaultPanelPlugin::OnDock().

int wxIFMDockEvent::GetDestinationType (   )  const [inline]

Returns: Type of destination component Definition at line 369 of file events.h. References m_destinationType. Referenced by wxIFMDefaultPanelPlugin::OnDock(), and wxIFMDefaultContainerPlugin::OnDock().

int wxIFMDockEvent::GetIndex (   )  const [inline]

Returns: Position of the component within its destination Definition at line 374 of file events.h. References m_index. Referenced by wxIFMDefaultDockingPlugin::OnDock(), wxIFMDefaultPlugin::OnDock(), and wxIFMDefaultPanelPlugin::OnDock().

void wxIFMDockEvent::SetDestination (  wxIFMComponent *  destination  )

Definition at line 136 of file events.cpp. References wxIFMComponent::GetType(), m_destination, and m_destinationType.

---

Member Data Documentation

wxIFMComponent* wxIFMDockEvent::m_destination [protected]

destination component to dock into Definition at line 343 of file events.h. Referenced by GetDestination(), and SetDestination().

int wxIFMDockEvent::m_destinationType [protected]

type of destination component Definition at line 344 of file events.h. Referenced by GetDestinationType(), SetDestination(), and wxIFMDockEvent().

int wxIFMDockEvent::m_index [protected]

position of component within its destination in index mode Definition at line 345 of file events.h. Referenced by GetIndex(), and wxIFMDockEventEx::SetIndex().

---

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

• /home/jacopo/matocad-0.1/include/wxIFM/events.h
• /home/jacopo/matocad-0.1/src/wxIFM/events.cpp