fe::ISubstringFiller Class Reference
[Ferry Core library]

Interface to provide custom filling of the part of a text line segment. More...

Inheritance diagram for fe::ISubstringFiller:

List of all members.

Public Member Functions
virtual void UC_DLL_CALL	paint (FeHandle *editor, const DecorMetrics &dm, Substring substr, PlatformTypes::graphics_handle_type g, int x, int y, unsigned width, unsigned lineHeight, unsigned lineAscent) const =0

---

Detailed Description

Interface to provide custom filling of the part of a text line segment.

Note:

This class is declared with UC_DLL_INTERFACE_DECLARE

---

Member Function Documentation

virtual void UC_DLL_CALL fe::ISubstringFiller::paint	(	FeHandle *	editor,
		const DecorMetrics &	dm,
		Substring	substr,
		PlatformTypes::graphics_handle_type	g,
		int	x,
		int	y,
		unsigned	width,
		unsigned	lineHeight,
		unsigned	lineAscent
	)			const [pure virtual]

Called by an editor to fill rectangular area occupied by a substring referenced with the substr parameter.

It is implementation responsibility to ensure that graphics output doesn't exceed passed in rectangular area bounds.

Parameters:

	editor	editor calling the method; never 0;
	dm	decoration applied to the substr; can be used as an additional source of information controlling how to fill the rectangular area;
	substr	substring that occupiers the given rectangular area;
	g	graphics context in which to perform all graphics output;
	x	X-coordinate of the top left corner of the rectangular area to fill;
	y	Y-coordinate of the top left corner of the rectangular area to fill;
	width	width of the rectangular area to fill;
	lineHeight	height of a text line segment to which the substr belongs; this value also specifies the height of the rectangular area to fill;
	lineAscent	text ascent of a text line segment to which the substr belongs; can be used as an additional source of information controlling how to fill the rectangular area.

---

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

• fe/ui/substring_filler.h