Back to index

lightning-sunbird  0.9+nobinonly
mimecont.h
Go to the documentation of this file.
00001 /* -*- Mode: C; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
00002 /* ***** BEGIN LICENSE BLOCK *****
00003  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00004  *
00005  * The contents of this file are subject to the Mozilla Public License Version
00006  * 1.1 (the "License"); you may not use this file except in compliance with
00007  * the License. You may obtain a copy of the License at
00008  * http://www.mozilla.org/MPL/
00009  *
00010  * Software distributed under the License is distributed on an "AS IS" basis,
00011  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00012  * for the specific language governing rights and limitations under the
00013  * License.
00014  *
00015  * The Original Code is mozilla.org code.
00016  *
00017  * The Initial Developer of the Original Code is
00018  * Netscape Communications Corporation.
00019  * Portions created by the Initial Developer are Copyright (C) 1998
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *
00024  * Alternatively, the contents of this file may be used under the terms of
00025  * either of the GNU General Public License Version 2 or later (the "GPL"),
00026  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00027  * in which case the provisions of the GPL or the LGPL are applicable instead
00028  * of those above. If you wish to allow use of your version of this file only
00029  * under the terms of either the GPL or the LGPL, and not to allow others to
00030  * use your version of this file under the terms of the MPL, indicate your
00031  * decision by deleting the provisions above and replace them with the notice
00032  * and other provisions required by the GPL or the LGPL. If you do not delete
00033  * the provisions above, a recipient may use your version of this file under
00034  * the terms of any one of the MPL, the GPL or the LGPL.
00035  *
00036  * ***** END LICENSE BLOCK ***** */
00037 
00038 #ifndef _MIMECONT_H_
00039 #define _MIMECONT_H_
00040 
00041 #include "mimeobj.h"
00042 
00043 /* MimeContainer is the class for the objects representing all MIME 
00044    types which can contain other MIME objects within them.  In addition 
00045    to the methods inherited from MimeObject, it provides one method:
00046 
00047    int add_child (MimeObject *parent, MimeObject *child)
00048 
00049      Given a parent (a subclass of MimeContainer) this method adds the
00050      child (any MIME object) to the parent's list of children.
00051 
00052      The MimeContainer `finalize' method will finalize the children as well.
00053  */
00054 
00055 typedef struct MimeContainerClass MimeContainerClass;
00056 typedef struct MimeContainer      MimeContainer;
00057 
00058 struct MimeContainerClass {
00059   MimeObjectClass object;
00060   int (*add_child) (MimeObject *parent, MimeObject *child);
00061 };
00062 
00063 extern MimeContainerClass mimeContainerClass;
00064 
00065 struct MimeContainer {
00066   MimeObject object;        /* superclass variables */
00067 
00068   MimeObject **children;    /* list of contained objects */
00069   PRInt32 nchildren;               /* how many */
00070 };
00071 
00072 #endif /* _MIMECONT_H_ */