All Frameworks Class Hierarchy This Framework Indexes
DraftingInterfaces Interface CATIDrwDraftingSettingAtt
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIDrwDraftingSettingAtt
Interface to manage drafting settings.
Even if GetXXX methods fail, returned arguments are valued to default.
Method Index
- o
GetCreateNewSheetFromInfo(CATSettingInfo*)
- Retrieves the state of the CreateNewSheetFrom parameter.
- o
GetCreateNewSheetFrom(CatDrwNewSheetFrom&)
- Retrieves the CreateNewSheetFrom attribute.
- o
GetDisplayResetButtonInfo(CATSettingInfo*)
- Retrieves the state of the DisplayResetButton parameter.
- o
GetDisplayResetButton(boolean&)
- Retrieves the DisplayResetButton attribute.
- o
GetLockUserDefaultInfo(CATSettingInfo*)
- Retrieves the state of the LockUserDefault parameter.
- o
GetLockUserDefault(boolean&)
- Retrieves the LockUserDefault attribute.
- o
GetPreventBackgroundAccessInfo(CATSettingInfo*)
- Retrieves the state of the PreventBackgroundAccess parameter.
- o
GetPreventBackgroundAccess(boolean&)
- Retrieves the PreventBackgroundAccess attribute.
- o
GetPreventDimDriving3DCstrInfo(CATSettingInfo*)
- Retrieves the state of the PreventDimDriving3DCstr parameter.
- o
GetPreventDimDriving3DCstr(boolean&)
- Retrieves the PreventDimDriving3DCstr attribute.
- o
GetPreventFileNewInfo(CATSettingInfo*)
- Retrieves the state of the PreventFileNew parameter.
- o
GetPreventFileNew(boolean&)
- Retrieves the PreventFileNew attribute.
- o
GetPreventGenViewStyleInfo(CATSettingInfo*)
- Retrieves the state of the PreventGenViewStyle parameter.
- o
GetPreventGenViewStyle(boolean&)
- Retrieves the PreventGenViewStyle attribute.
- o
GetPreventSetAsDefaultInfo(CATSettingInfo*)
- Retrieves the state of the PreventSetAsDefault parameter.
- o
GetPreventSetAsDefault(boolean&)
- Retrieves the PreventSetAsDefault attribute.
- o
GetPreventSwitchStandardInfo(CATSettingInfo*)
- Retrieves the state of the PreventSwitchStandard parameter.
- o
GetPreventSwitchStandard(boolean&)
- Retrieves the PreventSwitchStandard attribute.
- o
GetPreventTrueDimensionCreationInfo(CATSettingInfo*)
- Retrieves the state of the PreventTrueDimensionCreation parameter.
- o
GetPreventTrueDimensionCreation(boolean&)
- Retrieves the PreventTrueDimensionCreation attribute.
- o
GetPreventUpdateStandardInfo(CATSettingInfo*)
- Retrieves the state of the PreventUpdateStandard parameter.
- o
GetPreventUpdateStandard(boolean&)
- Retrieves the PreventUpdateStandard attribute.
- o
GetPreventViewGeomUpgradeInfo(CATSettingInfo*)
- Sets the state of the PreventViewGeomUpgrade parameter.
- o
GetPreventViewGeomUpgrade(boolean&)
- Retrieves the PreventViewGeomUpgrade attribute.
- o
GetUseStyleCreateObjectsInfo(CATSettingInfo*)
- Retrieves the state of the UseStyleCreateObjects parameter.
- o
GetUseStyleCreateObjects(boolean&)
- Retrieves the UseStyleCreateObjects attribute.
- o
SetCreateNewSheetFromLock(unsigned char)
- Locks or unlocks the CreateNewSheetFrom parameter.
- o
SetCreateNewSheetFrom(CatDrwNewSheetFrom&)
- Sets the CreateNewSheetFrom attribute.
- o
SetDisplayResetButtonLock(unsigned char)
- Locks or unlocks the DisplayResetButton parameter.
- o
SetDisplayResetButton(boolean&)
- Sets the DisplayResetButton attribute.
- o
SetLockUserDefaultLock(unsigned char)
- Locks or unlocks the LockUserDefault parameter.
- o
SetLockUserDefault(boolean&)
- Sets the LockUserDefault attribute.
- o
SetPreventBackgroundAccessLock(unsigned char)
- Locks or unlocks the PreventBackgroundAccess parameter.
- o
SetPreventBackgroundAccess(boolean&)
- Sets the PreventBackgroundAccess attribute.
- o
SetPreventDimDriving3DCstrLock(unsigned char)
- Locks or unlocks the PreventDimDriving3DCstr parameter.
- o
SetPreventDimDriving3DCstr(boolean&)
- Sets the PreventDimDriving3DCstr attribute.
- o
SetPreventFileNewLock(unsigned char)
- Locks or unlocks the PreventFileNew parameter.
- o
SetPreventFileNew(boolean&)
- Sets the PreventFileNew attribute.
- o
SetPreventGenViewStyleLock(unsigned char)
- Locks or unlocks the PreventGenViewStyle parameter.
- o
SetPreventGenViewStyle(boolean&)
- Sets the PreventGenViewStyle attribute.
- o
SetPreventSetAsDefaultLock(unsigned char)
- Locks or unlocks the PreventSetAsDefault parameter.
- o
SetPreventSetAsDefault(boolean&)
- Sets the PreventSetAsDefault attribute.
- o
SetPreventSwitchStandardLock(unsigned char)
- Locks or unlocks the PreventSwitchStandard parameter.
- o
SetPreventSwitchStandard(boolean&)
- Sets the PreventSwitchStandard attribute.
- o
SetPreventTrueDimensionCreationLock(unsigned char)
- Locks or unlocks the PreventTrueDimensionCreation parameter.
- o
SetPreventTrueDimensionCreation(boolean&)
- Sets the PreventTrueDimensionCreation attribute.
- o
SetPreventUpdateStandardLock(unsigned char)
- Locks or unlocks the PreventUpdateStandard parameter.
- o
SetPreventUpdateStandard(boolean&)
- Sets the PreventUpdateStandard attribute.
- o
SetPreventViewGeomUpgradeLock(unsigned char)
- Locks or unlocks the PreventViewGeomUpgrade parameter.
- o
SetPreventViewGeomUpgrade(boolean&)
- Sets the PreventViewGeomUpgrade attribute.
- o
SetUseStyleCreateObjectsLock(unsigned char)
- Locks or unlocks the UseStyleCreateObjects parameter.
- o
SetUseStyleCreateObjects(boolean&)
- Sets the UseStyleCreateObjects attribute.
Methods
o GetCreateNewSheetFromInfo
| public virtual GetCreateNewSheetFromInfo( | | oInfo) |
-
Retrieves the state of the CreateNewSheetFrom parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetCreateNewSheetFrom
| public virtual GetCreateNewSheetFrom( | | ioValue) |
-
Retrieves the CreateNewSheetFrom attribute.
o GetDisplayResetButtonInfo
| public virtual GetDisplayResetButtonInfo( | | oInfo) |
-
Retrieves the state of the DisplayResetButton parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetDisplayResetButton
| public virtual GetDisplayResetButton( | | ioValue) |
-
Retrieves the DisplayResetButton attribute.
o GetLockUserDefaultInfo
| public virtual GetLockUserDefaultInfo( | | oInfo) |
-
Retrieves the state of the LockUserDefault parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetLockUserDefault
| public virtual GetLockUserDefault( | | ioValue) |
-
Retrieves the LockUserDefault attribute.
o GetPreventBackgroundAccessInfo
| public virtual GetPreventBackgroundAccessInfo( | | oInfo) |
-
Retrieves the state of the PreventBackgroundAccess parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetPreventBackgroundAccess
| public virtual GetPreventBackgroundAccess( | | ioValue) |
-
Retrieves the PreventBackgroundAccess attribute.
o GetPreventDimDriving3DCstrInfo
| public virtual GetPreventDimDriving3DCstrInfo( | | oInfo) |
-
Retrieves the state of the PreventDimDriving3DCstr parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetPreventDimDriving3DCstr
| public virtual GetPreventDimDriving3DCstr( | | ioValue) |
-
Retrieves the PreventDimDriving3DCstr attribute.
o GetPreventFileNewInfo
| public virtual GetPreventFileNewInfo( | | oInfo) |
-
Retrieves the state of the PreventFileNew parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetPreventFileNew
| public virtual GetPreventFileNew( | | ioValue) |
-
Retrieves the PreventFileNew attribute.
o GetPreventGenViewStyleInfo
| public virtual GetPreventGenViewStyleInfo( | | oInfo) |
-
Retrieves the state of the PreventGenViewStyle parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetPreventGenViewStyle
| public virtual GetPreventGenViewStyle( | | ioValue) |
-
Retrieves the PreventGenViewStyle attribute.
o GetPreventSetAsDefaultInfo
| public virtual GetPreventSetAsDefaultInfo( | | oInfo) |
-
Retrieves the state of the PreventSetAsDefault parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetPreventSetAsDefault
| public virtual GetPreventSetAsDefault( | | ioValue) |
-
Retrieves the PreventSetAsDefault attribute.
o GetPreventSwitchStandardInfo
| public virtual GetPreventSwitchStandardInfo( | | oInfo) |
-
Retrieves the state of the PreventSwitchStandard parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetPreventSwitchStandard
| public virtual GetPreventSwitchStandard( | | ioValue) |
-
Retrieves the PreventSwitchStandard attribute.
o GetPreventTrueDimensionCreationInfo
| public virtual GetPreventTrueDimensionCreationInfo( | | oInfo) |
-
Retrieves the state of the PreventTrueDimensionCreation parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetPreventTrueDimensionCreation
| public virtual GetPreventTrueDimensionCreation( | | ioValue) |
-
Retrieves the PreventTrueDimensionCreation attribute.
o GetPreventUpdateStandardInfo
| public virtual GetPreventUpdateStandardInfo( | | oInfo) |
-
Retrieves the state of the PreventUpdateStandard parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetPreventUpdateStandard
| public virtual GetPreventUpdateStandard( | | ioValue) |
-
Retrieves the PreventUpdateStandard attribute.
o GetPreventViewGeomUpgradeInfo
| public virtual GetPreventViewGeomUpgradeInfo( | | oInfo) |
-
Sets the state of the PreventViewGeomUpgrade parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetPreventViewGeomUpgrade
| public virtual GetPreventViewGeomUpgrade( | | ioValue) |
-
Retrieves the PreventViewGeomUpgrade attribute.
- Parameters:
-
- ioValue
- The value that is retrieved
Legal values:
True : the parameter.is set
False.: the parameter.is unset
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetUseStyleCreateObjectsInfo
| public virtual GetUseStyleCreateObjectsInfo( | | oInfo) |
-
Retrieves the state of the UseStyleCreateObjects parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetUseStyleCreateObjects
| public virtual GetUseStyleCreateObjects( | | ioValue) |
-
Retrieves the UseStyleCreateObjects attribute.
o SetCreateNewSheetFromLock
| public virtual SetCreateNewSheetFromLock( | | iLocked) |
-
Locks or unlocks the CreateNewSheetFrom parameter.
Role: Locks or unlocks the CreateNewSheetFrom parameter if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetCreateNewSheetFrom
| public virtual SetCreateNewSheetFrom( | const | iValue) |
-
Sets the CreateNewSheetFrom attribute.
o SetDisplayResetButtonLock
| public virtual SetDisplayResetButtonLock( | | iLocked) |
-
Locks or unlocks the DisplayResetButton parameter.
Role: Locks or unlocks the DisplayResetButton parameter if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetDisplayResetButton
| public virtual SetDisplayResetButton( | const | iValue) |
-
Sets the DisplayResetButton attribute.
o SetLockUserDefaultLock
| public virtual SetLockUserDefaultLock( | | iLocked) |
-
Locks or unlocks the LockUserDefault parameter.
Role: Locks or unlocks the LockUserDefault parameter if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetLockUserDefault
| public virtual SetLockUserDefault( | const | iValue) |
-
Sets the LockUserDefault attribute.
o SetPreventBackgroundAccessLock
| public virtual SetPreventBackgroundAccessLock( | | iLocked) |
-
Locks or unlocks the PreventBackgroundAccess parameter.
Role: Locks or unlocks the PreventBackgroundAccess parameter if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetPreventBackgroundAccess
| public virtual SetPreventBackgroundAccess( | const | iValue) |
-
Sets the PreventBackgroundAccess attribute.
o SetPreventDimDriving3DCstrLock
| public virtual SetPreventDimDriving3DCstrLock( | | iLocked) |
-
Locks or unlocks the PreventDimDriving3DCstr parameter.
Role: Locks or unlocks the PreventDimDriving3DCstr parameter if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetPreventDimDriving3DCstr
| public virtual SetPreventDimDriving3DCstr( | const | iValue) |
-
Sets the PreventDimDriving3DCstr attribute.
o SetPreventFileNewLock
| public virtual SetPreventFileNewLock( | | iLocked) |
-
Locks or unlocks the PreventFileNew parameter.
Role: Locks or unlocks the PreventFileNew parameter if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetPreventFileNew
| public virtual SetPreventFileNew( | const | iValue) |
-
Sets the PreventFileNew attribute.
o SetPreventGenViewStyleLock
| public virtual SetPreventGenViewStyleLock( | | iLocked) |
-
Locks or unlocks the PreventGenViewStyle parameter.
Role: Locks or unlocks the PreventGenViewStyle parameter if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetPreventGenViewStyle
| public virtual SetPreventGenViewStyle( | const | iValue) |
-
Sets the PreventGenViewStyle attribute.
o SetPreventSetAsDefaultLock
| public virtual SetPreventSetAsDefaultLock( | | iLocked) |
-
Locks or unlocks the PreventSetAsDefault parameter.
Role: Locks or unlocks the PreventSetAsDefault parameter if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetPreventSetAsDefault
| public virtual SetPreventSetAsDefault( | const | iValue) |
-
Sets the PreventSetAsDefault attribute.
o SetPreventSwitchStandardLock
| public virtual SetPreventSwitchStandardLock( | | iLocked) |
-
Locks or unlocks the PreventSwitchStandard parameter.
Role: Locks or unlocks the PreventSwitchStandard parameter if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetPreventSwitchStandard
| public virtual SetPreventSwitchStandard( | const | iValue) |
-
Sets the PreventSwitchStandard attribute.
o SetPreventTrueDimensionCreationLock
| public virtual SetPreventTrueDimensionCreationLock( | | iLocked) |
-
Locks or unlocks the PreventTrueDimensionCreation parameter.
Role: Locks or unlocks the PreventTrueDimensionCreation parameter if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetPreventTrueDimensionCreation
| public virtual SetPreventTrueDimensionCreation( | const | iValue) |
-
Sets the PreventTrueDimensionCreation attribute.
o SetPreventUpdateStandardLock
| public virtual SetPreventUpdateStandardLock( | | iLocked) |
-
Locks or unlocks the PreventUpdateStandard parameter.
Role: Locks or unlocks the PreventUpdateStandard parameter if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetPreventUpdateStandard
| public virtual SetPreventUpdateStandard( | const | iValue) |
-
Sets the PreventUpdateStandard attribute.
o SetPreventViewGeomUpgradeLock
| public virtual SetPreventViewGeomUpgradeLock( | | iLocked) |
-
Locks or unlocks the PreventViewGeomUpgrade parameter.
Role: Locks or unlocks the PreventViewGeomUpgrade parameter if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetPreventViewGeomUpgrade
| public virtual SetPreventViewGeomUpgrade( | const | iValue) |
-
Sets the PreventViewGeomUpgrade attribute.
- Parameters:
-
- iValue
- The value that is set
Legal values:
True : to set the parameter.
False.: to unset the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetUseStyleCreateObjectsLock
| public virtual SetUseStyleCreateObjectsLock( | | iLocked) |
-
Locks or unlocks the UseStyleCreateObjects parameter.
Role: Locks or unlocks the UseStyleCreateObjects parameter if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetUseStyleCreateObjects
| public virtual SetUseStyleCreateObjects( | const | iValue) |
-
Sets the UseStyleCreateObjects attribute.
This object is included in the file: CATIDrwDraftingSettingAtt.h
If needed, your Imakefile.mk should include the module: CATDraftingInterfaces