diff options
Diffstat (limited to 'mimelib/doc/mboxlist.html')
| -rw-r--r-- | mimelib/doc/mboxlist.html | 232 |
1 files changed, 232 insertions, 0 deletions
diff --git a/mimelib/doc/mboxlist.html b/mimelib/doc/mboxlist.html new file mode 100644 index 000000000..2bae2b4e3 --- /dev/null +++ b/mimelib/doc/mboxlist.html @@ -0,0 +1,232 @@ +<HTML> +<HEAD> + <TITLE> DwMailboxList Man Page </TITLE> +</HEAD> +<BODY BGCOLOR="#FFFFFF"> +<H2> + <FONT COLOR="navy"> NAME </FONT> +</H2> +<P> +DwMailboxList -- Class representing a list of RFC-822 mailboxes +<H2> + <FONT COLOR="navy"> SYNOPSIS </FONT> +</H2> +<PRE>class DW_EXPORT DwMailboxList : public <A HREF="fieldbdy.html">DwFieldBody</A> { + +public: + + <A HREF="mboxlist.html#DwMailboxList">DwMailboxList</A>(); + <A HREF="mboxlist.html#DwMailboxList">DwMailboxList</A>(const DwMailboxList& aList); + <A HREF="mboxlist.html#DwMailboxList">DwMailboxList</A>(const DwString& aStr, DwMessageComponent* aParent=0); + virtual ~DwMailboxList(); + const DwMailboxList& <A HREF="mboxlist.html#op_eq">operator =</A> (const DwMailboxList& aList); + virtual void <A HREF="mboxlist.html#Parse">Parse</A>(); + virtual void <A HREF="mboxlist.html#Assemble">Assemble</A>(); + virtual DwMessageComponent* <A HREF="mboxlist.html#Clone">Clone</A>() const; + DwMailbox* <A HREF="mboxlist.html#FirstMailbox">FirstMailbox</A>() const; + void <A HREF="mboxlist.html#Add">Add</A>(DwMailbox* aMailbox); + void <A HREF="mboxlist.html#Remove">Remove</A>(DwMailbox* aMailbox); + void <A HREF="mboxlist.html#DeleteAll">DeleteAll</A>(); + static DwMailboxList* <A HREF="mboxlist.html#NewMailboxList">NewMailboxList</A>(const DwString& aStr, + DwMessageComponent* aParent); + static DwMailboxList* (*<A HREF="mboxlist.html#sNewMailboxList">sNewMailboxList</A>)(const DwString&, + DwMessageComponent*); + +protected: + + DwMailbox* <A HREF="mboxlist.html#mFirstMailbox">mFirstMailbox</A>; + void <A HREF="mboxlist.html#_AddMailbox">_AddMailbox</A>(DwMailbox* aMailbox); + void <A HREF="mboxlist.html#_DeleteAll">_DeleteAll</A>(); + +public: + + virtual void <A HREF="mboxlist.html#PrintDebugInfo">PrintDebugInfo</A>(ostream& aStrm, int aDepth=0) const; + virtual void <A HREF="mboxlist.html#CheckInvariants">CheckInvariants</A>() const; + +protected: + + void _PrintDebugInfo(ostream& aStrm) const; +}; +</PRE> +<H2> + <FONT COLOR="navy"> DESCRIPTION </FONT> +</H2> +<P> +<B><TT>DwMailboxList</TT></B> represents a list of <I>mailboxes</I> as described +in RFC-822. In MIME++, <B><TT>DwMailboxList</TT></B> is a container for objects +of type <B><TT><A HREF="mailbox.html">DwMailbox</A></TT></B>, and it contains +various member functions to manage its contained objects. +<B><TT><A HREF="addrlist.html">DwAddressList</A></TT></B> is also a +<B><TT><A HREF="fieldbdy.html">DwFieldBody</A></TT></B>. This reflects the +fact that certain RFC-822 header fields, such as the "From" header field, +have a list of mailboxes as their field bodies. +<H2> + <FONT COLOR="navy"> Public Member Functions </FONT> +</H2> +<P> +<FONT COLOR="teal"><B> <A NAME="DwMailboxList">DwMailboxList</A>() <BR> +DwMailboxList(const DwMailboxList& aList) <BR> +DwMailboxList(const DwString& aStr, DwMessageComponent* aParent=0) +</B></FONT> +<P> +The first constructor is the default constructor, which sets the +<B><TT>DwMailboxList</TT></B> object's string representation to the empty +string and sets its parent to <B><TT>NULL</TT></B>. +<P> +The second constructor is the copy constructor, which copies the string +representation and all <B><TT>DwMailbox</TT></B> objects from +<B><TT>aList</TT></B>. The parent of the new +<B><TT>DwMailboxList</TT></B> object is set to <B><TT>NULL</TT></B>. +<P> +The third constructor copies <B><TT>aStr</TT></B> to the +<B><TT>DwMailboxList</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 +<B><TT>NULL</TT></B>, <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 DwMailboxList& <A NAME="op_eq">operator +=</A> (const DwMailboxList& aList) </B></FONT> +<P> +This is the assignment operator, which performs a deep copy of +<B><TT>aList</TT></B>. The parent node of the +<B><TT>DwMailboxList</TT></B> object is not changed. +<P> +<FONT COLOR="teal"><B> virtual void <A NAME="Parse">Parse</A>() </B></FONT> +<P> +This virtual function, inherited from <B><TT>DwMessageComponent</TT></B>, +executes the parse method for <B><TT>DwMailboxList</TT></B> objects. The +parse method creates or updates the broken-down representation from the string +representation. For <B><TT>DwMailboxList</TT></B> objects, the parse method +parses the string representation to create a list of +<B><TT>DwMailbox</TT></B> objects. This member function also calls the +<B><TT>Parse()</TT></B> member function of each <B><TT>DwMailbox</TT></B> +object in its list. +<P> +You should call this member function after you set or modify the string +representation, and before you access any of the contained +<B><TT>DwMailbox</TT></B> objects. +<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 function, inherited from <B><TT>DwMessageComponent</TT></B>, +executes the assemble method for <B><TT>DwMailboxList</TT></B> objects. The +assemble method creates or updates the string representation from the broken-down +representation. For <B><TT>DwMailboxList</TT></B> objects, the assemble method +builds the string representation from its list of +<B><TT>DwMailbox</TT></B> objects. Before it builds the string representation +for the <B><TT>DwMailboxList</TT></B> object, this function first calls the +<B><TT>Assemble()</TT></B> member function of each +<B><TT>DwMailbox</TT></B> object in its list. +<P> +You should call this member function after you set or modify any of the contained +<B><TT>DwMailbox</TT></B> objects, and before you retrieve the string +representation. +<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>DwMailboxList</TT></B> on the free store that has the +same value as this <B><TT>DwMailboxList</TT></B> object. The basic idea is +that of a virtual copy constructor. +<P> +<FONT COLOR="teal"><B> DwMailbox* <A NAME="FirstMailbox">FirstMailbox</A>() +const </B></FONT> +<P> +Gets the first <B><TT>DwMailbox</TT></B> object in the list. Use the member +function <B><TT>DwMailbox::Next()</TT></B> to iterate. Returns +<B><TT>NULL</TT></B> if the list is empty. +<P> +<FONT COLOR="teal"><B> void <A NAME="Add">Add</A>(DwMailbox* aMailbox) +</B></FONT> +<P> +Adds <B><TT>aMailbox</TT></B> to the end of the list of +<B><TT>DwMailbox</TT></B> objects maintained by this +<B><TT>DwMailboxList</TT></B> object. +<P> +<FONT COLOR="teal"><B> void <A NAME="Remove">Remove</A>(DwMailbox* aMailbox) +</B></FONT> +<P> +Removes <B><TT>aMailbox</TT></B> from the list of +<B><TT>DwMailbox</TT></B> objects maintained by this +<B><TT>DwMailboxList</TT></B> object. The <B><TT>DwMailbox</TT></B> object +is not deleted by this member function. +<P> +<FONT COLOR="teal"><B> void <A NAME="DeleteAll">DeleteAll</A>() </B></FONT> +<P> +Removes and deletes all <B><TT>DwMailbox</TT></B> objects from the list +maintained by this <B><TT>DwMailboxList</TT></B> object. +<P> +<FONT COLOR="teal"><B> static DwMailboxList* +<A NAME="NewMailboxList">NewMailboxList</A>(const DwString& aStr, +DwMessageComponent* aParent) </B></FONT> +<P> +Creates a new <B><TT>DwMailboxList</TT></B> object on the free store. If +the static data member <B><TT>sNewMailboxList</TT></B> is +<B><TT>NULL</TT></B>, this member function will create a new +<B><TT>DwMailboxList</TT></B> and return it. Otherwise, +<B><TT>NewMailboxList()</TT></B> will call the user-supplied function pointed +to by <B><TT>sNewMailboxList</TT></B>, which is assumed to return an object +from a class derived from <B><TT>DwMailboxList</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 DwMailboxList* +(*<A NAME="sNewMailboxList">sNewMailboxList</A>)(const DwString&, +DwMessageComponent*) </B></FONT> +<P> +If <B><TT>sNewMailboxList</TT></B> is not <B><TT>NULL</TT></B>, it is assumed +to point to a user-supplied function that returns an object from a class +derived from <B><TT>DwMailboxList</TT></B>. +<H2> + <FONT COLOR="navy"> Protected Member Functions </FONT> +</H2> +<P> +<B><FONT COLOR="teal"> void <A NAME="_AddMailbox">_AddMailbox</A>(DwMailbox* +aMailbox) </FONT></B> +<P> +Adds a mailbox, but does not set the is-modified flag. +<P> +<B><FONT COLOR="teal"> void <A NAME="_DeleteAll">_DeleteAll</A>() </FONT></B> +<P> +Removes and deletes all <B><TT>DwMailbox</TT></B> objects from the list +maintained by this <B><TT>DwMailboxList</TT></B> object. Doesn't set the +is-modified flag. +<H2> + <FONT COLOR="navy"> Protected Data Members </FONT> +</H2> +<P> +<FONT COLOR="teal"><B> DwMailbox* <A NAME="mFirstMailbox">mFirstMailbox</A> +</B></FONT> +<P> +Points to first <B><TT>DwMailbox</TT></B> object in list. +<P> +</BODY></HTML> |