Element.h

Go to the documentation of this file.

//---------------------------------------------------------------------------------------
// Copyright (c) 2001-2008 by PDFTron Systems Inc. All Rights Reserved.
// Consult legal.txt regarding legal and license information.    
//---------------------------------------------------------------------------------------

#ifndef   H_CPPPDFElement
#define   H_CPPPDFElement

#include <SDF/Obj.h>
#include <PDF/GState.h>
#include <PDF/Rect.h>
#include <PDF/CharData.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();

        bool GetBBox(Rect& out_bbox);
        
        Struct::SElement GetParentStructElement();

        int GetStructMCID();

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

        bool IsClippingPath();

        bool IsStroked();

        bool IsFilled();
        
         bool IsWindingFill();

         bool IsClipWindingFill();

        enum PathSegmentType
        {
                // Start a new sub-path at the given (x,y) coordinate.
                // Number of arguments: 2
                e_moveto = 1,

                // A line from the current point to the given (x,y) coordinate which becomes 
                // the new current point.
                // Number of arguments: 2
                e_lineto,                

                // A cubic Bézier curve from the current point to (x,y) using (x1,y1) as
                // the control point at the beginning of the curve and (x2,y2) as the control
                // point at the end of the curve.
                // Number of arguments: 6
                e_cubicto,

                // A quadratic Bézier curve from the current point to (x,y) using (x1,y1) as
                // the control point. Note that e_conicto does not appear in PDF content streams.
                // This operator is only used to represent glyph outlines (e.g. PDF::Font::GetGlyphPath()
                // may return a path containing e_conicto operator).
                // Number of arguments: 4
                e_conicto,              

                // A rectangle at the given (x,y) coordinate and the given width and height (w, h).
                // Number of arguments: 4
                e_rect,

                // Close the current subpath by drawing a straight line from the current point 
                // to current subpath's initial point.
                // Number of arguments: 0
                e_closepath
        };      

         const char* GetPathTypes();

         int GetPathTypesCount();

         const double* GetPathPoints();

         int GetPointCount();


        // Path Element (e_path) Set Methods --------------------------------------------

         void SetPathClip(bool clip);

         void SetPathStroke(bool stroke);

         void SetPathFill(bool fill);

         void SetWindingFill(bool winding_rule);

         void SetClipWindingFill(bool winding_rule);


         void SetPathPoints(const double* in_points, int count);

         void SetPathTypes(const char* in_seg_types, int count);


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

         SDF::Obj GetXObject();


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

         Filters::Filter GetImageData();

         int GetImageDataSize();

        #if defined(_WIN32) && !defined(WINCE)
         Gdiplus::Bitmap* GetBitmap();
        #endif

         SDF::Obj GetImageColorSpace();

         int GetImageWidth();

         int GetImageHeight();

         SDF::Obj GetDecodeArray();

         int GetBitsPerComponent();

         int GetComponentNum();


         bool IsImageMask();

         bool IsImageInterpolate(); 

         SDF::Obj GetMask(); 

         GState::RenderingIntent GetImageRenderingIntent();

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

         const UString* GetTextString();

         const UChar* GetTextData();
        
         UInt GetTextDataSize();

         Common::Matrix2D GetTextMatrix();

         CharIterator GetCharIterator();

         double GetTextLength();
        
         double GetPosAdjustment();

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

         void GetNewTextLineOffset(double& out_x, double& out_y);

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

          bool HasTextMatrix();


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

         void SetTextData(const UChar* 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();


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

         void SetNewTextLineOffset(double dx, double dy);


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

         SDF::Obj GetShading();

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

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


         Element(TRN_Element impl);
        TRN_Element mp_elem;
};


#include <Impl/Element.inl>

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

#endif

---

© 2002-2008 PDFTron Systems Inc.