Version: 8.3.0
SALOMEDS::AttributeTextHighlightColor Interface Reference

Text highlight color attribute. More...

import "SALOMEDS_Attributes.idl";

Inheritance diagram for SALOMEDS::AttributeTextHighlightColor:

Public Member Functions

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

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

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
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
SObject SALOMEDS::GenericAttribute::GetSObject ( )
inherited

Get SObject.

void SALOME::GenericObj::Register ( )
inherited

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

void SALOMEDS::AttributeTextHighlightColor::SetTextHighlightColor ( in Color  value)

Sets the value of the attribute.

Parameters
valuehighlight color value being set to the attribute
Color SALOMEDS::AttributeTextHighlightColor::TextHighlightColor ( )

Returns the value of the attribute.

Returns
highlight color assigned to the attribute
string SALOMEDS::GenericAttribute::Type ( )
inherited

Get Type.

void SALOME::GenericObj::UnRegister ( )
inherited

Decrease the reference count (release by another object).