TNonPrintingCharVisibility Class Reference

#include <frmvis.h>

Link against: form.lib

class TNonPrintingCharVisibility

Public Member Functions
	TNonPrintingCharVisibility()
	TNonPrintingCharVisibility(const TNonPrintingCharVisibility &)
TBool	AllVisible()
IMPORT_C void	ExternalizeL(RWriteStream &)
IMPORT_C void	InternalizeL(RReadStream &)
TBool	LineBreaksVisible()
TBool	NonBreakingHyphensVisible()
TBool	NonBreakingSpacesVisible()
TBool	NoneVisible()
TBool	PageBreaksVisible()
TBool	ParagraphDelimitersVisible()
TBool	PotentialHyphensVisible()
IMPORT_C void	SetAllVisible()
IMPORT_C void	SetLineBreaksVisible(TBool)
IMPORT_C void	SetNonBreakingHyphensVisible(TBool)
IMPORT_C void	SetNonBreakingSpacesVisible(TBool)
IMPORT_C void	SetNoneVisible()
IMPORT_C void	SetPageBreaksVisible(TBool)
IMPORT_C void	SetParagraphDelimitersVisible(TBool)
IMPORT_C void	SetPotentialHyphensVisible(TBool)
IMPORT_C void	SetSpacesVisible(TBool)
IMPORT_C void	SetTabsVisible(TBool)
TBool	SpacesVisible()
TBool	TabsVisible()
IMPORT_C TNonPrintingCharVisibility &	operator=(const TNonPrintingCharVisibility &)

Detailed Description

A set of flags to indicate which non-printing characters (e.g. space, tab, paragraph break, etc.) should be drawn using symbols. By default, all non-printing characters are hidden.

An instance of this class is used in CTextLayout::SetNonPrintingCharsVisibility().

Constructor & Destructor Documentation

TNonPrintingCharVisibility ( )

IMPORT_C

TNonPrintingCharVisibility

(

)

TNonPrintingCharVisibility ( const TNonPrintingCharVisibility & )

IMPORT_C

TNonPrintingCharVisibility

(

const TNonPrintingCharVisibility &

aVisibility

)

Member Function Documentation

AllVisible ( )

TBool

AllVisible

(

)

const [inline]

Tests whether all non-printing characters are visible.

Returns: ETrue if all non-printing characters are visible. EFalse if any or all hidden.

ExternalizeL ( RWriteStream & )

IMPORT_C void

ExternalizeL

(

RWriteStream &

aStream

)

const

Externalises a TNonPrintingCharVisibility object to a write stream. The presence of this function means that the standard templated operator<<() (defined in s32strm.h) is available to externalise objects of this class.

Parameter	Description
aStream	Stream to which the object should be externalised.

InternalizeL ( RReadStream & )

IMPORT_C void

InternalizeL

(

RReadStream &

aStream

)

Internalises a TNonPrintingCharVisibility object from a read stream. The presence of this function means that the standard templated operator>>() (defined in s32strm.h) is available to internalise objects of this class.

Parameter	Description
aStream	Stream from which the object should be internalised.

LineBreaksVisible ( )

TBool

LineBreaksVisible

(

)

const [inline]

Tests whether forced line break characters are visible.

Returns: ETrue if forced line break characters are visible. EFalse if hidden.

NonBreakingHyphensVisible ( )

TBool

NonBreakingHyphensVisible

(

)

const [inline]

Tests whether non-breaking hyphens (enclosing word is always kept on the same line) are visible.

Returns: ETrue if non-breaking hyphens are visible. EFalse if hidden.

NonBreakingSpacesVisible ( )

TBool

NonBreakingSpacesVisible

(

)

const [inline]

Tests whether non-breaking spaces are visible.

Returns: ETrue if non-breaking spaces are visible. EFalse if hidden.

NoneVisible ( )

TBool

NoneVisible

(

)

const [inline]

Tests whether all non-printing characters are hidden.

Returns: ETrue if all non-printing characters are hidden. EFalse if any are visible.

PageBreaksVisible ( )

TBool

PageBreaksVisible

(

)

const [inline]

Tests whether page break characters are visible.

Returns: ETrue if page break characters are visible. EFalse if hidden.

ParagraphDelimitersVisible ( )

TBool

ParagraphDelimitersVisible

(

)

const [inline]

Tests whether paragraph delimiters are visible.

Returns: ETrue if paragraph delimiters are visible. EFalse if hidden.

PotentialHyphensVisible ( )

TBool

PotentialHyphensVisible

(

)

const [inline]

Tests whether potential hyphen characters (inserted before a line break within a word) are visible.

Returns: ETrue if potential hyphen characters are visible. EFalse if hidden.

SetAllVisible ( )

IMPORT_C void

SetAllVisible

(

)

Sets all non-printing characters to be drawn using symbols.

SetLineBreaksVisible ( TBool )

IMPORT_C void

SetLineBreaksVisible

(

TBool

aVisible

)

Sets the visibility of line breaks (force a new line without beginning a new paragraph).

Parameter	Description
aVisible	True for visible line breaks. False for hidden.

SetNonBreakingHyphensVisible ( TBool )

IMPORT_C void

SetNonBreakingHyphensVisible

(

TBool

aVisible

)

Sets the visibility of non-breaking hyphens (enclosing word is always kept on the same line).

Parameter	Description
aVisible	True for visible non-breaking hyphens, false for hidden.

SetNonBreakingSpacesVisible ( TBool )

IMPORT_C void

SetNonBreakingSpacesVisible

(

TBool

aVisible

)

Sets the visibility of non-breaking spaces.

Parameter	Description
aVisible	True for visible non-breaking spaces, false for hidden.

SetNoneVisible ( )

IMPORT_C void

SetNoneVisible

(

)

Sets all non-printing characters to be hidden.

SetPageBreaksVisible ( TBool )

IMPORT_C void

SetPageBreaksVisible

(

TBool

aVisible

)

Sets the visibility of page breaks.

Parameter	Description
aVisible	True for visible page breaks, false for hidden.

SetParagraphDelimitersVisible ( TBool )

IMPORT_C void

SetParagraphDelimitersVisible

(

TBool

aVisible

)

Sets the visibility of paragraph delimiters.

Parameter	Description
aVisible	True for visible paragraph delimiters, false for hidden.

SetPotentialHyphensVisible ( TBool )

IMPORT_C void

SetPotentialHyphensVisible

(

TBool

aVisible

)

Sets the visibility of potential hyphens (inserted before a line break within a word).

Parameter	Description
aVisible	True for visible potential hyphens, false for hidden.

SetSpacesVisible ( TBool )

IMPORT_C void

SetSpacesVisible

(

TBool

aVisible

)

Sets the visibility of space characters.

Parameter	Description
aVisible	True for visible space characters. False for hidden.

SetTabsVisible ( TBool )

IMPORT_C void

SetTabsVisible

(

TBool

aVisible

)

Sets the visibility of tab stops.

Parameter	Description
aVisible	True for visible tab stops. False for hidden.

SpacesVisible ( )

TBool

SpacesVisible

(

)

const [inline]

Tests whether space characters are visible.

Note: To get the the visibility of non-breaking space characters, use NonBreakingSpacesVisible() instead.

Returns: ETrue if space characters are visible. EFalse if hidden.

TabsVisible ( )

TBool

TabsVisible

(

)

const [inline]

Tests whether tab stop characters are visible.

Returns: ETrue if tab stop characters are visible. EFalse if hidden.

operator= ( const TNonPrintingCharVisibility & )

IMPORT_C TNonPrintingCharVisibility &

operator=

(

const TNonPrintingCharVisibility &

aVisibility

)