pycatia.in_interfaces.general_session_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.general_session_setting_att.GeneralSessionSettingAtt(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

GeneralSessionSettingAtt

Setting controller for the General property tab page.

Role: This interface is implemented by a component which represents the

controller of the general settings.

property auto_save: int

Note

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

o Property AutoSave() As CATGenDataSave

Returns the data save parameter.

Returns:

enum cat_gen_data_save

Return type:

int

property conferencing: int

Note

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

o Property Conferencing() As CATGenConferencing

Returns the conference driver parameter.

Returns:

enum cat_gen_conferencing

Return type:

int

property drag_drop: bool

Note

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

o Property DragDrop() As boolean

Returns the drag & drop parameter.

Return type:

bool

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

Note

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

o Func GetAutoSaveInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the data save

parameter.

Role:Retrieves the state of the data save parameter 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_conferencing_info(io_admin_level: str, io_locked: str) → bool

Note

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

o Func GetConferencingInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the conference driver

parameter.

Role:Retrieves the state of the conference driver parameter 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_drag_drop_info(io_admin_level: str, io_locked: str) → bool

Note

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

o Func GetDragDropInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the drag & drop

parameter.

Role:Retrieves the state of the drag & drop parameter 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_ref_doc_info(io_admin_level: str, io_locked: str) → bool

Note

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

o Func GetRefDocInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the referenced documents

parameter.

Role:Retrieves the state of the referenced documents parameter 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_ui_style_info(io_admin_level: str, io_locked: str) → bool

Note

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

o Func GetUIStyleInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the user interface style

parameter.

Role:Retrieves the state of the user interface style parameter 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 ref_doc: bool

Note

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

o Property RefDoc() As boolean

Returns the referenced documents parameter.

Return type:

bool

set_auto_save_lock(i_locked: bool) → None

Note

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

o Sub SetAutoSaveLock(boolean iLocked)

Locks or unlocks the data save parameter.

Role:Locks or unlocks the data save parameter 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_conferencing_lock(i_locked: bool) → None

Note

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

o Sub SetConferencingLock(boolean iLocked)

Locks or unlocks the conference driver parameter.

Role:Locks or unlocks the conference driver parameter 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_drag_drop_lock(i_locked: bool) → None

Note

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

o Sub SetDragDropLock(boolean iLocked)

Locks or unlocks the drag & drop parameter.

Role:Locks or unlocks the drag & drop parameter 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_ref_doc_lock(i_locked: bool) → None

Note

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

o Sub SetRefDocLock(boolean iLocked)

Locks or unlocks the referenced documents parameter.

Role:Locks or unlocks the referenced documents parameter 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_ui_style_lock(i_locked: bool) → None

Note

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

o Sub SetUIStyleLock(boolean iLocked)

Locks or unlocks the user interface style parameter.

Role:Locks or unlocks the user interface style parameter 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 time_roll: int

Note

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

o Property TimeRoll() As long

Returns the data save parameter (in milliseconds).

Return type:

int

property ui_style: int

Note

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

o Property UIStyle() As CATGenUIStyle

Returns the user interface style parameter.

Returns:

enum cat_gen_ui_style

Return type:

int