SALOMEDS::AttributePixMap Interface Reference

Icon attribute. More...

import "SALOMEDS_Attributes.idl";

Inheritance diagram for SALOMEDS::AttributePixMap:

Public Member Functions
boolean	HasPixMap ()
	Checks if the pixmap is assigned to the attribute. More...
string	GetPixMap ()
	Returns the value of the attribute. More...
void	SetPixMap (in string 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

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

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.

void SALOME::GenericObj::Destroy ( )

inherited

Obsolete, left for compatibility reasons only.

Use UnRegister() instead.

string SALOMEDS::GenericAttribute::GetClassType ( )

inherited

Get the class type.

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

inherited

Private method, returns an implementation of this GenericAttribute.

Parameters

theHostname	is a hostname of the caller
thePID	is a process ID of the caller
isLocal	is set True if the GenericAttribute is launched locally with the caller

string SALOMEDS::AttributePixMap::GetPixMap

(

)

Returns the value of the attribute.

Returns

icon file name assigned to the attribute (empty string if not set)

SObject SALOMEDS::GenericAttribute::GetSObject ( )

inherited

Get SObject.

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

void SALOME::GenericObj::Register ( )

inherited

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

void SALOMEDS::AttributePixMap::SetPixMap

(

in string

value

)

Sets the value of the attribute.

Parameters

icom	file name being set to the attribute

string SALOMEDS::GenericAttribute::Type ( )

inherited

Get Type.

void SALOME::GenericObj::UnRegister ( )

inherited

Decrease the reference count (release by another object).