CCommandTarget Class Reference
[GUI Utility Classes and Modules]

Search Toolkit Book for CCommandTarget

#include <command.hpp>

Inheritance diagram for CCommandTarget:

[legend]Collaboration diagram for CCommandTarget:

[legend]List of all members.

---

Detailed Description

Class CCommandTarget - the base class for all classes handling commands.

This class provides virtual functions that can be overridden in derived classes. However, in most cases this is not necessary. Derived classes can customize command handling by defining a Command Map.

Definition at line 159 of file command.hpp.

Public Member Functions
	CCommandTarget ()
virtual	~CCommandTarget ()
virtual bool	OnCommand (const TCmdID cmd)
virtual bool	OnUpdateCommand (const TCmdID cmd, ICmdUI *pCmdUI)
Static Public Member Functions
static void	OnFlMenuCommand (Fl_Menu_ *menu, void *user_data)
	Callback to be used by FLTK menu mechanism.
Private Attributes
bool	m_BlockDispatching

---

Constructor & Destructor Documentation

CCommandTarget::CCommandTarget (   )

Definition at line 44 of file command.cpp.

virtual CCommandTarget::~CCommandTarget (   )  [inline, virtual]

Definition at line 164 of file command.hpp.

---

Member Function Documentation

bool CCommandTarget::OnCommand (  const TCmdID  cmd  )  [virtual]

Reimplemented in CWindowManager, CWMCaptionPanel, CWMSplitter, and CWMTabControl. Definition at line 70 of file command.cpp. References CEventHandler::eDispatch_FirstHandler, CEvent::eEvent_Command, m_BlockDispatching, and CEventHandler::Send(). Referenced by CHomePageService::Execute(), CWMTabControl::OnCommand(), CWMSplitter::OnCommand(), CWMCaptionPanel::OnCommand(), CWindowManager::OnCommand(), CMapItem::OnDefaultAction(), OnFlMenuCommand(), CMenu::x_ExecuteCommand(), CFrameWindow::x_HandleAccelerator(), CButton::x_OnClick(), CSeqTextPane::x_SendCommand(), CPhyloTreePane::x_SendCommand(), CHitMatrixPane::x_SendCommand(), and CAlnMultiPane::x_SendCommand().

void CCommandTarget::OnFlMenuCommand (  Fl_Menu_ *  menu, void *  user_data )  [static]

Callback to be used by FLTK menu mechanism. Definition at line 50 of file command.cpp. References ERR_POST, IMenu::GetCmdTarget(), and OnCommand().

bool CCommandTarget::OnUpdateCommand (  const TCmdID  cmd, ICmdUI *  pCmdUI )  [virtual]

Reimplemented in CWMCaptionPanel, CWMSplitter, and CWMTabControl. Definition at line 80 of file command.cpp. References CEventHandler::eDispatch_FirstHandler, CEvent::eEvent_CommandUpdate, CEvent::eRelease, m_BlockDispatching, and CEventHandler::Send(). Referenced by CWindowManager::OnCaptionPanelUpdateCommand(), CWindowManager::OnContainerUpdateCommand(), CGBenchWindowManager::OnContainerUpdateCommand(), CWMTabControl::OnUpdateCommand(), CWMSplitter::OnUpdateCommand(), CWMCaptionPanel::OnUpdateCommand(), and CMenu::x_UpdateItems().

---

Member Data Documentation

bool CCommandTarget::m_BlockDispatching [private]

Definition at line 173 of file command.hpp. Referenced by OnCommand(), and OnUpdateCommand().

---

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

• include/gui/utils/command.hpp
• src/gui/utils/command.cpp

---