SCH::ISch_Sheet Struct Reference

#include <EDP.SCH.Interfaces.h>

Inheritance diagram for SCH::ISch_Sheet:

Public Member Functions
IConnectionsArray *	GetState_WireConnections ()
IConnectionsArray *	GetState_BusConnections ()
void	OptimizeUseOfPolylines ()
bool	GetState_HarnessDefinitionsChanged ()
void	Reset_HarnessDefinitionsChanged ()
void	Raise_HarnessDefinitionsChanged ()
std::wstring	GetState_ReleaseVaultGUID ()
std::wstring	GetState_ReleaseItemGUID ()
std::wstring	GetState_ItemRevisionGUID ()
void	SetState_ItemRevisionGUID (std::wstring AValue)
void	SetState_ReleaseItemGUID (std::wstring AValue)
void	SetState_ReleaseVaultGUID (std::wstring AValue)
Public Member Functions inherited from SCH::ISch_Document
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

GetState_BusConnections()

IConnectionsArray * SCH::ISch_Sheet::GetState_BusConnections

(

)

GetState_HarnessDefinitionsChanged()

bool SCH::ISch_Sheet::GetState_HarnessDefinitionsChanged

(

)

GetState_ItemRevisionGUID()

std::wstring SCH::ISch_Sheet::GetState_ItemRevisionGUID

(

)

GetState_ReleaseItemGUID()

std::wstring SCH::ISch_Sheet::GetState_ReleaseItemGUID

(

)

GetState_ReleaseVaultGUID()

std::wstring SCH::ISch_Sheet::GetState_ReleaseVaultGUID

(

)

GetState_WireConnections()

IConnectionsArray * SCH::ISch_Sheet::GetState_WireConnections

(

)

OptimizeUseOfPolylines()

void SCH::ISch_Sheet::OptimizeUseOfPolylines

(

)

Raise_HarnessDefinitionsChanged()

void SCH::ISch_Sheet::Raise_HarnessDefinitionsChanged

(

)

Reset_HarnessDefinitionsChanged()

void SCH::ISch_Sheet::Reset_HarnessDefinitionsChanged

(

)

SetState_ItemRevisionGUID()

void SCH::ISch_Sheet::SetState_ItemRevisionGUID

(

std::wstring

AValue

)

SetState_ReleaseItemGUID()

void SCH::ISch_Sheet::SetState_ReleaseItemGUID

(

std::wstring

AValue

)

SetState_ReleaseVaultGUID()

void SCH::ISch_Sheet::SetState_ReleaseVaultGUID

(

std::wstring

AValue

)

---

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

• EDP.SCH.Interfaces.h