Crystal Space: imap/saver.h Source File (Crystal Space Public API Reference)

| ## Public API Reference

- Main Page
- Modules
- Namespaces
- Classes
- Files
- Related Pages

- File List
- File Members

# imap/saver.h

Go to the documentation of this file.

    00001 /*
    00002     Copyright (C) 2002 by Jorrit Tyberghein
    00003
    00004     This library is free software; you can redistribute it and/or
    00005     modify it under the terms of the GNU Library General Public
    00006     License as published by the Free Software Foundation; either
    00007     version 2 of the License, or (at your option) any later version.
    00008
    00009     This library is distributed in the hope that it will be useful,
    00010     but WITHOUT ANY WARRANTY; without even the implied warranty of
    00011     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    00012     Library General Public License for more details.
    00013
    00014     You should have received a copy of the GNU Library General Public
    00015     License along with this library; if not, write to the Free
    00016     Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
    00017 */
    00018
    00019 #ifndef __CS_IMAP_SAVER_H__
    00020 #define __CS_IMAP_SAVER_H__
    00021
    00026 #include "csutil/scf_interface.h"
    00027
    00028 struct iDocumentNode;
    00029 struct iString;
    00030 struct iRegion;
    00031
    00036 struct iSaver : public virtual iBase
    00037 {
    00038   SCF_INTERFACE (iSaver, 2, 0, 1);
    00039
    00042
    00043   virtual bool SaveMapFile(const char *filename) = 0;
    00045   virtual csRef<iString> SaveMapFile() = 0;
    00047   virtual bool SaveMapFile(csRef<iDocumentNode> &root) = 0;
    00048
    00053   virtual bool SaveAllRegions() = 0;
    00054
    00056   virtual bool SaveRegionFile(iRegion* region, const char* filename,
    00057     int filetype) = 0;
    00058
    00060   virtual csRef<iString> SaveRegion(iRegion* region, int filetype) = 0;
    00061
    00063   virtual bool SaveRegion(iRegion* region, int filetype,
    00064     csRef<iDocumentNode>& root) = 0;
    00073   virtual bool SavePortal (iPortal *portal, iDocumentNode *parent) = 0;
    00074
    00075   // TODO: Add more, as needed
    00077 };
    00078
    00079 #endif // __CS_IMAP_SAVER_H__