Altium C++ SDK 3.0
Loading...
Searching...
No Matches
EDP::IWorkspace Struct Reference

#include <EDP.Interfaces.h>

Inheritance diagram for EDP::IWorkspace:
EDP::IDMObject

Public Member Functions

std::wstring DM_WorkspaceFullPath ()
std::wstring DM_WorkspaceFileName ()
IProjectDM_Projects (int Index)
IDocumentDM_InstalledLibraries (int Index)
int DM_ProjectCount ()
int DM_InstalledLibraryCount ()
IProjectDM_FocusedProject ()
IDocumentDM_FocusedDocument ()
std::wstring DM_GenerateUniqueID ()
void DM_ShowMessageView ()
void DM_ShowToDoList ()
int DM_ImageIndexForDocumentKind (std::wstring ADocumentKind)
IDocumentDM_GetDocumentFromPath (std::wstring DocumentPath)
IProjectDM_GetProjectFromPath (std::wstring ProjectPath)
std::wstring DM_ViolationTypeDescription (TErrorKind ErrorKind)
TErrorGroup DM_ViolationTypeGroup (TErrorKind ErrorKind)
IProjectDM_OpenProject (std::wstring ProjectPath, bool const Show)
void DM_CloseProject (std::wstring ProjectPath)
void DM_ShowProject (std::wstring ProjectPath)
void DM_HideProject (std::wstring ProjectPath)
IProjectDM_FreeDocumentsProject ()
std::wstring DM_CreateNewDocument (std::wstring ADocKind)
void DM_AddDocumentToActiveProject (std::wstring DocumentPath)
void DM_AddOutputLine (std::wstring const MessageLine, bool ReplaceLastLine, bool UpdateLastLine)
std::wstring DM_GetOutputLine (int Index)
int DM_GetOutputLineCount ()
void DM_ClearOutputLines ()
DXP::IOptionsStorageDM_OptionsStorage ()
void DM_SetRecoveryParameters (bool IsEnabled, int Interval)
bool DM_GetRecoveryIsEnabled ()
int DM_GetRecoveryInterval ()
IChangeManagerDM_ChangeManager ()
bool DM_PromptForDefaultPcbType (std::wstring *PcbType)
std::wstring DM_GetDefaultPcbType ()
int DM_NavigationZoomPrecision ()
DXP::ILocalHistoryManagerDM_LocalHistoryManager ()
void DM_SetRightClickCompStructure (std::wstring const AProjectPath, std::wstring const ALibReference, std::wstring const AUniqueId)
IWorkspacePreferencesDM_Preferences ()
void DM_FileOwnership_BulkWarnStart ()
void DM_FileOwnership_BulkWarnEnd (DXP::TFileOwnershipWarningLevel AWarningLevel)
bool DM_FileOwnership_BulkWarnRegister (std::wstring AFileName)
IProjectDM_LoadProjectHidden (std::wstring const ProjectPath)
bool DM_RunOpenDocumentDialog (std::wstring const Caption, bool AllowMultiSelect, std::wstring *Path, TFilterKind FilterKind, int FilterIndex, DXP::IStrings **DocumentPaths)
void DM_SetNavigationZoomPrecision (int ZoomPrecision)
IHarnessDefinitionListDM_CreateHarnessDefinitionList_DeviceSheets (std::wstring AFolderPath, bool ARecursive)
void DM_DestroyHarnessDefinitionList (IHarnessDefinitionList *AHarnessDefinitionList)
bool DM_IsReferencedAsDeviceSheet (std::wstring const AFilePath)
int DM_GetOutputCharCount ()
IReleaseViewDocumentDM_PCBReleaseViewDocument ()
IWSM_OutputJobDocumentDM_GetOutputJobDocumentByPath (std::wstring APath)
IReleaseManagerDM_GetReleaseManager ()
IVaultConfigurationReleaseManagerDM_GetVaultReleaseManager (IProject *AProject, IVaultConfiguration *AConfiguration)
std::wstring DM_GetDifferenceTypeDescription (TDifferenceKind DifferenceKind)
DXP::IDXPMessagesManagerDM_MessagesManager ()
void DM_NotifyObjectNavigated (int ACode, IDMObject *const ADMObject, TNavigationActionSet const ANavigationActionSet)
void DM_NotifyObjectsNavigated (int ACode, IDMObject *const ASourceDMObject, TNavigationActionSet const ANavigationActionSet, DXP::IInterfaceList *const ADMObjects)
void DM_Navigation_OpenHostDocuments (IProject *const AProject, DXP::IInterfaceList *const AObjectsList, TDocumentOpenMode ADocumentOpenMode)
void DM_DisplayNavigationHint (long AViewHandle, int X, int Y, IDMObject *const ADMObject, long AViewNavigatedHandle)
Public Member Functions inherited from EDP::IDMObject
IParameterDM_Parameters (int Index)
int DM_ParameterCount ()
bool DM_IsInferredObject ()
int DM_LocationX ()
int DM_LocationY ()
int DM_GeneralField ()
std::wstring DM_LocationString ()
std::wstring DM_LongDescriptorString ()
std::wstring DM_ShortDescriptorString ()
std::wstring DM_ObjectKindString ()
std::wstring DM_ObjectKindStringForCrossProbe ()
std::wstring DM_PrimaryCrossProbeString ()
std::wstring DM_SecondaryCrossProbeString ()
std::wstring DM_FullCrossProbeString ()
int DM_ImageIndex ()
IDocumentDM_OwnerDocument ()
std::wstring DM_OwnerDocumentName ()
std::wstring DM_OwnerDocumentFullPath ()
int DM_CurrentSheetInstanceNumber ()
bool DM_ValidForNavigation ()
int DM_NetIndex_Flat ()
int DM_NetIndex_Sheet ()
int DM_NetIndex_SubNet ()
int DM_SheetIndex_Logical ()
int DM_SheetIndex_Physical ()
IVHDLEntityDM_VHDLEntity ()
IDispatch * DM_GetVCSProject ()
void DM_SetVCSProject (IDispatch *const Value)
bool DM_IsFormulaString (std::wstring AFormula)
std::wstring DM_CalculateParameterValue (IParameter *AParameter)
int DM_PCBObjectHandle ()
int DM_SCHObjectHandle ()
IDispatch * DM_PCBObjectInterface ()
IDispatch * DM_SCHObjectInterface ()
std::wstring DM_PcbHandle ()
std::wstring DM_SchHandle ()

Member Function Documentation

◆ DM_AddDocumentToActiveProject()

void EDP::IWorkspace::DM_AddDocumentToActiveProject ( std::wstring DocumentPath)

◆ DM_AddOutputLine()

void EDP::IWorkspace::DM_AddOutputLine ( std::wstring const MessageLine,
bool ReplaceLastLine,
bool UpdateLastLine )

◆ DM_ChangeManager()

IChangeManager * EDP::IWorkspace::DM_ChangeManager ( )

◆ DM_ClearOutputLines()

void EDP::IWorkspace::DM_ClearOutputLines ( )

◆ DM_CloseProject()

void EDP::IWorkspace::DM_CloseProject ( std::wstring ProjectPath)

◆ DM_CreateHarnessDefinitionList_DeviceSheets()

IHarnessDefinitionList * EDP::IWorkspace::DM_CreateHarnessDefinitionList_DeviceSheets ( std::wstring AFolderPath,
bool ARecursive )

◆ DM_CreateNewDocument()

std::wstring EDP::IWorkspace::DM_CreateNewDocument ( std::wstring ADocKind)

◆ DM_DestroyHarnessDefinitionList()

void EDP::IWorkspace::DM_DestroyHarnessDefinitionList ( IHarnessDefinitionList * AHarnessDefinitionList)

◆ DM_DisplayNavigationHint()

void EDP::IWorkspace::DM_DisplayNavigationHint ( long AViewHandle,
int X,
int Y,
IDMObject *const ADMObject,
long AViewNavigatedHandle )

◆ DM_FileOwnership_BulkWarnEnd()

void EDP::IWorkspace::DM_FileOwnership_BulkWarnEnd ( DXP::TFileOwnershipWarningLevel AWarningLevel)

◆ DM_FileOwnership_BulkWarnRegister()

bool EDP::IWorkspace::DM_FileOwnership_BulkWarnRegister ( std::wstring AFileName)

◆ DM_FileOwnership_BulkWarnStart()

void EDP::IWorkspace::DM_FileOwnership_BulkWarnStart ( )

◆ DM_FocusedDocument()

IDocument * EDP::IWorkspace::DM_FocusedDocument ( )

◆ DM_FocusedProject()

IProject * EDP::IWorkspace::DM_FocusedProject ( )

◆ DM_FreeDocumentsProject()

IProject * EDP::IWorkspace::DM_FreeDocumentsProject ( )

◆ DM_GenerateUniqueID()

std::wstring EDP::IWorkspace::DM_GenerateUniqueID ( )

◆ DM_GetDefaultPcbType()

std::wstring EDP::IWorkspace::DM_GetDefaultPcbType ( )

◆ DM_GetDifferenceTypeDescription()

std::wstring EDP::IWorkspace::DM_GetDifferenceTypeDescription ( TDifferenceKind DifferenceKind)

◆ DM_GetDocumentFromPath()

IDocument * EDP::IWorkspace::DM_GetDocumentFromPath ( std::wstring DocumentPath)

◆ DM_GetOutputCharCount()

int EDP::IWorkspace::DM_GetOutputCharCount ( )

◆ DM_GetOutputJobDocumentByPath()

IWSM_OutputJobDocument * EDP::IWorkspace::DM_GetOutputJobDocumentByPath ( std::wstring APath)

◆ DM_GetOutputLine()

std::wstring EDP::IWorkspace::DM_GetOutputLine ( int Index)

◆ DM_GetOutputLineCount()

int EDP::IWorkspace::DM_GetOutputLineCount ( )

◆ DM_GetProjectFromPath()

IProject * EDP::IWorkspace::DM_GetProjectFromPath ( std::wstring ProjectPath)

◆ DM_GetRecoveryInterval()

int EDP::IWorkspace::DM_GetRecoveryInterval ( )

◆ DM_GetRecoveryIsEnabled()

bool EDP::IWorkspace::DM_GetRecoveryIsEnabled ( )

◆ DM_GetReleaseManager()

IReleaseManager * EDP::IWorkspace::DM_GetReleaseManager ( )

◆ DM_GetVaultReleaseManager()

IVaultConfigurationReleaseManager * EDP::IWorkspace::DM_GetVaultReleaseManager ( IProject * AProject,
IVaultConfiguration * AConfiguration )

◆ DM_HideProject()

void EDP::IWorkspace::DM_HideProject ( std::wstring ProjectPath)

◆ DM_ImageIndexForDocumentKind()

int EDP::IWorkspace::DM_ImageIndexForDocumentKind ( std::wstring ADocumentKind)

◆ DM_InstalledLibraries()

IDocument * EDP::IWorkspace::DM_InstalledLibraries ( int Index)

◆ DM_InstalledLibraryCount()

int EDP::IWorkspace::DM_InstalledLibraryCount ( )

◆ DM_IsReferencedAsDeviceSheet()

bool EDP::IWorkspace::DM_IsReferencedAsDeviceSheet ( std::wstring const AFilePath)

◆ DM_LoadProjectHidden()

IProject * EDP::IWorkspace::DM_LoadProjectHidden ( std::wstring const ProjectPath)

◆ DM_LocalHistoryManager()

DXP::ILocalHistoryManager * EDP::IWorkspace::DM_LocalHistoryManager ( )

◆ DM_MessagesManager()

DXP::IDXPMessagesManager * EDP::IWorkspace::DM_MessagesManager ( )

◆ DM_Navigation_OpenHostDocuments()

void EDP::IWorkspace::DM_Navigation_OpenHostDocuments ( IProject *const AProject,
DXP::IInterfaceList *const AObjectsList,
TDocumentOpenMode ADocumentOpenMode )

◆ DM_NavigationZoomPrecision()

int EDP::IWorkspace::DM_NavigationZoomPrecision ( )

◆ DM_NotifyObjectNavigated()

void EDP::IWorkspace::DM_NotifyObjectNavigated ( int ACode,
IDMObject *const ADMObject,
TNavigationActionSet const ANavigationActionSet )

◆ DM_NotifyObjectsNavigated()

void EDP::IWorkspace::DM_NotifyObjectsNavigated ( int ACode,
IDMObject *const ASourceDMObject,
TNavigationActionSet const ANavigationActionSet,
DXP::IInterfaceList *const ADMObjects )

◆ DM_OpenProject()

IProject * EDP::IWorkspace::DM_OpenProject ( std::wstring ProjectPath,
bool const Show )

◆ DM_OptionsStorage()

DXP::IOptionsStorage * EDP::IWorkspace::DM_OptionsStorage ( )

◆ DM_PCBReleaseViewDocument()

IReleaseViewDocument * EDP::IWorkspace::DM_PCBReleaseViewDocument ( )

◆ DM_Preferences()

IWorkspacePreferences * EDP::IWorkspace::DM_Preferences ( )

◆ DM_ProjectCount()

int EDP::IWorkspace::DM_ProjectCount ( )

◆ DM_Projects()

IProject * EDP::IWorkspace::DM_Projects ( int Index)

◆ DM_PromptForDefaultPcbType()

bool EDP::IWorkspace::DM_PromptForDefaultPcbType ( std::wstring * PcbType)

◆ DM_RunOpenDocumentDialog()

bool EDP::IWorkspace::DM_RunOpenDocumentDialog ( std::wstring const Caption,
bool AllowMultiSelect,
std::wstring * Path,
TFilterKind FilterKind,
int FilterIndex,
DXP::IStrings ** DocumentPaths )

◆ DM_SetNavigationZoomPrecision()

void EDP::IWorkspace::DM_SetNavigationZoomPrecision ( int ZoomPrecision)

◆ DM_SetRecoveryParameters()

void EDP::IWorkspace::DM_SetRecoveryParameters ( bool IsEnabled,
int Interval )

◆ DM_SetRightClickCompStructure()

void EDP::IWorkspace::DM_SetRightClickCompStructure ( std::wstring const AProjectPath,
std::wstring const ALibReference,
std::wstring const AUniqueId )

◆ DM_ShowMessageView()

void EDP::IWorkspace::DM_ShowMessageView ( )

◆ DM_ShowProject()

void EDP::IWorkspace::DM_ShowProject ( std::wstring ProjectPath)

◆ DM_ShowToDoList()

void EDP::IWorkspace::DM_ShowToDoList ( )

◆ DM_ViolationTypeDescription()

std::wstring EDP::IWorkspace::DM_ViolationTypeDescription ( TErrorKind ErrorKind)

◆ DM_ViolationTypeGroup()

TErrorGroup EDP::IWorkspace::DM_ViolationTypeGroup ( TErrorKind ErrorKind)

◆ DM_WorkspaceFileName()

std::wstring EDP::IWorkspace::DM_WorkspaceFileName ( )

◆ DM_WorkspaceFullPath()

std::wstring EDP::IWorkspace::DM_WorkspaceFullPath ( )

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