fl_Layout.h

Go to the documentation of this file.

/* AbiWord
 * Copyright (C) 1998 AbiSource, Inc.
 *
 * 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 FL_LAYOUT_H
#define FL_LAYOUT_H

#include "ut_types.h"
#include "pt_Types.h"
#include "fl_AutoNum.h"

class PP_AttrProp;
class PP_RevisionAttr;
class PD_Document;
class fd_Field;
class po_Bookmark;
class pf_Frag_Strux;

class ABI_EXPORT fl_Layout
{
public:
    fl_Layout(PTStruxType type, pf_Frag_Strux* sdh);
    virtual ~fl_Layout();

    pf_Frag_Strux*           getStruxDocHandle(void) const
        { return m_sdh; }
    pf_Frag_Strux*           getEndStruxDocHandle(void) const
        { return m_endSdh; }
    void                         setEndStruxDocHandle(pf_Frag_Strux * pfs);
    PTStruxType         getType(void) const
        { return m_type; }
    void                setType(PTStruxType type);
    PT_AttrPropIndex    getAttrPropIndex(void) const
        { return m_apIndex; }
    void                setAttrPropIndex(PT_AttrPropIndex apIndex);

    bool                getAttrProp(const PP_AttrProp ** ppAP, std::unique_ptr<PP_RevisionAttr>& pRevisions,
                                    bool bShowRevisions, UT_uint32 iRevisionId,
                                    bool &bHiddenRevision) const;

    bool    getSpanAttrProp(UT_uint32 offset, bool bLeftSide, const PP_AttrProp ** ppAP,
                                std::unique_ptr<PP_RevisionAttr>& pRevisions,
                                bool bShowRevisions, UT_uint32 iRevisionId,
                                bool &bHiddenRevision) const;

    bool                getField(UT_uint32 offset, fd_Field * &pField);
    po_Bookmark *       getBookmark(UT_uint32 offset);
    virtual void        listUpdate(void) { return; }
    inline const fl_AutoNumPtr &    getAutoNum(void) const { return m_pAutoNum; }
    void                setAutoNum(const fl_AutoNumPtr & pAutoNum);

    PD_Document *       getDocument(void) const { return m_pDoc; };

protected:
    PTStruxType             m_type;
    PT_AttrPropIndex        m_apIndex;
    fl_AutoNumPtr           m_pAutoNum;

    PD_Document *           m_pDoc;     // set by child
private:
    pf_Frag_Strux*      m_sdh;
    pf_Frag_Strux*      m_endSdh;
};

#endif /* FL_LAYOUT_H */