SCH::ISch_Document Struct Reference

#include <EDP.SCH.Interfaces.h>

Inheritance diagram for SCH::ISch_Document:

Public Member Functions
void	SetState_DocumentBorderStyle (TSheetDocumentBorderStyle AValue)
void	SetState_CustomSheetStyle (std::wstring AValue)
void	SetState_SheetStyle (TSheetStyle AValue)
void	SetState_WorkspaceOrientation (TSheetOrientation AValue)
void	SetState_TitleBlockOn (bool AValue)
void	SetState_ReferenceZonesOn (bool AValue)
void	SetState_BorderOn (bool AValue)
void	SetState_UseCustomSheet (bool AValue)
void	SetState_CustomX (int AValue)
void	SetState_CustomY (int AValue)
void	SetState_CustomXZones (int AValue)
void	SetState_CustomYZones (int AValue)
void	SetState_CustomMarginWidth (int AValue)
void	SetState_SnapGridOn (bool AValue)
void	SetState_SnapGridSize (int AValue)
void	SetState_VisibleGridOn (bool AValue)
void	SetState_VisibleGridSize (int AValue)
void	SetState_HotspotGridOn (bool AValue)
void	SetState_HotspotGridSize (int AValue)
void	SetState_ShowTemplateGraphics (bool AValue)
void	SetState_TemplateFileName (std::wstring AValue)
void	SetState_SheetSizeX (int AValue)
void	SetState_SheetSizeY (int AValue)
void	SetState_SheetZonesX (int AValue)
void	SetState_SheetZonesY (int AValue)
void	SetState_SheetMarginWidth (int AValue)
void	SetState_SystemFont (int AValue)
void	SetState_LoadFormat (std::wstring AValue)
void	SetState_Unit (TUnit AValue)
std::wstring	GetState_DocumentName ()
TSheetDocumentBorderStyle	GetState_DocumentBorderStyle ()
std::wstring	GetState_CustomSheetStyle ()
TSheetStyle	GetState_SheetStyle ()
TSheetOrientation	GetState_WorkspaceOrientation ()
bool	GetState_TitleBlockOn ()
bool	GetState_ReferenceZonesOn ()
bool	GetState_BorderOn ()
bool	GetState_UseCustomSheet ()
int	GetState_CustomX ()
int	GetState_CustomY ()
int	GetState_CustomXZones ()
int	GetState_CustomYZones ()
int	GetState_CustomMarginWidth ()
bool	GetState_SnapGridOn ()
int	GetState_SnapGridSize ()
bool	GetState_VisibleGridOn ()
int	GetState_VisibleGridSize ()
bool	GetState_HotspotGridOn ()
int	GetState_HotspotGridSize ()
bool	GetState_ShowTemplateGraphics ()
std::wstring	GetState_TemplateFileName ()
int	GetState_SheetSizeX ()
int	GetState_SheetSizeY ()
int	GetState_SheetZonesX ()
int	GetState_SheetZonesY ()
int	GetState_SheetMarginWidth ()
int	GetState_SystemFont ()
std::wstring	GetState_LoadFormat ()
TUnit	GetState_Unit ()
TUnitSystem	GetState_UnitSystem ()
int	GetState_InternalTolerance ()
C_CoordRect	Graphical_VirtualRectangle ()
C_CoordRect	BoundingRectangle_Selected ()
void	RegisterSchObjectInContainer (ISch_BasicContainer *AObject)
void	UnRegisterSchObjectFromContainer (ISch_BasicContainer *AObject)
std::wstring	ObjectReferenceZone (ISch_BasicContainer *AObject)
void	RedrawToDC (long DC, int PrintKind, int PrintWhat)
void	UnregisterAndFreeAllConnectionLines ()
void	LockViewUpdate ()
void	UnLockViewUpdate ()
ISch_HitTest *	CreateHitTest (THitTestMode ATestMode, DXP::C_Point ALocation)
void	CreateLibraryFromProject (bool AddLibToProject, std::wstring FileName, bool RunQuiet)
void	UpdateDocumentProperties ()
int	CountContextMenuObjects (TObjectSet AObjectSet)
ISch_HitTest *	PopupMenuHitTest ()
int	GridCoordinateUp (int ACoord)
int	GridCoordinateClosest (int ACoord)
void	UpdateDisplayForCurrentSheet ()
bool	IsInEditorView ()
bool	ChooseLocationInteractively (DXP::C_Point *ALocation, std::wstring Prompt)
bool	ChooseRectangleInteractively (C_CoordRect *ARect, std::wstring Prompt1, std::wstring Prompt2)
void	SetTemplateInfo (std::wstring const AVaultGUID, std::wstring const AItemGUID, std::wstring const ARevisionGUID, std::wstring const AVaultHRID, std::wstring const ARevisionHRID)
std::wstring	GetTemplateVaultGUID ()
std::wstring	GetTemplateItemGUID ()
std::wstring	GetTemplateRevisionGUID ()
std::wstring	GetTemplateVaultHRID ()
std::wstring	GetTemplateRevisionHRID ()
std::wstring	GetPropsVaultGUID ()
std::wstring	GetPropsRevisionGUID ()
void	SetPreferencesInfo (std::wstring const AVaultGUID, std::wstring const ARevisionGUID)
std::wstring	GenerateUniqueID ()
int	GetState_MinorVersion ()
void	RecreateHandles ()
bool	HasServerDocument ()
int	GetState_SchDocID ()
Public Member Functions inherited from SCH::ISch_ParametrizedGroup
bool	Import_FromUser_Parameters ()
void	ResetAllSchParametersPosition ()
Public Member Functions inherited from SCH::ISch_GraphicalObject
DXP::C_Point	GetState_Location ()
DXP::TColor	GetState_Color ()
DXP::TColor	GetState_AreaColor ()
bool	GetState_Selection ()
bool	GetState_EnableDraw ()
bool	GetState_Disabled ()
bool	GetState_Dimmed ()
int	GetState_OwnerPartId ()
int	GetState_OwnerPartDisplayMode ()
std::wstring	GetState_LiveHighlightValue ()
EDP::TErrorKind	GetState_ErrorKind ()
DXP::TColor	GetState_ErrorColor ()
bool	GetState_DisplayError ()
std::wstring	GetState_ErrorString ()
bool	GetState_CompilationMasked ()
void	SetState_Location (DXP::C_Point ALocation)
void	SetState_Color (DXP::TColor AColor)
void	SetState_AreaColor (DXP::TColor AColor)
void	SetState_Selection (bool B)
void	SetState_EnableDraw (bool B)
void	SetState_Disabled (bool B)
void	SetState_Dimmed (bool B)
void	SetState_OwnerPartId (int AValue)
void	SetState_OwnerPartDisplayMode (int AValue)
void	SetState_LiveHighlightValue (std::wstring AValue)
void	SetState_ErrorKind (EDP::TErrorKind AValue)
void	SetState_ErrorColor (DXP::TColor AValue)
void	SetState_DisplayError (bool AValue)
void	SetState_ErrorString (std::wstring const AValue)
void	SetState_CompilationMasked (bool AValue)
void	RotateBy90 (DXP::C_Point Center, TRotationBy90 A)
void	MoveByXY (int x, int y)
void	MoveToXY (int x, int y)
void	Mirror (DXP::C_Point Axis)
void	SetState_xSizeySize ()
void	GraphicallyInvalidate ()
C_CoordRect	BoundingRectangle ()
C_CoordRect	BoundingRectangle_Full ()
void	AddErrorString (std::wstring const AErrorString, bool AtEnd)
void	ResetErrorFields ()
Public Member Functions inherited from SCH::ISch_BasicContainer
void	SetState_Text (std::wstring AValue)
TObjectId	GetState_ObjectId ()
ISch_BasicContainer *	GetState_SchBasicContainer ()
ISch_Document *	GetState_OwnerSchDocument ()
std::wstring	GetState_Text ()
void	AddSchObject (ISch_BasicContainer *AObject)
void	AddAndPositionSchObject (ISch_BasicContainer *AObject)
void	RemoveSchObject (ISch_BasicContainer *AObject)
ISch_Iterator *	SchIterator_Create ()
void	DeleteAll ()
void	FreeAllContainedObjects ()
void	Setstate_Default (TUnitSystem AUnit)
bool	Import_FromUser ()
std::wstring	GetState_IdentifierString ()
std::wstring	GetState_DescriptionString ()
ISch_BasicContainer *	Replicate ()
std::wstring	ExportToParameters ()
void	SchIterator_Destroy (ISch_Iterator **AIterator)
void	SetState_UniqueId (std::wstring AValue)
std::wstring	GetState_Handle ()
std::wstring	GetState_UniqueId ()

Member Function Documentation

BoundingRectangle_Selected()

C_CoordRect SCH::ISch_Document::BoundingRectangle_Selected

(

)

ChooseLocationInteractively()

bool SCH::ISch_Document::ChooseLocationInteractively	(	DXP::C_Point *	ALocation,
		std::wstring	Prompt )

ChooseRectangleInteractively()

bool SCH::ISch_Document::ChooseRectangleInteractively	(	C_CoordRect *	ARect,
		std::wstring	Prompt1,
		std::wstring	Prompt2 )

CountContextMenuObjects()

int SCH::ISch_Document::CountContextMenuObjects

(

TObjectSet

AObjectSet

)

CreateHitTest()

ISch_HitTest * SCH::ISch_Document::CreateHitTest	(	THitTestMode	ATestMode,
		DXP::C_Point	ALocation )

CreateLibraryFromProject()

void SCH::ISch_Document::CreateLibraryFromProject	(	bool	AddLibToProject,
		std::wstring	FileName,
		bool	RunQuiet )

GenerateUniqueID()

std::wstring SCH::ISch_Document::GenerateUniqueID

(

)

GetPropsRevisionGUID()

std::wstring SCH::ISch_Document::GetPropsRevisionGUID

(

)

GetPropsVaultGUID()

std::wstring SCH::ISch_Document::GetPropsVaultGUID

(

)

GetState_BorderOn()

bool SCH::ISch_Document::GetState_BorderOn

(

)

GetState_CustomMarginWidth()

int SCH::ISch_Document::GetState_CustomMarginWidth

(

)

GetState_CustomSheetStyle()

std::wstring SCH::ISch_Document::GetState_CustomSheetStyle

(

)

GetState_CustomX()

int SCH::ISch_Document::GetState_CustomX

(

)

GetState_CustomXZones()

int SCH::ISch_Document::GetState_CustomXZones

(

)

GetState_CustomY()

int SCH::ISch_Document::GetState_CustomY

(

)

GetState_CustomYZones()

int SCH::ISch_Document::GetState_CustomYZones

(

)

GetState_DocumentBorderStyle()

TSheetDocumentBorderStyle SCH::ISch_Document::GetState_DocumentBorderStyle

(

)

GetState_DocumentName()

std::wstring SCH::ISch_Document::GetState_DocumentName

(

)

GetState_HotspotGridOn()

bool SCH::ISch_Document::GetState_HotspotGridOn

(

)

GetState_HotspotGridSize()

int SCH::ISch_Document::GetState_HotspotGridSize

(

)

GetState_InternalTolerance()

int SCH::ISch_Document::GetState_InternalTolerance

(

)

GetState_LoadFormat()

std::wstring SCH::ISch_Document::GetState_LoadFormat

(

)

GetState_MinorVersion()

int SCH::ISch_Document::GetState_MinorVersion

(

)

GetState_ReferenceZonesOn()

bool SCH::ISch_Document::GetState_ReferenceZonesOn

(

)

GetState_SchDocID()

int SCH::ISch_Document::GetState_SchDocID

(

)

GetState_SheetMarginWidth()

int SCH::ISch_Document::GetState_SheetMarginWidth

(

)

GetState_SheetSizeX()

int SCH::ISch_Document::GetState_SheetSizeX

(

)

GetState_SheetSizeY()

int SCH::ISch_Document::GetState_SheetSizeY

(

)

GetState_SheetStyle()

TSheetStyle SCH::ISch_Document::GetState_SheetStyle

(

)

GetState_SheetZonesX()

int SCH::ISch_Document::GetState_SheetZonesX

(

)

GetState_SheetZonesY()

int SCH::ISch_Document::GetState_SheetZonesY

(

)

GetState_ShowTemplateGraphics()

bool SCH::ISch_Document::GetState_ShowTemplateGraphics

(

)

GetState_SnapGridOn()

bool SCH::ISch_Document::GetState_SnapGridOn

(

)

GetState_SnapGridSize()

int SCH::ISch_Document::GetState_SnapGridSize

(

)

GetState_SystemFont()

int SCH::ISch_Document::GetState_SystemFont

(

)

GetState_TemplateFileName()

std::wstring SCH::ISch_Document::GetState_TemplateFileName

(

)

GetState_TitleBlockOn()

bool SCH::ISch_Document::GetState_TitleBlockOn

(

)

GetState_Unit()

TUnit SCH::ISch_Document::GetState_Unit

(

)

GetState_UnitSystem()

TUnitSystem SCH::ISch_Document::GetState_UnitSystem

(

)

GetState_UseCustomSheet()

bool SCH::ISch_Document::GetState_UseCustomSheet

(

)

GetState_VisibleGridOn()

bool SCH::ISch_Document::GetState_VisibleGridOn

(

)

GetState_VisibleGridSize()

int SCH::ISch_Document::GetState_VisibleGridSize

(

)

GetState_WorkspaceOrientation()

TSheetOrientation SCH::ISch_Document::GetState_WorkspaceOrientation

(

)

GetTemplateItemGUID()

std::wstring SCH::ISch_Document::GetTemplateItemGUID

(

)

GetTemplateRevisionGUID()

std::wstring SCH::ISch_Document::GetTemplateRevisionGUID

(

)

GetTemplateRevisionHRID()

std::wstring SCH::ISch_Document::GetTemplateRevisionHRID

(

)

GetTemplateVaultGUID()

std::wstring SCH::ISch_Document::GetTemplateVaultGUID

(

)

GetTemplateVaultHRID()

std::wstring SCH::ISch_Document::GetTemplateVaultHRID

(

)

Graphical_VirtualRectangle()

C_CoordRect SCH::ISch_Document::Graphical_VirtualRectangle

(

)

GridCoordinateClosest()

int SCH::ISch_Document::GridCoordinateClosest

(

int

ACoord

)

GridCoordinateUp()

int SCH::ISch_Document::GridCoordinateUp

(

int

ACoord

)

HasServerDocument()

bool SCH::ISch_Document::HasServerDocument

(

)

IsInEditorView()

bool SCH::ISch_Document::IsInEditorView

(

)

LockViewUpdate()

void SCH::ISch_Document::LockViewUpdate

(

)

ObjectReferenceZone()

std::wstring SCH::ISch_Document::ObjectReferenceZone

(

ISch_BasicContainer *

AObject

)

PopupMenuHitTest()

ISch_HitTest * SCH::ISch_Document::PopupMenuHitTest

(

)

RecreateHandles()

void SCH::ISch_Document::RecreateHandles

(

)

RedrawToDC()

void SCH::ISch_Document::RedrawToDC	(	long	DC,
		int	PrintKind,
		int	PrintWhat )

RegisterSchObjectInContainer()

void SCH::ISch_Document::RegisterSchObjectInContainer

(

ISch_BasicContainer *

AObject

)

SetPreferencesInfo()

void SCH::ISch_Document::SetPreferencesInfo	(	std::wstring const	AVaultGUID,
		std::wstring const	ARevisionGUID )

SetState_BorderOn()

void SCH::ISch_Document::SetState_BorderOn

(

bool

AValue

)

SetState_CustomMarginWidth()

void SCH::ISch_Document::SetState_CustomMarginWidth

(

int

AValue

)

SetState_CustomSheetStyle()

void SCH::ISch_Document::SetState_CustomSheetStyle

(

std::wstring

AValue

)

SetState_CustomX()

void SCH::ISch_Document::SetState_CustomX

(

int

AValue

)

SetState_CustomXZones()

void SCH::ISch_Document::SetState_CustomXZones

(

int

AValue

)

SetState_CustomY()

void SCH::ISch_Document::SetState_CustomY

(

int

AValue

)

SetState_CustomYZones()

void SCH::ISch_Document::SetState_CustomYZones

(

int

AValue

)

SetState_DocumentBorderStyle()

void SCH::ISch_Document::SetState_DocumentBorderStyle

(

TSheetDocumentBorderStyle

AValue

)

SetState_HotspotGridOn()

void SCH::ISch_Document::SetState_HotspotGridOn

(

bool

AValue

)

SetState_HotspotGridSize()

void SCH::ISch_Document::SetState_HotspotGridSize

(

int

AValue

)

SetState_LoadFormat()

void SCH::ISch_Document::SetState_LoadFormat

(

std::wstring

AValue

)

SetState_ReferenceZonesOn()

void SCH::ISch_Document::SetState_ReferenceZonesOn

(

bool

AValue

)

SetState_SheetMarginWidth()

void SCH::ISch_Document::SetState_SheetMarginWidth

(

int

AValue

)

SetState_SheetSizeX()

void SCH::ISch_Document::SetState_SheetSizeX

(

int

AValue

)

SetState_SheetSizeY()

void SCH::ISch_Document::SetState_SheetSizeY

(

int

AValue

)

SetState_SheetStyle()

void SCH::ISch_Document::SetState_SheetStyle

(

TSheetStyle

AValue

)

SetState_SheetZonesX()

void SCH::ISch_Document::SetState_SheetZonesX

(

int

AValue

)

SetState_SheetZonesY()

void SCH::ISch_Document::SetState_SheetZonesY

(

int

AValue

)

SetState_ShowTemplateGraphics()

void SCH::ISch_Document::SetState_ShowTemplateGraphics

(

bool

AValue

)

SetState_SnapGridOn()

void SCH::ISch_Document::SetState_SnapGridOn

(

bool

AValue

)

SetState_SnapGridSize()

void SCH::ISch_Document::SetState_SnapGridSize

(

int

AValue

)

SetState_SystemFont()

void SCH::ISch_Document::SetState_SystemFont

(

int

AValue

)

SetState_TemplateFileName()

void SCH::ISch_Document::SetState_TemplateFileName

(

std::wstring

AValue

)

SetState_TitleBlockOn()

void SCH::ISch_Document::SetState_TitleBlockOn

(

bool

AValue

)

SetState_Unit()

void SCH::ISch_Document::SetState_Unit

(

TUnit

AValue

)

SetState_UseCustomSheet()

void SCH::ISch_Document::SetState_UseCustomSheet

(

bool

AValue

)

SetState_VisibleGridOn()

void SCH::ISch_Document::SetState_VisibleGridOn

(

bool

AValue

)

SetState_VisibleGridSize()

void SCH::ISch_Document::SetState_VisibleGridSize

(

int

AValue

)

SetState_WorkspaceOrientation()

void SCH::ISch_Document::SetState_WorkspaceOrientation

(

TSheetOrientation

AValue

)

SetTemplateInfo()

void SCH::ISch_Document::SetTemplateInfo	(	std::wstring const	AVaultGUID,
		std::wstring const	AItemGUID,
		std::wstring const	ARevisionGUID,
		std::wstring const	AVaultHRID,
		std::wstring const	ARevisionHRID )

UnLockViewUpdate()

void SCH::ISch_Document::UnLockViewUpdate

(

)

UnregisterAndFreeAllConnectionLines()

void SCH::ISch_Document::UnregisterAndFreeAllConnectionLines

(

)

UnRegisterSchObjectFromContainer()

void SCH::ISch_Document::UnRegisterSchObjectFromContainer

(

ISch_BasicContainer *

AObject

)

UpdateDisplayForCurrentSheet()

void SCH::ISch_Document::UpdateDisplayForCurrentSheet

(

)

UpdateDocumentProperties()

void SCH::ISch_Document::UpdateDocumentProperties

(

)

---

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

• EDP.SCH.Interfaces.h