MatOCAD Logo

Main Page | Class Hierarchy | Class List | Directories | File List | Class Members | File Members | Related Pages

wxIFMInterfacePluginBase Class Reference

#include <plugin.h>

Inherited by wxIFMDefaultInterfacePlugin.

Inheritance diagram for wxIFMInterfacePluginBase:

Inheritance graph
[legend]
Collaboration diagram for wxIFMInterfacePluginBase:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 wxIFMInterfacePluginBase ()
virtual ~wxIFMInterfacePluginBase ()
wxInterfaceManager * GetManager ()
virtual bool Initialize (wxInterfaceManager *manager)
virtual void Shutdown ()
bool PushExtensionPlugin (wxIFMExtensionPluginBase *plugin)
 Adds an extension plugin.
void PopExtensionPlugin ()
 Removes and deletes the most recently added extension plugin.
void PopAllExtensionPlugins ()
 Removes and deletes all extension plugins.
virtual void Enable (bool val=true)
 Enables or Disables the interface plugin as well as all extension plugins.
void Disable ()
const wxIFMComponentArray & GetComponents () const
virtual bool ProcessPluginEvent (wxIFMPluginEvent &event)
 Processes a plugin event.
void AddPendingPluginEvent (wxIFMPluginEvent &event)
 Adds a plugin event to the event que to be processed later.
virtual wxIFMComponent * GetComponentByPos (const wxPoint &pos, wxIFMComponent *component=NULL, bool floating=false)
wxIFMComponent * FindChildWindow (wxWindow *window)
 Finds the component containing the given child window.
void AddChildWindow (wxWindow *window, wxIFMComponent *component)
 Adds a child window to the interface plugin, associated with a given component.

Protected Attributes

wxIFMComponentArray m_components
wxIFMChildWindowMap m_windows

Private Member Functions

wxEvtHandler * GetTopPlugin ()
void OnMouseEvent (wxMouseEvent &event)
void OnKeyDown (wxKeyEvent &event)
void OnKeyUp (wxKeyEvent &event)
void OnPaint (wxPaintEvent &event)
void OnSetCursor (wxSetCursorEvent &event)
void OnSize (wxSizeEvent &event)
void OnFocus (wxFocusEvent &event)
void OnActivate (wxActivateEvent &event)

Private Attributes

wxInterfaceManager * m_manager
wxIFMExtensionPluginBase * m_topExtensionPlugin

Detailed Description

Interface plugin base class

Definition at line 21 of file plugin.h.

Constructor & Destructor Documentation

wxIFMInterfacePluginBase::wxIFMInterfacePluginBase (   ) 
 

Definition at line 22 of file plugin.cpp.

wxIFMInterfacePluginBase::~wxIFMInterfacePluginBase (   )  [virtual]
 

Definition at line 164 of file plugin.cpp.

References m_components, and PopAllExtensionPlugins().

Member Function Documentation

void wxIFMInterfacePluginBase::AddChildWindow (  wxWindow *  window,
wxIFMComponent *  component
) 
 

Adds a child window to the interface plugin, associated with a given component.

If a window was already associated with a component, and the component changed, calling this function again will update the its associated component.

Parameters:
window Child window to add
component Component owning this child window

Definition at line 322 of file plugin.cpp.

References m_windows.

Referenced by wxIFMDefaultInterfacePlugin::OnAddChild().

void wxIFMInterfacePluginBase::AddPendingPluginEvent (  wxIFMPluginEvent &  event  ) 
 

Adds a plugin event to the event que to be processed later.

Definition at line 159 of file plugin.cpp.

References GetTopPlugin().

void wxIFMInterfacePluginBase::Disable (   )  [inline]
 

Definition at line 68 of file plugin.h.

References Enable().

void wxIFMInterfacePluginBase::Enable (  bool  val = true  )  [virtual]
 

Enables or Disables the interface plugin as well as all extension plugins.

Definition at line 235 of file plugin.cpp.

References wxIFMExtensionPluginBase::Enable(), and m_topExtensionPlugin.

Referenced by Disable().

wxIFMComponent * wxIFMInterfacePluginBase::FindChildWindow (  wxWindow *  window  ) 
 

Finds the component containing the given child window.

Definition at line 328 of file plugin.cpp.

References m_windows.

Referenced by ProcessPluginEvent().

wxIFMComponent * wxIFMInterfacePluginBase::GetComponentByPos (  const wxPoint &  pos,
wxIFMComponent *  component = NULL,
bool  floating = false
)  [virtual]
 

Return the component at the given position or NULL if none found within the children of the given component and the component itself.

Parameters:
pos Position in managed window client coordinates. The managed window is the parent of the wxInterfaceManager that owns this plugin.
component If NULL, the components array will be searched. If non null, only the given component and its children will be searched.
floating If true, floating windows will be searched first. This parameter does nothing if the current platform does not support floating.

Reimplemented in wxIFMDefaultInterfacePlugin.

Definition at line 255 of file plugin.cpp.

References wxInterfaceManager::GetParent(), wxIFMComponent::m_children, m_components, wxIFMComponent::m_hidden, m_manager, and wxIFMComponent::m_rect.

Referenced by OnMouseEvent(), and OnSetCursor().

const wxIFMComponentArray & wxIFMInterfacePluginBase::GetComponents (   )  const
 

Returns:
Const reference to the components array

Definition at line 33 of file plugin.cpp.

References m_components.

wxInterfaceManager * wxIFMInterfacePluginBase::GetManager (   ) 
 

Definition at line 28 of file plugin.cpp.

References m_manager.

Referenced by wxIFMDefaultInterfacePlugin::GetComponentByPos(), wxIFMExtensionPluginBase::GetManager(), wxIFMComponent::GetManager(), wxIFMDefaultPlugin::GetManager(), Initialize(), wxIFMDefaultInterfacePlugin::OnGetContentRect(), OnPaint(), wxIFMDefaultPlugin::OnShowComponent(), and wxIFMDefaultInterfacePlugin::OnUpdate().

wxEvtHandler * wxIFMInterfacePluginBase::GetTopPlugin (   )  [private]
 

Returns the top most extension plugin, or this if there are no extension plugins

Definition at line 227 of file plugin.cpp.

References m_topExtensionPlugin.

Referenced by AddPendingPluginEvent(), and ProcessPluginEvent().

bool wxIFMInterfacePluginBase::Initialize (  wxInterfaceManager *  manager  )  [virtual]
 

Reimplemented in wxIFMDefaultInterfacePlugin.

Definition at line 45 of file plugin.cpp.

References GetManager(), m_manager, OnActivate(), OnFocus(), OnKeyDown(), OnKeyUp(), OnMouseEvent(), OnPaint(), OnSetCursor(), and OnSize().

Referenced by wxInterfaceManager::AddInterfacePlugin(), and wxIFMDefaultInterfacePlugin::Initialize().

void wxIFMInterfacePluginBase::OnActivate (  wxActivateEvent &  event  )  [private]
 

Definition at line 436 of file plugin.cpp.

References ProcessPluginEvent().

Referenced by Initialize().

void wxIFMInterfacePluginBase::OnFocus (  wxFocusEvent &  event  )  [private]
 

Definition at line 428 of file plugin.cpp.

References ProcessPluginEvent().

Referenced by Initialize().

void wxIFMInterfacePluginBase::OnKeyDown (  wxKeyEvent &  event  )  [private]
 

Definition at line 381 of file plugin.cpp.

References wxInterfaceManager::GetCapturedComponent(), m_manager, and ProcessPluginEvent().

Referenced by Initialize().

void wxIFMInterfacePluginBase::OnKeyUp (  wxKeyEvent &  event  )  [private]
 

Definition at line 388 of file plugin.cpp.

References wxInterfaceManager::GetCapturedComponent(), m_manager, and ProcessPluginEvent().

Referenced by Initialize().

void wxIFMInterfacePluginBase::OnMouseEvent (  wxMouseEvent &  event  )  [private]
 

Definition at line 333 of file plugin.cpp.

References wxInterfaceManager::GetCapturedComponent(), GetComponentByPos(), wxInterfaceManager::IsInputCaptured(), m_manager, and ProcessPluginEvent().

Referenced by Initialize().

void wxIFMInterfacePluginBase::OnPaint (  wxPaintEvent &  event  )  [private]
 

Definition at line 395 of file plugin.cpp.

References wxIFMBeginPaintEvent::GetDC(), GetManager(), wxInterfaceManager::GetParent(), m_manager, and ProcessPluginEvent().

Referenced by Initialize().

void wxIFMInterfacePluginBase::OnSetCursor (  wxSetCursorEvent &  event  )  [private]
 

Definition at line 374 of file plugin.cpp.

References GetComponentByPos(), and ProcessPluginEvent().

Referenced by Initialize().

void wxIFMInterfacePluginBase::OnSize (  wxSizeEvent &  event  )  [private]
 

Definition at line 419 of file plugin.cpp.

References wxInterfaceManager::GetFlags(), IFM_NO_RESIZE_UPDATE, m_manager, and wxInterfaceManager::Update().

Referenced by Initialize().

void wxIFMInterfacePluginBase::PopAllExtensionPlugins (   ) 
 

Removes and deletes all extension plugins.

Definition at line 221 of file plugin.cpp.

References m_topExtensionPlugin, and PopExtensionPlugin().

Referenced by wxInterfaceManager::RemoveAllExtensionPlugins(), Shutdown(), and ~wxIFMInterfacePluginBase().

void wxIFMInterfacePluginBase::PopExtensionPlugin (   ) 
 

Removes and deletes the most recently added extension plugin.

Definition at line 199 of file plugin.cpp.

References m_topExtensionPlugin, and wxIFMExtensionPluginBase::Shutdown().

Referenced by PopAllExtensionPlugins(), and wxInterfaceManager::RemoveExtensionPlugin().

bool wxIFMInterfacePluginBase::ProcessPluginEvent (  wxIFMPluginEvent &  event  )  [virtual]
 

Processes a plugin event.

Reimplemented in wxIFMDefaultInterfacePlugin.

Definition at line 100 of file plugin.cpp.

References FindChildWindow(), wxIFMChildEvent::GetChild(), GetTopPlugin(), m_components, and wxIFMChildEvent::SetComponent().

Referenced by wxInterfaceManager::AddChild(), wxIFMComponent::GetBackgroundRect(), wxIFMComponent::GetClientRect(), wxIFMComponent::GetConvertedRect(), wxIFMComponent::GetDesiredSize(), wxIFMComponent::GetMaxSize(), wxIFMComponent::GetMinSize(), wxInterfaceManager::IsChildVisible(), OnActivate(), wxIFMDefaultResizePlugin::OnAddTopContainer(), wxIFMDefaultPlugin::OnConvertRect(), wxIFMDefaultPlugin::OnDeleteComponent(), wxIFMDefaultResizePlugin::OnDock(), wxIFMDefaultDockingPlugin::OnDock(), wxIFMDefaultPlugin::OnDock(), wxIFMDefaultPanelPlugin::OnDock(), wxIFMDefaultDockingPlugin::OnDrag(), wxIFMDefaultDockingPlugin::OnDragBegin(), wxIFMDefaultDockingPlugin::OnDragEnd(), OnFocus(), wxIFMDefaultPlugin::OnGetDesiredSize(), wxIFMDefaultPlugin::OnGetMaxSize(), wxIFMDefaultPlugin::OnGetMinSize(), wxIFMDefaultPlugin::OnGetRect(), wxIFMDefaultPlugin::OnHitTest(), wxIFMDefaultResizePlugin::OnKeyDown(), OnKeyDown(), wxIFMDefaultDockingPlugin::OnKeyDown(), OnKeyUp(), wxIFMDefaultResizePlugin::OnLeftDown(), wxIFMDefaultPanelPlugin::OnLeftDown(), wxIFMDefaultContainerPlugin::OnLeftDown(), wxIFMDefaultResizePlugin::OnLeftUp(), wxIFMDefaultDockingPlugin::OnLeftUp(), wxIFMComponentButton::OnLeftUp(), OnMouseEvent(), wxIFMDefaultResizePlugin::OnMouseMove(), wxIFMDefaultDockingPlugin::OnMouseMove(), OnPaint(), wxIFMDefaultPlugin::OnPaintBg(), wxIFMDefaultPlugin::OnPaintBorder(), wxIFMDefaultResizePlugin::OnPaintDecor(), wxIFMDefaultResizePlugin::OnResizeBegin(), wxIFMDefaultResizePlugin::OnResizeEnd(), wxIFMDefaultPanelPlugin::OnSelectTab(), wxIFMDefaultResizePlugin::OnSetCursor(), OnSetCursor(), wxIFMDefaultPlugin::OnSetDesiredSize(), wxIFMDefaultContainerPlugin::OnSetDesiredSize(), wxIFMDefaultPlugin::OnSetRect(), wxIFMDefaultResizePlugin::OnShowChild(), wxIFMDefaultPanelPlugin::OnShowComponent(), wxIFMDefaultDockingPlugin::OnShowDropTargets(), wxIFMDefaultResizePlugin::OnUndock(), wxIFMDefaultPlugin::OnUndock(), wxIFMDefaultPanelPlugin::OnUndock(), wxIFMDefaultContainerPlugin::OnUndock(), wxIFMDefaultPlugin::OnUpdate(), wxIFMDefaultPanelPlugin::OnUpdate(), wxIFMDefaultContainerPlugin::OnUpdate(), wxIFMComponent::Paint(), wxIFMDefaultInterfacePlugin::ProcessPluginEvent(), wxIFMDefaultResizePlugin::ResizeComponent(), wxInterfaceManager::SetChildSize(), wxIFMComponent::SetDesiredSize(), wxIFMComponent::Show(), wxInterfaceManager::ShowChild(), wxInterfaceManager::Update(), wxIFMDefaultResizePlugin::UpdateResizeSashes(), and wxIFMComponent::VisibilityChanged().

bool wxIFMInterfacePluginBase::PushExtensionPlugin (  wxIFMExtensionPluginBase *  plugin  ) 
 

Adds an extension plugin.

wxIFMExtensionPluginBase::Initialize will be called prior to adding the plugin. If that function returns false, the plugin will not be added and false will be returned.

Parameters:
plugin The plugin to add

Definition at line 176 of file plugin.cpp.

References wxIFMExtensionPluginBase::Initialize(), and m_topExtensionPlugin.

Referenced by wxInterfaceManager::AddExtensionPlugin(), and wxIFMDefaultInterfacePlugin::Initialize().

void wxIFMInterfacePluginBase::Shutdown (   )  [virtual]
 

Definition at line 94 of file plugin.cpp.

References PopAllExtensionPlugins().

Member Data Documentation

wxIFMComponentArray wxIFMInterfacePluginBase::m_components [protected]
 

Definition at line 28 of file plugin.h.

Referenced by GetComponentByPos(), GetComponents(), ProcessPluginEvent(), and ~wxIFMInterfacePluginBase().

wxInterfaceManager* wxIFMInterfacePluginBase::m_manager [private]
 

Definition at line 24 of file plugin.h.

Referenced by GetComponentByPos(), GetManager(), Initialize(), OnKeyDown(), OnKeyUp(), OnMouseEvent(), OnPaint(), and OnSize().

wxIFMExtensionPluginBase* wxIFMInterfacePluginBase::m_topExtensionPlugin [private]
 

Definition at line 25 of file plugin.h.

Referenced by Enable(), GetTopPlugin(), PopAllExtensionPlugins(), PopExtensionPlugin(), and PushExtensionPlugin().

wxIFMChildWindowMap wxIFMInterfacePluginBase::m_windows [protected]
 

Definition at line 29 of file plugin.h.

Referenced by AddChildWindow(), and FindChildWindow().

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

 

SourceForge Logo