TFormatRange encapsulates the FORMATRANGE structure, which contains information that a rich edit control uses to format its output for a particular device. More...

#include <owl/richedit.h>

Inheritance diagram for owl::TFormatRange:

Public Member Functions
	TFormatRange ()
	Constructs a default 'TFormatRange' object with all members initialized to zero.
	TFormatRange (HDC renderDC, HDC targetDC, const TRect &renderArea, const TRect &entireArea, const TCharRange &txtRange)
	Constructs a TFormatRange object initializing data members with the specified parameters.
	TFormatRange (HDC renderDC, HDC targetDC, const TRect &renderArea, const TRect &entireArea, long firstChar, long lastChar)
void	SetRenderDC (HDC)
	Sets the device context of the device to render to.
void	SetTargetDC (HDC)
	Sets the device context of the target device to format for.
void	SetRenderRect (const TRect &)
	Sets the area to render to.
void	SetPageRect (const TRect &)
	Sets the entire area of the rendering device.
void	SetRange (const TCharRange &)
	Sets the range of text to format.
void	SetRange (long, long)
	Sets the range of text to format, specifying the starting and ending character offsets.

Detailed Description

TFormatRange encapsulates the FORMATRANGE structure, which contains information that a rich edit control uses to format its output for a particular device.

Definition at line 156 of file richedit.h.

Constructor & Destructor Documentation

◆ TFormatRange() [1/3]

owl::TFormatRange::TFormatRange ( )

inline

Constructs a default 'TFormatRange' object with all members initialized to zero.

Definition at line 658 of file richedit.h.

◆ TFormatRange() [2/3]

owl::TFormatRange::TFormatRange	(	HDC	renderDC,
		HDC	targetDC,
		const TRect &	renderArea,
		const TRect &	entireArea,
		const TCharRange &	txtRange )

Constructs a TFormatRange object initializing data members with the specified parameters.

Definition at line 394 of file richedit.cpp.

References SetPageRect(), SetRange(), SetRenderDC(), SetRenderRect(), and SetTargetDC().

◆ TFormatRange() [3/3]

owl::TFormatRange::TFormatRange	(	HDC	renderDC,
		HDC	targetDC,
		const TRect &	renderArea,
		const TRect &	entireArea,
		long	firstChar,
		long	lastChar )

References SetPageRect(), SetRange(), SetRenderDC(), SetRenderRect(), and SetTargetDC().

Member Function Documentation

◆ SetPageRect()

void owl::TFormatRange::SetPageRect ( const TRect & pgRect )

Sets the entire area of the rendering device.

Note: The specified units are in TWIPS.

Definition at line 437 of file richedit.cpp.

◆ SetRange() [1/2]

void owl::TFormatRange::SetRange ( const TCharRange & charRange )

Sets the range of text to format.

Definition at line 446 of file richedit.cpp.

◆ SetRange() [2/2]

void owl::TFormatRange::SetRange	(	long	start,
		long	end )

Sets the range of text to format, specifying the starting and ending character offsets.

Definition at line 455 of file richedit.cpp.

◆ SetRenderDC()

void owl::TFormatRange::SetRenderDC ( HDC renderDC )

Sets the device context of the device to render to.

Definition at line 408 of file richedit.cpp.

◆ SetRenderRect()

void owl::TFormatRange::SetRenderRect ( const TRect & renderRect )

Sets the area to render to.

Note: The specified units are in TWIPS.

Definition at line 427 of file richedit.cpp.

◆ SetTargetDC()

void owl::TFormatRange::SetTargetDC ( HDC targetDC )

Sets the device context of the target device to format for.

Definition at line 417 of file richedit.cpp.

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

include/owl/richedit.h
source/owlcore/richedit.cpp

Public Member Functions