kspread

KSpread::Map

KSpread::Map Class Reference

The "embedded document". More...

#include <Map.h>

Inheritance diagram for KSpread::Map:
Inheritance graph
[legend]

List of all members.

Public Slots

void flushDamages ()
void handleDamages (const QList< Damage * > &damages)

Signals

void damagesFlushed (const QList< Damage * > &damages)
void sheetAdded (Sheet *sheet)
void sheetRemoved (Sheet *sheet)
void sheetRevived (Sheet *sheet)

Public Member Functions

 Map (Doc *doc, const char *name=0)
virtual ~Map ()
void addDamage (Damage *damage)
Sheet * addNewSheet ()
void addSheet (Sheet *sheet)
BindingManager * bindingManager () const
ValueCalc * calc () const
CalculationSettings * calculationSettings () const
bool checkPassword (QByteArray const &passwd) const
virtual bool completeLoading (KoStore *store)
virtual bool completeSaving (KoStore *store, KoXmlWriter *manifestWriter, KoShapeSavingContext *context)
ValueConverter * converter () const
int count () const
Sheet * createSheet ()
DatabaseManager * databaseManager () const
const ColumnFormat * defaultColumnFormat () const
const RowFormat * defaultRowFormat () const
void deleteLoadingInfo ()
DependencyManager * dependencyManager () const
Doc * doc () const
Sheet * findSheet (const QString &name) const
ValueFormatter * formatter () const
QStringList hiddenSheets () const
void increaseLoadedRowsCounter (int i=1)
bool isLoading () const
bool isProtected () const
bool isReadWrite () const
bool loadChildren (KoStore *_store)
LoadingInfo * loadingInfo () const
bool loadOdf (const KoXmlElement &mymap, KoOdfLoadingContext &odfContext)
void loadOdfSettings (KoOasisSettings &settings)
bool loadXML (const KoXmlElement &mymap)
void moveSheet (const QString &_from, const QString &_to, bool _before=true)
NamedAreaManager * namedAreaManager () const
Sheet * nextSheet (Sheet *sheet) const
ValueParser * parser () const
void password (QByteArray &passwd) const
Sheet * previousSheet (Sheet *) const
RecalcManager * recalcManager () const
void removeSheet (Sheet *sheet)
void reviveSheet (Sheet *sheet)
QDomElement save (QDomDocument &doc)
bool saveChildren (KoStore *_store)
bool saveOdf (KoXmlWriter &xmlWriter, KoShapeSavingContext &savingContext)
void saveOdfSettings (KoXmlWriter &settingsWriter)
void setDefaultColumnWidth (double width)
void setDefaultRowHeight (double height)
void setProtected (QByteArray const &passwd)
void setReadWrite (bool readwrite=true)
ApplicationSettings * settings () const
Sheet * sheet (int index) const
QList< Sheet * > & sheetList () const
StyleManager * styleManager () const
QStringList visibleSheets () const

Detailed Description

The "embedded document".

The Map holds all the document data.

Definition at line 69 of file Map.h.

Constructor & Destructor Documentation

Map::Map ( Doc *  doc,
const char *  name = 0 
) [explicit]

Created an empty map.

Definition at line 122 of file Map.cpp.

Map::~Map (  )  [virtual]

This deletes all sheets contained in this map.

Definition at line 172 of file Map.cpp.

Member Function Documentation

Sheet * Map::addNewSheet (  ) 

Creates a new sheet.

Adds a new sheet to this map.

Returns:
a pointer to the new sheet

Definition at line 322 of file Map.cpp.

void Map::addSheet ( Sheet *  sheet  ) 

Adds sheet to this map.

The sheet becomes the active sheet.

Definition at line 316 of file Map.cpp.

BindingManager * Map::bindingManager (  )  const
Returns:
a pointer to the binding manager

Definition at line 224 of file Map.cpp.

ValueCalc * Map::calc (  )  const
Returns:
the value calculator of this Document

Definition at line 269 of file Map.cpp.

CalculationSettings * Map::calculationSettings (  )  const
Returns:
the calculation settings

Definition at line 299 of file Map.cpp.

bool Map::checkPassword ( QByteArray const &  passwd  )  const

Definition at line 806 of file Map.cpp.

bool Map::completeLoading ( KoStore *  store  )  [virtual]

Definition at line 208 of file Map.cpp.

bool Map::completeSaving ( KoStore *  store,
KoXmlWriter *  manifestWriter,
KoShapeSavingContext *  context 
) [virtual]

Definition at line 216 of file Map.cpp.

ValueConverter * Map::converter (  )  const
Returns:
the value converter of this Document

Definition at line 264 of file Map.cpp.

int Map::count (  )  const
Returns:
amount of sheets in this map

Definition at line 821 of file Map.cpp.

Sheet * Map::createSheet (  ) 

Creates a new sheet.

The sheet is not added to the map nor added to the GUI.

Returns:
a pointer to a new Sheet

Definition at line 309 of file Map.cpp.

DatabaseManager * Map::databaseManager (  )  const
Returns:
a pointer to the database manager

Definition at line 229 of file Map.cpp.

const ColumnFormat * Map::defaultColumnFormat (  )  const
Returns:
the default row format

Definition at line 274 of file Map.cpp.

const RowFormat * Map::defaultRowFormat (  )  const
Returns:
the default row format

Definition at line 279 of file Map.cpp.

DependencyManager * Map::dependencyManager (  )  const
Returns:
a pointer to the dependency manager

Definition at line 234 of file Map.cpp.

Doc * Map::doc (  )  const
Returns:
the document this map belongs to

Definition at line 193 of file Map.cpp.

Sheet * Map::findSheet ( const QString &  name  )  const

Searches for a sheet named name .

Returns:
a pointer to the searched sheet
0 if nothing was found

Definition at line 698 of file Map.cpp.

ValueFormatter * Map::formatter (  )  const
Returns:
the value formatter of this Document

Definition at line 259 of file Map.cpp.

QStringList Map::hiddenSheets (  )  const

Definition at line 785 of file Map.cpp.

void Map::increaseLoadedRowsCounter ( int  i = 1  ) 

Definition at line 826 of file Map.cpp.

bool Map::isProtected (  )  const

Definition at line 801 of file Map.cpp.

bool Map::isReadWrite (  )  const
Returns:
Returns whether the document can be edited or is read only.

Definition at line 203 of file Map.cpp.

bool Map::loadChildren ( KoStore *  _store  ) 

Definition at line 747 of file Map.cpp.

void Map::moveSheet ( const QString &  _from,
const QString &  _to,
bool  _before = true 
)

The sheet named _from is being moved to the sheet _to.

If _before is true _from is inserted before (after otherwise) _to.

Definition at line 329 of file Map.cpp.

NamedAreaManager * Map::namedAreaManager (  )  const
Returns:
a pointer to the named area manager

Definition at line 239 of file Map.cpp.

Sheet * Map::nextSheet ( Sheet *  sheet  )  const
Returns:
a pointer to the next sheet to sheet

Definition at line 708 of file Map.cpp.

ValueParser * Map::parser (  )  const
Returns:
the value parser of this Document

Definition at line 254 of file Map.cpp.

void Map::password ( QByteArray &  passwd  )  const

Definition at line 796 of file Map.cpp.

Sheet * Map::previousSheet ( Sheet *  currentSheet  )  const
Returns:
a pointer to the previous sheet to sheet

Definition at line 722 of file Map.cpp.

RecalcManager * Map::recalcManager (  )  const
Returns:
a pointer to the recalculation manager

Definition at line 244 of file Map.cpp.

void Map::removeSheet ( Sheet *  sheet  ) 

Definition at line 757 of file Map.cpp.

void Map::reviveSheet ( Sheet *  sheet  ) 

Definition at line 765 of file Map.cpp.

bool Map::saveChildren ( KoStore *  _store  ) 

Definition at line 736 of file Map.cpp.

void Map::setDefaultColumnWidth ( double  width  ) 

Sets the default column width to width.

Definition at line 284 of file Map.cpp.

void Map::setDefaultRowHeight ( double  height  ) 

Sets the default row height to height.

Definition at line 289 of file Map.cpp.

void Map::setProtected ( QByteArray const &  passwd  ) 

Definition at line 304 of file Map.cpp.

void Map::setReadWrite ( bool  readwrite = true  ) 

Sets whether the document can be edited or is read only.

Definition at line 198 of file Map.cpp.

ApplicationSettings * Map::settings (  )  const
Returns:
the application settings

Definition at line 294 of file Map.cpp.

Sheet * Map::sheet ( int  index  )  const
Returns:
a pointer to the sheet at index index in this map
0 if the index exceeds the list boundaries

Definition at line 811 of file Map.cpp.

void KSpread::Map::sheetAdded ( Sheet *  sheet  )  [signal]

Emitted, if a newly created sheet was added to the document.

QList< Sheet * > & Map::sheetList (  )  const
Returns:
the list of sheets in this map

Definition at line 816 of file Map.cpp.

void KSpread::Map::sheetRemoved ( Sheet *  sheet  )  [signal]

Emitted, if a sheet was deleted from the document.

void KSpread::Map::sheetRevived ( Sheet *  sheet  )  [signal]

Emitted, if a sheet was revived, i.e.

a deleted sheet was reinserted.

StyleManager * Map::styleManager (  )  const
Returns:
the StyleManager of this Document

Definition at line 249 of file Map.cpp.

QStringList Map::visibleSheets (  )  const

Definition at line 773 of file Map.cpp.

The documentation for this class was generated from the following files: