TNonPrintingCharVisibility Class Reference

class TNonPrintingCharVisibility

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

Public Member Functions
TNonPrintingCharVisibility()
TNonPrintingCharVisibility(const TNonPrintingCharVisibility &)
TBool AllVisible()
IMPORT_C voidExternalizeL(RWriteStream &)
IMPORT_C voidInternalizeL(RReadStream &)
TBool LineBreaksVisible()
TBool NonBreakingHyphensVisible()
TBool NonBreakingSpacesVisible()
TBool NoneVisible()
TBool PageBreaksVisible()
TBool ParagraphDelimitersVisible()
TBool PotentialHyphensVisible()
IMPORT_C voidSetAllVisible()
IMPORT_C voidSetLineBreaksVisible(TBool)
IMPORT_C voidSetNonBreakingHyphensVisible(TBool)
IMPORT_C voidSetNonBreakingSpacesVisible(TBool)
IMPORT_C voidSetNoneVisible()
IMPORT_C voidSetPageBreaksVisible(TBool)
IMPORT_C voidSetParagraphDelimitersVisible(TBool)
IMPORT_C voidSetPotentialHyphensVisible(TBool)
IMPORT_C voidSetSpacesVisible(TBool)
IMPORT_C voidSetTabsVisible(TBool)
TBool SpacesVisible()
TBool TabsVisible()
IMPORT_C TNonPrintingCharVisibility &operator=(const TNonPrintingCharVisibility &)
Private Member Enumerations
enumTShowFormatChars {
EFNothingVisible = 0x000, EFTabsVisible = 0x001, EFSpacesVisible = 0x002, EFParagraphDelimitersVisible = 0x004, EFLineBreaksVisible = 0x008, EFPotentialHyphensVisible = 0x010, EFNonBreakingHyphensVisible = 0x020, EFNonBreakingSpacesVisible = 0x040, EFPageBreaksVisible = 0x080, EFEverythingVisible = 0xffffffff
}
Private Attributes
TUint32 iVisible

Constructor & Destructor Documentation

TNonPrintingCharVisibility()

IMPORT_CTNonPrintingCharVisibility()

TNonPrintingCharVisibility(const TNonPrintingCharVisibility &)

IMPORT_CTNonPrintingCharVisibility(const TNonPrintingCharVisibility &aVisibility)

Parameters

const TNonPrintingCharVisibility & aVisibility

Member Functions Documentation

AllVisible()

TBool AllVisible()const [inline]

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

ExternalizeL(RWriteStream &)

IMPORT_C voidExternalizeL(RWriteStream &aStream)const

Parameters

RWriteStream & aStream

InternalizeL(RReadStream &)

IMPORT_C voidInternalizeL(RReadStream &aStream)

Parameters

RReadStream & aStream

LineBreaksVisible()

TBool LineBreaksVisible()const [inline]

Tests whether forced line break characters are visible. 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. ETrue if non-breaking hyphens are visible. EFalse if hidden.

NonBreakingSpacesVisible()

TBool NonBreakingSpacesVisible()const [inline]

Tests whether non-breaking spaces are visible. ETrue if non-breaking spaces are visible. EFalse if hidden.

NoneVisible()

TBool NoneVisible()const [inline]

Tests whether all non-printing characters are hidden. 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. ETrue if page break characters are visible. EFalse if hidden.

ParagraphDelimitersVisible()

TBool ParagraphDelimitersVisible()const [inline]

Tests whether paragraph delimiters are visible. 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.

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

SetAllVisible()

IMPORT_C voidSetAllVisible()

SetLineBreaksVisible(TBool)

IMPORT_C voidSetLineBreaksVisible(TBoolaVisible)

Parameters

TBool aVisible

SetNonBreakingHyphensVisible(TBool)

IMPORT_C voidSetNonBreakingHyphensVisible(TBoolaVisible)

Parameters

TBool aVisible

SetNonBreakingSpacesVisible(TBool)

IMPORT_C voidSetNonBreakingSpacesVisible(TBoolaVisible)

Parameters

TBool aVisible

SetNoneVisible()

IMPORT_C voidSetNoneVisible()

SetPageBreaksVisible(TBool)

IMPORT_C voidSetPageBreaksVisible(TBoolaVisible)

Parameters

TBool aVisible

SetParagraphDelimitersVisible(TBool)

IMPORT_C voidSetParagraphDelimitersVisible(TBoolaVisible)

Parameters

TBool aVisible

SetPotentialHyphensVisible(TBool)

IMPORT_C voidSetPotentialHyphensVisible(TBoolaVisible)

Parameters

TBool aVisible

SetSpacesVisible(TBool)

IMPORT_C voidSetSpacesVisible(TBoolaVisible)

Parameters

TBool aVisible

SetTabsVisible(TBool)

IMPORT_C voidSetTabsVisible(TBoolaVisible)

Parameters

TBool aVisible

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. ETrue if space characters are visible. EFalse if hidden.

TabsVisible()

TBool TabsVisible()const [inline]

Tests whether tab stop characters are visible. ETrue if tab stop characters are visible. EFalse if hidden.

operator=(const TNonPrintingCharVisibility &)

IMPORT_C TNonPrintingCharVisibility &operator=(const TNonPrintingCharVisibility &aVisibility)

Parameters

const TNonPrintingCharVisibility & aVisibility

Member Enumerations Documentation

Enum TShowFormatChars

Enumerators

EFNothingVisible = 0x000
EFTabsVisible = 0x001
EFSpacesVisible = 0x002
EFParagraphDelimitersVisible = 0x004
EFLineBreaksVisible = 0x008
EFPotentialHyphensVisible = 0x010
EFNonBreakingHyphensVisible = 0x020
EFNonBreakingSpacesVisible = 0x040
EFPageBreaksVisible = 0x080
EFEverythingVisible = 0xffffffff

Member Data Documentation

TUint32 iVisible

TUint32 iVisible[private]
© Nokia 2010.