1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
|
<HTML>
<HEAD>
<TITLE> DwText Man Page </TITLE>
</HEAD>
<BODY BGCOLOR="#FFFFFF">
<H2>
<FONT COLOR="navy"> NAME </FONT>
</H2>
<P>
DwText -- Class representing text in a RFC-822 header field-body
<H2>
<FONT COLOR="navy"> SYNOPSIS </FONT>
</H2>
<PRE>class DW_EXPORT DwText : public <A HREF="fieldbdy.html">DwFieldBody</A> {
public:
<A HREF="text.html#DwText">DwText</A>();
<A HREF="text.html#DwText">DwText</A>(const DwText& aText);
<A HREF="text.html#DwText">DwText</A>(const DwString& aStr, DwMessageComponent* aParent=0);
virtual ~DwText();
const DwText& <A HREF="text.html#op_eq">operator =</A> (const DwText& aText);
virtual void <A HREF="text.html#Parse">Parse</A>();
virtual void <A HREF="text.html#Assemble">Assemble</A>();
virtual DwMessageComponent* <A HREF="text.html#Clone">Clone</A>() const;
static DwText* <A HREF="text.html#NewText">NewText</A>(const DwString& aStr, DwMessageComponent* aParent);
static DwText* (*<A HREF="text.html#sNewText">sNewText</A>)(const DwString&, DwMessageComponent*);
public:
virtual void <A HREF="text.html#PrintDebugInfo">PrintDebugInfo</A>(ostream& aStrm, int aDepth=0) const;
virtual void <A HREF="text.html#CheckInvariants">CheckInvariants</A>() const;
protected:
void _PrintDebugInfo(ostream& aStrm) const;
};
</PRE>
<H2>
<FONT COLOR="navy"> DESCRIPTION </FONT>
</H2>
<P>
<B><TT>DwText</TT></B> represents an unstructured field body in a header
field. It roughly corresponds to the <I>text</I> element of the BNF grammar
defined in RFC-822.
<H2>
<FONT COLOR="navy"> Public Member Functions </FONT>
</H2>
<P>
<FONT COLOR="teal"><B> <A NAME="DwText">DwText</A>() <BR>
DwText(const DwText& aText) <BR>
DwText(const DwString& aStr, DwMessageComponent* aParent=0) </B></FONT>
<P>
The first constructor is the default constructor, which sets the
<B><TT>DwText</TT></B> object's string representation to the empty string
and sets its parent to NULL.
<P>
The second constructor is the copy constructor, which copies the string
representation from <B><TT>aText</TT></B>. The parent of the new
<B><TT>DwText</TT></B> object is set to NULL.
<P>
The third constructor copies <B><TT>aStr</TT></B> to the
<B><TT>DwText</TT></B> object's string representation and sets
<B><TT>aParent</TT></B> as its parent. The virtual member function
<B><TT>Parse()</TT></B> should be called immediately after this constructor
in order to parse the string representation. Unless it is NULL,
<B><TT>aParent</TT></B> should point to an object of a class derived from
<B><TT>DwField</TT></B>.
<P>
<FONT COLOR="teal"><B> const DwText& <A NAME="op_eq">operator =</A> (const
DwText& aText) </B></FONT>
<P>
This is the assignment operator.
<P>
<FONT COLOR="teal"><B> virtual void <A NAME="Parse">Parse</A>() </B></FONT>
<P>
This virtual member function is inherited from
<B><TT>DwMessageComponent</TT></B>, where it is declared a pure virtual function.
For a <B><TT>DwText</TT></B> object, this member function does nothing, since
<B><TT>DwText</TT></B> represents an unstructured field body (like the Subject
header field) that does not have a broken-down form.
<P>
Note, however, that this function should still be called consistently, since
a subclass of <B><TT>DwText</TT></B> may implement a parse method.
<P>
This function clears the is-modified flag.
<P>
<FONT COLOR="teal"><B> virtual void <A NAME="Assemble">Assemble</A>()
</B></FONT>
<P>
This virtual member function is inherited from
<B><TT>DwMessageComponent</TT></B>, where it is declared a pure virtual function.
For a <B><TT>DwText</TT></B> object, this member function does nothing, since
<B><TT>DwText</TT></B> represents an unstructured field body (like the Subject
header field) that does not have a broken-down form.
<P>
Note, however, that this function should still be called consistently, since
a subclass of <B><TT>DwText</TT></B> may implement an assemble method.
<P>
This function clears the is-modified flag.
<P>
<FONT COLOR="teal"><B> virtual DwMessageComponent*
<A NAME="Clone">Clone</A>() const </B></FONT>
<P>
This virtual function, inherited from <B><TT>DwMessageComponent</TT></B>,
creates a new <B><TT>DwText</TT></B> on the free store that has the same
value as this <B><TT>DwText</TT></B> object. The basic idea is that of a
``virtual copy constructor.''
<P>
<FONT COLOR="teal"><B> static DwText* <A NAME="NewText">NewText</A>(const
DwString& aStr, DwMessageComponent* aParent) </B></FONT>
<P>
Creates a new <B><TT>DwText</TT></B> object on the free store. If the static
data member <B><TT>sNewText</TT></B> is NULL, this member function will create
a new <B><TT>DwText</TT></B> and return it. Otherwise,
<B><TT>NewText()</TT></B> will call the user-supplied function pointed to
by <B><TT>sNewText</TT></B>, which is assumed to return an object from a
class derived from <B><TT>DwText</TT></B>, and return that object.
<P>
<FONT COLOR="teal"><B> virtual void
<A NAME="PrintDebugInfo">PrintDebugInfo</A>(ostream& aStrm, int aDepth=0)
const </B></FONT>
<P>
This virtual function, inherited from <B><TT>DwMessageComponent</TT></B>,
prints debugging information about this object to <B><TT>aStrm</TT></B>.
It will also call <B><TT>PrintDebugInfo()</TT></B> for any of its child
components down to a level of <B><TT>aDepth</TT></B>.
<P>
This member function is available only in the debug version of the library.
<P>
<FONT COLOR="teal"><B> virtual void
<A NAME="CheckInvariants">CheckInvariants</A>() const </B></FONT>
<P>
Aborts if one of the invariants of the object fails. Use this member function
to track down bugs.
<P>
This member function is available only in the debug version of the library.
<H2>
<FONT COLOR="navy"> Public Data Members </FONT>
</H2>
<P>
<FONT COLOR="teal"><B> static DwText*
(*<A NAME="sNewText">sNewText</A>)(const DwString&, DwMessageComponent*)
</B></FONT>
<P>
If <B><TT>sNewText</TT></B> is not NULL, it is assumed to point to a
user-supplied function that returns an object from a class derived from
<B><TT>DwText</TT></B>.
</BODY></HTML>
|
