Version: 9.12.0
SALOMEDS::AttributeExpandable Interface Reference

Expandable flag attribute. More...

import"SALOMEDS_Attributes.idl";

Inheritance diagram for SALOMEDS::AttributeExpandable:

Public Member Functions

boolean IsExpandable ()
 Returns the value of the attribute. More...
 
void SetExpandable (in boolean value)
 Sets the value of the attribute. More...
 
void CheckLocked () raises (LockProtection)
 Method CheckLocked. More...
 
string Type ()
 Get Type. More...
 
string GetClassType ()
 Get the class type. More...
 
SObject GetSObject ()
 Get SObject. More...
 
long long GetLocalImpl (in string theHostname, in long thePID, out boolean isLocal)
 Private method, returns an implementation of this GenericAttribute. More...
 
void Register ()
 Increase the reference count (mark as used by another object). More...
 
void UnRegister ()
 Decrease the reference count (release by another object). More...
 
void Destroy ()
 Obsolete, left for compatibility reasons only. More...
 

Detailed Description

Expandable flag attribute.

This presentation attribute specifies if the parent SObject can be expanded by the user in the Object browser (to show its child objects). If this attribute is defined for the parent object and set to false, the item is not expandable in the Object browser. By default, the item is always expandable (if it has children).

See example10 for an example of this attribute usage in batchmode of SALOME application.

See also
AttributeDrawable, AttributeSelectable

Member Function Documentation

◆ CheckLocked()

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.

◆ Destroy()

void SALOME::GenericObj::Destroy ( )
inherited

Obsolete, left for compatibility reasons only.

Use UnRegister() instead.

◆ GetClassType()

string SALOMEDS::GenericAttribute::GetClassType ( )
inherited

Get the class type.

◆ GetLocalImpl()

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

◆ GetSObject()

SObject SALOMEDS::GenericAttribute::GetSObject ( )
inherited

Get SObject.

◆ IsExpandable()

boolean SALOMEDS::AttributeExpandable::IsExpandable ( )

Returns the value of the attribute.

Returns
true if the item is expandable or false otherwise

◆ Register()

void SALOME::GenericObj::Register ( )
inherited

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

◆ SetExpandable()

void SALOMEDS::AttributeExpandable::SetExpandable ( in boolean  value)

Sets the value of the attribute.

Parameters
valuevalue being set to the attribute (true if item should be expandable or false otherwise)

◆ Type()

string SALOMEDS::GenericAttribute::Type ( )
inherited

Get Type.

◆ UnRegister()

void SALOME::GenericObj::UnRegister ( )
inherited

Decrease the reference count (release by another object).

Referenced by SALOME_PyNode.Generic::Destroy().