DXP::IClient Struct Reference

#include <DXP.Interfaces.h>

Inheritance diagram for DXP::IClient:

Public Member Functions
void	BeginDocumentLoad ()
void	BroadcastNotification (INotification *ANotification)
void	CloseDocument (IServerDocument *const ADocument)
void	DispatchNotification (IServerModule *const AServerModule, INotification *const ANotification)
void	EndDocumentLoad (bool AShow)
void	SetCurrentView (IServerDocumentView *const Value)
int	GetApplicationHandle ()
ICommandLauncher *	GetCommandLauncher ()
int	GetCount ()
int	GetServerRecordCount ()
IServerDocumentView *	GetCurrentView ()
IServerDocument *	GetDocumentByPath (std::wstring const AFilePath)
long	GetMainWindowHandle ()
IProcessControl *	GetProcessControl ()
IGUIManager *	GetGUIManager ()
IServerModule *	GetServerModule (int Index)
IServerModule *	GetServerModuleByName (std::wstring const AModuleName)
IServerRecord *	GetServerRecord (int Index)
IServerRecord *	GetServerRecordByName (std::wstring const AModuleName)
IServerWindowKind *	GetWindowKindByName (std::wstring const AWindowKindName)
IServerPanelInfo *	GetPanelInfoByName (std::wstring const APanelName)
int	GetOptionsSetCount ()
IDocumentOptionsSet *	GetOptionsSet (int Index)
IDocumentOptionsSet *	GetOptionsSetByName (std::wstring const AName)
bool	IsQuitting ()
bool	IsDocumentOpen (std::wstring const AFilePath)
IServerDocument *	OpenDocument (std::wstring const AKind, std::wstring const AFileName)
bool	StartServer (std::wstring const AModuleName)
bool	StopServer (std::wstring const AModuleName, bool UnloadDLL)
std::wstring	GetDocumentKindFromDocumentPath (std::wstring const Path)
std::wstring	GetDefaultExtensionForDocumentKind (std::wstring const DocumentKind)
bool	LicenseInfoStillValid (long const RetrievedAt)
void	AddServerView (IServerView *const AView)
IServerView *	GetServerViewFromName (std::wstring const ViewName)
void	ShowDocument (IServerDocument *const ADocument)
void	ShowDocumentDontFocus (IServerDocument *const ADocument)
void	HideDocument (IServerDocument *const ADocument)
IServerDocument *	LastActiveDocumentOfType (std::wstring const AType)
void	BeginDisableInterface ()
void	EndDisableInterface ()
void	BeginRecoverySave ()
void	EndRecoverySave ()
bool	InRecoverySave ()
std::wstring	GetServerNameByPLID (std::wstring const APLID)
void	QuerySystemFont (TFontQueryMode QueryMode, bool *AUseSysFont, std::wstring *AFontName, int *AFontSize, TFontStylesSet &AFontStyle, TColor *AFontColor, TFontCharset *AFontCharset)
INavigationSystem *	GetNavigationSystem ()
void	RegisterNotificationHandler (INotificationHandler *const Handler)
void	UnregisterNotificationHandler (INotificationHandler *const Handler)
void	ApplicationIdle ()
long	GetRealMainWindowHandle ()
ITimerManager *	GetTimerManager ()
void	RemoveServerView (IServerView *const AView)
IOptionsManager *	GetOptionsManager ()
bool	IsInitialized ()
ILicenseManager *	GetLicenseManager ()
std::wstring	GetDocumentKindFromDocumentFileName (std::wstring const Path, bool CheckForTextFiles)
void	HandleException (std::wstring const AMessage)
IServerDocument *	OpenNewDocument (std::wstring const AKind, std::wstring const AFileName, std::wstring const ANewName, bool ReuseExisting)
IServerDocument *	OpenDocumentShowOrHide (std::wstring const AKind, std::wstring const AFileName, bool AShowInTree)
bool	AddViewToFavorites (IServerDocumentView *const AView, bool AIsSnippet)
IDynamicHelpManager *	GetDynamicHelpManager ()
bool	GetState_AccessFeaturesInDevelopment ()
IDXPAltiumPortal *	GetDXPAltiumPortal ()
IDocumentPreviewManager *	GetDocumentPreviewManager ()
IDocumentPreviewHint *	GetDocumentPreviewHint ()
std::wstring	GetVersion ()
std::wstring	GetProductVersion ()
std::wstring	GetProductName ()
void	DisplayDocsTogetherForCompare ()
void	DisplaySplashScreen (std::wstring AImagePath, int AFadeInMillis, int ADisplayMillis, int AFadeOutMillis, int AAlphaStep)
std::wstring	GetDocumentKindFromDocumentPathEx (std::wstring const Path, std::wstring *DocSubKind)
bool	IsDocumentOfKind (std::wstring const Path, std::wstring const DocKind)
ISaveLoadLayout *	GetLayoutSaveLoadManager ()
std::wstring	SaveCustomizationsForExport ()
void	LoadCustomizationsFromFile (std::wstring ARCSFileName)
void	LoadCustomizationsFromPath (std::wstring ARCSFilePath)
void	BroadcastNotificationAsynchronously (INotification *ANotification)
std::wstring	GetDocumentCaptionFromDocumentKind (std::wstring const ADocumentKind)
std::wstring	GetDocumentCaptionFromDocumentPath (std::wstring const APath)
ISearchManager *	GetSearchManager ()
IServerRecord *	GetServerRecordByFeature (std::wstring const AFeature)
IDXPWorkSpace *	GetDXPWorkspace ()
ISceneManager *	GetSceneManager ()
IDXPSplash *	GetDXPSplash ()
IClientAPI_Interface *	GetClientAPI ()
ISecurityManager *	GetSecurityManager ()
ISecurityServerManager *	GetSecurityServerManager ()
void	ReleaseGlobalPreferencesToVault (std::wstring const VaultGUID, std::wstring const ItemGUID)
std::wstring	GetGlobalPreferencesVaultGUID ()
std::wstring	GetGlobalPreferencesRevisionGUID ()
IPluginsRegistry *	GetPluginsRegistry ()
std::wstring	GetTechnologySets (long *ValidAtTimestamp)
bool	ArePreferencesReadOnly (std::wstring const AServerName, std::wstring const AFormName)
bool	GetPreferencesChanged ()
void	SetPreferencesChanged (bool Value)
void	LoadGlobalPreferencesFromVault (std::wstring const VaultGuid, std::wstring const ItemRevisionGUID)
double	GetTechnologySubscriptionExpirationDate (std::wstring const ATechnologySet)
bool	GetDXPUrlCommandData (std::wstring const Url, std::wstring *Command, std::wstring *Params)
IProductInfo *	ProductInfo ()

Member Function Documentation

AddServerView()

void DXP::IClient::AddServerView

(

IServerView *const

AView

)

AddViewToFavorites()

bool DXP::IClient::AddViewToFavorites	(	IServerDocumentView *const	AView,
		bool	AIsSnippet )

ApplicationIdle()

void DXP::IClient::ApplicationIdle

(

)

ArePreferencesReadOnly()

bool DXP::IClient::ArePreferencesReadOnly	(	std::wstring const	AServerName,
		std::wstring const	AFormName )

BeginDisableInterface()

void DXP::IClient::BeginDisableInterface

(

)

BeginDocumentLoad()

void DXP::IClient::BeginDocumentLoad

(

)

BeginRecoverySave()

void DXP::IClient::BeginRecoverySave

(

)

BroadcastNotification()

void DXP::IClient::BroadcastNotification

(

INotification *

ANotification

)

BroadcastNotificationAsynchronously()

void DXP::IClient::BroadcastNotificationAsynchronously

(

INotification *

ANotification

)

CloseDocument()

void DXP::IClient::CloseDocument

(

IServerDocument *const

ADocument

)

DispatchNotification()

void DXP::IClient::DispatchNotification	(	IServerModule *const	AServerModule,
		INotification *const	ANotification )

DisplayDocsTogetherForCompare()

void DXP::IClient::DisplayDocsTogetherForCompare

(

)

DisplaySplashScreen()

void DXP::IClient::DisplaySplashScreen	(	std::wstring	AImagePath,
		int	AFadeInMillis,
		int	ADisplayMillis,
		int	AFadeOutMillis,
		int	AAlphaStep )

EndDisableInterface()

void DXP::IClient::EndDisableInterface

(

)

EndDocumentLoad()

void DXP::IClient::EndDocumentLoad

(

bool

AShow

)

EndRecoverySave()

void DXP::IClient::EndRecoverySave

(

)

GetApplicationHandle()

int DXP::IClient::GetApplicationHandle

(

)

GetClientAPI()

IClientAPI_Interface * DXP::IClient::GetClientAPI

(

)

GetCommandLauncher()

ICommandLauncher * DXP::IClient::GetCommandLauncher

(

)

GetCount()

int DXP::IClient::GetCount

(

)

GetCurrentView()

IServerDocumentView * DXP::IClient::GetCurrentView

(

)

GetDefaultExtensionForDocumentKind()

std::wstring DXP::IClient::GetDefaultExtensionForDocumentKind

(

std::wstring const

DocumentKind

)

GetDocumentByPath()

IServerDocument * DXP::IClient::GetDocumentByPath

(

std::wstring const

AFilePath

)

GetDocumentCaptionFromDocumentKind()

std::wstring DXP::IClient::GetDocumentCaptionFromDocumentKind

(

std::wstring const

ADocumentKind

)

GetDocumentCaptionFromDocumentPath()

std::wstring DXP::IClient::GetDocumentCaptionFromDocumentPath

(

std::wstring const

APath

)

GetDocumentKindFromDocumentFileName()

std::wstring DXP::IClient::GetDocumentKindFromDocumentFileName	(	std::wstring const	Path,
		bool	CheckForTextFiles )

GetDocumentKindFromDocumentPath()

std::wstring DXP::IClient::GetDocumentKindFromDocumentPath

(

std::wstring const

Path

)

GetDocumentKindFromDocumentPathEx()

std::wstring DXP::IClient::GetDocumentKindFromDocumentPathEx	(	std::wstring const	Path,
		std::wstring *	DocSubKind )

GetDocumentPreviewHint()

IDocumentPreviewHint * DXP::IClient::GetDocumentPreviewHint

(

)

GetDocumentPreviewManager()

IDocumentPreviewManager * DXP::IClient::GetDocumentPreviewManager

(

)

GetDXPAltiumPortal()

IDXPAltiumPortal * DXP::IClient::GetDXPAltiumPortal

(

)

GetDXPSplash()

IDXPSplash * DXP::IClient::GetDXPSplash

(

)

GetDXPUrlCommandData()

bool DXP::IClient::GetDXPUrlCommandData	(	std::wstring const	Url,
		std::wstring *	Command,
		std::wstring *	Params )

GetDXPWorkspace()

IDXPWorkSpace * DXP::IClient::GetDXPWorkspace

(

)

GetDynamicHelpManager()

IDynamicHelpManager * DXP::IClient::GetDynamicHelpManager

(

)

GetGlobalPreferencesRevisionGUID()

std::wstring DXP::IClient::GetGlobalPreferencesRevisionGUID

(

)

GetGlobalPreferencesVaultGUID()

std::wstring DXP::IClient::GetGlobalPreferencesVaultGUID

(

)

GetGUIManager()

IGUIManager * DXP::IClient::GetGUIManager

(

)

GetLayoutSaveLoadManager()

ISaveLoadLayout * DXP::IClient::GetLayoutSaveLoadManager

(

)

GetLicenseManager()

ILicenseManager * DXP::IClient::GetLicenseManager

(

)

GetMainWindowHandle()

long DXP::IClient::GetMainWindowHandle

(

)

GetNavigationSystem()

INavigationSystem * DXP::IClient::GetNavigationSystem

(

)

GetOptionsManager()

IOptionsManager * DXP::IClient::GetOptionsManager

(

)

GetOptionsSet()

IDocumentOptionsSet * DXP::IClient::GetOptionsSet

(

int

Index

)

GetOptionsSetByName()

IDocumentOptionsSet * DXP::IClient::GetOptionsSetByName

(

std::wstring const

AName

)

GetOptionsSetCount()

int DXP::IClient::GetOptionsSetCount

(

)

GetPanelInfoByName()

IServerPanelInfo * DXP::IClient::GetPanelInfoByName

(

std::wstring const

APanelName

)

GetPluginsRegistry()

IPluginsRegistry * DXP::IClient::GetPluginsRegistry

(

)

GetPreferencesChanged()

bool DXP::IClient::GetPreferencesChanged

(

)

GetProcessControl()

IProcessControl * DXP::IClient::GetProcessControl

(

)

GetProductName()

std::wstring DXP::IClient::GetProductName

(

)

GetProductVersion()

std::wstring DXP::IClient::GetProductVersion

(

)

GetRealMainWindowHandle()

long DXP::IClient::GetRealMainWindowHandle

(

)

GetSceneManager()

ISceneManager * DXP::IClient::GetSceneManager

(

)

GetSearchManager()

ISearchManager * DXP::IClient::GetSearchManager

(

)

GetSecurityManager()

ISecurityManager * DXP::IClient::GetSecurityManager

(

)

GetSecurityServerManager()

ISecurityServerManager * DXP::IClient::GetSecurityServerManager

(

)

GetServerModule()

IServerModule * DXP::IClient::GetServerModule

(

int

Index

)

GetServerModuleByName()

IServerModule * DXP::IClient::GetServerModuleByName

(

std::wstring const

AModuleName

)

GetServerNameByPLID()

std::wstring DXP::IClient::GetServerNameByPLID

(

std::wstring const

APLID

)

GetServerRecord()

IServerRecord * DXP::IClient::GetServerRecord

(

int

Index

)

GetServerRecordByFeature()

IServerRecord * DXP::IClient::GetServerRecordByFeature

(

std::wstring const

AFeature

)

GetServerRecordByName()

IServerRecord * DXP::IClient::GetServerRecordByName

(

std::wstring const

AModuleName

)

GetServerRecordCount()

int DXP::IClient::GetServerRecordCount

(

)

GetServerViewFromName()

IServerView * DXP::IClient::GetServerViewFromName

(

std::wstring const

ViewName

)

GetState_AccessFeaturesInDevelopment()

bool DXP::IClient::GetState_AccessFeaturesInDevelopment

(

)

GetTechnologySets()

std::wstring DXP::IClient::GetTechnologySets

(

long *

ValidAtTimestamp

)

GetTechnologySubscriptionExpirationDate()

double DXP::IClient::GetTechnologySubscriptionExpirationDate

(

std::wstring const

ATechnologySet

)

GetTimerManager()

ITimerManager * DXP::IClient::GetTimerManager

(

)

GetVersion()

std::wstring DXP::IClient::GetVersion

(

)

GetWindowKindByName()

IServerWindowKind * DXP::IClient::GetWindowKindByName

(

std::wstring const

AWindowKindName

)

HandleException()

void DXP::IClient::HandleException

(

std::wstring const

AMessage

)

HideDocument()

void DXP::IClient::HideDocument

(

IServerDocument *const

ADocument

)

InRecoverySave()

bool DXP::IClient::InRecoverySave

(

)

IsDocumentOfKind()

bool DXP::IClient::IsDocumentOfKind	(	std::wstring const	Path,
		std::wstring const	DocKind )

IsDocumentOpen()

bool DXP::IClient::IsDocumentOpen

(

std::wstring const

AFilePath

)

IsInitialized()

bool DXP::IClient::IsInitialized

(

)

IsQuitting()

bool DXP::IClient::IsQuitting

(

)

LastActiveDocumentOfType()

IServerDocument * DXP::IClient::LastActiveDocumentOfType

(

std::wstring const

AType

)

LicenseInfoStillValid()

bool DXP::IClient::LicenseInfoStillValid

(

long const

RetrievedAt

)

LoadCustomizationsFromFile()

void DXP::IClient::LoadCustomizationsFromFile

(

std::wstring

ARCSFileName

)

LoadCustomizationsFromPath()

void DXP::IClient::LoadCustomizationsFromPath

(

std::wstring

ARCSFilePath

)

LoadGlobalPreferencesFromVault()

void DXP::IClient::LoadGlobalPreferencesFromVault	(	std::wstring const	VaultGuid,
		std::wstring const	ItemRevisionGUID )

OpenDocument()

IServerDocument * DXP::IClient::OpenDocument	(	std::wstring const	AKind,
		std::wstring const	AFileName )

OpenDocumentShowOrHide()

IServerDocument * DXP::IClient::OpenDocumentShowOrHide	(	std::wstring const	AKind,
		std::wstring const	AFileName,
		bool	AShowInTree )

OpenNewDocument()

IServerDocument * DXP::IClient::OpenNewDocument	(	std::wstring const	AKind,
		std::wstring const	AFileName,
		std::wstring const	ANewName,
		bool	ReuseExisting )

ProductInfo()

IProductInfo * DXP::IClient::ProductInfo

(

)

QuerySystemFont()

void DXP::IClient::QuerySystemFont	(	TFontQueryMode	QueryMode,
		bool *	AUseSysFont,
		std::wstring *	AFontName,
		int *	AFontSize,
		TFontStylesSet &	AFontStyle,
		TColor *	AFontColor,
		TFontCharset *	AFontCharset )

RegisterNotificationHandler()

void DXP::IClient::RegisterNotificationHandler

(

INotificationHandler *const

Handler

)

ReleaseGlobalPreferencesToVault()

void DXP::IClient::ReleaseGlobalPreferencesToVault	(	std::wstring const	VaultGUID,
		std::wstring const	ItemGUID )

RemoveServerView()

void DXP::IClient::RemoveServerView

(

IServerView *const

AView

)

SaveCustomizationsForExport()

std::wstring DXP::IClient::SaveCustomizationsForExport

(

)

SetCurrentView()

void DXP::IClient::SetCurrentView

(

IServerDocumentView *const

Value

)

SetPreferencesChanged()

void DXP::IClient::SetPreferencesChanged

(

bool

Value

)

ShowDocument()

void DXP::IClient::ShowDocument

(

IServerDocument *const

ADocument

)

ShowDocumentDontFocus()

void DXP::IClient::ShowDocumentDontFocus

(

IServerDocument *const

ADocument

)

StartServer()

bool DXP::IClient::StartServer

(

std::wstring const

AModuleName

)

StopServer()

bool DXP::IClient::StopServer	(	std::wstring const	AModuleName,
		bool	UnloadDLL )

UnregisterNotificationHandler()

void DXP::IClient::UnregisterNotificationHandler

(

INotificationHandler *const

Handler

)

---

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

• DXP.Interfaces.h