Class DocumentBlock

Summary

Public Methods

DocumentBlock(regionId)

inline int getRegionId() const

inline string getType() const

inline int getDepth() const

inline int getRow() const

inline int getColumn() const

inline int itemCount() const

inline bool isWritable() const

inline string getText(itemIndex) const

inline string getStyle(itemIndex) const

string getBookmark(itemIndex, createIfNone) const

string adjustBookmark(oldRegionId, itemIndex)

inline string getLink(itemIndex) const

inline string getKey(itemIndex) const

inline string getAlignment(itemIndex) const

inline string getComment(itemIndex) const

inline string getName(itemIndex) const

inline string getListType(itemIndex) const

inline string getCaption(itemIndex) const

inline void setRegionId(newId)

inline void setType(newType)

inline void setDepth(newDepth)

inline void setRowColumn(newRow, newColumn)

inline void setRow(newRow)

inline void setColumn(newColumn)

inline void addItem(text, style, bookmark, link, key)

void addComment(comment)

inline bool isNewPage() const

inline bool isHeader() const

inline bool isParagraph() const

inline bool isListItem() const

inline bool isBeginList() const

inline bool isEndList() const

inline bool isBulletList() const

inline bool isNumberList() const

inline bool isCell() const

inline bool isBeginTable() const

inline bool isEndTable() const

inline bool isHorizontalLine() const

inline bool isBeginSection() const

inline bool isEndSection() const

inline bool isImage() const

inline bool isToC() const

inline bool isIndex() const

inline void setNewPage(width, height)

inline void setHeaderItem(text, depth, bookmarkLabel)

inline void setParagraph(style)

inline void setBeginList(listtype, style)

inline void setEndList(listtype)

inline void setListItem(listtype, style)

inline void setBeginTable(rows, columns, name, alignment)

inline void setRows(rows)

inline void setEndTable()

inline void setCell(newRow, newColumn, style)

inline void setHorizontalLine()

inline void setBeginSection(sectionType)

inline void setBegin1ColumnSection()

inline void setBegin2ColumnSection()

inline void setBegin3ColumnSection()

inline void setEndSection()

DocumentBlock& setImage(imageIndex, alignment)

DocumentBlock& setImage(imageFile, alignment)

inline void setTableOfContents(text, maxdepth)

inline void setIndex(text, indexName)

inline void setParam(key, value, index)

inline void setParam(key, value, index)

inline void setParam(key, value, index)

inline string getParam(key, index) const

inline int getParamInt(key, index) const

inline float getParamFloat(key, index) const

XMLData toXML() const

Private Properties

#include <Document.h >

Summary

Class to handle a block of text for the Document class.

Public Methods

DocumentBlock(regionId)

int regionId

Default value: 0

inline int getRegionId() const

GET methods

inline string getType() const

inline int getDepth() const

inline int getRow() const

inline int getColumn() const

inline int itemCount() const

inline bool isWritable() const

inline string getText(itemIndex) const

int itemIndex

Default value: 0

inline string getStyle(itemIndex) const

int itemIndex

Default value: 0

string getBookmark(itemIndex, createIfNone) const

int itemIndex	Default value: 0
bool createIfNone	Default value: true

string adjustBookmark(oldRegionId, itemIndex)

int oldRegionId
int itemIndex	Default value: 0

inline string getLink(itemIndex) const

int itemIndex

Default value: 0

inline string getKey(itemIndex) const

int itemIndex

Default value: 0

inline string getAlignment(itemIndex) const

int itemIndex

Default value: 0

inline string getComment(itemIndex) const

int itemIndex

Default value: 0

inline string getName(itemIndex) const

int itemIndex

Default value: 0

inline string getListType(itemIndex) const

int itemIndex

Default value: 0

inline string getCaption(itemIndex) const

int itemIndex

Default value: 0

inline void setRegionId(newId)

DbRecNum newId

SET methods

inline void setType(newType)

string newType

inline void setDepth(newDepth)

int newDepth

inline void setRowColumn(newRow, newColumn)

int newRow
int newColumn

inline void setRow(newRow)

int newRow

inline void setColumn(newColumn)

int newColumn

inline void addItem(text, style, bookmark, link, key)

const string& text
const string& style	Default value: ""
const string& bookmark	Default value: ""
const string& link	Default value: ""
const string& key	Default value: ""

void addComment(comment)

const string& comment

inline bool isNewPage() const

inline bool isHeader() const

inline bool isParagraph() const

inline bool isListItem() const

inline bool isBeginList() const

inline bool isEndList() const

inline bool isBulletList() const

inline bool isNumberList() const

inline bool isCell() const

inline bool isBeginTable() const

inline bool isEndTable() const

inline bool isHorizontalLine() const

inline bool isBeginSection() const

inline bool isEndSection() const

inline bool isImage() const

inline bool isToC() const

inline bool isIndex() const

inline void setNewPage(width, height)

float width	Default value: 8.5
float height	Default value: 11.

inline void setHeaderItem(text, depth, bookmarkLabel)

const string& text
int depth	Default value: 1
const string& bookmarkLabel	Default value: ""

inline void setParagraph(style)

string style

Default value: ""

inline void setBeginList(listtype, style)

const string& listtype	Default value: "."
const string& style	Default value: ""

inline void setEndList(listtype)

const string& listtype

Default value: "."

inline void setListItem(listtype, style)

const string& listtype	Default value: "."
const string& style	Default value: ""

inline void setBeginTable(rows, columns, name, alignment)

int rows
int columns
const string& name	Default value: ""
const string& alignment	Default value: "center"

inline void setRows(rows)

int rows

inline void setEndTable()

inline void setCell(newRow, newColumn, style)

int newRow	Default value: 0
int newColumn	Default value: 0
const string& style	Default value: ""

inline void setHorizontalLine()

inline void setBeginSection(sectionType)

const string& sectionType

inline void setBegin1ColumnSection()

inline void setBegin2ColumnSection()

inline void setBegin3ColumnSection()

inline void setEndSection()

DocumentBlock& setImage(imageIndex, alignment)

int imageIndex
const string& alignment

DocumentBlock& setImage(imageFile, alignment)

const string& imageFile
const string& alignment

inline void setTableOfContents(text, maxdepth)

const string& text	Default value: ""
int maxdepth	Default value: 0

inline void setIndex(text, indexName)

const string& text	Default value: ""
const string& indexName	Default value: ""

inline void setParam(key, value, index)

const string& key
const string& value
int index	Default value: 0

inline void setParam(key, value, index)

const string& key
int value
int index	Default value: 0

inline void setParam(key, value, index)

const string& key
float value
int index	Default value: 0

inline string getParam(key, index) const

const string& key
int index	Default value: 0

inline int getParamInt(key, index) const

const string& key
int index	Default value: 0

inline float getParamFloat(key, index) const

const string& key
int index	Default value: 0

XMLData toXML() const

Private Properties

DbRecNum id
string type
int row
int column
vector <HashArray > item