Class TNonPrintingCharVisibility

class TNonPrintingCharVisibility;

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

Members

Defined in TNonPrintingCharVisibility:
AllVisible(), ExternalizeL(), InternalizeL(), LineBreaksVisible(), NonBreakingHyphensVisible(), NonBreakingSpacesVisible(), NoneVisible(), PageBreaksVisible(), ParagraphDelimitersVisible(), PotentialHyphensVisible(), SetAllVisible(), SetLineBreaksVisible(), SetNonBreakingHyphensVisible(), SetNonBreakingSpacesVisible(), SetNoneVisible(), SetPageBreaksVisible(), SetParagraphDelimitersVisible(), SetPotentialHyphensVisible(), SetSpacesVisible(), SetTabsVisible(), SpacesVisible(), TNonPrintingCharVisibility(), TNonPrintingCharVisibility(), TabsVisible(), operator=()

IMPORT_C TNonPrintingCharVisibility();

Description

IMPORT_C TNonPrintingCharVisibility(const TNonPrintingCharVisibility &aVisibility);

Description

Parameters

const TNonPrintingCharVisibility &aVisibility

IMPORT_C TNonPrintingCharVisibility &operator=(const TNonPrintingCharVisibility &aVisibility);

Description

Parameters

const TNonPrintingCharVisibility &aVisibility

Return value

TNonPrintingCharVisibility &

IMPORT_C void ExternalizeL(RWriteStream &aStream) const;

Description

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.

Parameters

RWriteStream &aStream Stream to which the object should be externalised.

IMPORT_C void InternalizeL(RReadStream &aStream);

Description

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.

Parameters

RReadStream &aStream Stream from which the object should be internalised.

IMPORT_C void SetAllVisible();

Description

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

IMPORT_C void SetNoneVisible();

Description

Sets all non-printing characters to be hidden.

IMPORT_C void SetTabsVisible(TBool aVisible);

Description

Sets the visibility of tab stops.

Parameters

TBool aVisible True for visible tab stops. False for hidden.

IMPORT_C void SetSpacesVisible(TBool aVisible);

Description

Sets the visibility of space characters.

Parameters

TBool aVisible True for visible space characters. False for hidden.

IMPORT_C void SetParagraphDelimitersVisible(TBool aVisible);

Description

Sets the visibility of paragraph delimiters.

Parameters

TBool aVisible True for visible paragraph delimiters, false for hidden.

IMPORT_C void SetLineBreaksVisible(TBool aVisible);

Description

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

Parameters

TBool aVisible True for visible line breaks. False for hidden.

IMPORT_C void SetPotentialHyphensVisible(TBool aVisible);

Description

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

Parameters

TBool aVisible True for visible potential hyphens, false for hidden.

IMPORT_C void SetNonBreakingHyphensVisible(TBool aVisible);

Description

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

Parameters

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

IMPORT_C void SetNonBreakingSpacesVisible(TBool aVisible);

Description

Sets the visibility of non-breaking spaces.

Parameters

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

IMPORT_C void SetPageBreaksVisible(TBool aVisible);

Description

Sets the visibility of page breaks.

Parameters

TBool aVisible True for visible page breaks, false for hidden.

inline TBool AllVisible() const;

Description

Tests whether all non-printing characters are visible.

Return value

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

inline TBool NoneVisible() const;

Description

Tests whether all non-printing characters are hidden.

Return value

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

inline TBool TabsVisible() const;

Description

Tests whether tab stop characters are visible.

Return value

TBool ETrue if tab stop characters are visible. EFalse if hidden.

inline TBool SpacesVisible() const;

Description

Tests whether space characters are visible.

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

Return value

TBool ETrue if space characters are visible. EFalse if hidden.

inline TBool ParagraphDelimitersVisible() const;

Description

Tests whether paragraph delimiters are visible.

Return value

TBool ETrue if paragraph delimiters are visible. EFalse if hidden.

inline TBool LineBreaksVisible() const;

Description

Tests whether forced line break characters are visible.

Return value

TBool ETrue if forced line break characters are visible. EFalse if hidden.

inline TBool PotentialHyphensVisible() const;

Description

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

Return value

TBool ETrue if potential hyphen characters are visible. EFalse if hidden.

inline TBool NonBreakingHyphensVisible() const;

Description

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

Return value

TBool ETrue if non-breaking hyphens are visible. EFalse if hidden.

inline TBool NonBreakingSpacesVisible() const;

Description

Tests whether non-breaking spaces are visible.

Return value

TBool ETrue if non-breaking spaces are visible. EFalse if hidden.

inline TBool PageBreaksVisible() const;

Description

Tests whether page break characters are visible.

Return value

TBool ETrue if page break characters are visible. EFalse if hidden.