Version: 6.3.1

SALOMEDS::AttributePixMap Interface Reference

Icon attribute. More...

Inheritance diagram for SALOMEDS::AttributePixMap:
Inheritance graph

Public Member Functions

boolean HasPixMap ()
string GetPixMap ()
 Returns the value of the attribute.
void SetPixMap (in string value)
 Sets the value of the attribute.
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 UnRegister ()
 Decrease the reference count (release by another object).
void Destroy ()
 Obsolete, left for compatibility reasons only. Use UnRegister() instead.

Detailed Description

Icon attribute.

This attribute is used to specifiy the name (file name) of an icon which should be drawn in the Object browser when rendering an item.

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

See also:
AttributeTextColor, AttributeTextHighlightColor

Member Function Documentation

boolean SALOMEDS::AttributePixMap::HasPixMap ( )

Checks if the pixmap is assigned to the attribute.

Returns:
true if an icon file name is set to the attribute
string SALOMEDS::AttributePixMap::GetPixMap ( )

Returns the value of the attribute.

Returns:
icon file name assigned to the attribute (empty string if not set)
void SALOMEDS::AttributePixMap::SetPixMap ( in string  value)

Sets the value of the attribute.

Parameters:
icomfile name being set to the attribute
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::UnRegister ( ) [inherited]

Decrease the reference count (release by another object).

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

Obsolete, left for compatibility reasons only. Use UnRegister() instead.

Copyright © 2007-2011 CEA/DEN, EDF R&D, OPEN CASCADE
Copyright © 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN, CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS