All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

CATIAApplicationFrame Interface CATICafTreeVizManipSettingAtt

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---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 GetArcSelectionActivation(CATBoolean&)
To retrieve the arc-selection mode applied to the specification tree.
o GetArcSelectionActivationInfo(CATSettingInfo*)
Retrieves the state of the arc-selection mode applied to the specification tree.
o GetAutoExpandActivation(CATBoolean&)
To retrieve the automatic expand mode applied to the specification tree.
o GetAutoExpandActivationInfo(CATSettingInfo*)
Retrieves the state of the automatic expand mode applied to the specification tree.
o GetAutoScrollActivation(CATBoolean&)
To retrieve the automatic scrolling mode applied to the specification tree.
o GetAutoScrollActivationInfo(CATSettingInfo*)
Retrieves the state of the automatic scrolling mode applied to the specification tree.
o GetDisplayGeomOnScrolling(CATBoolean&)
To retrieve the "display geometry on scrolling" mode.
o GetDisplayGeomOnScrollingInfo(CATSettingInfo*)
Retrieves the state of the "display geometry on scrolling" mode applied to the specification tree.
o GetOrientation(CatTreeOrientationEnum&)
To retrieve the orientation applied to the specification tree.
o GetOrientationInfo(CATSettingInfo*)
Retrieves the state of the orientation parameter.
o GetShowActivation(CATBoolean&)
To retrieve the visualization Show/NoShow's mode applied to the specification tree.
o GetShowActivationInfo(CATSettingInfo*)
Retrieves the state of the visualization Show/NoShow's mode applied to the specification tree.
o GetSize(CATLONG&)
To retrieve the number of characters shown for the text of the specification tree.
o GetSizeType(CatTreeSizeTypeEnum&)
To retrieve the type of size applied to the text of the specification tree.
o GetSizeTypeInfo(CATSettingInfo*)
Retrieves the state of the type of size applied to the text of the specification tree.
o GetType(CatTreeTypeEnum&)
To retrieve the type applied to the specification tree.
o GetTypeInfo(CATSettingInfo*)
Retrieves the state of the type parameter.
o SetArcSelectionActivation(CATBoolean&)
To set the arc-selection mode applied to the specification tree.
o SetArcSelectionActivationLock(unsigned char)
Locks or unlocks the arc-selection mode applied to the specification tre.
o SetAutoExpandActivation(CATBoolean&)
To set the automatic expand mode applied to the specification tree.
o SetAutoExpandActivationLock(unsigned char)
Locks or unlocks the automatic expand mode.
o SetAutoScrollActivation(CATBoolean&)
To set the automatic scrolling mode applied to the specification tree.
o SetAutoScrollActivationLock(unsigned char)
Locks or unlocks the automatic scrolling mode applied to the specification tre.
o SetDisplayGeomOnScrolling(CATBoolean&)
To set the "display geometry on scrolling" mode applied to the specification tree.
o SetDisplayGeomOnScrollingLock(unsigned char)
Locks or unlocks the "display geometry on scrolling" mode.
o SetOrientation(CatTreeOrientationEnum&)
To set the orientation applied to the specification tree.
o SetOrientationLock(unsigned char)
Locks or unlocks the orientation applied to the specification tree .
o SetShowActivation(CATBoolean&)
To set the visualization Show/NoShow's mode applied to the specification tree.
o SetShowActivationLock(unsigned char)
Locks or unlocks the visualization Show/NoShow's mode applied to the specification tree.
o SetSize(CATLONG&)
To set the number of characters shown for the text of the specification tree.
o SetSizeType(CatTreeSizeTypeEnum&)
To set the type of size applied to the text of the specification tree.
o SetSizeTypeLock(unsigned char)
Locks or unlocks the type of size applied to the text of the specification tree .
o SetType(CatTreeTypeEnum&)
To set the type applied to the specification tree.
o SetTypeLock(unsigned char)
Locks or unlocks the type applied to the specification tree .

Methods


o GetArcSelectionActivation
public virtual HRESULT GetArcSelectionActivation(CATBoolean& oType) = 0
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 GetArcSelectionActivationInfo
public virtual HRESULT GetArcSelectionActivationInfo(CATSettingInfo* ioTypeInfo) = 0
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 GetAutoExpandActivation
public virtual HRESULT GetAutoExpandActivation(CATBoolean& oType) = 0
To retrieve the automatic expand mode applied to the specification tree.
o GetAutoExpandActivationInfo
public virtual HRESULT GetAutoExpandActivationInfo(CATSettingInfo* ioTypeInfo) = 0
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 GetAutoScrollActivation
public virtual HRESULT GetAutoScrollActivation(CATBoolean& oType) = 0
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 GetAutoScrollActivationInfo
public virtual HRESULT GetAutoScrollActivationInfo(CATSettingInfo* ioTypeInfo) = 0
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 GetDisplayGeomOnScrolling
public virtual HRESULT GetDisplayGeomOnScrolling(CATBoolean& oType) = 0
To retrieve the "display geometry on scrolling" mode.
o GetDisplayGeomOnScrollingInfo
public virtual HRESULT GetDisplayGeomOnScrollingInfo(CATSettingInfo* ioTypeInfo) = 0
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 GetOrientation
public virtual HRESULT GetOrientation(CatTreeOrientationEnum& oOrientation) = 0
To retrieve the orientation applied to the specification tree.
o GetOrientationInfo
public virtual HRESULT GetOrientationInfo(CATSettingInfo* ioOrientationInfo) = 0
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 GetShowActivation
public virtual HRESULT GetShowActivation(CATBoolean& oType) = 0
To retrieve the visualization Show/NoShow's mode applied to the specification tree.
o GetShowActivationInfo
public virtual HRESULT GetShowActivationInfo(CATSettingInfo* ioTypeInfo) = 0
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 GetSize
public virtual HRESULT GetSize(CATLONG& oSize) = 0
To retrieve the number of characters shown for the text of the specification tree.
o GetSizeType
public virtual HRESULT GetSizeType(CatTreeSizeTypeEnum& oSizeType) = 0
To retrieve the type of size applied to the text of the specification tree.
o GetSizeTypeInfo
public virtual HRESULT GetSizeTypeInfo(CATSettingInfo* ioSizeTypeInfo) = 0
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 GetType
public virtual HRESULT GetType(CatTreeTypeEnum& oType) = 0
To retrieve the type applied to the specification tree.
o GetTypeInfo
public virtual HRESULT GetTypeInfo(CATSettingInfo* ioTypeInfo) = 0
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 SetArcSelectionActivation
public virtual HRESULT SetArcSelectionActivation(CATBoolean& iType) = 0
To set the arc-selection mode applied to the specification tree.
o SetArcSelectionActivationLock
public virtual HRESULT SetArcSelectionActivationLock(unsigned char iLocked)= 0
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 SetAutoExpandActivation
public virtual HRESULT SetAutoExpandActivation(CATBoolean& iType) = 0
To set the automatic expand mode applied to the specification tree.
o SetAutoExpandActivationLock
public virtual HRESULT SetAutoExpandActivationLock(unsigned char iLocked)= 0
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 SetAutoScrollActivation
public virtual HRESULT SetAutoScrollActivation(CATBoolean& iType) = 0
To set the automatic scrolling mode applied to the specification tree.
o SetAutoScrollActivationLock
public virtual HRESULT SetAutoScrollActivationLock(unsigned char iLocked)= 0
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 SetDisplayGeomOnScrolling
public virtual HRESULT SetDisplayGeomOnScrolling(CATBoolean& iType) = 0
To set the "display geometry on scrolling" mode applied to the specification tree.
o SetDisplayGeomOnScrollingLock
public virtual HRESULT SetDisplayGeomOnScrollingLock(unsigned char iLocked)= 0
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 SetOrientation
public virtual HRESULT SetOrientation(CatTreeOrientationEnum& iOrientation) = 0
To set the orientation applied to the specification tree.
o SetOrientationLock
public virtual HRESULT SetOrientationLock(unsigned char iLocked)= 0
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 SetShowActivation
public virtual HRESULT SetShowActivation(CATBoolean& iType) = 0
To set the visualization Show/NoShow's mode applied to the specification tree.
o SetShowActivationLock
public virtual HRESULT SetShowActivationLock(unsigned char iLocked)= 0
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 SetSize
public virtual HRESULT SetSize(CATLONG& iSize) = 0
To set the number of characters shown for the text of the specification tree.
o SetSizeType
public virtual HRESULT SetSizeType(CatTreeSizeTypeEnum& iSizeType) = 0
To set the type of size applied to the text of the specification tree.
o SetSizeTypeLock
public virtual HRESULT SetSizeTypeLock(unsigned char iLocked)= 0
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 SetType
public virtual HRESULT SetType(CatTreeTypeEnum& iType) = 0
To set the type applied to the specification tree.
o SetTypeLock
public virtual HRESULT SetTypeLock(unsigned char iLocked)= 0
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

This object is included in the file: CATICafTreeVizManipSettingAtt.h
If needed, your Imakefile.mk should include the module: CATIAApplicationFrame

Copyright © 2003, Dassault Systèmes. All rights reserved.