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

PdeCell class. More...

#include <pdfix.h>

Inheritance diagram for PdeCell:
PdeContainer PdeElement

Public Member Functions

virtual int GetRowNum () const =0
 Returns the row number of the cell. More...
 
virtual bool SetRowNum (int row)=0
 Sets a cell's row number. More...
 
virtual int GetColNum () const =0
 Returns the col number of the cell. More...
 
virtual bool SetColNum (int col)=0
 Sets a cell's col number. More...
 
virtual bool GetHeader () const =0
 Returns a cell header or data type. More...
 
virtual bool SetHeader (bool header)=0
 Set cell header or data type. More...
 
virtual PdfCellScope GetHeaderScope () const =0
 Returns cell header scope attribute. More...
 
virtual bool SetHeaderScope (PdfCellScope scope)=0
 Set cell header scope attribute. More...
 
virtual int GetRowSpan () const =0
 
virtual bool 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 bool 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 () const =0
 Returns the parent cell. More...
 
virtual int GetNumAssociatedHeaders () const =0
 Get the number of associated header cells. More...
 
virtual int GetAssociatedHeader (int index, wchar_t *buffer, int len) const =0
 Get the associated header cell by index. More...
 
virtual bool AddAssociatedHeader (const wchar_t *id)=0
 Adds an associated header cell. More...
 
virtual bool RemoveAssociatedHeader (int index)=0
 Removes an associated header cell by index. 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 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 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

◆ AddAssociatedHeader()

virtual bool PdeCell::AddAssociatedHeader ( const wchar_t *  id)
pure virtual

Adds an associated header cell.

Parameters
idthe ID of the header cell
Returns
true if cell was added sucessfully, false otherwise.

◆ GetAssociatedHeader()

virtual int PdeCell::GetAssociatedHeader ( int  index,
wchar_t *  buffer,
int  len 
) const
pure virtual

Get the associated header cell by index.

Parameters
indexThe index of associated header cell.
buffer(filled by method) If the buffer is null function returns required length of string
lenLength of a buffer to be filled in.
Returns
Number of characters written into buffer of required length.

◆ GetColNum()

virtual int PdeCell::GetColNum ( ) const
pure virtual

Returns the col number of the cell.

Returns
Cell col number. The col number ignores the cell span.
See also
PdeTable::GetCell

◆ 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

◆ GetHeader()

virtual bool PdeCell::GetHeader ( ) const
pure virtual

Returns a cell header or data type.

Returns
true if cell is header.

◆ GetHeaderScope()

virtual PdfCellScope PdeCell::GetHeaderScope ( ) const
pure virtual

Returns cell header scope attribute.

Returns
The header scope attribute.

◆ GetNumAssociatedHeaders()

virtual int PdeCell::GetNumAssociatedHeaders ( ) const
pure virtual

Get the number of associated header cells.

Returns
A requested number of associated header cells.

◆ GetRowNum()

virtual int PdeCell::GetRowNum ( ) const
pure virtual

Returns the row number of the cell.

Returns
Cell row number. The row number ignores the cell span.
See also
PdeTable::GetCell

◆ 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 ( ) const
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.

◆ RemoveAssociatedHeader()

virtual bool PdeCell::RemoveAssociatedHeader ( int  index)
pure virtual

Removes an associated header cell by index.

Parameters
indexThe index of the cell to remove.
Returns
true if cell was removed sucessfully, false otherwise.

◆ SetColNum()

virtual bool PdeCell::SetColNum ( int  col)
pure virtual

Sets a cell's col number.

Parameters
columnnumber.

◆ SetColSpan()

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

Sets a cell's colspan.

Parameters
spanColspan.

◆ SetHeader()

virtual bool PdeCell::SetHeader ( bool  header)
pure virtual

Set cell header or data type.

Parameters
headerSet true if cell is a header.

◆ SetHeaderScope()

virtual bool PdeCell::SetHeaderScope ( PdfCellScope  scope)
pure virtual

Set cell header scope attribute.

Parameters
headerSet true if cell is a header.
Returns
true if the header scope arrtibute was set, false othervise.

◆ SetRowNum()

virtual bool PdeCell::SetRowNum ( int  row)
pure virtual

Sets a cell's row number.

Parameters
rownumber.

◆ SetRowSpan()

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

Sets a cell's rowspan.

Parameters
spanRowspan.