|
sl@0
|
1 |
/*
|
|
sl@0
|
2 |
* Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).
|
|
sl@0
|
3 |
* All rights reserved.
|
|
sl@0
|
4 |
* This component and the accompanying materials are made available
|
|
sl@0
|
5 |
* under the terms of "Eclipse Public License v1.0"
|
|
sl@0
|
6 |
* which accompanies this distribution, and is available
|
|
sl@0
|
7 |
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
|
|
sl@0
|
8 |
*
|
|
sl@0
|
9 |
* Initial Contributors:
|
|
sl@0
|
10 |
* Nokia Corporation - initial contribution.
|
|
sl@0
|
11 |
*
|
|
sl@0
|
12 |
* Contributors:
|
|
sl@0
|
13 |
*
|
|
sl@0
|
14 |
* Description:
|
|
sl@0
|
15 |
*
|
|
sl@0
|
16 |
*/
|
|
sl@0
|
17 |
|
|
sl@0
|
18 |
|
|
sl@0
|
19 |
#ifndef __FRMVIS_H__
|
|
sl@0
|
20 |
#define __FRMVIS_H__
|
|
sl@0
|
21 |
|
|
sl@0
|
22 |
#include <e32std.h>
|
|
sl@0
|
23 |
#include <e32base.h>
|
|
sl@0
|
24 |
|
|
sl@0
|
25 |
class RReadStream;
|
|
sl@0
|
26 |
class RWriteStream;
|
|
sl@0
|
27 |
|
|
sl@0
|
28 |
/**
|
|
sl@0
|
29 |
A set of flags to indicate which non-printing characters (e.g. space, tab,
|
|
sl@0
|
30 |
paragraph break, etc.) should be drawn using symbols. By default, all
|
|
sl@0
|
31 |
non-printing characters are hidden.
|
|
sl@0
|
32 |
|
|
sl@0
|
33 |
An instance of this class is used in
|
|
sl@0
|
34 |
CTextLayout::SetNonPrintingCharsVisibility().
|
|
sl@0
|
35 |
@publishedAll
|
|
sl@0
|
36 |
@released
|
|
sl@0
|
37 |
*/
|
|
sl@0
|
38 |
class TNonPrintingCharVisibility
|
|
sl@0
|
39 |
|
|
sl@0
|
40 |
{
|
|
sl@0
|
41 |
private:
|
|
sl@0
|
42 |
enum TShowFormatChars
|
|
sl@0
|
43 |
{
|
|
sl@0
|
44 |
EFNothingVisible=0x000,
|
|
sl@0
|
45 |
EFTabsVisible=0x001,
|
|
sl@0
|
46 |
EFSpacesVisible=0x002,
|
|
sl@0
|
47 |
EFParagraphDelimitersVisible=0x004,
|
|
sl@0
|
48 |
EFLineBreaksVisible=0x008,
|
|
sl@0
|
49 |
EFPotentialHyphensVisible=0x010,
|
|
sl@0
|
50 |
EFNonBreakingHyphensVisible=0x020,
|
|
sl@0
|
51 |
EFNonBreakingSpacesVisible=0x040,
|
|
sl@0
|
52 |
EFPageBreaksVisible=0x080,
|
|
sl@0
|
53 |
EFEverythingVisible=0xffffffff
|
|
sl@0
|
54 |
};
|
|
sl@0
|
55 |
public:
|
|
sl@0
|
56 |
IMPORT_C TNonPrintingCharVisibility();
|
|
sl@0
|
57 |
IMPORT_C TNonPrintingCharVisibility(const TNonPrintingCharVisibility& aVisibility);
|
|
sl@0
|
58 |
IMPORT_C TNonPrintingCharVisibility& operator=(const TNonPrintingCharVisibility& aVisibility);
|
|
sl@0
|
59 |
IMPORT_C void ExternalizeL(RWriteStream& aStream)const;
|
|
sl@0
|
60 |
IMPORT_C void InternalizeL(RReadStream& aStream);
|
|
sl@0
|
61 |
IMPORT_C void SetAllVisible();
|
|
sl@0
|
62 |
IMPORT_C void SetNoneVisible();
|
|
sl@0
|
63 |
IMPORT_C void SetTabsVisible(TBool aVisible);
|
|
sl@0
|
64 |
IMPORT_C void SetSpacesVisible(TBool aVisible);
|
|
sl@0
|
65 |
IMPORT_C void SetParagraphDelimitersVisible(TBool aVisible);
|
|
sl@0
|
66 |
IMPORT_C void SetLineBreaksVisible(TBool aVisible);
|
|
sl@0
|
67 |
IMPORT_C void SetPotentialHyphensVisible(TBool aVisible);
|
|
sl@0
|
68 |
IMPORT_C void SetNonBreakingHyphensVisible(TBool aVisible);
|
|
sl@0
|
69 |
IMPORT_C void SetNonBreakingSpacesVisible(TBool aVisible);
|
|
sl@0
|
70 |
IMPORT_C void SetPageBreaksVisible(TBool aVisible);
|
|
sl@0
|
71 |
|
|
sl@0
|
72 |
/** Tests whether all non-printing characters are visible.
|
|
sl@0
|
73 |
@return ETrue if all non-printing characters are visible. EFalse if any or
|
|
sl@0
|
74 |
all hidden. */
|
|
sl@0
|
75 |
inline TBool AllVisible()const{return iVisible==EFEverythingVisible;};
|
|
sl@0
|
76 |
|
|
sl@0
|
77 |
/** Tests whether all non-printing characters are hidden.
|
|
sl@0
|
78 |
@return ETrue if all non-printing characters are hidden. EFalse if any are
|
|
sl@0
|
79 |
visible. */
|
|
sl@0
|
80 |
inline TBool NoneVisible()const{return iVisible==EFNothingVisible;};
|
|
sl@0
|
81 |
|
|
sl@0
|
82 |
/** Tests whether tab stop characters are visible.
|
|
sl@0
|
83 |
@return ETrue if tab stop characters are visible. EFalse if hidden. */
|
|
sl@0
|
84 |
inline TBool TabsVisible()const{return iVisible&EFTabsVisible;};
|
|
sl@0
|
85 |
|
|
sl@0
|
86 |
/** Tests whether space characters are visible.
|
|
sl@0
|
87 |
|
|
sl@0
|
88 |
Note: To get the the visibility of non-breaking space characters, use
|
|
sl@0
|
89 |
NonBreakingSpacesVisible() instead.
|
|
sl@0
|
90 |
@return ETrue if space characters are visible. EFalse if hidden. */
|
|
sl@0
|
91 |
inline TBool SpacesVisible()const{return iVisible&EFSpacesVisible;};
|
|
sl@0
|
92 |
|
|
sl@0
|
93 |
/** Tests whether paragraph delimiters are visible.
|
|
sl@0
|
94 |
@return ETrue if paragraph delimiters are visible. EFalse if hidden. */
|
|
sl@0
|
95 |
inline TBool ParagraphDelimitersVisible()const{return iVisible&EFParagraphDelimitersVisible;};
|
|
sl@0
|
96 |
|
|
sl@0
|
97 |
/** Tests whether forced line break characters are visible.
|
|
sl@0
|
98 |
@return ETrue if forced line break characters are visible. EFalse if hidden.
|
|
sl@0
|
99 |
*/
|
|
sl@0
|
100 |
inline TBool LineBreaksVisible()const{return iVisible&EFLineBreaksVisible;};
|
|
sl@0
|
101 |
|
|
sl@0
|
102 |
/** Tests whether potential hyphen characters (inserted before a line break
|
|
sl@0
|
103 |
within a word) are visible.
|
|
sl@0
|
104 |
|
|
sl@0
|
105 |
@return ETrue if potential hyphen characters are visible. EFalse if hidden.
|
|
sl@0
|
106 |
*/
|
|
sl@0
|
107 |
inline TBool PotentialHyphensVisible()const{return iVisible&EFPotentialHyphensVisible;};
|
|
sl@0
|
108 |
|
|
sl@0
|
109 |
/** Tests whether non-breaking hyphens (enclosing word is always kept on
|
|
sl@0
|
110 |
the same line) are visible.
|
|
sl@0
|
111 |
@return ETrue if non-breaking hyphens are visible. EFalse if hidden. */
|
|
sl@0
|
112 |
inline TBool NonBreakingHyphensVisible()const{return iVisible&EFNonBreakingHyphensVisible;};
|
|
sl@0
|
113 |
|
|
sl@0
|
114 |
/** Tests whether non-breaking spaces are visible.
|
|
sl@0
|
115 |
@return ETrue if non-breaking spaces are visible. EFalse if hidden. */
|
|
sl@0
|
116 |
inline TBool NonBreakingSpacesVisible()const{return iVisible&EFNonBreakingSpacesVisible;};
|
|
sl@0
|
117 |
|
|
sl@0
|
118 |
/** Tests whether page break characters are visible.
|
|
sl@0
|
119 |
@return ETrue if page break characters are visible. EFalse if hidden. */
|
|
sl@0
|
120 |
inline TBool PageBreaksVisible()const{return iVisible&EFPageBreaksVisible;};
|
|
sl@0
|
121 |
|
|
sl@0
|
122 |
private:
|
|
sl@0
|
123 |
TUint32 iVisible;
|
|
sl@0
|
124 |
};
|
|
sl@0
|
125 |
|
|
sl@0
|
126 |
#endif
|
|
sl@0
|
127 |
|
|
sl@0
|
128 |
|