Altium C++ SDK 3.0
Loading...
Searching...
No Matches
EDP::CAbstractHighlightedDocument Class Referenceabstract

#include <EDP.AbstractClasses.h>

Inheritance diagram for EDP::CAbstractHighlightedDocument:
DXP::CAbstractServerDocument CAbstractSupportService CDispatchObject IServicesSupportInternal CDispatchRecord

Public Member Functions

IHighlightedDocument * GetIHighlightedDocument ()
Public Member Functions inherited from DXP::CAbstractServerDocument
IServerDocument * GetIServerDocument ()
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)
IServicesSupportInternal * GetServicesSupportInternal ()
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 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 HL_Begin ()=0
virtual void HL_End ()=0
virtual void HL_Perform ()=0
virtual void HL_HighlightMethod_Add (THighlightMethod AHighlightMethod)=0
virtual void HL_HighlightMethod_Remove (THighlightMethod AHighlightMethod)=0
virtual void HL_HighlightMethod_Clear (THighlightMethod AHighlightMethod)=0
virtual bool HL_HighlightMethod_IsApplicable (THighlightMethod AHighlightMethod)=0
virtual void HL_Register_DMObject (IDMObject *const AnObject)=0
virtual void HL_Register_NetItem (INetItem *const ANetItem)=0
virtual void HL_Register_Net (INet *const ANet)=0
virtual void HL_Register_Bus (IBus *const ABus)=0
virtual void HL_Register_Part (IPart *const APart)=0
virtual void HL_Register_Component (IComponent *const AComponent)=0
virtual void HL_Register_VHDLEntity (IVHDLEntity *const AVHDLEntity)=0
virtual void HL_Register_Area (DXP::C_Rect const AnArea)=0
virtual void HL_UnRegister_Object (IDMObject *const AnObject)=0
virtual void HL_UnRegister_AllObjects ()=0
virtual int HL_ObjectCount ()=0
virtual IDMObject * HL_Objects (int AnIndex)=0
virtual void HL_SetHighlightedNet (INet *const ANet)=0
virtual INet * HL_GetHighlightedNet ()=0
virtual IDMObject * HL_GetLinkedObject (IDMObject *const ADMObject)=0
virtual bool HL_ChooseObjectGraphically (IDMObject **ADMObject)=0
virtual bool HL_XProbeChooseObject (IDMObject **ADMObject)=0
Protected Member Functions inherited from DXP::CAbstractServerDocument
virtual void AddView (IServerDocumentView *const AView)=0
virtual void SetModified (bool const Value)=0
virtual void SetIsShown (bool const Value)=0
virtual void SetBeingClosed (bool const Value)=0
virtual void Focus ()=0
virtual bool DoFileLoad ()=0
virtual bool DoFileSave (std::wstring const AKind)=0
virtual bool SupportsReload ()=0
virtual bool GetCanClose ()=0
virtual int GetCount ()=0
virtual std::wstring GetFileName ()=0
virtual std::wstring SetFileName (std::wstring const AFileName)=0
virtual std::wstring GetKind ()=0
virtual bool GetModified ()=0
virtual bool GetIsShown ()=0
virtual bool GetBeingClosed ()=0
virtual double GetFileModifiedDate ()=0
virtual void UpdateModifiedDate ()=0
virtual IServerModule * GetServerModule ()=0
virtual IServerDocumentView * GetView (int Index)=0
virtual IServerDocumentView * GetViewByName (std::wstring const ViewName)=0
virtual void NotifyViews (INotification *ANotification)=0
virtual bool GetSupportsOwnSave ()=0
virtual std::wstring GetContextHelpTopicName ()=0
virtual void SetFileModifiedDate (double const AValue)=0
virtual bool WarnIfOwnedByOther (TFileOwnershipWarningLevel AWarningLevel)=0
virtual void AcquireFileOwnership ()=0
virtual void ReleaseFileOwnership ()=0
virtual void ReleaseDataFileHandle ()=0
virtual void AcquireDataFileHandle ()=0
virtual bool OwnsFile ()=0
virtual bool DoSafeFileSave (std::wstring const AKind)=0
virtual bool DoSafeChangeFileNameAndSave (std::wstring const ANewFileName, std::wstring const AKind)=0
virtual bool CreateSnippetFile (IServerDocumentView *const AView, std::wstring ASnippetFilePath, TSnippetCreationMode AMode, bool AContextSensitive)=0
virtual void ZoomSnippetContents ()=0
virtual IServerDocumentView * GetSnippetView ()=0
virtual void PlaceSnippet (std::wstring ASnippetAddress, IServerDocumentView *const AView)=0
virtual bool CanPlaceSnippet (std::wstring const ASnippetPath)=0
virtual bool CanCreateSnippet (IServerDocumentView *const AView, TSnippetCreationMode AMode, bool AContextSensitive)=0
virtual void DocumentDirectoryChanged ()=0
virtual double GetDocumentModifiedDate ()=0

Additional Inherited Members

Protected Attributes inherited from CDispatchRecord
ULONG mRefCount

Member Function Documentation

◆ GetIHighlightedDocument()

IHighlightedDocument * EDP::CAbstractHighlightedDocument::GetIHighlightedDocument ( )
inline

◆ HL_Begin()

virtual void EDP::CAbstractHighlightedDocument::HL_Begin ( )
protectedpure virtual

◆ HL_ChooseObjectGraphically()

virtual bool EDP::CAbstractHighlightedDocument::HL_ChooseObjectGraphically ( IDMObject ** ADMObject)
protectedpure virtual

◆ HL_End()

virtual void EDP::CAbstractHighlightedDocument::HL_End ( )
protectedpure virtual

◆ HL_GetHighlightedNet()

virtual INet * EDP::CAbstractHighlightedDocument::HL_GetHighlightedNet ( )
protectedpure virtual

◆ HL_GetLinkedObject()

virtual IDMObject * EDP::CAbstractHighlightedDocument::HL_GetLinkedObject ( IDMObject *const ADMObject)
protectedpure virtual

◆ HL_HighlightMethod_Add()

virtual void EDP::CAbstractHighlightedDocument::HL_HighlightMethod_Add ( THighlightMethod AHighlightMethod)
protectedpure virtual

◆ HL_HighlightMethod_Clear()

virtual void EDP::CAbstractHighlightedDocument::HL_HighlightMethod_Clear ( THighlightMethod AHighlightMethod)
protectedpure virtual

◆ HL_HighlightMethod_IsApplicable()

virtual bool EDP::CAbstractHighlightedDocument::HL_HighlightMethod_IsApplicable ( THighlightMethod AHighlightMethod)
protectedpure virtual

◆ HL_HighlightMethod_Remove()

virtual void EDP::CAbstractHighlightedDocument::HL_HighlightMethod_Remove ( THighlightMethod AHighlightMethod)
protectedpure virtual

◆ HL_ObjectCount()

virtual int EDP::CAbstractHighlightedDocument::HL_ObjectCount ( )
protectedpure virtual

◆ HL_Objects()

virtual IDMObject * EDP::CAbstractHighlightedDocument::HL_Objects ( int AnIndex)
protectedpure virtual

◆ HL_Perform()

virtual void EDP::CAbstractHighlightedDocument::HL_Perform ( )
protectedpure virtual

◆ HL_Register_Area()

virtual void EDP::CAbstractHighlightedDocument::HL_Register_Area ( DXP::C_Rect const AnArea)
protectedpure virtual

◆ HL_Register_Bus()

virtual void EDP::CAbstractHighlightedDocument::HL_Register_Bus ( IBus *const ABus)
protectedpure virtual

◆ HL_Register_Component()

virtual void EDP::CAbstractHighlightedDocument::HL_Register_Component ( IComponent *const AComponent)
protectedpure virtual

◆ HL_Register_DMObject()

virtual void EDP::CAbstractHighlightedDocument::HL_Register_DMObject ( IDMObject *const AnObject)
protectedpure virtual

◆ HL_Register_Net()

virtual void EDP::CAbstractHighlightedDocument::HL_Register_Net ( INet *const ANet)
protectedpure virtual

◆ HL_Register_NetItem()

virtual void EDP::CAbstractHighlightedDocument::HL_Register_NetItem ( INetItem *const ANetItem)
protectedpure virtual

◆ HL_Register_Part()

virtual void EDP::CAbstractHighlightedDocument::HL_Register_Part ( IPart *const APart)
protectedpure virtual

◆ HL_Register_VHDLEntity()

virtual void EDP::CAbstractHighlightedDocument::HL_Register_VHDLEntity ( IVHDLEntity *const AVHDLEntity)
protectedpure virtual

◆ HL_SetHighlightedNet()

virtual void EDP::CAbstractHighlightedDocument::HL_SetHighlightedNet ( INet *const ANet)
protectedpure virtual

◆ HL_UnRegister_AllObjects()

virtual void EDP::CAbstractHighlightedDocument::HL_UnRegister_AllObjects ( )
protectedpure virtual

◆ HL_UnRegister_Object()

virtual void EDP::CAbstractHighlightedDocument::HL_UnRegister_Object ( IDMObject *const AnObject)
protectedpure virtual

◆ HL_XProbeChooseObject()

virtual bool EDP::CAbstractHighlightedDocument::HL_XProbeChooseObject ( IDMObject ** ADMObject)
protectedpure virtual

◆ Invoke()

virtual HRESULT __stdcall EDP::CAbstractHighlightedDocument::Invoke ( DISPID dispIdMember,
REFIID riid,
LCID lcid,
WORD wFlags,
DISPPARAMS * pDispParams,
VARIANT * pVarResult,
EXCEPINFO * pExcepInfo,
UINT * puArgErr )
protectedvirtual

Reimplemented from DXP::CAbstractServerDocument.

◆ SupportsService()

virtual bool EDP::CAbstractHighlightedDocument::SupportsService ( std::wstring const AServiceName)
protectedvirtual

Reimplemented from DXP::CAbstractServerDocument.

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