SALOMEDS::AttributeTextHighlightColor Interface Reference

Text highlight color attribute. More...

Inheritance diagram for SALOMEDS::AttributeTextHighlightColor:

Public Member Functions
Color	TextHighlightColor ()
	Returns the value of the attribute.
void	SetTextHighlightColor (in Color 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

Text highlight color attribute.

This attribute allows to specify the highlight color to be used to render the item in the Object browser (used only when the item is selected). If the attribute is not set for the SObject, default value (GUI specific) is used.

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

See also:

AttributeTextColor, AttributePixMap

---

Member Function Documentation

Color SALOMEDS::AttributeTextHighlightColor::TextHighlightColor

(

)

Returns the value of the attribute.

Returns:

highlight color assigned to the attribute

void SALOMEDS::AttributeTextHighlightColor::SetTextHighlightColor

(

in Color

value

)

Sets the value of the attribute.

Parameters:

value

highlight color value 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:

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

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.