pycatia.in_interfaces.tree_viz_manip_setting_att

Module initially auto generated using V5Automation files from CATIA V5 R28 on 2020-06-11 12:40:47.360445

Warning

The notes denoted “CAA V5 Visual Basic Help” are to be used as reference only. They are there as a guide as to how the visual basic / catscript functions work and thus help debugging in pycatia.

class pycatia.in_interfaces.tree_viz_manip_setting_att.TreeVizManipSettingAtt(com_object)

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

System.IUnknown

System.IDispatch

System.CATBaseUnknown

System.CATBaseDispatch

System.AnyObject

System.SettingController

TreeVizManipSettingAtt

The Interface to retrieve and set the visual information on the specification

tree.

property arc_selection_activation: bool

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)

o Property ArcSelectionActivation() As boolean

Retrieves or Sets the arc-selection mode applied to the specification tree.

Return type:

bool

property auto_expand_activation: bool

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)

o Property AutoExpandActivation() As boolean

Retrieves or Sets the automatic expand mode applied to the specification

tree.

Return type:

bool

property auto_scroll_activation: bool

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)

o Property AutoScrollActivation() As boolean

Retrieves or Sets the automatic scrolling mode applied to the specification

tree.

Return type:

bool

property display_geom_on_scrolling: bool

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)

o Property DisplayGeomOnScrolling() As boolean

Retrieves or Sets the “display geometry on scrolling” mode.

Return type:

bool

get_arc_selection_activation_info(io_admin_level: str, io_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Func GetArcSelectionActivationInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for arc-selection mode applied to the

specification tree.

Role:Retrieves the state of arc-selection mode applied to the specification

tree in the current environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

get_auto_expand_activation_info(io_admin_level: str, io_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Func GetAutoExpandActivationInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for automatic expand mode applied to the

specification tree.

Role:Retrieves the state of automatic expand mode applied to the

specification tree in the current environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

get_auto_scroll_activation_info(io_admin_level: str, io_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Func GetAutoScrollActivationInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for automatic scrolling mode applied to

the specification tree.

Role:Retrieves the state of the automatic scrolling mode applied to the

specification tree in the current environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

get_display_geom_on_scrolling_info(io_admin_level: str, io_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Func GetDisplayGeomOnScrollingInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for “display geometry on scrolling”

mode.

Role:Retrieves the state of “display geometry on scrolling” mode in the

current environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

get_orientation_info(io_admin_level: str, io_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Func GetOrientationInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the orientation applied to the

specification tree.

Role:Retrieves the state of the orientation applied to the specification

tree in the current environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

get_show_activation_info(io_admin_level: str, io_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Func GetShowActivationInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the visualization Show/NoShow’s mode

applied to the specification tree.

Role:Retrieves the state of the visualization Show/NoShow’s mode applied to

the specification tree in the current environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

get_size_type_info(io_admin_level: str, io_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Func GetSizeTypeInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the type of size applied to the text

of the specification tree.

Role:Retrieves the state of the type of size applied to the text of the

specification tree in the current environment. Attributes “size” and “SizeType”

are linked together by the same lock. So there is no function

“GetSizeInfo”.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

get_type_info(io_admin_level: str, io_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Func GetTypeInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the type applied to the

specification tree.

Role:Retrieves the state of the type applied to the specification tree in

the current environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

property orientation: int

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)

o Property Orientation() As CatTreeOrientationEnum

Retrieves or Sets the orientation applied to the specification tree.

Returns:

enum cat_tree_orientation_enum

Return type:

int

set_arc_selection_activation_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Sub SetArcSelectionActivationLock(boolean iLocked)

Locks or unlocks the arc-selection mode applied to the specification

tree.

Role:Locks or unlocks the arc-selection mode applied to the specification

tree if it is possible in the current administrative context. In user mode this

method will always return E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

TRUE : to lock the parameter.

FALSE: to unlock the parameter.

Parameters:

i_locked (bool) –

Return type:

None

set_auto_expand_activation_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Sub SetAutoExpandActivationLock(boolean iLocked)

Locks or unlocks the automatic expand mode applied to the specification

tree.

Role:Locks or unlocks the automatic expand mode applied to the

specification tree if it is possible in the current administrative context. In

user mode this method will always return E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

TRUE : to lock the parameter.

FALSE: to unlock the parameter.

Parameters:

i_locked (bool) –

Return type:

None

set_auto_scroll_activation_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Sub SetAutoScrollActivationLock(boolean iLocked)

Locks or unlocks the automatic scrolling mode applied to the specification

tree.

Role:Locks or unlocks the automatic scrolling mode applied to the

specification tree if it is possible in the current administrative context. In

user mode this method will always return E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

TRUE : to lock the parameter.

FALSE: to unlock the parameter.

Parameters:

i_locked (bool) –

Return type:

None

set_display_geom_on_scrolling_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Sub SetDisplayGeomOnScrollingLock(boolean iLocked)

Locks or unlocks the “display geometry on scrolling” mode.

Role:Locks or unlocks “display geometry on scrolling” mode if it is

possible in the current administrative context. In user mode this method will

always return E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

TRUE : to lock the parameter.

FALSE: to unlock the parameter.

Parameters:

i_locked (bool) –

Return type:

None

set_orientation_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Sub SetOrientationLock(boolean iLocked)

Locks or unlocks the orientation applied to the specification

tree.

Role:Locks or unlocks the orientation applied to the specification tree if

it is possible in the current administrative context. In user mode this method

will always return E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

TRUE : to lock the parameter.

FALSE: to unlock the parameter.

Parameters:

i_locked (bool) –

Return type:

None

set_show_activation_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Sub SetShowActivationLock(boolean 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 it is possible in the current administrative context. In

user mode this method will always return E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

TRUE : to lock the parameter.

FALSE: to unlock the parameter.

Parameters:

i_locked (bool) –

Return type:

None

set_size_type_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Sub SetSizeTypeLock(boolean 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 it is possible in the current administrative context. 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:

TRUE : to lock the parameter.

FALSE: to unlock the parameter.

Parameters:

i_locked (bool) –

Return type:

None

set_type_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Sub SetTypeLock(boolean iLocked)

Locks or unlocks the type of the specification tree.

Role:Locks or unlocks the type applied to the specification tree if it is

possible in the current administrative context. In user mode this method will

always return E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

TRUE : to lock the parameter.

FALSE: to unlock the parameter.

Parameters:

i_locked (bool) –

Return type:

None

property show_activation: bool

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)

o Property ShowActivation() As boolean

Retrieves or Sets the visualization Show/NoShow’s mode applied to the

specification tree.

Return type:

bool

property size: int

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)

o Property Size() As long

Retrieves or Sets the number of characters shown for the text of the

specification tree.

Return type:

int

property size_type: int

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)

o Property SizeType() As CatTreeSizeTypeEnum

Retrieves or Sets the type of size applied to the text of the specification

tree.

Returns:

enum cat_tree_size_type_enum

Return type:

int

property type: int

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)

o Property Type() As CatTreeTypeEnum

Retrieves or Sets the type applied to the specification tree.

Returns:

enum cat_tree_type_enum

Return type:

int