#include <pdfix.h>

Inheritance diagram for PdeText:

Public Member Functions
virtual int	GetText (wchar_t *buffer, int len) const =0
	Gets the text of the text element. More...

virtual bool	HasTextState () const =0

virtual void	GetTextState (PdfTextState *text_state)=0
	Gets the text state of the text element. More...

virtual int	GetNumTextLines () const =0
	Gets the number of lines of text in text element. More...

virtual PdeTextLine *	GetTextLine (int index)=0
	Gets the text line element from the text element. More...

virtual int	GetNumWords () const =0
	Gets the number of words of text in text element. More...

virtual PdeWord *	GetWord (int index)=0
	Gets the word from the text element. More...

virtual float	GetLineSpacing () const =0
	Gets the text element line spacing. More...

virtual float	GetIndent () const =0
	Gets the text element indent. More...

virtual PdfTextStyle	GetTextStyle () const =0
	Gets the text element style. More...

virtual bool	SetTextStyle (PdfTextStyle style)=0
	Sets the text element style. More...

virtual PdfTextFlags	GetTextFlags () const =0
	Gets the text element flags. More...

virtual bool	SetTextFlags (PdfTextFlags flags)=0
	Sets the text element flags. More...

Public Member Functions inherited from PdeElement
virtual PdfElementType	GetType () const =0
	Gets the type of an element. More...

virtual void	GetBBox (PdfRect *bbox) const =0

virtual bool	SetBBox (const PdfRect *bbox)=0

virtual void	GetQuad (PdfQuad *quad) const =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 () const =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 () const =0
	Gets the element alignment within the content column. More...

virtual float	GetAngle () const =0
	Gets the element angle. More...

virtual void	SetData (void *data)=0
	Sets user-supplied data to pass to the element. More...

virtual void *	GetData () const =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	GetTag (wchar_t *buffer, int len) const =0
	Gets the tag name of the element. More...

virtual bool	SetTag (const wchar_t *text)=0
	Sets the tag name of the element. More...

virtual int	GetTagId (wchar_t *buffer, int len) const =0
	Gets the tag id of the element. More...

virtual bool	SetTagId (const wchar_t *id)=0
	Sets the tag id of the element. More...

virtual int	GetFlags () const =0
	Get the element state flags. More...

virtual bool	SetFlags (int flags)=0
	Set the element state flags. More...

virtual int	GetStateFlags () const =0
	Get the element state flags. More...

virtual bool	SetStateFlags (PdfStateFlags flags, bool objects)=0
	Set the element state flags. More...

virtual int	GetNumPageObjects () const =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...

virtual PdfLabelType	GetLabelType () const =0
	Gets the element label type. More...

virtual bool	SetLabelType (PdfLabelType type)=0
	Sets the element type level. More...

Detailed Description

PdeText class.

A PdeText object represents a group of text line objects which forms a paragraph in a PDF file.

Member Function Documentation

◆ GetIndent()

virtual float PdeText::GetIndent ( ) const

pure virtual

Gets the text element indent.

Returns: The text element indent.

◆ GetLineSpacing()

virtual float PdeText::GetLineSpacing ( ) const

pure virtual

Gets the text element line spacing.

Returns: The text element line spacing.

◆ GetNumTextLines()

virtual int PdeText::GetNumTextLines ( ) const

pure virtual

Gets the number of lines of text in text element.

Returns: Number of lines.

See also: PdeText::GetTextLine

◆ GetNumWords()

virtual int PdeText::GetNumWords ( ) const

pure virtual

Gets the number of words of text in text element.

Returns: Number of words.

See also: PdeText::GetWord

◆ GetText()

virtual int PdeText::GetText	(	wchar_t *	buffer,
		int	len
	)		const

pure virtual

Gets the text of the text 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: PdeTextLine::GetText, PdeWord::GetText

◆ GetTextFlags()

virtual PdfTextFlags PdeText::GetTextFlags ( ) const

pure virtual

Gets the text element flags.

Returns: The text element flags.

◆ GetTextLine()

virtual PdeTextLine * PdeText::GetTextLine ( int index )

pure virtual

Gets the text line element from the text element.

Parameters

index The index of line to get.

Returns: PdeTextLine element.

See also: PdeText::GetNumTextLines

◆ GetTextState()

virtual void PdeText::GetTextState ( PdfTextState * text_state )

pure virtual

Gets the text state of the text element.

Parameters

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

See also: PdeText::HasTextState

◆ GetTextStyle()

virtual PdfTextStyle PdeText::GetTextStyle ( ) const

pure virtual

Gets the text element style.

Returns: The text element style.

◆ GetWord()

virtual PdeWord * PdeText::GetWord ( int index )

pure virtual

Gets the word from the text element.

Parameters

index The index of word to get.

Returns: PdeWord element.

See also: PdeText::GetNumWords

◆ HasTextState()

virtual bool PdeText::HasTextState ( ) const

pure virtual

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

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

See also: PdeText::GetTextState, PdeTextLine::GetTextState

◆ SetTextFlags()

virtual bool PdeText::SetTextFlags ( PdfTextFlags flags )

pure virtual

Sets the text element flags.

Parameters

style Text flags.

Returns: true if text flags was set, false otherwise.

◆ SetTextStyle()

virtual bool PdeText::SetTextStyle ( PdfTextStyle style )

pure virtual

Sets the text element style.

Parameters

style Text heading style H1, H2, and more.

Returns: true if text style was set, false otherwise.

Public Member Functions

Detailed Description

Member Function Documentation

◆ GetIndent()

◆ GetLineSpacing()

◆ GetNumTextLines()

◆ GetNumWords()

◆ GetText()

◆ GetTextFlags()

◆ GetTextLine()

◆ GetTextState()

◆ GetTextStyle()

◆ GetWord()

◆ HasTextState()

◆ SetTextFlags()

◆ SetTextStyle()