ContentTree.h

Go to the documentation of this file.

#ifndef PDFTRON_H_CPPContentTree
#define PDFTRON_H_CPPContentTree

#include <C/Layout/TRN_ContentElement.h>
#include <C/Layout/TRN_ContentNode.h>
#include <C/Layout/TRN_Paragraph.h>
#include <C/Layout/TRN_Table.h>
#include <C/Layout/TRN_TableRow.h>
#include <C/Layout/TRN_TableCell.h>
#include <C/Layout/TRN_TextRun.h>
#include <C/Layout/TRN_TextStyledElement.h>
#include <C/Layout/TRN_List.h>
#include <C/Layout/TRN_ListItem.h>

#include <Common/BasicTypes.h>
#include <Common/UString.h>

namespace pdftron { namespace Layout {

class Paragraph;
class ContentNode;
class TextRun;
class Table;
class TableRow;
class TableCell;
class ContentGroup;
class FlowDocument;
class List;
class ListItem;

template <typename T>
class ElementRef
{
    friend class ContentElement;

    template <typename TImpl>
    ElementRef(TImpl impl);

public:
    ElementRef();

    T& GetElement();

    bool IsValid();

    operator void*();

    T* operator->();

    T& operator*();

private:
    T m_element;
};

class TextStyledElement
{
    friend class ContentNode;
    friend class TextRun;
    friend class List;
    friend class ContentElement;

    TextStyledElement(TRN_TextStyledElement impl);

public:

    void SetFontFace(const UString& font_name);

    UString GetFontFace();

    void SetFontSize(double font_size);
    
    double GetFontSize();

    void SetItalic(bool val);

    bool IsItalic();
    
    void SetBold(bool val);

    bool IsBold();

    void SetTextColor(UInt8 red, UInt8 green, UInt8 blue);

    void SetBackgroundColor(UInt8 red, UInt8 green, UInt8 blue);

#ifndef SWIGHIDDEN
    TRN_TextStyledElement m_impl;
#endif
};

class ContentElement
{
protected:
    ContentElement(TRN_ContentElement impl);

public:
    ~ContentElement();
    void Destroy();

    ElementRef<List> AsList() const;

    ElementRef<ListItem> AsListItem() const;

    ElementRef<ContentNode> AsContentNode() const;

    ElementRef<TextRun> AsTextRun() const;

    ElementRef<Paragraph> AsParagraph() const;

    ElementRef<Table> AsTable() const;

    ElementRef<TableRow> AsTableRow() const;

    ElementRef<TableCell> AsTableCell() const;

    TextStyledElement GetTextStyledElement();

#ifndef SWIGHIDDEN
    TRN_ContentElement m_impl;
#endif
};

class TextRun : public ContentElement
{
    friend class Paragraph;
    friend class ElementRef<TextRun>;

    TextRun(TRN_TextRun impl);

public:
    ~TextRun();
    void Destroy();

    void SetText(const UString& text);

    UString GetText();
};

typedef Common::Iterator<ContentElement> ContentNodeIterator;

class ContentNode : public ContentElement
{
    friend class FlowDocument;
    friend class ElementRef<TableCell>;
    friend class ElementRef<ContentNode>;

protected:
    ContentNode(TRN_ContentNode impl);

public:
    ~ContentNode();
    void Destroy();

    ContentNodeIterator GetContentNodeIterator();
};

class Paragraph : public ContentNode
{
    friend class FlowDocument;
    friend class ListItem;
    friend class ElementRef<Paragraph>;
    friend class TableCell;

    Paragraph(TRN_Paragraph impl);

public:
    enum TextJustification
    {
        e_text_justification_invalid = 0,
        e_text_justify_left = 1,
        e_text_justify_right = 2,
        e_text_justify_center = 3
    };

    ~Paragraph();
    void Destroy();

    TextRun AddText(const UString& text);

    void SetSpaceBefore(double val);

    double GetSpaceBefore();

    void SetSpaceAfter(double val);

    double GetSpaceAfter();

    void SetJustificationMode(TextJustification val);

    TextJustification GetJustificationMode();

    void SetStartIndent(double val);

    double GetStartIndent();

    void SetEndIndent(double val);

    double GetEndIndent();

    void SetTextIndent(double val);

    double GetTextIndent();

    void SetBorder(double thickness, UInt8 red, UInt8 green, UInt8 blue);

    double GetBorderThickness();

    void AddTabStop(double val);

    double GetNextTabStop(double val);

    void SetDefaultTabStop(double val);

    double GetDefaultTabStop();

    void SetSpacesPerTab(UInt32 val);

    UInt32 GetSpacesPerTab();

    void SetDisplayRtl(bool val);

    bool IsDisplayRtl();
};


class TableCell : public ContentNode
{
    friend class Table;
    friend class TableRow;
    friend class ElementRef<TableCell>;

    TableCell(TRN_TableCell impl);

public:
    enum CellAlignmentVertical
    {
        e_alignment_top = 1,
        e_alignment_center = 2,
        e_alignment_bottom = 3,
    };

    enum CellAlignmentHorizontal
    {
        e_alignment_left = 1,
        e_alignment_middle = 2,
        e_alignment_right = 3,
    };

    ~TableCell();
    void Destroy();

    Paragraph AddParagraph();

    Paragraph AddParagraph(const UString& text);

    Table AddTable();

    TableCell MergeCellsRight(UInt32 num);

    TableCell MergeCellsDown(UInt32 num);

    void SetBackgroundColor(UInt8 red, UInt8 green, UInt8 blue);
    
    void SetBorder(double thickness, UInt8 red, UInt8 green, UInt8 blue);

    double GetBorderThickness();

    void SetVerticalAlignment(CellAlignmentVertical val);
    
    CellAlignmentVertical GetVerticalAlignment(); 

    void SetHorizontalAlignment(CellAlignmentHorizontal val);
    
    CellAlignmentHorizontal GetHorizontalAlignment(); 

    void SetHeight(double val);

    double GetHeight();

    void SetWidth(double val);

    double GetWidth();
};

class TableRow : public ContentNode
{
    friend class Table;
    friend class ElementRef<TableRow>;

    TableRow(TRN_TableRow impl);

public:
    ~TableRow();
    void Destroy();

    TableCell AddTableCell();

    void SetRowHeight(double val);

    UInt32 GetNumColumns();
};

class Table : public ContentNode
{
    friend class FlowDocument;
    friend class ElementRef<Table>;
    friend class TableCell;

    Table(TRN_Table impl);

public:
    ~Table();
    void Destroy();

    TableRow AddTableRow();

    TableCell GetTableCell(UInt32 column, UInt32 row);

    void SetDefaultColumnWidth(double val);

    double GetDefaultRowHeight();

    void SetDefaultRowHeight(double val);

    void SetBorder(double thickness, UInt8 red, UInt8 green, UInt8 blue);

    double GetBorderThickness();

    UInt32 GetNumRows();

    UInt32 GetNumColumns();
};

class List : public ContentNode
{
    friend class FlowDocument;
    friend class TableCell;
    friend class ListItem;
    friend class ElementRef<List>;

    List(TRN_List impl);
    void Destroy();
    void UpdateLastItemRef(TRN_ContentElement last_item);

public:
    enum NumberFormat
    {
        e_none = 0,
        e_decimal,
        e_lower_roman,
        e_upper_roman,
        e_lower_letter,
        e_upper_letter,
        e_ordinal,
        e_ordinal_text,
        e_chinese_counting,
        e_chinese_counting_thousand,
        e_cardinal_text,
        e_decimal_zero,
    };

    ~List();

    void SetNumberFormat(const NumberFormat format);

    void SetNumberFormat(const NumberFormat format, const UString& suffix, bool cascade);

    TextStyledElement GetLabelStyle();

    void SetStartIndex(int idx);

    ListItem AddItem();

    void ContinueList();

    int GetIndentationLevel();

    int GetListIdentifier();

#ifndef SWIGHIDDEN
    TRN_List m_impl;
#endif
};

class ListItem : public ContentNode
{
    friend class List;
    friend class ElementRef<ListItem>;

    ListItem(TRN_ListItem impl);
    void Destroy();
    void UpdateLastItemRef(TRN_ContentElement last_item);

public:
    ~ListItem();

    Paragraph AddParagraph();

    Paragraph AddParagraph(const UString& text);

    List AddList();

    int GetIndentationLevel();

    int GetListIdentifier();

    int GetItemIndex();

#ifndef SWIGHIDDEN
    TRN_ListItem m_impl;
#endif
};

#include <Impl/ContentElement.inl>
#include <Impl/ContentNode.inl>
#include <Impl/ElementRef.inl>
#include <Impl/Paragraph.inl>
#include <Impl/TextRun.inl>
#include <Impl/TextStyledElement.inl>
#include <Impl/TableCell.inl>
#include <Impl/TableRow.inl>
#include <Impl/Table.inl>
#include <Impl/ListItem.inl>
#include <Impl/List.inl>

} //end pdftron
} //end Layout

#endif // PDFTRON_H_CPPContentTree