nsISVGGlyphGeometrySource Interface Reference
[Rendering Backend Interfaces]

import "nsISVGGlyphGeometrySource.idl";

Inheritance diagram for nsISVGGlyphGeometrySource:

[legend]Collaboration diagram for nsISVGGlyphGeometrySource:

[legend]List of all members.

---

Detailed Description

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).

Definition at line 70 of file nsISVGGlyphGeometrySource.idl.

Partial highlighting for selection feedback

• void getHighlight (out unsigned long charnum, out unsigned long nchars, out nscolor foreground, out nscolor background)
• readonly attribute boolean hasHighlight
• const unsigned long UPDATEMASK_HAS_HIGHLIGHT = 0x00200000
• const unsigned long UPDATEMASK_HIGHLIGHT = 0x00400000

Glyph metrics

• readonly attribute nsISVGRendererGlyphMetrics metrics
• const unsigned long UPDATEMASK_METRICS = 0x00040000

Glyph start position

• readonly attribute float x
• const unsigned long UPDATEMASK_X = 0x00080000
• readonly attribute float y
• const unsigned long UPDATEMASK_Y = 0x00100000

---

Member Function Documentation

void nsISVGGlyphGeometrySource::getHighlight (  out unsigned long  charnum, out unsigned long  nchars, out nscolor  foreground, out nscolor  background )

---

Member Data Documentation

readonly attribute nsISVGRendererGlyphMetrics nsISVGGlyphGeometrySource::metrics

Definition at line 76 of file nsISVGGlyphGeometrySource.idl.

const unsigned long nsISVGGlyphGeometrySource::UPDATEMASK_METRICS = 0x00040000

Definition at line 77 of file nsISVGGlyphGeometrySource.idl. Referenced by nsSVGGlyphFrame::NotifyMetricsUnsuspended(), nsSVGGDIPlusGlyphGeometry::Update(), and nsSVGGlyphFrame::UpdateMetrics().

readonly attribute float nsISVGGlyphGeometrySource::x

Definition at line 84 of file nsISVGGlyphGeometrySource.idl.

const unsigned long nsISVGGlyphGeometrySource::UPDATEMASK_X = 0x00080000

Definition at line 85 of file nsISVGGlyphGeometrySource.idl. Referenced by nsSVGGlyphFrame::SetGlyphPosition(), and nsSVGGDIPlusGlyphGeometry::Update().

readonly attribute float nsISVGGlyphGeometrySource::y

Definition at line 86 of file nsISVGGlyphGeometrySource.idl.

const unsigned long nsISVGGlyphGeometrySource::UPDATEMASK_Y = 0x00100000

Definition at line 87 of file nsISVGGlyphGeometrySource.idl. Referenced by nsSVGGlyphFrame::SetGlyphPosition(), and nsSVGGDIPlusGlyphGeometry::Update().

readonly attribute boolean nsISVGGlyphGeometrySource::hasHighlight

Definition at line 94 of file nsISVGGlyphGeometrySource.idl. Referenced by nsSVGGlyphFrame::GetHighlight().

const unsigned long nsISVGGlyphGeometrySource::UPDATEMASK_HAS_HIGHLIGHT = 0x00200000

Definition at line 95 of file nsISVGGlyphGeometrySource.idl.

const unsigned long nsISVGGlyphGeometrySource::UPDATEMASK_HIGHLIGHT = 0x00400000

Definition at line 98 of file nsISVGGlyphGeometrySource.idl.

---

The documentation for this interface was generated from the following file:

• /layout/svg/renderer/public/nsISVGGlyphGeometrySource.idl

---