SALOME documentation central

SALOMEDS::AttributePixMap Interface Reference

PixMapAttribute. More...

Inheritance diagram for SALOMEDS::AttributePixMap:

Public Member Functions

boolean HasPixMap ()
string GetPixMap ()
void SetPixMap (in string 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

PixMapAttribute.

This attribute stores an icon which is put before the name of an item.


Member Function Documentation

boolean SALOMEDS::AttributePixMap::HasPixMap ( )

Returns True if there is an icon before the name of the given item.

string SALOMEDS::AttributePixMap::GetPixMap ( )

Returns the name of the icon in the format of a string.

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

void SALOMEDS::AttributePixMap::SetPixMap ( in string  value)

Sets the name of the icon.

Parameters:
valueThis string parameter defines the name of the icon.

See example14 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).