Trees       Indices       Help   
PyCIM
Package CIM15 :: Package IEC61970 :: Package Informative :: Package InfGMLSupport :: Module GmlHalo' :: Class GmlHalo
[hide private]
[frames] | no frames]

Class GmlHalo

                         object --+        
                                  |        
                   Element'.Element --+    
                                      |    
Core.IdentifiedObject'.IdentifiedObject --+
                                          |
                                         GmlHalo

A type of Fill that is applied to the backgrounds of font glyphs. The use of halos greatly improves the readability of text labels.A type of Fill that is applied to the backgrounds of font glyphs. The use of halos greatly improves the readability of text labels.

Instance Methods [hide private]
 
__init__(self, radius='', opacity=0.0, GmlTextSymbols=None, *args, **kw_args)
Initialises a new 'GmlHalo' instance.
 
addGmlTextSymbols(self, *GmlTextSymbols)
 
getGmlTextSymbols(self)
 
removeGmlTextSymbols(self, *GmlTextSymbols)
 
setGmlTextSymbols(self, value)

Inherited from Core.IdentifiedObject'.IdentifiedObject: addDiagramObjects, addNames, getDiagramObjects, getModelingAuthoritySet, getNames, removeDiagramObjects, removeNames, setDiagramObjects, setModelingAuthoritySet, setNames

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Class Variables [hide private]
  _attr_types = {'opacity': <type 'float'>, 'radius': <type 'str'>}
  _attrs = ['radius', 'opacity']
  _defaults = {'opacity': 0.0, 'radius': ''}
  _many_refs = ['GmlTextSymbols']
  _refs = ['GmlTextSymbols']

Inherited from Element'.Element (private): _enums

Properties [hide private]
  GmlTextSymbols

Inherited from Core.IdentifiedObject'.IdentifiedObject: DiagramObjects, ModelingAuthoritySet, Names

Inherited from object: __class__

Method Details [hide private]

__init__(self, radius='', opacity=0.0, GmlTextSymbols=None, *args, **kw_args)
(Constructor)

 

Initialises a new 'GmlHalo' instance.

Parameters:
  • radius - The Radius element gives the absolute size of a halo radius in pixels encoded as a floating-point number. The radius is taken from the outside edge of a font glyph to extend the area of coverage of the glyph (and the inside edge of ?holes? in the glyphs). The default radius is one pixel. Negative values are not allowed.
  • opacity - Specifies the level of translucency to use when rendering the Fill. The value is encoded as a floating-point value between 0.0 and 1.0 with 0.0 representing completely transparent and 1.0 representing completely opaque, with a linear scale of translucency for intermediate values. The default value is 1.0
  • GmlTextSymbols
Overrides: object.__init__

Property Details [hide private]

GmlTextSymbols

Get Method:
getGmlTextSymbols(self)
Set Method:
setGmlTextSymbols(self, value)

   Trees       Indices       Help   
PyCIM
Generated by Epydoc 3.0.1 on Sat Jul 2 18:27:48 2011 http://epydoc.sourceforge.net