PDFix SDK  6.19.0
Loading...
Searching...
No Matches
PdeCell Struct Referenceabstract

PdeCell class. More...

#include <pdfix.h>

Inheritance diagram for PdeCell:
PdeContainer PdeElement

Public Member Functions

virtual bool GetRowHeader () const =0
 Returns a cell's scope. More...
 
virtual void SetRowHeader (bool header)=0
 Sets a cell's scope. More...
 
virtual bool GetColHeader () const =0
 Returns a cell's scope. More...
 
virtual void SetColHeader (bool header)=0
 Sets a cell's scope. More...
 
virtual int GetRowSpan () const =0
 
virtual void SetRowSpan (int span)=0
 Sets a cell's rowspan. More...
 
virtual int GetColSpan () const =0
 Returns the number of columns spanned by the cell. More...
 
virtual void SetColSpan (int span)=0
 Sets a cell's colspan. More...
 
virtual bool HasBorderGraphicState (int index) const =0
 Returns the number of columns spanned by the cell. More...
 
virtual PdeCellGetSpanCell ()=0
 Returns the parent cell. 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 PdeElementGetChild (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 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 (int 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 PdsPageObjectGetPageObject (int index)=0
 Get the the page object of the element by index. More...
 
virtual PdePageMapGetPageMap ()=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

PdeCell class.

A PdeCell class represents a single cell of PdeTable element.

Member Function Documentation

◆ GetColHeader()

virtual bool PdeCell::GetColHeader ( ) const
pure virtual

Returns a cell's scope.

Returns
true if cell is a column header.

◆ GetColSpan()

virtual int PdeCell::GetColSpan ( ) const
pure virtual

Returns the number of columns spanned by the cell.

Returns
Cell colspan, 0 if the cell is merged with another cell.
See also
PdeTable::GetCell

◆ GetRowHeader()

virtual bool PdeCell::GetRowHeader ( ) const
pure virtual

Returns a cell's scope.

Returns
true if cell is a row header.

◆ GetRowSpan()

virtual int PdeCell::GetRowSpan ( ) const
pure virtual

Returns the number of rows spanned by the cell. The default value is 0, which indicates that this cell is merged. NOTE: Ignore such cells in further processing.

Returns
Cell rowspan, 0 if the cell is merged with another cell.
See also
PdeTable::GetCell

◆ GetSpanCell()

virtual PdeCell * PdeCell::GetSpanCell ( )
pure virtual

Returns the parent cell.

Returns
A requested span parent cell.

◆ HasBorderGraphicState()

virtual bool PdeCell::HasBorderGraphicState ( int  index) const
pure virtual

Returns the number of columns spanned by the cell.

Returns
Cell colspan, 0 if the cell is merged with another cell. Sets a cell's colspan.
Parameters
spanColspan. Returns true if the border with requested index has a stoke border.
indexThe border index from 0(top) to 3(left).
Returns
True if the stroke border exist, false otherwise.

◆ SetColHeader()

virtual void PdeCell::SetColHeader ( bool  header)
pure virtual

Sets a cell's scope.

Parameters
headerSet true when cell is a column header.

◆ SetColSpan()

virtual void PdeCell::SetColSpan ( int  span)
pure virtual

Sets a cell's colspan.

Parameters
spanColspan.

◆ SetRowHeader()

virtual void PdeCell::SetRowHeader ( bool  header)
pure virtual

Sets a cell's scope.

Parameters
headerSet true when cell is a row header.

◆ SetRowSpan()

virtual void PdeCell::SetRowSpan ( int  span)
pure virtual

Sets a cell's rowspan.

Parameters
spanRowspan.