nsISVGGlyphGeometrySource

IID:b36065f1-c52b-4eda-b9ad-e483cf1a63bf
Inherits From:nsISVGGlyphMetricsSource

\addtogroup rendering_backend_interfaces Rendering Backend Interfaces Abstracts a description of a 'composite glyph' (character string with associated font and styling information) in the SVG rendering backend for use by a rendering engine's nsISVGRendererGlyphGeometry objects. In addition to the attributes of the nsISVGGlyphMetricsSource interface, this interface contains absolute positioning and other information, such as e.g. individual character highlighting, which doesn't affect the actual metrics of the glyph. The metrics of the glyph, as given by the rendering engine-native object implementing nsISVGRendererGlyphMetrics are also provided as an attribute.

An engine-native glyph geometry object will be informed of changes in its associated composite glyph with a call to its nsISVGRendererGlyphMetrics::update() method with an OR-ed combination of the UPDATEMASK_* constants defined in this interface (and its base-interface).


Constants

PRUint32 UPDATEMASK_METRICS = 262144
PRUint32 UPDATEMASK_X = 524288
PRUint32 UPDATEMASK_Y = 1048576
PRUint32 UPDATEMASK_HAS_HIGHLIGHT = 2097152
PRUint32 UPDATEMASK_HIGHLIGHT = 4194304

Properties

readonly PRBool hasHighlight

readonly nsISVGRendererGlyphMetrics metrics

readonly float x

readonly float y


Methods

[noscript] void getHighlight ( out PRUint32 charnum , out PRUint32 nchars , out nscolor foreground , out nscolor background )

void getHighlight ( out PRUint32 charnum , out PRUint32 nchars , out nscolor foreground , out nscolor background )

Arguments:
charnum
nchars
foreground
background

References

This interface is passed as an argument to the following methods:

nsISVGRenderer.createGlyphGeometry

Reference documentation is generated from Mozilla's source.

Add a note User Contributed Notes
No comments available

Copyright © 1999 - 2005 XULPlanet.com