SALOME documentation central

SALOMEDS::AttributeOpened Interface Reference

Opened flag Attribute. More...

Inheritance diagram for SALOMEDS::AttributeOpened:

Public Member Functions

boolean IsOpened ()
void SetOpened (in boolean value)
void CheckLocked () raises (LockProtection)
 Method CheckLocked.
string Type ()
 Get Type.
string GetClassType ()
 Get the class type.
SObject GetSObject ()
 Get SObject.
long long GetLocalImpl (in string theHostname, in long thePID, out boolean isLocal)
 Private method, returns an implementation of this GenericAttribute.
void Register ()
 Increase the reference count (mark as used by another object).
void Destroy ()
 Decrease the reference count (release by another object).

Detailed Description

Opened flag Attribute.

This is a presentation attribute necessary for display of the study tree in the browser. It sets this item to be open (its children are visible) if bool is TRUE, and to be closed (its children are not visible) if bool is FALSE.


Member Function Documentation

boolean SALOMEDS::AttributeOpened::IsOpened ( )

Returns TRUE if this item is open (its children are visible) and FALSE if it isn't.

See example11 for an example of this method usage in batchmode of SALOME application.

void SALOMEDS::AttributeOpened::SetOpened ( in boolean  value)

Sets this item to be open (its children are visible)

Parameters:
valueIf the value of this boolean parameter is TRUE this item will be set as open, and as closed if FALSE.

See example11 for an example of this method usage in batchmode of SALOME application.

void SALOMEDS::GenericAttribute::CheckLocked ( ) raises (LockProtection) [inherited]

Method CheckLocked.

Checks whether the Study is protected for modifications.

Note:

This exception is raised only outside a transaction.
string SALOMEDS::GenericAttribute::Type ( ) [inherited]

Get Type.

string SALOMEDS::GenericAttribute::GetClassType ( ) [inherited]

Get the class type.

SObject SALOMEDS::GenericAttribute::GetSObject ( ) [inherited]

Get SObject.

long long SALOMEDS::GenericAttribute::GetLocalImpl ( in string  theHostname,
in long  thePID,
out boolean  isLocal 
) [inherited]

Private method, returns an implementation of this GenericAttribute.

Parameters:
theHostnameis a hostname of the caller
thePIDis a process ID of the caller
isLocalis set True if the GenericAttribute is launched locally with the caller
void SALOME::GenericObj::Register ( ) [inherited]

Increase the reference count (mark as used by another object).

void SALOME::GenericObj::Destroy ( ) [inherited]

Decrease the reference count (release by another object).