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

#include <DXP.Classes.h>

Inheritance diagram for CServerDocument:
DXP::CAbstractServerDocument CAbstractSupportService CDispatchObject IServicesSupportInternal CDispatchRecord

Public Member Functions

 CServerDocument (IServerModule *const AServerModule, const wstring AKind, const wstring AFileName)
virtual ~CServerDocument ()
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 FileLoad ()
virtual bool FileSave (const wstring AKind)
virtual unsigned int GetFileShareMode ()
void ModifiedChanged ()
virtual void AddView (IServerDocumentView *const AView)
virtual void SetModified (bool const Value)
virtual void SetIsShown (bool const Value)
virtual void SetBeingClosed (bool const Value)
virtual void Focus ()
virtual bool DoFileLoad ()
virtual bool DoFileSave (wstring const AKind)
virtual bool SupportsReload ()
virtual bool GetCanClose ()
virtual int GetCount ()
virtual wstring GetFileName ()
virtual wstring SetFileName (wstring const AFileName)
virtual wstring GetKind ()
virtual bool GetModified ()
virtual bool GetIsShown ()
virtual bool GetBeingClosed ()
virtual double GetFileModifiedDate ()
virtual void UpdateModifiedDate ()
virtual IServerModule * GetServerModule ()
virtual IServerDocumentView * GetView (int Index)
virtual IServerDocumentView * GetViewByName (wstring const ViewName)
virtual void NotifyViews (INotification *ANotification)
virtual bool GetSupportsOwnSave ()
virtual wstring GetContextHelpTopicName ()
virtual void SetFileModifiedDate (double const AValue)
virtual bool WarnIfOwnedByOther (TFileOwnershipWarningLevel AWarningLevel)
virtual void AcquireFileOwnership ()
virtual void ReleaseFileOwnership ()
virtual void ReleaseDataFileHandle ()
virtual void AcquireDataFileHandle ()
virtual bool OwnsFile ()
virtual bool DoSafeFileSave (wstring const AKind)
virtual bool DoSafeChangeFileNameAndSave (wstring const ANewFileName, wstring const AKind)
virtual bool CreateSnippetFile (IServerDocumentView *const AView, wstring ASnippetFilePath, TSnippetCreationMode AMode, bool AContextSensitive)
virtual void ZoomSnippetContents ()
virtual IServerDocumentView * GetSnippetView ()
virtual void PlaceSnippet (wstring ASnippetAddress, IServerDocumentView *const AView)
virtual bool CanPlaceSnippet (wstring const ASnippetPath)
virtual bool CanCreateSnippet (IServerDocumentView *const AView, TSnippetCreationMode AMode, bool AContextSensitive)
virtual void DocumentDirectoryChanged ()
virtual double GetDocumentModifiedDate ()
Protected Member Functions inherited from DXP::CAbstractServerDocument
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 bool DoFileSave (std::wstring const AKind)=0
virtual std::wstring SetFileName (std::wstring const AFileName)=0
virtual IServerDocumentView * GetViewByName (std::wstring const ViewName)=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 PlaceSnippet (std::wstring ASnippetAddress, IServerDocumentView *const AView)=0
virtual bool CanPlaceSnippet (std::wstring const ASnippetPath)=0

Protected Attributes

std::vector< IServerDocumentView * > mDocumentViews
Protected Attributes inherited from CDispatchRecord
ULONG mRefCount

Private Member Functions

bool FileHandleIsOwned_Data ()
bool FileHandleIsOwned_Lock ()
bool IsFileInAnyProjectOutputDirectory ()

Private Attributes

wstring mFileName
wstring mKind
bool mModified
IServerModulePtr mServerModule
bool mIsShown
bool mBeingClosed
double mFileModifiedDate
double mDocModifiedDate
HANDLE mFileHandle_Data
HANDLE mFileHandle_Lock
bool mIsOwnedByOther

Constructor & Destructor Documentation

◆ CServerDocument()

CServerDocument::CServerDocument ( IServerModule *const AServerModule,
const wstring AKind,
const wstring AFileName )

◆ ~CServerDocument()

virtual CServerDocument::~CServerDocument ( )
virtual

Member Function Documentation

◆ AcquireDataFileHandle()

virtual void CServerDocument::AcquireDataFileHandle ( )
protectedvirtual

Implements DXP::CAbstractServerDocument.

◆ AcquireFileOwnership()

virtual void CServerDocument::AcquireFileOwnership ( )
protectedvirtual

Implements DXP::CAbstractServerDocument.

◆ AddView()

virtual void CServerDocument::AddView ( IServerDocumentView *const AView)
protectedvirtual

Implements DXP::CAbstractServerDocument.

◆ CanCreateSnippet()

virtual bool CServerDocument::CanCreateSnippet ( IServerDocumentView *const AView,
TSnippetCreationMode AMode,
bool AContextSensitive )
protectedvirtual

Implements DXP::CAbstractServerDocument.

◆ CanPlaceSnippet()

virtual bool CServerDocument::CanPlaceSnippet ( wstring const ASnippetPath)
protectedvirtual

◆ CreateSnippetFile()

virtual bool CServerDocument::CreateSnippetFile ( IServerDocumentView *const AView,
wstring ASnippetFilePath,
TSnippetCreationMode AMode,
bool AContextSensitive )
protectedvirtual

◆ DocumentDirectoryChanged()

virtual void CServerDocument::DocumentDirectoryChanged ( )
protectedvirtual

Implements DXP::CAbstractServerDocument.

◆ DoFileLoad()

virtual bool CServerDocument::DoFileLoad ( )
protectedvirtual

Implements DXP::CAbstractServerDocument.

◆ DoFileSave()

virtual bool CServerDocument::DoFileSave ( wstring const AKind)
protectedvirtual

◆ DoSafeChangeFileNameAndSave()

virtual bool CServerDocument::DoSafeChangeFileNameAndSave ( wstring const ANewFileName,
wstring const AKind )
protectedvirtual

◆ DoSafeFileSave()

virtual bool CServerDocument::DoSafeFileSave ( wstring const AKind)
protectedvirtual

◆ FileHandleIsOwned_Data()

bool CServerDocument::FileHandleIsOwned_Data ( )
private

◆ FileHandleIsOwned_Lock()

bool CServerDocument::FileHandleIsOwned_Lock ( )
private

◆ FileLoad()

virtual bool CServerDocument::FileLoad ( )
protectedvirtual

◆ FileSave()

virtual bool CServerDocument::FileSave ( const wstring AKind)
protectedvirtual

◆ Focus()

virtual void CServerDocument::Focus ( )
protectedvirtual

Implements DXP::CAbstractServerDocument.

◆ GetBeingClosed()

virtual bool CServerDocument::GetBeingClosed ( )
protectedvirtual

Implements DXP::CAbstractServerDocument.

◆ GetCanClose()

virtual bool CServerDocument::GetCanClose ( )
protectedvirtual

Implements DXP::CAbstractServerDocument.

◆ GetContextHelpTopicName()

virtual wstring CServerDocument::GetContextHelpTopicName ( )
protectedvirtual

Implements DXP::CAbstractServerDocument.

◆ GetCount()

virtual int CServerDocument::GetCount ( )
protectedvirtual

Implements DXP::CAbstractServerDocument.

◆ GetDocumentModifiedDate()

virtual double CServerDocument::GetDocumentModifiedDate ( )
protectedvirtual

Implements DXP::CAbstractServerDocument.

◆ GetFileModifiedDate()

virtual double CServerDocument::GetFileModifiedDate ( )
protectedvirtual

Implements DXP::CAbstractServerDocument.

◆ GetFileName()

virtual wstring CServerDocument::GetFileName ( )
protectedvirtual

Implements DXP::CAbstractServerDocument.

◆ GetFileShareMode()

virtual unsigned int CServerDocument::GetFileShareMode ( )
protectedvirtual

◆ GetIsShown()

virtual bool CServerDocument::GetIsShown ( )
protectedvirtual

Implements DXP::CAbstractServerDocument.

◆ GetKind()

virtual wstring CServerDocument::GetKind ( )
protectedvirtual

Implements DXP::CAbstractServerDocument.

◆ GetModified()

virtual bool CServerDocument::GetModified ( )
protectedvirtual

Implements DXP::CAbstractServerDocument.

◆ GetServerModule()

virtual IServerModule * CServerDocument::GetServerModule ( )
protectedvirtual

Implements DXP::CAbstractServerDocument.

◆ GetSnippetView()

virtual IServerDocumentView * CServerDocument::GetSnippetView ( )
protectedvirtual

Implements DXP::CAbstractServerDocument.

◆ GetSupportsOwnSave()

virtual bool CServerDocument::GetSupportsOwnSave ( )
protectedvirtual

Implements DXP::CAbstractServerDocument.

◆ GetView()

virtual IServerDocumentView * CServerDocument::GetView ( int Index)
protectedvirtual

Implements DXP::CAbstractServerDocument.

◆ GetViewByName()

virtual IServerDocumentView * CServerDocument::GetViewByName ( wstring const ViewName)
protectedvirtual

◆ IsFileInAnyProjectOutputDirectory()

bool CServerDocument::IsFileInAnyProjectOutputDirectory ( )
private

◆ ModifiedChanged()

void CServerDocument::ModifiedChanged ( )
protected

◆ NotifyViews()

virtual void CServerDocument::NotifyViews ( INotification * ANotification)
protectedvirtual

Implements DXP::CAbstractServerDocument.

◆ OwnsFile()

virtual bool CServerDocument::OwnsFile ( )
protectedvirtual

Implements DXP::CAbstractServerDocument.

◆ PlaceSnippet()

virtual void CServerDocument::PlaceSnippet ( wstring ASnippetAddress,
IServerDocumentView *const AView )
protectedvirtual

◆ ReleaseDataFileHandle()

virtual void CServerDocument::ReleaseDataFileHandle ( )
protectedvirtual

Implements DXP::CAbstractServerDocument.

◆ ReleaseFileOwnership()

virtual void CServerDocument::ReleaseFileOwnership ( )
protectedvirtual

Implements DXP::CAbstractServerDocument.

◆ SetBeingClosed()

virtual void CServerDocument::SetBeingClosed ( bool const Value)
protectedvirtual

Implements DXP::CAbstractServerDocument.

◆ SetFileModifiedDate()

virtual void CServerDocument::SetFileModifiedDate ( double const AValue)
protectedvirtual

Implements DXP::CAbstractServerDocument.

◆ SetFileName()

virtual wstring CServerDocument::SetFileName ( wstring const AFileName)
protectedvirtual

◆ SetIsShown()

virtual void CServerDocument::SetIsShown ( bool const Value)
protectedvirtual

Implements DXP::CAbstractServerDocument.

◆ SetModified()

virtual void CServerDocument::SetModified ( bool const Value)
protectedvirtual

Implements DXP::CAbstractServerDocument.

◆ SupportsReload()

virtual bool CServerDocument::SupportsReload ( )
protectedvirtual

Implements DXP::CAbstractServerDocument.

◆ UpdateModifiedDate()

virtual void CServerDocument::UpdateModifiedDate ( )
protectedvirtual

Implements DXP::CAbstractServerDocument.

◆ WarnIfOwnedByOther()

virtual bool CServerDocument::WarnIfOwnedByOther ( TFileOwnershipWarningLevel AWarningLevel)
protectedvirtual

Implements DXP::CAbstractServerDocument.

◆ ZoomSnippetContents()

virtual void CServerDocument::ZoomSnippetContents ( )
protectedvirtual

Implements DXP::CAbstractServerDocument.

Member Data Documentation

◆ mBeingClosed

bool CServerDocument::mBeingClosed
private

◆ mDocModifiedDate

double CServerDocument::mDocModifiedDate
private

◆ mDocumentViews

std::vector<IServerDocumentView *> CServerDocument::mDocumentViews
protected

◆ mFileHandle_Data

HANDLE CServerDocument::mFileHandle_Data
private

◆ mFileHandle_Lock

HANDLE CServerDocument::mFileHandle_Lock
private

◆ mFileModifiedDate

double CServerDocument::mFileModifiedDate
private

◆ mFileName

wstring CServerDocument::mFileName
private

◆ mIsOwnedByOther

bool CServerDocument::mIsOwnedByOther
private

◆ mIsShown

bool CServerDocument::mIsShown
private

◆ mKind

wstring CServerDocument::mKind
private

◆ mModified

bool CServerDocument::mModified
private

◆ mServerModule

IServerModulePtr CServerDocument::mServerModule
private
The documentation for this class was generated from the following file: