libs/odf/KoOdf.h

0001 /* This file is part of the KDE project
0002    Copyright (C) 2007 Thorsten Zachmann <zachmann@kde.org>
0003
0004    This library is free software; you can redistribute it and/or
0005    modify it under the terms of the GNU Library General Public
0006    License as published by the Free Software Foundation; either
0007    version 2 of the License, or (at your option) any later version.
0008
0009    This library is distributed in the hope that it will be useful,
0010    but WITHOUT ANY WARRANTY; without even the implied warranty of
0011    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
0012    Library General Public License for more details.
0013
0014    You should have received a copy of the GNU Library General Public License
0015    along with this library; see the file COPYING.LIB.  If not, write to
0016    the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
0017  * Boston, MA 02110-1301, USA.
0018 */
0019
0020 #ifndef KOODF_H
0021 #define KOODF_H
0022
0023 #include "koodf_export.h"
0024
0025 namespace KoOdf
0026 {
0027     enum DocumentType {
0028         Text,
0029         Graphics,
0030         Presentation,
0031         Spreadsheet,
0032         Chart,
0033         Image,
0034         Formula,
0035         OpenOfficeClipboard
0036     };
0037
0038     /**
0039      * Get the mime type
0040      *
0041      * @param documentType the document type
0042      * @return the mime type used for the given document type
0043      */
0044     KOODF_EXPORT const char * mimeType(DocumentType documentType);
0045
0046     /**
0047      * Get the mime type
0048      *
0049      * @param documentType the document type
0050      * @return the mime type used for templates of the given document type
0051      */
0052     KOODF_EXPORT const char * templateMimeType(DocumentType documentType);
0053
0054     /**
0055      * Get the mime type
0056      *
0057      * @param documentType the document type
0058      * @param withNamespace if true the namespace before the element is also returned
0059      *                      if false only the element is returned
0060      * @return the body element name for the given document type
0061      */
0062     KOODF_EXPORT const char * bodyContentElement(DocumentType documentType, bool withNamespace);
0063 }
0064
0065 #endif /* KOODF_H */