Element.h

Go to the documentation of this file.

//---------------------------------------------------------------------------------------
// Copyright (c) 2001-2024 by Apryse Software Inc. All Rights Reserved.
// Consult legal.txt regarding legal and license information.    
//---------------------------------------------------------------------------------------
#ifndef PDFTRON_H_CPPPDFElement
#define PDFTRON_H_CPPPDFElement

#include <SDF/Obj.h>
#include <PDF/GState.h>
#include <PDF/Rect.h>
#include <PDF/CharData.h> 
#include <PDF/PathData.h> 
#include <PDF/Struct/SElement.h>
#include <C/PDF/TRN_Element.h>

namespace pdftron { 
    namespace PDF {


class Element 
{
public:
    // Common Methods ---------------------------------------------------------------

    enum Type
    {
        e_null,                  // undefined element type
        e_path,                  // path object
        e_text_begin,            // marks the beginning of a text container
        e_text,                  // text object within a text container
        e_text_new_line,         // indicates the start of the new text line
        e_text_end,              // marks the end of text container
        e_image,                 // image XObject
        e_inline_image,          // inline image object
        e_shading,               // shading object
        e_form,                  // a form XObject 
        e_group_begin,           // push graphics state operator (q)
        e_group_end,             // pop graphics state operator (Q)
        e_marked_content_begin,  // marks the beginning of marked content sequence (BMC, BDC)
        e_marked_content_end,    // marks the end of marked content sequence (EMC)
        e_marked_content_point   // designate a marked-content point (MP, DP) 
    };

    Element();
    Element(const Element& c);
    Element& operator=(const Element&c);
    operator bool () { return mp_elem!=0;}

    Type GetType();

    GState GetGState();

    Common::Matrix2D GetCTM();

    Rect GetBBox();

#ifndef SWIG
    bool GetBBox(Rect& out_bbox);
#endif
    
    Struct::SElement GetParentStructElement();

    int GetStructMCID();

    bool IsOCVisible();
    
    // Path Element (e_path) Get Methods --------------------------------------------

    bool IsClippingPath();

    bool IsStroked();

    bool IsFilled();
    
     bool IsWindingFill();

     bool IsClipWindingFill();

     PathData GetPathData() const;
     
    // Path Element (e_path) Set Methods --------------------------------------------
     
     void SetPathData(const PathData& data);

     void SetPathClip(bool clip);

     void SetPathStroke(bool stroke);

     void SetPathFill(bool fill);

     void SetWindingFill(bool winding_rule);

     void SetClipWindingFill(bool winding_rule);

    // XObject Element (e_image or e_form_begin) Methods ----------------------------

     SDF::Obj GetXObject();


    // Image (e_image and e_inline_image) Element Methods ---------------------------

     Filters::Filter GetImageData() const;

     int GetImageDataSize() const;

    #if defined(_WIN32)
     Gdiplus::Bitmap* GetBitmap() const;
    #endif

     ColorSpace GetImageColorSpace() const;

     int GetImageWidth() const;

     int GetImageHeight() const;

     SDF::Obj GetDecodeArray() const;

     int GetBitsPerComponent() const;

     int GetComponentNum() const;


     bool IsImageMask() const;

     bool IsImageInterpolate() const; 

     SDF::Obj GetMask() const; 

     GState::RenderingIntent GetImageRenderingIntent() const;

    // Text Element (e_text) Get Methods --------------------------------------------

     UString GetTextString();

#ifdef SWIG
     std::vector<unsigned char> GetTextData();
#else
     const UChar* GetTextData();
#endif
    
     UInt32 GetTextDataSize();

     Common::Matrix2D GetTextMatrix();

     CharIterator GetCharIterator();

     double GetTextLength();
    
     double GetPosAdjustment();

    // Text New Line Element (e_text_new_line) Methods ------------------------------

     Point GetNewTextLineOffset();

#ifndef SWIG
     void GetNewTextLineOffset(double& out_x, double& out_y);
#endif

     void SetNewTextLineOffset(double dx, double dy);


    // Text Element (e_text and e_text_new_line) Methods ----------------------------

      bool HasTextMatrix();


    // Text Element (e_text) Set Methods --------------------------------------------

      void SetTextData(const UChar* buf_text_data, int text_data_size);
    
     void SetTextMatrix(Common::Matrix2D& mtx);

     void SetTextMatrix(double a, double b, double c, double d, double h, double v);
    
     void SetPosAdjustment(double adjust);

     void UpdateTextMetrics();


    // Shading Element (e_shading) Methods ------------------------------------------

     Shading GetShading();

    // Marked Content Elements 
    // (e_marked_content_begin and e_marked_content_point) Methods ------------------

     SDF::Obj GetMCPropertyDict();
    
     SDF::Obj GetMCTag();
    
     ~Element() {}


// @cond PRIVATE_DOC
#ifndef SWIGHIDDEN
     Element(TRN_Element impl);
    TRN_Element mp_elem;
#endif
// @endcond
};


#include <Impl/Element.inl>

    };  // namespace PDF
};  // namespace pdftron

#endif // PDFTRON_H_CPPPDFElement