PDFix SDK  5.0.27
PdeElement Struct Referenceabstract

PdeElement class. More...

Inheritance diagram for PdeElement:
PdeAnnot PdeContainer PdeLine PdeList PdeText PdeTextLine PdeWord PdeFormField PdeCell PdeFooter PdeHeader PdeImage PdeRect PdeTable PdeToc

Public Member Functions

virtual PdfElementType GetType ()=0
 Gets the type of an element. More...
 
virtual void GetBBox (_out_ 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 (_out_ 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 PdeElementGetChild (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...
 

Detailed Description

PdeElement class.

PdeElement is the base class for elements of a pagemap (PdePageMap). The general PdeElement methods allow you to get and set general element properties. PdeElement is an abstract superclass from which the PdeText, PdeTextLine, PdeWord, PdeTable, PdeImage, PdeContainer, PdeLine, PdeRect, PdeTableCell, PdeFormField, PdeHeader, PdeFooter classes are derived. Use PdeElement::GetType method to find the type of an element.

Member Function Documentation

◆ GetAlignment()

virtual PdfAlignment PdeElement::GetAlignment ( )
pure virtual

Gets the element alignment within the content column.

Returns
Requested element alignment.

◆ GetAngle()

virtual double PdeElement::GetAngle ( )
pure virtual

Gets the element angle.

Returns
Requested element angle.

◆ GetBBox()

virtual void PdeElement::GetBBox ( _out_ PdfRect bbox)
pure virtual

Gets the bounding box for an element in user space coordinates. To avoid the device-dependent effects of specifying objects in device space, PDF defines a device-independent coordinate system that always bears the same relationship to the current page, regardless of the output device on which printing or displaying occurs. This device-independent coordinate system is called user space. The origin of the user space(0, 0) represents the bottom-left corner of the PDF page. PDF files specify 72 points to 1 physical inch. The returned bounding box is guaranteed to encompass the element.


Parameters
bbox(Filled by the method) A pointer to a PdfRect structure specifying the bounding box of an element, specified in user space coordinates.

◆ GetChild()

virtual PdeElement* PdeElement::GetChild ( int  index)
pure virtual

Gets the requested child element from an element.

Parameters
indexThe index of element to obtain.
Returns
Requested element.
See also
PdeElement::GetNumChildren

◆ GetData()

virtual void* PdeElement::GetData ( )
pure virtual

Gets user-supplied data to pass to the element.

Returns
User-supplied data from the element.

◆ GetFlags()

virtual int PdeElement::GetFlags ( )
pure virtual

Get the element state flags.

Returns
the element flags as PdfElementStateFlags.

◆ GetGraphicState()

virtual void PdeElement::GetGraphicState ( _out_ PdfGraphicState g_state)
pure virtual

Gets the graphics state information for an element.

Parameters
g_state(Filled by the method) Pointer to a PdfGraphicState structure that contains graphics state information for pdeElement.

◆ GetId()

virtual int PdeElement::GetId ( )
pure virtual

Gets the id of an element. The id is unique number on a page.

Returns
Unique number for the element.

◆ GetNumChildren()

virtual int PdeElement::GetNumChildren ( )
pure virtual

Gets the number of child elements in an element object.

Returns
The number of children.
See also
PdeElement::GetChild

◆ GetType()

virtual PdfElementType PdeElement::GetType ( )
pure virtual

Gets the type of an element.

Returns
Element type, kElementUnknown otherwise.

◆ SetActualText()

virtual bool PdeElement::SetActualText ( const wchar_t *  text)
pure virtual

Sets the actual text of the element.

Parameters
altThe actual text to be set.
Returns
true if the actual text was set, false otherwise.

◆ SetAlt()

virtual bool PdeElement::SetAlt ( const wchar_t *  alt)
pure virtual

Sets the alternate description of the element.

Parameters
altThe alternate decsription to be set.
Returns
true if the description was set, false otherwise.

◆ SetBBox()

virtual bool PdeElement::SetBBox ( const PdfRect bbox)
pure virtual

Gets the bounding box for an element in user space coordinates. To avoid the device-dependent effects of specifying objects in device space, PDF defines a device-independent coordinate system that always bears the same relationship to the current page, regardless of the output device on which printing or displaying occurs. This device-independent coordinate system is called user space. The origin of the user space(0, 0) represents the bottom-left corner of the PDF page. PDF files specify 72 points to 1 physical inch. The returned bounding box is guaranteed to encompass the element.


Parameters
bboxA pointer to a PdfRect structure specifying the bounding box of an element, specified in user space coordinates.

◆ SetData()

virtual void PdeElement::SetData ( void *  data)
pure virtual

Sets user-supplied data to pass to the element.

Parameters
dataUser-supplied data to pass to element.

◆ SetFlags()

virtual bool PdeElement::SetFlags ( int  flags)
pure virtual

Set the element state flags.

Parameters
flagsthe PdfElementFlags flags to be set
Returns
true if the element flags was set false othervise

◆ SetRender()

virtual void PdeElement::SetRender ( bool  render)
pure virtual

Sets render mode of the element. This mode is used, when element is saved.

Parameters
modeRender mode.