OXML_Document.h

Go to the documentation of this file.

/* -*- mode: C++; tab-width: 4; c-basic-offset: 4; -*- */

/* AbiSource
 *
 * Copyright (C) 2007 Philippe Milot <PhilMilot@gmail.com>
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
 * 02110-1301 USA.
 */

#ifndef _OXML_DOCUMENT_H_
#define _OXML_DOCUMENT_H_

// Internal includes
#include <OXML_Types.h>
#include <OXML_ObjectWithAttrProp.h>
#include "OXML_Section.h"
#include "OXML_Style.h"
#include "OXML_Theme.h"
#include "OXML_FontManager.h"

// AbiWord includes
#include <ut_types.h>
#include <pd_Document.h>
#include <ie_exp_OpenXML.h>

// External includes
#include <string>

/* \class OXML_Document
 * This class represents the data model representation of the OpenXML document.
 * Since there is only one document to be imported / exported at a time, this is
 * enforced by the use of the Singleton pattern.
 */
class OXML_Document : public OXML_ObjectWithAttrProp
{
public:
    static OXML_Document* getNewInstance();
    static OXML_Document* getInstance();
    static void destroyInstance();
    static OXML_SharedSection getCurrentSection();

    OXML_SharedStyle getStyleById(const std::string & id) const;
    OXML_SharedStyle getStyleByName(const std::string & name) const;
    UT_Error addStyle(const std::string & id, const std::string & name, const gchar ** attributes);
    UT_Error addStyle(const OXML_SharedStyle & obj);
    UT_Error clearStyles();

    UT_Error addList(const OXML_SharedList& obj);
    UT_Error addImage(const OXML_SharedImage& obj);
    OXML_SharedList getListById(UT_uint32 id) const;
    OXML_SharedImage getImageById(const std::string & id) const;

    OXML_SharedSection getFootnote(const std::string & id) const;
    UT_Error addFootnote(const OXML_SharedSection & obj);
    UT_Error clearFootnotes();

    OXML_SharedSection getEndnote(const std::string & id) const;
    UT_Error addEndnote(const OXML_SharedSection & obj);
    UT_Error clearEndnotes();

    OXML_SharedSection getHeader(const std::string & id) const;
    UT_Error addHeader(const OXML_SharedSection & obj);
    UT_Error clearHeaders();

    bool isAllDefault(const bool & header) const;
    OXML_SharedSection getHdrFtrById(const bool & header, const std::string & id) const;

    OXML_SharedSection getFooter(const std::string & id) const;
    UT_Error addFooter(const OXML_SharedSection & obj);
    UT_Error clearFooters();

    OXML_SharedSection getLastSection() const;
    OXML_SharedSection getSection(const std::string & id) const;
    UT_Error appendSection(const OXML_SharedSection & obj);
    UT_Error clearSections();

    OXML_SharedTheme getTheme();
    OXML_SharedFontManager getFontManager();


    UT_Error serialize(IE_Exp_OpenXML* exporter);

    UT_Error addToPT(PD_Document * pDocument);

    std::string getMappedNumberingId(const std::string & numId) const;
    bool setMappedNumberingId(const std::string & numId, const std::string & abstractNumId);

    std::string getBookmarkName(const std::string & bookmarkId) const;
    std::string getBookmarkId(const std::string & bookmarkName) const;
    bool setBookmarkName(const std::string & bookmarkId, const std::string & bookmarkName);

    void setPageWidth(const std::string & width);
    void setPageHeight(const std::string & height);
    void setPageOrientation(const std::string & orientation);
    void setPageMargins(const std::string & top, const std::string & left, const std::string & right, const std::string & bottom);
    void setColumns(const std::string & colNum, const std::string & colSep);

private:
    static OXML_Document* s_docInst;
    OXML_Document();
    virtual ~OXML_Document();

    OXML_SectionVector m_sections;

    OXML_SectionMap m_headers;
    OXML_SectionMap m_footers;
    OXML_SectionMap m_footnotes;
    OXML_SectionMap m_endnotes;

    OXML_StyleMap m_styles_by_id;
    OXML_StyleMap m_styles_by_name;

    OXML_SharedTheme m_theme;
    OXML_SharedFontManager m_fontManager;

    OXML_ListMap m_lists_by_id;
    OXML_ImageMap m_images_by_id;

    std::map<std::string, std::string> m_numberingMap;
    std::map<std::string, std::string> m_bookmarkMap;

    std::string m_pageWidth;
    std::string m_pageHeight;
    std::string m_pageOrientation;

    std::string m_pageMarginTop;
    std::string m_pageMarginLeft;
    std::string m_pageMarginRight;
    std::string m_pageMarginBottom;

    std::string m_colNum;
    std::string m_colSep;

    void _assignHdrFtrIds();
    UT_Error applyPageProps(PD_Document* pDocument);
};

#endif //_OXML_DOCUMENT_H_