Altium C++ SDK 3.0
Loading...
Searching...
No Matches
CCommandLauncher Class Reference

#include <DXP.Classes.h>

Inheritance diagram for CCommandLauncher:
DXP::CAbstractCommandLauncher CAbstractSupportService CDispatchObject IServicesSupportInternal CDispatchRecord

Classes

struct  CommandHandler

Public Member Functions

 CCommandLauncher (const wstring ModuleName)
virtual ~CCommandLauncher ()
void RegisterCommand (const wstring ACommandId, pCommandProc ACommandProc, pGetStateProc AGetStateProc=NULL)
Public Member Functions inherited from DXP::CAbstractCommandLauncher
ICommandLauncherGetICommandLauncher ()
Public Member Functions inherited from CAbstractSupportService
virtual HRESULT __stdcall QueryInterface (const IID &riid, void **ppvObject)
virtual ULONG __stdcall AddRef (void)
virtual ULONG __stdcall Release (void)
IServicesSupportInternalGetServicesSupportInternal ()
Public Member Functions inherited from CDispatchObject
 CDispatchObject ()
virtual ~CDispatchObject ()
IDispatch * GetIDispatch ()
Public Member Functions inherited from CDispatchRecord
 CDispatchRecord ()
virtual HRESULT __stdcall GetTypeInfoCount (UINT *pctinfo)
virtual HRESULT __stdcall GetTypeInfo (UINT iTInfo, LCID lcid, ITypeInfo **ppTInfo)
virtual HRESULT __stdcall GetIDsOfNames (REFIID riid, LPOLESTR *rgszNames, UINT cNames, LCID lcid, DISPID *rgDispId)

Protected Member Functions

virtual void LaunchCommand (wstring const ACommandName, wstring *AParameters, IServerDocumentView *const AContext)
virtual void GetCommandState (wstring const ACommandName, wstring *AParameters, IServerDocumentView *const AContext, bool *Enabled, bool *Checked, bool *Visible, wstring *Caption, wstring *ImageFile)
Protected Member Functions inherited from DXP::CAbstractCommandLauncher
virtual bool SupportsService (std::wstring const AServiceName)
virtual HRESULT __stdcall Invoke (DISPID dispIdMember, REFIID riid, LCID lcid, WORD wFlags, DISPPARAMS *pDispParams, VARIANT *pVarResult, EXCEPINFO *pExcepInfo, UINT *puArgErr)
virtual void LaunchCommand (std::wstring const ACommandName, std::wstring *AParameters, IServerDocumentView *const AContext)=0
virtual void GetCommandState (std::wstring const ACommandName, std::wstring *AParameters, IServerDocumentView *const AContext, bool *Enabled, bool *Checked, bool *Visible, std::wstring *Caption, std::wstring *ImageFile)=0

Private Types

typedef std::map< wstring, CommandHandler, CInsensitiveCompareCommandHandlers

Private Member Functions

pCommandProc GetCommandProc (const wstring ACommandName)
pGetStateProc GetGetStateProc (const wstring ACommandName)

Private Attributes

CommandHandlers mCommandHandlers
wstring mModuleName

Additional Inherited Members

Protected Attributes inherited from CDispatchRecord
ULONG mRefCount

Member Typedef Documentation

◆ CommandHandlers

Constructor & Destructor Documentation

◆ CCommandLauncher()

CCommandLauncher::CCommandLauncher ( const wstring ModuleName)
inline

◆ ~CCommandLauncher()

virtual CCommandLauncher::~CCommandLauncher ( )
inlinevirtual

Member Function Documentation

◆ GetCommandProc()

pCommandProc CCommandLauncher::GetCommandProc ( const wstring ACommandName)
private

◆ GetCommandState()

virtual void CCommandLauncher::GetCommandState ( wstring const ACommandName,
wstring * AParameters,
IServerDocumentView *const AContext,
bool * Enabled,
bool * Checked,
bool * Visible,
wstring * Caption,
wstring * ImageFile )
protectedvirtual

◆ GetGetStateProc()

pGetStateProc CCommandLauncher::GetGetStateProc ( const wstring ACommandName)
private

◆ LaunchCommand()

virtual void CCommandLauncher::LaunchCommand ( wstring const ACommandName,
wstring * AParameters,
IServerDocumentView *const AContext )
protectedvirtual

◆ RegisterCommand()

void CCommandLauncher::RegisterCommand ( const wstring ACommandId,
pCommandProc ACommandProc,
pGetStateProc AGetStateProc = NULL )

Member Data Documentation

◆ mCommandHandlers

CommandHandlers CCommandLauncher::mCommandHandlers
private

◆ mModuleName

wstring CCommandLauncher::mModuleName
private

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