GcApDocument

class pygcad.pygrx.GcApDocument

Bases: GcRxObject

Attributes Summary

`k2000_Standard`
`k2000_Template`
`k2000_dwg`
`k2000_dxf`
`k2000_xml`
`k2004_Standard`
`k2004_Template`
`k2004_dwg`
`k2004_dxf`
`k2007_Standard`
`k2007_Template`
`k2007_dwg`
`k2007_dxf`
`k2010_Standard`
`k2010_Template`
`k2010_dwg`
`k2010_dxf`
`k2013_Standard`
`k2013_Template`
`k2013_dwg`
`k2013_dxf`
`k2018_Standard`
`k2018_Template`
`k2018_dwg`
`k2018_dxf`
`kNative`
`kNative_Template`
`kR12_dxf`
`kR13_dwg`
`kR13_dxf`
`kR14_dwg`
`kR14_dxf`
`kUnknown`

Methods Summary

`GetCountOfLispList`(self)	C++: GcApDocument::GetCountOfLispList() const --> int
`GetItemOfLispList`(self, nIndex)	C++: GcApDocument::GetItemOfLispList(int) const --> class GcLispAppInfo *
`assign`(self, para)	C++: GcApDocument::operator=(const class GcApDocument &) --> class GcApDocument &
`cast`(inPtr)	C++: GcApDocument::cast(const class GcRxObject ) --> class GcApDocument
`className`()	C++: GcApDocument::className() --> const wchar_t *
`contextPtr`(self)	C++: GcApDocument::contextPtr() const --> void *
`database`(self)	C++: GcApDocument::database() const --> class GcDbDatabase *
`desc`()	C++: GcApDocument::desc() --> class GcRxClass *
`docTitle`(self)	C++: GcApDocument::docTitle() const --> const wchar_t *
`downgradeDocOpen`(self, bPromptForSave)	C++: GcApDocument::downgradeDocOpen(bool) --> enum Gcad::ErrorStatus
`fileName`(self)	C++: GcApDocument::fileName() const --> const wchar_t *
`formatForSave`(self)	C++: GcApDocument::formatForSave() const --> enum GcApDocument::SaveFormat
`getDwgVersionFromSaveFormat`(docFormat, ...)	C++: GcApDocument::getDwgVersionFromSaveFormat(enum GcApDocument::SaveFormat, enum GcDb::GcDbDwgVersion &, enum GcDb::MaintenanceReleaseVersion &) --> enum Gcad::ErrorStatus
`isA`(self)	C++: GcApDocument::isA() const --> class GcRxClass *
`isCommandInputInactive`(self)	C++: GcApDocument::isCommandInputInactive() const --> bool
`isNamedDrawing`(self)	C++: GcApDocument::isNamedDrawing() const --> bool
`isQuiescent`(self)	C++: GcApDocument::isQuiescent() const --> bool
`isReadOnly`(self)	C++: GcApDocument::isReadOnly() const --> bool
`lockMode`(args, *kwargs)	Overloaded function.
`myLockMode`(self)	C++: GcApDocument::myLockMode() const --> enum GcAp::DocLockMode
`popDbmod`(self)	C++: GcApDocument::popDbmod() --> enum Gcad::ErrorStatus
`pushDbmod`(self)	C++: GcApDocument::pushDbmod() --> void
`rxInit`()	C++: GcApDocument::rxInit() --> void
`setDocTitle`(self, title)	C++: GcApDocument::setDocTitle(const wchar_t *) --> void
`upgradeDocOpen`(self)	C++: GcApDocument::upgradeDocOpen() --> enum Gcad::ErrorStatus

Attributes Documentation

k2000_Standard = <SaveFormat.k2000_Standard: 15>

k2000_Template = <SaveFormat.k2000_Template: 14>

k2000_dwg = <SaveFormat.k2000_dwg: 12>

k2000_dxf = <SaveFormat.k2000_dxf: 13>

k2000_xml = <SaveFormat.k2000_xml: 16>

k2004_Standard = <SaveFormat.k2004_Standard: 27>

k2004_Template = <SaveFormat.k2004_Template: 26>

k2004_dwg = <SaveFormat.k2004_dwg: 24>

k2004_dxf = <SaveFormat.k2004_dxf: 25>

k2007_Standard = <SaveFormat.k2007_Standard: 39>

k2007_Template = <SaveFormat.k2007_Template: 38>

k2007_dwg = <SaveFormat.k2007_dwg: 36>

k2007_dxf = <SaveFormat.k2007_dxf: 37>

k2010_Standard = <SaveFormat.k2010_Standard: 51>

k2010_Template = <SaveFormat.k2010_Template: 50>

k2010_dwg = <SaveFormat.k2010_dwg: 48>

k2010_dxf = <SaveFormat.k2010_dxf: 49>

k2013_Standard = <SaveFormat.k2013_Standard: 63>

k2013_Template = <SaveFormat.k2013_Template: 62>

k2013_dwg = <SaveFormat.k2013_dwg: 60>

k2013_dxf = <SaveFormat.k2013_dxf: 61>

k2018_Standard = <SaveFormat.k2018_Standard: 67>

k2018_Template = <SaveFormat.k2018_Template: 66>

k2018_dwg = <SaveFormat.k2018_dwg: 64>

k2018_dxf = <SaveFormat.k2018_dxf: 65>

kNative = <SaveFormat.k2018_dwg: 64>

kNative_Template = <SaveFormat.k2018_Template: 66>

kR12_dxf = <SaveFormat.kR12_dxf: 1>

kR13_dwg = <SaveFormat.kR13_dwg: 4>

kR13_dxf = <SaveFormat.kR13_dxf: 5>

kR14_dwg = <SaveFormat.kR14_dwg: 8>

kR14_dxf = <SaveFormat.kR14_dxf: 9>

kUnknown = <SaveFormat.kUnknown: -1>

Methods Documentation

GetCountOfLispList(self: pygcad.pygrx.GcApDocument) → int: C++: GcApDocument::GetCountOfLispList() const –> int

GetItemOfLispList(self: pygcad.pygrx.GcApDocument, nIndex: int) → pygcad.pygrx.GcLispAppInfo: C++: GcApDocument::GetItemOfLispList(int) const –> class GcLispAppInfo *

assign(self: pygcad.pygrx.GcApDocument, para: pygcad.pygrx.GcApDocument) → pygcad.pygrx.GcApDocument: C++: GcApDocument::operator=(const class GcApDocument &) –> class GcApDocument &

static cast(inPtr: pygcad.pygrx.GcRxObject) → pygcad.pygrx.GcApDocument: C++: GcApDocument::cast(const class GcRxObject *) –> class GcApDocument *

static className() → str: C++: GcApDocument::className() –> const wchar_t *

contextPtr(self: pygcad.pygrx.GcApDocument) → capsule: C++: GcApDocument::contextPtr() const –> void *

database(self: pygcad.pygrx.GcApDocument) → pygcad.pygrx.GcDbDatabase: C++: GcApDocument::database() const –> class GcDbDatabase *

static desc() → pygcad.pygrx.GcRxClass: C++: GcApDocument::desc() –> class GcRxClass *

docTitle(self: pygcad.pygrx.GcApDocument) → str: C++: GcApDocument::docTitle() const –> const wchar_t *

downgradeDocOpen(self: pygcad.pygrx.GcApDocument, bPromptForSave: bool) → pygcad.pygrx.Gcad.ErrorStatus: C++: GcApDocument::downgradeDocOpen(bool) –> enum Gcad::ErrorStatus

fileName(self: pygcad.pygrx.GcApDocument) → str: C++: GcApDocument::fileName() const –> const wchar_t *

formatForSave(self: pygcad.pygrx.GcApDocument) → pygcad.pygrx.GcApDocument.SaveFormat: C++: GcApDocument::formatForSave() const –> enum GcApDocument::SaveFormat

static getDwgVersionFromSaveFormat(docFormat: pygcad.pygrx.GcApDocument.SaveFormat, dwgVer: pygcad.pygrx.GcDb.GcDbDwgVersion, dwgMaintVer: pygcad.pygrx.GcDb.MaintenanceReleaseVersion) → pygcad.pygrx.Gcad.ErrorStatus: C++: GcApDocument::getDwgVersionFromSaveFormat(enum GcApDocument::SaveFormat, enum GcDb::GcDbDwgVersion &, enum GcDb::MaintenanceReleaseVersion &) –> enum Gcad::ErrorStatus

isA(self: pygcad.pygrx.GcApDocument) → pygcad.pygrx.GcRxClass: C++: GcApDocument::isA() const –> class GcRxClass *

isCommandInputInactive(self: pygcad.pygrx.GcApDocument) → bool: C++: GcApDocument::isCommandInputInactive() const –> bool

isNamedDrawing(self: pygcad.pygrx.GcApDocument) → bool: C++: GcApDocument::isNamedDrawing() const –> bool

isQuiescent(self: pygcad.pygrx.GcApDocument) → bool: C++: GcApDocument::isQuiescent() const –> bool

isReadOnly(self: pygcad.pygrx.GcApDocument) → bool: C++: GcApDocument::isReadOnly() const –> bool

lockMode(*args, **kwargs)

Overloaded function.

lockMode(self: pygcad.pygrx.GcApDocument) -> GcAp::DocLockMode
lockMode(self: pygcad.pygrx.GcApDocument, bIncludeMyLocks: bool) -> GcAp::DocLockMode

C++: GcApDocument::lockMode(bool) const –> enum GcAp::DocLockMode

myLockMode(self: pygcad.pygrx.GcApDocument) → GcAp::DocLockMode: C++: GcApDocument::myLockMode() const –> enum GcAp::DocLockMode

popDbmod(self: pygcad.pygrx.GcApDocument) → pygcad.pygrx.Gcad.ErrorStatus: C++: GcApDocument::popDbmod() –> enum Gcad::ErrorStatus

pushDbmod(self: pygcad.pygrx.GcApDocument) → None: C++: GcApDocument::pushDbmod() –> void

static rxInit() → None: C++: GcApDocument::rxInit() –> void

setDocTitle(self: pygcad.pygrx.GcApDocument, title: str) → None: C++: GcApDocument::setDocTitle(const wchar_t *) –> void

upgradeDocOpen(self: pygcad.pygrx.GcApDocument) → pygcad.pygrx.Gcad.ErrorStatus: C++: GcApDocument::upgradeDocOpen() –> enum Gcad::ErrorStatus