Class TNonPrintingCharVisibility

TNonPrintingCharVisibility

Support

Supported from 5.0

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

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(), TabsVisible(), operator=()

TNonPrintingCharVisibility();

Description

Trivial default C++ constructor.

This constructs a TNonPrintingCharVisibility object. By default, all non-printing characters are hidden.

TNonPrintingCharVisibility(const TNonPrintingCharVisibility& aVisibility);

Description

Copy constructor.

The C++ copy constructor constructs a new TNonPrintingCharVisibility object from an existing one.

TNonPrintingCharVisibility& operator=(const TNonPrintingCharVisibility& aVisibility);

Description

Assigns a TNonPrintingCharVisibility object to this one.

Parameters

const TNonPrintingCharVisibility& aVisibility The TNonPrintingCharVisibility object to assign to this one.

Return value

TNonPrintingCharVisibility& This TNonPrintingCharVisibility object.

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.

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.

void SetAllVisible();

Description

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

void SetNoneVisible();

Description

Sets all non-printing characters to be hidden.

void SetTabsVisible(TBool aVisible);

Description

Sets the visibility of tab stops.

Parameters

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

void SetSpacesVisible(TBool aVisible);

Description

Sets the visibility of space characters.

Parameters

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

void SetParagraphDelimitersVisible(TBool aVisible);

Description

Sets the visibility of paragraph delimiters.

Parameters

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

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.

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.

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.

void SetNonBreakingSpacesVisible(TBool aVisible);

Description

Sets the visibility of non-breaking spaces.

Parameters

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

void SetPageBreaksVisible(TBool aVisible);

Description

Sets the visibility of page breaks.

Parameters

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

TBool AllVisible()const;

Description

Tests whether all non-printing characters are visible.

Return value

TBool True if all non-printing characters are visible. False if any or all hidden.

TBool NoneVisible()const;

Description

Tests whether all non-printing characters are hidden.

Return value

TBool True if all non-printing characters are hidden. False if any are visible.

TBool TabsVisible()const;

Description

Tests whether tab stop characters are visible.

Return value

TBool True if tab stop characters are visible. False if hidden.

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 True if space characters are visible. False if hidden.

TBool ParagraphDelimitersVisible()const;

Description

Tests whether paragraph delimiters are visible.

Return value

TBool True if paragraph delimiters are visible. False if hidden.

TBool LineBreaksVisible()const;

Description

Tests whether forced line break characters are visible.

Return value

TBool True if forced line break characters are visible. False if hidden.

TBool PotentialHyphensVisible()const;

Description

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

Return value

TBool True if potential hyphen characters are visible. False if hidden.

TBool NonBreakingHyphensVisible()const;

Description

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

Return value

TBool True if non-breaking hyphens are visible. False if hidden.

TBool NonBreakingSpacesVisible()const;

Description

Tests whether non-breaking spaces are visible.

Return value

TBool True if non-breaking spaces are visible. False if hidden.

TBool PageBreaksVisible()const;

Description

Tests whether page break characters are visible.

Return value

TBool True if page break characters are visible. False if hidden.