All Frameworks Class Hierarchy This Framework Previous Next Indexes
CATIAApplicationFrame Interface CATICafTreeSettingAtt
System.IUnknown
|
+---CATICafTreeSettingAtt
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATICafTreeSettingAtt
Interface to retrieve and set the information on the specification tree.
- See also:
- GetCATCafTreeSettingCtrl, CATIIniSettingManagment
Method Index
- o
GetArcSelectionActivation(CATBoolean&)
- To retrieve the arc-selection mode applied to the specification tree.
- o
GetArcSelectionSettingInfo(CATSettingInfo&)
- To retrieve a CATSettingInfo on the parameter concerning the arc-selection mode.
- o
GetAutoExpandActivation(CATBoolean&)
- To retrieve the auto-expand mode applied to the specification tree.
- o
GetAutoExpandSettingInfo(CATSettingInfo&)
- To retrieve a CATSettingInfo on the parameter concerning the auto-expansion mode.
- o
GetAutoScrollActivation(CATBoolean&)
- To retrieve the auto-scrolling mode applied to the specification tree.
- o
GetAutoScrollSettingInfo(CATSettingInfo&)
- To retrieve a CATSettingInfo on the parameter concerning the auto-scroll mode.
- o
GetOrientation(CATICafTreeSettingAtt::Orientation&)
- To retrieve the orientation applied to the specification tree.
- o
GetOrientationSettingInfo(CATSettingInfo&)
- To retrieve a CATSettingInfo on the orientation parameter.
- o
GetShowActivation(CATBoolean&)
- To retrieve the visualization Show/NoShow's mode applied to the specification tree.
- o
GetShowSettingInfo(CATSettingInfo&)
- To retrieve a CATSettingInfo on the parameter concerning the Show/NoShow's mode.
- o
GetSize(int&)
- To retrieve the number of characters shown for the text of the
specification tree.
- o
GetSizeType(CATICafTreeSettingAtt::SizeType&)
- To retrieve the type of size applied to the text of the specification tree.
- o
GetSizeTypeSettingInfo(CATSettingInfo*&,int&)
- To retrieve an array of CATSettingInfo on the parameter representing the type of size.
- o
GetType(CATICafTreeSettingAtt::Type&)
- To retrieve the type applied to the specification tree.
- o
GetTypeSettingInfo(CATSettingInfo&)
- To retrieve a CATSettingInfo on the type parameter.
- o
SetArcSelectionActivation(CATBoolean&)
- To set the arc-selection mode to be applied to the specification tree.
- o
SetAutoExpandActivation(CATBoolean&)
- To set the auto-expand mode to be applied to the specification tree.
- o
SetAutoScrollActivation(CATBoolean&)
- To set the auto-scrolling mode to be applied to the specification tree.
- o
SetOrientation(CATICafTreeSettingAtt::Orientation&)
- To set the orientation applied to the specification tree.
- o
SetShowActivation(CATBoolean&)
- To set the visualization Show/NoShow's mode to be applied to the specification tree.
- o
SetSizeType(CATICafTreeSettingAtt::SizeType&,int)
- To set the type of size applied to the text of the specification tree.
- o
SetType(CATICafTreeSettingAtt::Type&)
- To set the type applied to the specification tree.
Enumerated Type Index
- o
Orientation
- Enumeration of available orientations for the specification tree.
- o
SizeType
- Enumeration of available types for the size of the text
in the specification tree.
- o
Type
- Enumeration of available types for the specification tree.
Methods
o GetArcSelectionActivation
-
To retrieve the arc-selection mode applied to the specification tree.
If this mode is enabled, a simple click onto an arc of the tree, will switch from the document viewpoint to the tree viewpoint, or vice-versa.
If this mode is disabled, you can still switch back and forth by clicking onto the bottom right compass.
- Parameters:
-
- oStatus
- TRUE, if the mode is activated
FALSE, otherwise
- Returns:
- a HRESULT value
o GetArcSelectionSettingInfo
-
To retrieve a CATSettingInfo on the parameter concerning the arc-selection mode.
- Parameters:
-
- oArcSelectionInfo
- A
CATSettingInfo class embeds all the necessary information concerning a parameter stored in a .CATSetting file.
- Returns:
- a HRESULT value
o GetAutoExpandActivation
-
To retrieve the auto-expand mode applied to the specification tree.
Role: This mode enables the automatic expansion of the tree when a document is opened.
- Parameters:
-
- oStatus
- TRUE, if the mode is activated
FALSE, otherwise
- Returns:
- a HRESULT value
o GetAutoExpandSettingInfo
-
To retrieve a CATSettingInfo on the parameter concerning the auto-expansion mode.
- Parameters:
-
- oAutoExpansionInfo
- A
CATSettingInfo class embeds all the necessary information concerning a parameter stored in a .CATSetting file.
- Returns:
- a HRESULT value
o GetAutoScrollActivation
-
To retrieve the auto-scrolling mode applied to the specification tree.
Role: This mode enables the automatic scroll of the tree when a Drag&Drop operation is performed.
- Parameters:
-
- oStatus
- TRUE, if the mode is activated
FALSE, otherwise
- Returns:
- a HRESULT value
o GetAutoScrollSettingInfo
-
To retrieve a CATSettingInfo on the parameter concerning the auto-scroll mode.
- Parameters:
-
- oAutoScrollInfo
- A
CATSettingInfo class embeds all the necessary information concerning a parameter stored in a .CATSetting file.
- Returns:
- a HRESULT value
o GetOrientation
public virtual HRESULT GetOrientation( | CATICafTreeSettingAtt::Orientation& | oOrientation) = 0 |
-
To retrieve the orientation applied to the specification tree.
- Parameters:
-
- oOrientation
- The orientation of the specification tree.
- Returns:
- a HRESULT value
o GetOrientationSettingInfo
-
To retrieve a CATSettingInfo on the orientation parameter.
- Parameters:
-
- oOrientationInfo
- A
CATSettingInfo class embeds all the necessary information concerning a parameter stored in a .CATSetting file.
- Returns:
- a HRESULT value
o GetShowActivation
-
To retrieve the visualization Show/NoShow's mode applied to the specification tree.
- Parameters:
-
- oStatus
- TRUE, if the mode is activated
FALSE, otherwise
- Returns:
- a HRESULT value
o GetShowSettingInfo
-
To retrieve a CATSettingInfo on the parameter concerning the Show/NoShow's mode.
- Parameters:
-
- oShowInfo
- A
CATSettingInfo class embeds all the necessary information concerning a parameter stored in a .CATSetting file.
- Returns:
- a HRESULT value
o GetSize
public virtual HRESULT GetSize( | int& | oSize) = 0 |
-
To retrieve the number of characters shown for the text of the
specification tree.
- Returns:
- E_FAIL if the type of size is not FixedSize.
S_OK otherwise.
- Parameters:
-
- oSize
- The number of characters shown in the specification tree.
o GetSizeType
public virtual HRESULT GetSizeType( | CATICafTreeSettingAtt::SizeType& | oSizeType) = 0 |
-
To retrieve the type of size applied to the text of the specification tree.
- Parameters:
-
- oSizeType
- The type of size applied to the text of the specification tree.
- Returns:
- a HRESULT value
o GetSizeTypeSettingInfo
-
To retrieve an array of CATSettingInfo on the parameter representing the type of size.
- Parameters:
-
- oSettingInfoArray
- An array of
CATSettingInfo, which items embed all the necessary information concerning a parameter stored in a .CATSetting file.
- oNbOfAttributes
- The size of this array.
- Returns:
- a HRESULT value
o GetType
public virtual HRESULT GetType( | CATICafTreeSettingAtt::Type& | oType) = 0 |
-
To retrieve the type applied to the specification tree.
- Parameters:
-
- oType
- The type of the specification tree
o GetTypeSettingInfo
-
To retrieve a CATSettingInfo on the type parameter.
- Parameters:
-
- oTypeInfo
- A
CATSettingInfo class embeds all the necessary information concerning a parameter stored in a .CATSetting file.
o SetArcSelectionActivation
-
To set the arc-selection mode to be applied to the specification tree.
If this mode is enabled, a simple click onto an arc of the tree will switch from the document viewpoint to the tree viewpoint, or vice-versa.
If this mode is disabled, you can still switch back and forth by clicking onto the bottom right compass.
- Parameters:
-
- iStatus
- TRUE, to activate this mode
FALSE, otherwise
- Returns:
- a HRESULT value
o SetAutoExpandActivation
-
To set the auto-expand mode to be applied to the specification tree.
Role: This mode enables the automatic expansion of the tree when a document is opened.
- Parameters:
-
- iStatus
- TRUE, if the mode is activated
FALSE, otherwise
- Returns:
- a HRESULT value
o SetAutoScrollActivation
-
To set the auto-scrolling mode to be applied to the specification tree.
Role: This mode enables the automatic scroll of the tree when a Drag&Drop operation is performed.
- Parameters:
-
- iStatus
- TRUE, if the mode is activated
FALSE, otherwise
- Returns:
- a HRESULT value
o SetOrientation
public virtual HRESULT SetOrientation( | CATICafTreeSettingAtt::Orientation& | iOrientation) = 0 |
-
To set the orientation applied to the specification tree.
- Parameters:
-
- iOrientation
- The orientation of the specification tree.
- Returns:
- a HRESULT value
o SetShowActivation
-
To set the visualization Show/NoShow's mode to be applied to the specification tree.
- Parameters:
-
- iStatus
- TRUE, if the mode is to be activated
FALSE, otherwise
- Returns:
- a HRESULT value
o SetSizeType
public virtual HRESULT SetSizeType( | CATICafTreeSettingAtt::SizeType& | iSizeType, |
| int | iSize | =0) = 0 |
-
To set the type of size applied to the text of the specification tree.
- Parameters:
-
- iSizeType
- The type of size applied to the text of the specification tree.
- iSize
- If the style is FixedSize, iSize represents the number of fixed characters to be shown. The value cannot be 0.
If the style is TextDependentStyle, this argument is to be omitted.
- Returns:
- a HRESULT value
o SetType
public virtual HRESULT SetType( | CATICafTreeSettingAtt::Type& | iType) = 0 |
-
To set the type applied to the specification tree.
- Parameters:
-
- iType
- The type of the specification tree
Enumerated Types
o Orientation
-
enum Orientation {
Vertical,
Horizontal
}
Enumeration of available orientations for the specification tree.
The following orientations are allowed:
- Parameters:
-
- Vertical
- The tree is oriented vertically.
- Horizontal
- The tree is oriented horizontally.
o SizeType
-
enum SizeType {
FixedSize,
TextDependentSize
}
Enumeration of available types for the size of the text
in the specification tree.
The following types for the size are allowed:
- Parameters:
-
- FixedSize
- Only a fixed number of characters are shown in the specification tree,
for the names of its items.
- TextDependentSize
- The integrality of each item's name is shown.
o Type
-
enum Type {
Classical,
Structural,
Historical,
Relational
}
Enumeration of available types for the specification tree.
The following types are allowed:
- Parameters:
-
- Classical
- Classical Windows style tree.
- Structural
- Structure-oriented representation of the tree.
- Historical
- Constructive historic representation of the tree.
- Relational
- Relation-oriented representation of the tree.
This object is included in the file: CATICafTreeSettingAtt.h
If needed, your Imakefile.mk should include the module: CATIAApplicationFrame