PdfOutlines.h

// SPDX-FileCopyrightText: 2006 Dominik Seichter <domseichter@web.de>
// SPDX-License-Identifier: LGPL-2.0-or-later OR MPL-2.0
 
#ifndef PDF_OUTLINE_H
#define PDF_OUTLINE_H
 
#include "PdfElement.h"
#include "PdfColor.h"
 
namespace PoDoFo {
 
class PdfDestination;
class PdfAction;
 
enum class PdfOutlineFormat : uint8_t
{
    Default = 0,      
    Italic = 1,       
    Bold = 2,         
    BoldItalic = 3,   
};
 
class PODOFO_API PdfOutlineItem : public PdfDictionaryElement
{
    friend class PdfOutlines;
    friend class PdfDocument;
 
private:
    PdfOutlineItem(PdfDocument& doc, PdfOutlineItem* parentOutline = nullptr);
 
    PdfOutlineItem(PdfObject& obj, PdfOutlineItem* parentOutline, PdfOutlineItem* previous);
 
    PdfOutlineItem(const PdfOutlineItem&) = delete;
 
public:
    virtual ~PdfOutlineItem();
 
    PdfOutlineItem& CreateChild(const PdfString& title);
 
    PdfOutlineItem& CreateNext(const PdfString& title);
 
    inline PdfOutlineItem* Prev() const { return m_Prev; }
 
    inline PdfOutlineItem* Next() const { return m_Next; }
 
    inline PdfOutlineItem* First() const { return m_First; }
 
    inline PdfOutlineItem* Last() const { return m_Last; }
 
    inline PdfOutlineItem* GetParentOutline() const { return m_ParentOutline; }
 
    void Erase();
 
    void SetDestination(nullable<const PdfDestination&> dest);
 
    nullable<const PdfDestination&> GetDestination() const;
    nullable<PdfDestination&> GetDestination();
 
    void SetAction(nullable<const PdfAction&> action);
 
    nullable<const PdfAction&> GetAction() const;
    nullable<PdfAction&> GetAction();
 
    void SetTitle(const PdfString& title);
 
    const PdfString& GetTitle() const;
 
    void SetTextFormat(PdfOutlineFormat format);
 
    PdfOutlineFormat GetTextFormat() const;
 
    void SetTextColor(const PdfColor& color);
 
    PdfColor GetTextColor() const;
 
private:
    void InsertChild(std::unique_ptr<PdfOutlineItem> item);
 
    nullable<PdfAction&> getAction();
    nullable<PdfDestination&> getDestination();
    void setPrevious(PdfOutlineItem* item);
    void setNext(PdfOutlineItem* item);
    void setLast(PdfOutlineItem* item);
    void setFirst(PdfOutlineItem* item);
    void insertChildInternal(PdfOutlineItem* item, bool checkSameTree);
 
private:
    PdfOutlineItem* m_ParentOutline;
 
    PdfOutlineItem* m_Prev;
    PdfOutlineItem* m_Next;
 
    PdfOutlineItem* m_First;
    PdfOutlineItem* m_Last;
 
    nullable<std::unique_ptr<PdfDestination>> m_Destination;
    nullable<std::unique_ptr<PdfAction>> m_Action;
};
 
class PODOFO_API PdfOutlines final : public PdfOutlineItem
{
    friend class PdfDocument;
 
private:
    PdfOutlines(PdfDocument& doc);
 
    PdfOutlines(PdfObject& obj);
 
public:
    PdfOutlineItem& CreateRoot(const PdfString& title);
};
 
};
 
#endif // PDF_OUTLINE_H