All Frameworks Class Hierarchy This Framework Indexes
CATIAApplicationFrame Interface CATICafGeneralSessionSettingAtt
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATICafGeneralSessionSettingAtt
Interface to the General setting controller.
Role: The General setting controller is dedicated to manage some
of the setting parameters displayed in the General property page.
Method Index
- o
GetAutoSaveInfo(CATSettingInfo*)
- Retrieves the Auto Save setting attribute information object.
- o
GetAutoSave(CATGenDataSave&)
- Retrieves the Auto Save setting attribute value.
- o
GetConferencingInfo(CATSettingInfo*)
- Retrieves the Conference driver setting attribute information object.
- o
GetConferencing(CATGenConferencing&)
- Retrieves the Conference driver setting attribute value.
- o
GetDragDropInfo(CATSettingInfo*)
- Retrieves the Drag & Drop setting attribute information object.
- o
GetDragDrop(CATBoolean&)
- Retrieves the Drag & Drop setting attribute value.
- o
GetRefDocInfo(CATSettingInfo*)
- Retrieves the Referenced Documents setting attribute information object.
- o
GetRefDoc(CATBoolean&)
- Retrieves the Referenced Documents setting attribute value.
- o
GetTimeRoll(int&)
- Retrieves the Save Frequency setting attribute value.
- o
GetUIStyleInfo(CATSettingInfo*)
- Retrieves the User Interface Style setting attribute information object.
- o
GetUIStyle(CATGenUIStyle&)
- Retrieves the User Interface Style setting attribute value.
- o
SetAutoSaveLock(unsigned char)
- Locks or unlocks the Auto Save parameter.
- o
SetAutoSave(CATGenDataSave&)
- Sets the Auto Save setting attribute value.
- o
SetConferencingLock(unsigned char)
- Locks or unlocks the Conference driver parameter.
- o
SetConferencing(CATGenConferencing&)
- Sets the Conference driver setting attribute value.
- o
SetDragDropLock(unsigned char)
- Locks or unlocks the Drag & Drop parameter.
- o
SetDragDrop(CATBoolean&)
- Sets the Drag & Drop setting attribute value.
- o
SetRefDocLock(unsigned char)
- Locks or unlocks the Referenced Documents parameter.
- o
SetRefDoc(CATBoolean&)
- Sets the Referenced Documents setting attribute value.
- o
SetTimeRoll(int&)
- Sets the Save Frequency setting attribute value.
- o
SetUIStyleLock(unsigned char)
- Locks or unlocks the User Interface Style setting attribute.
- o
SetUIStyle(CATGenUIStyle&)
- Sets the User Interface Style setting attribute value.
Methods
o GetAutoSaveInfo
| public virtual GetAutoSaveInfo( | | ioInfo) |
-
Retrieves the Auto Save setting attribute information object.
- Parameters:
-
- ioInfo
- [inout] The Auto Save setting attribute information object
- Returns:
- S_OK if the Auto Save setting attribute information
is successfully retrieved, and E_FAIL otherwise
o GetAutoSave
| public virtual GetAutoSave( | | ioAutoSave) |
-
Retrieves the Auto Save setting attribute value.
Role: The Auto Save setting attribute manages the automatic backup of the documents
- Parameters:
-
- ioAutoSave
- [inout] The Auto Save setting attribute value
- Returns:
- S_OK if the Auto Save setting attribute value is successfully retrieved, and E_FAIL otherwise
o GetConferencingInfo
| public virtual GetConferencingInfo( | | ioInfo) |
-
Retrieves the Conference driver setting attribute information object.
- Parameters:
-
- ioInfo
- [inout] The Conferencing setting attribute information object
- Returns:
- S_OK if the Conference driver setting attribute information
is successfully retrieved, and E_FAIL otherwise
o GetConferencing
| public virtual GetConferencing( | | ioConferencing) |
-
Retrieves the Conference driver setting attribute value.
Role: The Conference driver setting attribute manages the choice of the means of communication between processes
This property is not available on UNIX
- Parameters:
-
- ioConferencing
- [inout] The Conference driver setting attribute value
- Returns:
- S_OK if the Conference driver setting attribute value is successfully retrieved, and E_FAIL otherwise
o GetDragDropInfo
| public virtual GetDragDropInfo( | | ioInfo) |
-
Retrieves the Drag & Drop setting attribute information object.
- Parameters:
-
- ioInfo
- [inout] The Drag & Drop setting attribute information object
- Returns:
- S_OK if the Drag & Drop setting attribute information
is successfully retrieved, and E_FAIL otherwise
o GetDragDrop
| public virtual GetDragDrop( | | ioDragDrop) |
-
Retrieves the Drag & Drop setting attribute value.
Role: The Drag & Drop setting attribute manages the possibility of dragging and dropping in the viewers (for copying, pasting or cutting purpose only)
- Parameters:
-
- ioDragDrop
- [inout] The Drag & Drop setting attribute value
- Returns:
- S_OK if the Drag & Drop setting attribute value is successfully retrieved, and E_FAIL otherwise
o GetRefDocInfo
| public virtual GetRefDocInfo( | | ioInfo) |
-
Retrieves the Referenced Documents setting attribute information object.
- Parameters:
-
- ioInfo
- [inout] The Referenced Documents setting attribute information object
- Returns:
- S_OK if the Referenced Documents setting attribute information
is successfully retrieved, and E_FAIL otherwise
o GetRefDoc
| public virtual GetRefDoc( | | ioRefDoc) |
-
Retrieves the Referenced Documents setting attribute value.
Role: The Referenced Documents setting attribute manages the loading of the documents pointed by another document
- Parameters:
-
- ioRefDoc
- [inout] The Referenced Documents setting attribute value
- Returns:
- S_OK if the Referenced Documents setting attribute value is successfully retrieved, and E_FAIL otherwise
o GetTimeRoll
| public virtual GetTimeRoll( | | ioTimeRoll) |
-
Retrieves the Save Frequency setting attribute value.
Role: The Save Frequency setting attribute manages the frequency of the documents backup
- Parameters:
-
- ioTimeRoll
- [inout] The Save Frequency setting attribute value
- Returns:
- S_OK if the Save Frequency setting attribute value is successfully retrieved, and E_FAIL otherwise
o GetUIStyleInfo
| public virtual GetUIStyleInfo( | | ioInfo) |
-
Retrieves the User Interface Style setting attribute information object.
- Parameters:
-
- ioInfo
- [inout] The User Interface Style setting attribute information object
- Returns:
- S_OK if the User Interface Style setting attribute information
is successfully retrieved, and E_FAIL otherwise
o GetUIStyle
| public virtual GetUIStyle( | | ioUIStyle) |
-
Retrieves the User Interface Style setting attribute value.
Role: The User Interface Style setting attribute manages the look of the user interface
- Parameters:
-
- ioUIStyle
- [inout] The User Interface Style setting attribute value
- Returns:
- S_OK if the User Interface Style setting attribute value
is successfully retrieved, and E_FAIL otherwise
o SetAutoSaveLock
| public virtual SetAutoSaveLock( | | iLocked) |
-
Locks or unlocks the Auto Save parameter.
Role: Locks or unlocks the Auto Save setting attribute if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- [in] A flag to indicate whether the Auto Save setting attribute
should be locked.
Legal values:
TRUE to lock
FALSE to unlock
- Returns:
- S_OK if the Auto Save setting attribute is successfully locked or unlocked, and E_FAIL otherwise
o SetAutoSave
| public virtual SetAutoSave( | const | iAutoSave) |
-
Sets the Auto Save setting attribute value.
- Parameters:
-
- iAutoSave
- [in] The Auto Save setting attribute value.
Legal values:
NoAutoBackup: No automatic backup
AutoBackupEvery: Automatic backup every...
IncrBackup: Incremental backup
- Returns:
- S_OK if the Auto Save setting attribute value
is successfully set, and E_FAIL otherwise
o SetConferencingLock
| public virtual SetConferencingLock( | | iLocked) |
-
Locks or unlocks the Conference driver parameter.
Role: Locks or unlocks the Conference driver setting attribute if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- [in] A flag to indicate whether the Conference driver setting attribute
should be locked.
Legal values:
TRUE to lock
FALSE to unlock
- Returns:
- S_OK if the Conference driver setting attribute is successfully locked or unlocked, and E_FAIL otherwise
o SetConferencing
| public virtual SetConferencing( | const | iConferencing) |
-
Sets the Conference driver setting attribute value.
- Parameters:
-
- iConferencing
- [in] The Conference driver setting attribute value.
Legal values:
NetMeeting: Microsoft® Windows® NetMeeting®
Backbone: Backbone
- Returns:
- S_OK if the Conference driver setting attribute value
is successfully set, and E_FAIL otherwise
o SetDragDropLock
| public virtual SetDragDropLock( | | iLocked) |
-
Locks or unlocks the Drag & Drop parameter.
Role: Locks or unlocks the Drag & Drop setting attribute if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- [in] A flag to indicate whether the Drag & Drop setting attribute
should be locked.
Legal values:
TRUE to lock
FALSE to unlock
- Returns:
- S_OK if the Drag & Drop setting attribute is successfully locked or unlocked, and E_FAIL otherwise
o SetDragDrop
| public virtual SetDragDrop( | const | iDragDrop) |
-
Sets the Drag & Drop setting attribute value.
- Parameters:
-
- iDragDrop
- [in] The Drag & Drop setting attribute value.
Legal values:
TRUE to enable the Drag & Drop
FALSE to disable the Drag & Drop
- Returns:
- S_OK if the Drag & Drop setting attribute value
is successfully set, and E_FAIL otherwise
o SetRefDocLock
| public virtual SetRefDocLock( | | iLocked) |
-
Locks or unlocks the Referenced Documents parameter.
Role: Locks or unlocks the Referenced Documents setting attribute if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- [in] A flag to indicate whether the Referenced Documents setting attribute
should be locked.
Legal values:
TRUE to lock
FALSE to unlock
- Returns:
- S_OK if the Referenced Documents setting attribute is successfully locked or unlocked, and E_FAIL otherwise
o SetRefDoc
| public virtual SetRefDoc( | const | iRefDoc) |
-
Sets the Referenced Documents setting attribute value.
- Parameters:
-
- iRefDoc
- [in] The Referenced Documents setting attribute value.
Legal values:
TRUE to enable the loading of referenced documents
FALSE to disable the loadinf of referenced documents
- Returns:
- S_OK if the Referenced Documents setting attribute value
is successfully set, and E_FAIL otherwise
o SetTimeRoll
| public virtual SetTimeRoll( | const | iTimeRoll) |
-
Sets the Save Frequency setting attribute value.
- Parameters:
-
- iTimeRoll
- [in] The Save Frequency setting attribute value.
Legal values:
NoAutoBackup: No automatic backup
AutoBackupEvery: Automatic backup every...
IncrBackup: Incremental backup
- Returns:
- S_OK if the Save Frequency setting attribute value
is successfully set, and E_FAIL otherwise
o SetUIStyleLock
| public virtual SetUIStyleLock( | | iLocked) |
-
Locks or unlocks the User Interface Style setting attribute.
Role: Locks or unlocks the User Interface Style setting attribute if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- [in] A flag to indicate whether the User Interface Style setting attribute
should be locked.
Legal values:
TRUE to lock
FALSE to unlock
- Returns:
- S_OK if the User Interface Style setting attribute
is successfully locked or unlocked, and E_FAIL otherwise
o SetUIStyle
| public virtual SetUIStyle( | const | iUIStyle) |
-
Sets the User Interface Style setting attribute value.
- Parameters:
-
- iUIStyle
- [in] The User Interface Style setting attribute value.
Legal values:
UIStyleP1: look is P1
UIStyleP2: look is P2
UIStyleP3: look is P3
- Returns:
- S_OK if the User Interface Style setting attribute value
is successfully set, and E_FAIL otherwise
This object is included in the file: CATICafGeneralSessionSettingAtt.h
If needed, your Imakefile.mk should include the module: CATIAApplicationFrame