All Frameworks Class Hierarchy This Framework Indexes
CATIAApplicationFrame Interface CATICafTreeVizManipSettingAtt
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATICafTreeVizManipSettingAtt
Interface to retrieve and set the information on the specification tree.
Method Index
- o
GetArcSelectionActivationInfo(CATSettingInfo*)
- Retrieves the state of the arc-selection mode applied to the specification tree.
- o
GetArcSelectionActivation(CATBoolean&)
- To retrieve the arc-selection mode applied to the specification tree.
- o
GetAutoExpandActivationInfo(CATSettingInfo*)
- Retrieves the state of the automatic expand mode applied to the specification tree.
- o
GetAutoExpandActivation(CATBoolean&)
- To retrieve the automatic expand mode applied to the specification tree.
- o
GetAutoScrollActivationInfo(CATSettingInfo*)
- Retrieves the state of the automatic scrolling mode applied to the specification tree.
- o
GetAutoScrollActivation(CATBoolean&)
- To retrieve the automatic scrolling mode applied to the specification tree.
- o
GetDisplayGeomOnScrollingInfo(CATSettingInfo*)
- Retrieves the state of the "display geometry on scrolling" mode applied to the specification tree.
- o
GetDisplayGeomOnScrolling(CATBoolean&)
- To retrieve the "display geometry on scrolling" mode.
- o
GetOrientationInfo(CATSettingInfo*)
- Retrieves the state of the orientation parameter.
- o
GetOrientation(CatTreeOrientationEnum&)
- To retrieve the orientation applied to the specification tree.
- o
GetShowActivationInfo(CATSettingInfo*)
- Retrieves the state of the visualization Show/NoShow's mode applied to the specification tree.
- o
GetShowActivation(CATBoolean&)
- To retrieve the visualization Show/NoShow's mode applied to the specification tree.
- o
GetSizeTypeInfo(CATSettingInfo*)
- Retrieves the state of the type of size applied to the text of the specification tree.
- o
GetSizeType(CatTreeSizeTypeEnum&)
- To retrieve the type of size applied to the text of the specification tree.
- o
GetSize(CATLONG&)
- To retrieve the number of characters shown for the text of the specification tree.
- o
GetTypeInfo(CATSettingInfo*)
- Retrieves the state of the type parameter.
- o
GetType(CatTreeTypeEnum&)
- To retrieve the type applied to the specification tree.
- o
SetArcSelectionActivationLock(unsigned char)
- Locks or unlocks the arc-selection mode applied to the specification tre.
- o
SetArcSelectionActivation(CATBoolean&)
- To set the arc-selection mode applied to the specification tree.
- o
SetAutoExpandActivationLock(unsigned char)
- Locks or unlocks the automatic expand mode.
- o
SetAutoExpandActivation(CATBoolean&)
- To set the automatic expand mode applied to the specification tree.
- o
SetAutoScrollActivationLock(unsigned char)
- Locks or unlocks the automatic scrolling mode applied to the specification tre.
- o
SetAutoScrollActivation(CATBoolean&)
- To set the automatic scrolling mode applied to the specification tree.
- o
SetDisplayGeomOnScrollingLock(unsigned char)
- Locks or unlocks the "display geometry on scrolling" mode.
- o
SetDisplayGeomOnScrolling(CATBoolean&)
- To set the "display geometry on scrolling" mode applied to the specification tree.
- o
SetOrientationLock(unsigned char)
- Locks or unlocks the orientation applied to the specification tree .
- o
SetOrientation(CatTreeOrientationEnum&)
- To set the orientation applied to the specification tree.
- o
SetShowActivationLock(unsigned char)
- Locks or unlocks the visualization Show/NoShow's mode applied to the specification tree.
- o
SetShowActivation(CATBoolean&)
- To set the visualization Show/NoShow's mode applied to the specification tree.
- o
SetSizeTypeLock(unsigned char)
- Locks or unlocks the type of size applied to the text of the specification tree .
- o
SetSizeType(CatTreeSizeTypeEnum&)
- To set the type of size applied to the text of the specification tree.
- o
SetSize(CATLONG&)
- To set the number of characters shown for the text of the specification tree.
- o
SetTypeLock(unsigned char)
- Locks or unlocks the type applied to the specification tree .
- o
SetType(CatTreeTypeEnum&)
- To set the type applied to the specification tree.
Methods
o GetArcSelectionActivationInfo
| public virtual GetArcSelectionActivationInfo( | | ioTypeInfo) |
-
Retrieves the state of the arc-selection mode applied to the specification tree.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetArcSelectionActivation
| public virtual GetArcSelectionActivation( | | oType) |
-
To retrieve the arc-selection mode applied to the specification tree.
Role: The "arc selection" mode allows to swap in
the tree viewpoint when the user left click, with the mouse, on an arc of the tree.
o GetAutoExpandActivationInfo
| public virtual GetAutoExpandActivationInfo( | | ioTypeInfo) |
-
Retrieves the state of the automatic expand mode applied to the specification tree.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetAutoExpandActivation
| public virtual GetAutoExpandActivation( | | oType) |
-
To retrieve the automatic expand mode applied to the specification tree.
o GetAutoScrollActivationInfo
| public virtual GetAutoScrollActivationInfo( | | ioTypeInfo) |
-
Retrieves the state of the automatic scrolling mode applied to the specification tree.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetAutoScrollActivation
| public virtual GetAutoScrollActivation( | | oType) |
-
To retrieve the automatic scrolling mode applied to the specification tree.
Role: The "automatic scrolling" mode allows to scroll automaticaly the tree
when a user try to drag and drop an object ont the top or the bottom of the tree.
o GetDisplayGeomOnScrollingInfo
| public virtual GetDisplayGeomOnScrollingInfo( | | ioTypeInfo) |
-
Retrieves the state of the "display geometry on scrolling" mode applied to the specification tree.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetDisplayGeomOnScrolling
| public virtual GetDisplayGeomOnScrolling( | | oType) |
-
To retrieve the "display geometry on scrolling" mode.
o GetOrientationInfo
| public virtual GetOrientationInfo( | | ioOrientationInfo) |
-
Retrieves the state of the orientation parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetOrientation
| public virtual GetOrientation( | | oOrientation) |
-
To retrieve the orientation applied to the specification tree.
o GetShowActivationInfo
| public virtual GetShowActivationInfo( | | ioTypeInfo) |
-
Retrieves the state of the visualization Show/NoShow's mode applied to the specification tree.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetShowActivation
| public virtual GetShowActivation( | | oType) |
-
To retrieve the visualization Show/NoShow's mode applied to the specification tree.
o GetSizeTypeInfo
| public virtual GetSizeTypeInfo( | | ioSizeTypeInfo) |
-
Retrieves the state of the type of size applied to the text of the specification tree.
Role: Attributes "size" and "SizeType" are linked together by the same
lock. So there is no function "GetSizeInfo".
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetSizeType
| public virtual GetSizeType( | | oSizeType) |
-
To retrieve the type of size applied to the text of the specification tree.
o GetSize
| public virtual GetSize( | | oSize) |
-
To retrieve the number of characters shown for the text of the specification tree.
o GetTypeInfo
| public virtual GetTypeInfo( | | ioTypeInfo) |
-
Retrieves the state of the type parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetType
| public virtual GetType( | | oType) |
-
To retrieve the type applied to the specification tree.
o SetArcSelectionActivationLock
| public virtual SetArcSelectionActivationLock( | | iLocked) |
-
Locks or unlocks the arc-selection mode applied to the specification tre.
Role: Locks or unlocks the arc-selection mode applied to the specification tre 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 SetArcSelectionActivation
| public virtual SetArcSelectionActivation( | | iType) |
-
To set the arc-selection mode applied to the specification tree.
o SetAutoExpandActivationLock
| public virtual SetAutoExpandActivationLock( | | iLocked) |
-
Locks or unlocks the automatic expand mode.
Role: Locks or unlocks the automatic expand mode 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 SetAutoExpandActivation
| public virtual SetAutoExpandActivation( | | iType) |
-
To set the automatic expand mode applied to the specification tree.
o SetAutoScrollActivationLock
| public virtual SetAutoScrollActivationLock( | | iLocked) |
-
Locks or unlocks the automatic scrolling mode applied to the specification tre.
Role: Locks or unlocks the automatic scrolling mode applied to the specification tre 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 SetAutoScrollActivation
| public virtual SetAutoScrollActivation( | | iType) |
-
To set the automatic scrolling mode applied to the specification tree.
o SetDisplayGeomOnScrollingLock
| public virtual SetDisplayGeomOnScrollingLock( | | iLocked) |
-
Locks or unlocks the "display geometry on scrolling" mode.
Role: Locks or unlocks the "dislpay geometry on scrolling" mode 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 SetDisplayGeomOnScrolling
| public virtual SetDisplayGeomOnScrolling( | | iType) |
-
To set the "display geometry on scrolling" mode applied to the specification tree.
o SetOrientationLock
| public virtual SetOrientationLock( | | iLocked) |
-
Locks or unlocks the orientation applied to the specification tree .
Role: Locks or unlocks the orientation applied to the specification tree 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 SetOrientation
| public virtual SetOrientation( | | iOrientation) |
-
To set the orientation applied to the specification tree.
o SetShowActivationLock
| public virtual SetShowActivationLock( | | iLocked) |
-
Locks or unlocks the visualization Show/NoShow's mode applied to the specification tree.
Role: Locks or unlocks the visualization Show/NoShow's mode applied to the specification tree 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 SetShowActivation
| public virtual SetShowActivation( | | iType) |
-
To set the visualization Show/NoShow's mode applied to the specification tree.
o SetSizeTypeLock
| public virtual SetSizeTypeLock( | | iLocked) |
-
Locks or unlocks the type of size applied to the text of the specification tree .
Role: Locks or unlocks the type of size applied to the text of the specification tree if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
Attributs "size" and "SizeType" are linked together by the same
lock. So there is no function "SetSizeTypeLock".
- 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 SetSizeType
| public virtual SetSizeType( | | iSizeType) |
-
To set the type of size applied to the text of the specification tree.
o SetSize
| public virtual SetSize( | | iSize) |
-
To set the number of characters shown for the text of the specification tree.
o SetTypeLock
| public virtual SetTypeLock( | | iLocked) |
-
Locks or unlocks the type applied to the specification tree .
Role: Locks or unlocks the type applied to the specification tree 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 SetType
| public virtual SetType( | | iType) |
-
To set the type applied to the specification tree.
This object is included in the file: CATICafTreeVizManipSettingAtt.h
If needed, your Imakefile.mk should include the module: CATIAApplicationFrame