COOPY » Guide  version 0.6.5
Public Member Functions | Static Public Member Functions
coopy::store::gnumeric::GnumericSheet Class Reference

#include <GnumericSheet.h>

Inheritance diagram for coopy::store::gnumeric::GnumericSheet:
coopy::store::DataSheet coopy::store::RefCount

Public Member Functions

 GnumericSheet (void *sheet)
virtual ~GnumericSheet ()
virtual int width () const
virtual int height () const
virtual SheetCell cellSummary (int x, int y) const
virtual bool cellSummary (int x, int y, const SheetCell &c)
 sets the contents of cell in column x, row y to a specified value.
virtual std::string cellString (int x, int y) const
virtual std::string cellString (int x, int y, bool &escaped) const
virtual bool cellString (int x, int y, const std::string &str)
 sets the contents of cell in column x, row y to a specified string value
virtual bool cellString (int x, int y, const std::string &str, bool escaped)
 sets the contents of cell in column x, row y to a specified string value, or to NULL if "escaped" is set.
virtual ColumnRef moveColumn (const ColumnRef &src, const ColumnRef &base)
virtual bool deleteColumn (const ColumnRef &column)
virtual ColumnRef insertColumn (const ColumnRef &base)
virtual ColumnRef insertColumn (const ColumnRef &base, const ColumnInfo &kind)
virtual bool modifyColumn (const ColumnRef &base, const ColumnInfo &kind)
virtual RowRef insertRow (const RowRef &base)
virtual bool deleteRow (const RowRef &src)
virtual bool deleteRows (const RowRef &first, const RowRef &last)
virtual RowRef moveRow (const RowRef &src, const RowRef &base)
virtual bool hasDimension () const
virtual bool forceWidth (int width)
virtual bool deleteData (int offset=0)
virtual Poly< AppearancegetCellAppearance (int x, int y)
virtual Poly< AppearancegetRowAppearance (int y)
virtual Poly< AppearancegetColAppearance (int x)
virtual std::string getDescription () const
virtual bool canEscape () const
virtual SheetCell getCell (int x, int y) const
virtual bool setCell (int x, int y, const SheetCell &c)
 set contents of cell in column x, row y
std::string encode (const SheetStyle &style) const
 Render table as serialized text, using the specified style.
std::string toString () const
 Render table as serialized text, using a default style.
virtual bool clearCache ()
 Remove any cached values if used, e.g.
virtual SheetSchemagetSchema () const
virtual bool forceHeight (int height)
virtual Poly< SheetRowinsertRow ()
virtual bool copyData (const DataSheet &src)
virtual bool canWrite ()
virtual bool canResize ()
virtual bool hasExternalColumnNames () const
virtual bool resize (int w, int h)
virtual Poly< SheetRowinsertRowOrdered (const RowRef &base)
virtual bool applyRowCache (const RowCache &cache, int row, SheetCell *result)
virtual bool applySchema (const SheetSchema &ss)
virtual bool addedHeader ()
virtual std::vector< std::string > getNestedDescription () const
virtual std::string desc () const
virtual std::string getHash (bool cache=false) const
virtual std::string getRawHash () const
virtual DataSheettail ()
virtual const DataSheettail_const () const
virtual const DataSheetdataTail () const
virtual bool isSequential () const
virtual DataSheetgetNestedSheet (int x, int y)
virtual bool hasSheetName () const
virtual bool hasRowOffset () const
virtual bool setPool (Pool *pool)
virtual PoolgetPool () const
virtual void setMeta (SheetSchema *hint)
virtual SheetSchemagetMeta () const
virtual bool beginTransaction ()
virtual bool rollbackTransaction ()
virtual bool endTransaction ()
virtual void * getDatabase () const
virtual coopy::cmp::ComparegetComparisonMethod ()
int addReference ()
int removeReference ()
int getReferenceCount ()

Static Public Member Functions

static std::string encodeCell (const SheetCell &str, const SheetStyle &style)
 Encode a cell value as text using a specified style.

Detailed Description

Definition at line 14 of file GnumericSheet.h.


Constructor & Destructor Documentation

GnumericSheet::GnumericSheet ( void *  sheet)

Definition at line 16 of file GnumericSheet.cpp.

References dbg_printf, gnumeric_sheet_get_size(), NULL, and SHEET.

GnumericSheet::~GnumericSheet ( ) [virtual]

Definition at line 25 of file GnumericSheet.cpp.


Member Function Documentation

virtual bool coopy::store::DataSheet::addedHeader ( ) [inline, virtual, inherited]
int coopy::store::RefCount::addReference ( ) [inline, inherited]
bool DataSheet::applyRowCache ( const RowCache cache,
int  row,
SheetCell result 
) [virtual, inherited]
virtual bool coopy::store::DataSheet::applySchema ( const SheetSchema ss) [inline, virtual, inherited]
virtual bool coopy::store::DataSheet::beginTransaction ( ) [inline, virtual, inherited]
virtual bool coopy::store::DataSheet::canEscape ( ) const [inline, virtual, inherited]
Returns:
true iff cells in this table may be NULL

Definition at line 139 of file DataSheet.h.

virtual bool coopy::store::DataSheet::canResize ( ) [inline, virtual, inherited]
virtual bool coopy::store::DataSheet::canWrite ( ) [inline, virtual, inherited]
virtual bool coopy::store::gnumeric::GnumericSheet::cellString ( int  x,
int  y,
const std::string &  str,
bool  escaped 
) [inline, virtual]

sets the contents of cell in column x, row y to a specified string value, or to NULL if "escaped" is set.

Reimplemented from coopy::store::DataSheet.

Definition at line 43 of file GnumericSheet.h.

References cellSummary().

virtual std::string coopy::store::gnumeric::GnumericSheet::cellString ( int  x,
int  y,
bool &  escaped 
) const [inline, virtual]
Returns:
contents of cell in column x, row y, as a string. The "escaped" variable is set to true iff the cell has a NULL value.

Reimplemented from coopy::store::DataSheet.

Definition at line 33 of file GnumericSheet.h.

References cellSummary(), coopy::store::SheetCell::escaped, and coopy::store::SheetCell::text.

virtual std::string coopy::store::gnumeric::GnumericSheet::cellString ( int  x,
int  y 
) const [inline, virtual]
Returns:
contents of cell in column x, row y, as a string. The value returned by a cell with a NULL value is unspecified.

Implements coopy::store::DataSheet.

Definition at line 28 of file GnumericSheet.h.

References cellSummary(), and coopy::store::SheetCell::text.

Referenced by cellString(), and main().

virtual bool coopy::store::gnumeric::GnumericSheet::cellString ( int  x,
int  y,
const std::string &  str 
) [inline, virtual]

sets the contents of cell in column x, row y to a specified string value

Reimplemented from coopy::store::DataSheet.

Definition at line 39 of file GnumericSheet.h.

References cellString().

SheetCell GnumericSheet::cellSummary ( int  x,
int  y 
) const [virtual]
bool GnumericSheet::cellSummary ( int  x,
int  y,
const SheetCell c 
) [virtual]
virtual bool coopy::store::DataSheet::clearCache ( ) [inline, virtual, inherited]

Remove any cached values if used, e.g.

in proxies for remote tables.

Reimplemented in coopy::store::remotesql::RemoteSqlSheet, and coopy::store::sqlite::SqliteSheet.

Definition at line 191 of file DataSheet.h.

bool DataSheet::copyData ( const DataSheet src) [virtual, inherited]
virtual const DataSheet& coopy::store::DataSheet::dataTail ( ) const [inline, virtual, inherited]

Reimplemented in coopy::store::PolySheet.

Definition at line 329 of file DataSheet.h.

Referenced by coopy::store::PolySheet::dataTail(), and coopy::cmp::Patcher::getSheet().

bool GnumericSheet::deleteColumn ( const ColumnRef column) [virtual]

Reimplemented from coopy::store::DataSheet.

Definition at line 107 of file GnumericSheet.cpp.

References coopy::store::ColumnRef::getIndex(), gnumeric_delete_column(), and SHEET.

bool GnumericSheet::deleteData ( int  offset = 0) [virtual]

Reimplemented from coopy::store::DataSheet.

Definition at line 209 of file GnumericSheet.cpp.

References gnumeric_delete_rows(), and SHEET.

bool GnumericSheet::deleteRow ( const RowRef src) [virtual]

Reimplemented from coopy::store::DataSheet.

Definition at line 175 of file GnumericSheet.cpp.

References coopy::store::RowRef::getIndex(), gnumeric_delete_row(), and SHEET.

bool GnumericSheet::deleteRows ( const RowRef first,
const RowRef last 
) [virtual]

Reimplemented from coopy::store::DataSheet.

Definition at line 184 of file GnumericSheet.cpp.

References coopy::store::RowRef::getIndex(), gnumeric_delete_rows(), and SHEET.

virtual std::string coopy::store::DataSheet::desc ( ) const [inline, virtual, inherited]
std::string DataSheet::encode ( const SheetStyle style) const [inherited]
std::string DataSheet::encodeCell ( const SheetCell str,
const SheetStyle style 
) [static, inherited]
virtual bool coopy::store::DataSheet::endTransaction ( ) [inline, virtual, inherited]
virtual bool coopy::store::DataSheet::forceHeight ( int  height) [inline, virtual, inherited]

Reimplemented in coopy::store::PolySheet.

Definition at line 246 of file DataSheet.h.

Referenced by coopy::store::PolySheet::forceHeight().

virtual bool coopy::store::gnumeric::GnumericSheet::forceWidth ( int  width) [inline, virtual]

Reimplemented from coopy::store::DataSheet.

Definition at line 71 of file GnumericSheet.h.

References width().

virtual SheetCell coopy::store::DataSheet::getCell ( int  x,
int  y 
) const [inline, virtual, inherited]
Returns:
contents of cell in column x, row y

Definition at line 148 of file DataSheet.h.

References coopy::store::DataSheet::cellSummary().

Referenced by coopy::store::DataSheet::copyData().

Poly< Appearance > GnumericSheet::getCellAppearance ( int  x,
int  y 
) [virtual]

Reimplemented from coopy::store::DataSheet.

Definition at line 294 of file GnumericSheet.cpp.

References SHEET.

Poly< Appearance > GnumericSheet::getColAppearance ( int  x) [virtual]

Reimplemented from coopy::store::DataSheet.

Definition at line 304 of file GnumericSheet.cpp.

References SHEET.

virtual coopy::cmp::Compare* coopy::store::DataSheet::getComparisonMethod ( ) [inline, virtual, inherited]
virtual void* coopy::store::DataSheet::getDatabase ( ) const [inline, virtual, inherited]
virtual std::string coopy::store::gnumeric::GnumericSheet::getDescription ( ) const [inline, virtual]

Reimplemented from coopy::store::DataSheet.

Definition at line 84 of file GnumericSheet.h.

std::string DataSheet::getHash ( bool  cache = false) const [virtual, inherited]
SheetSchema * DataSheet::getMeta ( ) const [virtual, inherited]

Reimplemented in coopy::store::PolySheet.

Definition at line 12 of file DataSheet.cpp.

Referenced by coopy::store::PolySheet::getMeta(), and coopy::cmp::Patcher::metaHint().

virtual std::vector<std::string> coopy::store::DataSheet::getNestedDescription ( ) const [inline, virtual, inherited]
virtual DataSheet* coopy::store::DataSheet::getNestedSheet ( int  x,
int  y 
) [inline, virtual, inherited]

Reimplemented in coopy::fold::FoldedSheet, and coopy::store::PolySheet.

Definition at line 338 of file DataSheet.h.

Referenced by coopy::store::PolySheet::getNestedSheet(), and writePart().

virtual Pool* coopy::store::DataSheet::getPool ( ) const [inline, virtual, inherited]

Reimplemented in coopy::store::PolySheet.

Definition at line 367 of file DataSheet.h.

Referenced by coopy::store::PolySheet::getPool().

virtual std::string coopy::store::DataSheet::getRawHash ( ) const [inline, virtual, inherited]
int coopy::store::RefCount::getReferenceCount ( ) [inline, inherited]

Definition at line 40 of file RefCount.h.

Poly< Appearance > GnumericSheet::getRowAppearance ( int  y) [virtual]

Reimplemented from coopy::store::DataSheet.

Definition at line 299 of file GnumericSheet.cpp.

References SHEET.

virtual SheetSchema* coopy::store::DataSheet::getSchema ( ) const [inline, virtual, inherited]
virtual bool coopy::store::gnumeric::GnumericSheet::hasDimension ( ) const [inline, virtual]

Reimplemented from coopy::store::DataSheet.

Definition at line 67 of file GnumericSheet.h.

virtual bool coopy::store::DataSheet::hasExternalColumnNames ( ) const [inline, virtual, inherited]
virtual bool coopy::store::DataSheet::hasRowOffset ( ) const [inline, virtual, inherited]

Reimplemented in coopy::store::PolySheet.

Definition at line 358 of file DataSheet.h.

Referenced by coopy::store::PolySheet::hasRowOffset(), and coopy::cmp::Patcher::metaHint().

virtual bool coopy::store::DataSheet::hasSheetName ( ) const [inline, virtual, inherited]

Reimplemented in coopy::store::CsvSheet, and coopy::store::PolySheet.

Definition at line 354 of file DataSheet.h.

Referenced by coopy::store::PolySheet::hasSheetName().

virtual int coopy::store::gnumeric::GnumericSheet::height ( ) const [inline, virtual]
Returns:
height of table

Implements coopy::store::DataSheet.

Definition at line 21 of file GnumericSheet.h.

Referenced by main().

ColumnRef GnumericSheet::insertColumn ( const ColumnRef base) [virtual]

Reimplemented from coopy::store::DataSheet.

Definition at line 116 of file GnumericSheet.cpp.

ColumnRef GnumericSheet::insertColumn ( const ColumnRef base,
const ColumnInfo kind 
) [virtual]
Poly< SheetRow > DataSheet::insertRow ( ) [virtual, inherited]
RowRef GnumericSheet::insertRow ( const RowRef base) [virtual]

Reimplemented from coopy::store::DataSheet.

Definition at line 157 of file GnumericSheet.cpp.

References coopy::store::RowRef::getIndex(), gnumeric_insert_row(), and SHEET.

Poly< SheetRow > DataSheet::insertRowOrdered ( const RowRef base) [virtual, inherited]
virtual bool coopy::store::DataSheet::isSequential ( ) const [inline, virtual, inherited]
bool GnumericSheet::modifyColumn ( const ColumnRef base,
const ColumnInfo kind 
) [virtual]
ColumnRef GnumericSheet::moveColumn ( const ColumnRef src,
const ColumnRef base 
) [virtual]

Reimplemented from coopy::store::DataSheet.

Definition at line 91 of file GnumericSheet.cpp.

References coopy::store::ColumnRef::getIndex(), gnumeric_move_column(), and SHEET.

RowRef GnumericSheet::moveRow ( const RowRef src,
const RowRef base 
) [virtual]

Reimplemented from coopy::store::DataSheet.

Definition at line 195 of file GnumericSheet.cpp.

References coopy::store::RowRef::getIndex(), gnumeric_move_row(), and SHEET.

int coopy::store::RefCount::removeReference ( ) [inline, inherited]
virtual bool coopy::store::DataSheet::resize ( int  w,
int  h 
) [inline, virtual, inherited]
virtual bool coopy::store::DataSheet::rollbackTransaction ( ) [inline, virtual, inherited]
virtual bool coopy::store::DataSheet::setCell ( int  x,
int  y,
const SheetCell c 
) [inline, virtual, inherited]

set contents of cell in column x, row y

Definition at line 157 of file DataSheet.h.

References coopy::store::DataSheet::cellSummary().

Referenced by coopy::store::DataSheet::applyRowCache(), and coopy::store::DataSheet::copyData().

void DataSheet::setMeta ( SheetSchema hint) [virtual, inherited]

Reimplemented in coopy::store::PolySheet.

Definition at line 18 of file DataSheet.cpp.

References NULL.

Referenced by coopy::store::PolySheet::setMeta(), and coopy::store::DataSheet::~DataSheet().

virtual bool coopy::store::DataSheet::setPool ( Pool pool) [inline, virtual, inherited]

Reimplemented in coopy::store::PolySheet.

Definition at line 362 of file DataSheet.h.

Referenced by coopy::store::TextBook::applyPool(), and coopy::store::PolySheet::setPool().

virtual DataSheet& coopy::store::DataSheet::tail ( ) [inline, virtual, inherited]
virtual const DataSheet& coopy::store::DataSheet::tail_const ( ) const [inline, virtual, inherited]

Reimplemented in coopy::store::PolySheet.

Definition at line 325 of file DataSheet.h.

Referenced by coopy::store::PolySheet::tail_const().

std::string coopy::store::DataSheet::toString ( ) const [inline, inherited]

Render table as serialized text, using a default style.

Definition at line 173 of file DataSheet.h.

References coopy::store::DataSheet::encode().

Referenced by coopy::cmp::SheetPatcher::changeColumn(), main(), coopy::store::TextBook::toString(), and coopy::store::socialcalc::SocialCalcTextBook::write().

virtual int coopy::store::gnumeric::GnumericSheet::width ( ) const [inline, virtual]
Returns:
width of table

Implements coopy::store::DataSheet.

Definition at line 20 of file GnumericSheet.h.

Referenced by forceWidth(), and main().


The documentation for this class was generated from the following files:
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Defines