Version: 9.12.0
SALOMEDS::AttributeTextColor Interface Reference

Text color attribute. More...

import"SALOMEDS_Attributes.idl";

Inheritance diagram for SALOMEDS::AttributeTextColor:

Public Member Functions

Color TextColor ()
 Returns the value of the attribute. More...
 
void SetTextColor (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 color attribute.

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

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

See also
AttributeTextHighlightColor, AttributePixMap

Member Function Documentation

◆ CheckLocked()

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.

◆ Destroy()

void SALOME::GenericObj::Destroy ( )
inherited

Obsolete, left for compatibility reasons only.

Use UnRegister() instead.

◆ GetClassType()

string SALOMEDS::GenericAttribute::GetClassType ( )
inherited

Get the class type.

◆ GetLocalImpl()

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

◆ GetSObject()

SObject SALOMEDS::GenericAttribute::GetSObject ( )
inherited

Get SObject.

◆ Register()

void SALOME::GenericObj::Register ( )
inherited

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

◆ SetTextColor()

void SALOMEDS::AttributeTextColor::SetTextColor ( in Color  value)

Sets the value of the attribute.

Parameters
valuetext color value being set to the attribute

◆ TextColor()

Color SALOMEDS::AttributeTextColor::TextColor ( )

Returns the value of the attribute.

Returns
text color assigned to the attribute

◆ Type()

string SALOMEDS::GenericAttribute::Type ( )
inherited

Get Type.

◆ UnRegister()

void SALOME::GenericObj::UnRegister ( )
inherited

Decrease the reference count (release by another object).

Referenced by SALOME_PyNode.Generic::Destroy().