TParaFormat encapsulates the PARAFORMAT structure, which contains information about paragraph formatting attributes of a rich edit control. More...

#include <owl/richedit.h>

Inheritance diagram for owl::TParaFormat:

Public Member Functions
	TParaFormat (ulong mask=0)
	Constructs a default TParaFormat structure.

	TParaFormat (const TRichEdit &, ulong mask=PFM_ALL)
	Constructs a TParaFormat structure whose members are initialized with the paragraph formatting attributes of the current selection of a rich edit control.

void	ToggleMaskBit (ulong flag)
	Toggles the specified flag in the member which describes which information of the PARAFORMAT structures is valid.

void	SetNumbering (uint16)
	Sets the numbering options. The only valid parameter is '0' or PFN_BULLET.

void	SetStartIndent (long, bool relative=false)
	Sets the indentation of the first line in the paragraph.

void	SetRightIndent (long)
	Sets the size of the right identation, relative to the right margin.

void	SetOffset (long)
	Sets the indentation of the second line and subsequent lines, relative to the starting indentation.

void	SetAlignment (uint16)
	Sets the alignment option.

void	SetTabCount (short, long *)
	Sets the number and absolute positions of the tab stops.

void	SetSpaceBefore (long space)
	Vertical spacing before para.

void	SetSpaceAfter (long space)
	Vertical spacing after para.

void	SetLineSpacing (long space, uint8 rule)
	Line spacing depending on Rule.

void	SetStyle (int16 style)
	Style handle.

void	SetShading (uint16 wight, uint16 style)
	Shading in hundredths of a per cent Nibble 0: style, 1: cfpat, 2: cbpat.

void	SetNumStart (uint16 start)
	Starting value for numbering.

void	SetNumStyle (uint16 style)
	Alignment, roman/arabic, (), ), ., etc.

void	SetNumTab (uint16 tab)
	Space bet 1st indent and 1st-line text.

void	SetBorder (uint16 spac, uint16 width, uint16 border)

Detailed Description

TParaFormat encapsulates the PARAFORMAT structure, which contains information about paragraph formatting attributes of a rich edit control.

Definition at line 119 of file richedit.h.

Constructor & Destructor Documentation

◆ TParaFormat() [1/2]

owl::TParaFormat::TParaFormat ( ulong mask = 0 )

Constructs a default TParaFormat structure.

Definition at line 465 of file richedit.cpp.

◆ TParaFormat() [2/2]

owl::TParaFormat::TParaFormat	(	const TRichEdit &	edit,
		ulong	mask = PFM_ALL )

Constructs a TParaFormat structure whose members are initialized with the paragraph formatting attributes of the current selection of a rich edit control.

Definition at line 480 of file richedit.cpp.

References owl::TRichEdit::GetParaFormat(), and PRECONDITION.

Member Function Documentation

◆ SetAlignment()

void owl::TParaFormat::SetAlignment ( uint16 opt )

Sets the alignment option.

The 'opt' parameter can be one of the following values:

PFA_LEFT Paragraphs are aligned with the left margin.
PFA_RIGHT Paragraphs are aligned with the right margin.
PFA_CENTER Paragraphs are centered.

Definition at line 563 of file richedit.cpp.

◆ SetBorder()

void owl::TParaFormat::SetBorder	(	uint16	spac,
		uint16	width,
		uint16	border )

Definition at line 670 of file richedit.cpp.

◆ SetLineSpacing()

void owl::TParaFormat::SetLineSpacing	(	long	space,
		uint8	rule )

Line spacing depending on Rule.

Definition at line 607 of file richedit.cpp.

◆ SetNumbering()

void owl::TParaFormat::SetNumbering ( uint16 opt )

Sets the numbering options. The only valid parameter is '0' or PFN_BULLET.

Definition at line 508 of file richedit.cpp.

References PRECONDITION.

◆ SetNumStart()

void owl::TParaFormat::SetNumStart ( uint16 start )

Starting value for numbering.

Definition at line 640 of file richedit.cpp.

◆ SetNumStyle()

void owl::TParaFormat::SetNumStyle ( uint16 style )

Alignment, roman/arabic, (), ), ., etc.

Definition at line 650 of file richedit.cpp.

◆ SetNumTab()

void owl::TParaFormat::SetNumTab ( uint16 tab )

Space bet 1st indent and 1st-line text.

Definition at line 660 of file richedit.cpp.

◆ SetOffset()

void owl::TParaFormat::SetOffset ( long offset )

Sets the indentation of the second line and subsequent lines, relative to the starting indentation.

The first line is indented if the 'offset' parameter is negative, or outdented if it is positive.

Definition at line 550 of file richedit.cpp.

◆ SetRightIndent()

void owl::TParaFormat::SetRightIndent ( long indent )

Sets the size of the right identation, relative to the right margin.

Definition at line 538 of file richedit.cpp.

◆ SetShading()

void owl::TParaFormat::SetShading	(	uint16	wight,
		uint16	style )

Shading in hundredths of a per cent Nibble 0: style, 1: cfpat, 2: cbpat.

Definition at line 629 of file richedit.cpp.

◆ SetSpaceAfter()

void owl::TParaFormat::SetSpaceAfter ( long space )

Vertical spacing after para.

Definition at line 597 of file richedit.cpp.

◆ SetSpaceBefore()

void owl::TParaFormat::SetSpaceBefore ( long space )

Vertical spacing before para.

Definition at line 587 of file richedit.cpp.

◆ SetStartIndent()

void owl::TParaFormat::SetStartIndent	(	long	start,
		bool	relative = false )

Sets the indentation of the first line in the paragraph.

If the paragraph formatting is being set and the 'relative' parameter is true, the 'start' value is treated as a relative value that is added to the starting indentation of each affected paragraph.

Definition at line 523 of file richedit.cpp.

◆ SetStyle()

void owl::TParaFormat::SetStyle ( int16 style )

Style handle.

Definition at line 618 of file richedit.cpp.

◆ SetTabCount()

void owl::TParaFormat::SetTabCount	(	short	cnt,
		long *	tabs )

Sets the number and absolute positions of the tab stops.

Definition at line 573 of file richedit.cpp.