PdeTextLine Struct Reference

PdeTextLine class. More...

Inheritance diagram for PdeTextLine:

Public Member Functions
virtual int	GetText (wchar_t *buffer, int len)=0
	Gets the text of the text line element. More...
virtual bool	HasTextState ()=0
virtual void	GetTextState (PdfTextState *text_state)=0
	Gets the text state of the text line element. More...
virtual int	GetNumWords ()=0
	Gets the number of word elements in the text line element. More...
virtual PdeWord *	GetWord (int index)=0
	Gets the word element from the text line element. More...
virtual int	GetTextLineFlags ()=0
	Gets the text line flags like bullet, list etc. More...
Public Member Functions inherited from PdeElement
virtual PdfElementType	GetType ()=0
	Gets the type of an element. More...
virtual void	GetBBox (PdfRect *bbox)=0
virtual bool	SetBBox (const PdfRect *bbox)=0
virtual int	GetId ()=0
	Gets the id of an element. The id is unique number on a page. More...
virtual void	GetGraphicState (PdfGraphicState *g_state)=0
	Gets the graphics state information for an element. More...
virtual int	GetNumChildren ()=0
	Gets the number of child elements in an element object. More...
virtual PdeElement *	GetChild (int index)=0
	Gets the requested child element from an element. More...
virtual PdfAlignment	GetAlignment ()=0
	Gets the element alignment within the content column. More...
virtual double	GetAngle ()=0
	Gets the element angle. More...
virtual void	SetRender (bool render)=0
	Sets render mode of the element. This mode is used, when element is saved. More...
virtual void	SetData (void *data)=0
	Sets user-supplied data to pass to the element. More...
virtual void *	GetData ()=0
	Gets user-supplied data to pass to the element. More...
virtual bool	SetAlt (const wchar_t *alt)=0
	Sets the alternate description of the element. More...
virtual bool	SetActualText (const wchar_t *text)=0
	Sets the actual text of the element. More...
virtual int	GetFlags ()=0
	Get the element state flags. More...
virtual bool	SetFlags (int flags)=0
	Set the element state flags. More...
virtual int	GetNumPageObjects ()=0
	Get the the number pf page object in the element. More...
virtual PdsPageObject *	GetPageObject (int index)=0
	Get the the page object of the element by index. More...
virtual PdePageMap *	GetPageMap ()=0
	Get the the page map object containing this element. More...

Detailed Description

PdeTextLine class.

A PdeTextLine object represents a line of text in a PDF file. Each text line contains an array of PdeWord objects with in one or more styles.

Member Function Documentation

GetNumWords()

virtual int PdeTextLine::GetNumWords ( )

pure virtual

Gets the number of word elements in the text line element.

Returns

Number of word elements within the text line element.

GetText()

virtual int PdeTextLine::GetText ( wchar_t *  buffer, int  len  )

pure virtual

Gets the text of the text line element.

Parameters

buffer	(filled by method) If the buffer is null function returns required length of string
len	Length of a buffer to be filled in.

Returns

Number of characters written into buffer of required length.

See also

PdeWord::GetText, PdeText::GetText

GetTextLineFlags()

virtual int PdeTextLine::GetTextLineFlags ( )

pure virtual

Gets the text line flags like bullet, list etc.

Returns

The combination of PdfTextLineFlags.

GetTextState()

virtual void PdeTextLine::GetTextState ( PdfTextState *  text_state )

pure virtual

Gets the text state of the text line element.

Parameters

text_state

(filled by method) A pointer to a PdfTextState structure specifying the text state of a first line character.

See also

PdeTextLine::HasTextState

GetWord()

virtual PdeWord* PdeTextLine::GetWord ( int  index )

pure virtual

Gets the word element from the text line element.

Parameters

index

The index of word element to obtain.

Returns

PdeWord element.

HasTextState()

virtual bool PdeTextLine::HasTextState ( )

pure virtual

Checks whether the text state can be obtained. It means that an each word of the text line has the same text state.

Returns

true if the text state is the same for the whole line, false otherwise. In that case use PdeWord::GetTextState to obtain correct values.

See also

PdeTextLine::GetTextState, PdeWord::GetTextState