PdsPath Struct Reference

PdsPath class. More...

#include <pdfix.h>

Inheritance diagram for PdsPath:

Public Member Functions
virtual int	GetNumPathPoints () const =0
	Gets the number of path points. More...
virtual PdsPathPoint *	GetPathPoint (int index)=0
	Gets the requested path point. More...
virtual bool	SetStroke (bool stroke)=0
	Indicate whether the path should be stroked. More...
virtual bool	SetFillType (PdfFillRule fill)=0
	Sets path's fill rule. More...
virtual bool	MoveTo (const PdfPoint *point)=0
	Set the current point. More...
virtual bool	LineTo (const PdfPoint *point)=0
	Draw a line from the current point to the given point. More...
virtual bool	CurveTo (const PdfPoint *control_p_1, const PdfPoint *control_p_2, const PdfPoint *point)=0
virtual bool	ArcTo (const PdfPoint *end_p, const PdfPoint *radius_p, float angle, bool is_large, bool sweep)=0
	Draw an arc from the current point to the end point. More...
virtual bool	ClosePath ()=0
	Closes the current subpath. More...
Public Member Functions inherited from PdsPageObject
virtual PdfPageObjectType	GetObjectType () const =0
	Gets the type of an object. More...
virtual void	GetBBox (PdfRect *bbox) const =0
virtual void	GetQuad (PdfQuad *quad) const =0
virtual int	GetId ()=0
	Gets the ordinal number of a page object. More...
virtual int	GetStateFlags () const =0
	Get the object state flags. More...
virtual bool	SetStateFlags (PdfStateFlags flags)=0
	Set the object state flags. More...
virtual PdsObject *	GetStructObject (bool struct_parent)=0
virtual PdsContentMark *	GetContentMark ()=0
virtual int	GetMcid ()=0
	Gets content mark ID for this object or -1 if the object does not have MCID property. More...
virtual bool	RemoveTags (PdfContentMarkFlags flags)=0
virtual PdfPage *	GetPage ()=0
	Gets a reference to the page on which the object is present. More...
virtual int	GetContentStreamIndex ()=0
virtual PdsContent *	GetParentContent ()=0
	Gets a reference to the content in which the object is present. More...
virtual bool	GetGState (PdfGraphicState *g_state)=0
	Gets the graphic state of the page object. More...
virtual bool	SetGState (const PdfGraphicState *g_state)=0
virtual bool	TransformCTM (const PdfMatrix *matrix)=0
virtual bool	MoveToObject (PdsPageObject *ref_obj, bool after, int dst_tag_index, int obj_tag_index)=0
	Moves object within a content to another position. More...
virtual bool	MoveToContent (PdsContent *content, int index)=0
	Moves object to another content. More...
virtual PdsPageObject *	CopyToContent (PdsContent *content, int index)=0
	Copies object to another content. More...
virtual PdfDoc *	GetDoc ()=0
	Gets a reference to a document object. More...
virtual int	GetNumEqualTags (PdsPageObject *object)=0
	Count the number of different tags within the marked content of the two page objects. More...
virtual int	GetOperatorId ()=0
	Get the operator index which construcs the object in the page content. More...
virtual int	GetContentId ()=0
	Get the content index which identifies it within the tagged or untagged content. More...
virtual int	GetNumContentItemIds ()=0
	Get the number of content item identifiers within all marked contents. More...
virtual int	GetContentItemId (int level)=0
virtual bool	RegisterEvent (PdfEventType type, PdsPageObjectEventProc proc, void *data)=0
	Registers a user-supplied procedure to call when the specified event occurs. More...
virtual bool	UnregisterEvent (PdfEventType type, PdsPageObjectEventProc proc, void *data)=0

Detailed Description

PdsPath class.

A PdsPath is a path object in a PDF page content.

Member Function Documentation

ArcTo()

virtual bool PdsPath::ArcTo ( const PdfPoint *  end_p, const PdfPoint *  radius_p, float  angle, bool  is_large, bool  sweep  )

pure virtual

Draw an arc from the current point to the end point.

Parameters

end_p	Path point where the arc ends.
radius_p	Path point of radius.
angle	X-axis rotation in degrees.
is_large	Indicates if smaller or larger arc is chosen.
sweep	Direction in which arc is drawn.

Returns

true if the arc was successfully added. false otherwise.

ClosePath()

virtual bool PdsPath::ClosePath ( )

pure virtual

Closes the current subpath.

Returns

true if the line was successfully added. false otherwise.

CurveTo()

virtual bool PdsPath::CurveTo ( const PdfPoint *  control_p_1, const PdfPoint *  control_p_2, const PdfPoint *  point  )

pure virtual

Draw a Bezier curve from the current point to the given point using control_p_1 and control_p_2 as control points.

Parameters

control_p_1	First control point.
control_p_2	Second control point.
point	Path point where the curve ends.

Returns

true if the curve was successfully added. false otherwise.

GetNumPathPoints()

virtual int PdsPath::GetNumPathPoints ( ) const

pure virtual

Gets the number of path points.

Returns

Number of path points in the path construction.

GetPathPoint()

virtual PdsPathPoint * PdsPath::GetPathPoint ( int  index )

pure virtual

Gets the requested path point.

Parameters

index

Index of path point to obtain.

Returns

The requested path point.

LineTo()

virtual bool PdsPath::LineTo ( const PdfPoint *  point )

pure virtual

Draw a line from the current point to the given point.

Parameters

point

Path point where the line ends.

Returns

true if the line was successfully added. false otherwise.

MoveTo()

virtual bool PdsPath::MoveTo ( const PdfPoint *  point )

pure virtual

Set the current point.

Parameters

point

Path point to set.

Returns

true if the point was successfully set. false otherwise.

SetFillType()

virtual bool PdsPath::SetFillType ( PdfFillRule  fill )

pure virtual

Sets path's fill rule.

Parameters

fill	Path's fill rule.

Returns

true if the fill rule was successfully set. false otherwise.

SetStroke()

virtual bool PdsPath::SetStroke ( bool  stroke )

pure virtual

Indicate whether the path should be stroked.

Parameters

stroke

if true the path should be stroked otherwise not.

Returns

true if the stroke was successfully set. false otherwise.