kspread

KSpread::Map Class Reference

#include <kspread_map.h>

List of all members.


Detailed Description

A map is a simple container for all sheets.

Usually a complete map is saved in one file.

Definition at line 58 of file kspread_map.h.


Signals

void sig_addSheet (Sheet *_table)

Public Member Functions

 Map (Doc *doc, const char *name=0)
virtual ~Map ()
Docdoc () const
QDomElement save (QDomDocument &doc)
void saveOasisSettings (KoXmlWriter &settingsWriter)
void loadOasisSettings (KoOasisSettings &settings)
bool saveOasis (KoXmlWriter &xmlWriter, KoGenStyles &mainStyles, KoStore *store, KoXmlWriter *manifestWriter, int &_indexObj, int &_partIndexObj)
bool loadOasis (const QDomElement &mymap, KoOasisLoadingContext &oasisContext)
bool loadXML (const QDomElement &mymap)
bool loadChildren (KoStore *_store)
bool saveChildren (KoStore *_store)
void password (QCString &passwd) const
bool isProtected () const
void setProtected (QCString const &passwd)
bool checkPassword (QCString const &passwd) const
void moveSheet (const QString &_from, const QString &_to, bool _before=true)
SheetfindSheet (const QString &_name)
SheetnextSheet (Sheet *)
SheetpreviousSheet (Sheet *)
SheetinitialActiveSheet () const
int initialMarkerColumn () const
int initialMarkerRow () const
double initialXOffset () const
double initialYOffset () const
SheetcreateSheet ()
void addSheet (Sheet *_sheet)
SheetaddNewSheet ()
SheetfirstSheet ()
SheetlastSheet ()
SheetnextSheet ()
QPtrList< Sheet > & sheetList ()
int count () const
void update ()
virtual DCOPObject * dcopObject ()
void takeSheet (Sheet *sheet)
void insertSheet (Sheet *sheet)
QStringList visibleSheets () const
QStringList hiddenSheets () const

Static Public Attributes

static bool respectCase

Constructor & Destructor Documentation

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

Created an empty map.

Definition at line 51 of file kspread_map.cc.

Map::~Map (  )  [virtual]

This deletes all sheets contained in this map.

Definition at line 65 of file kspread_map.cc.


Member Function Documentation

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 105 of file kspread_map.cc.

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

searches for a sheet named _name

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

Definition at line 401 of file kspread_map.cc.

Sheet * Map::createSheet (  ) 

Returns:
a pointer to a new Sheet.

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

Definition at line 80 of file kspread_map.cc.

void Map::addSheet ( Sheet _sheet  ) 

add sheet to the map, making it active

Definition at line 89 of file kspread_map.cc.

Sheet * Map::addNewSheet (  ) 

add a new sheet to the map, returning a pointer to it

Definition at line 98 of file kspread_map.cc.

Sheet* KSpread::Map::firstSheet (  )  [inline]

Use the nextSheet function to get all the other sheets.

Attention: Function is not reentrant.

Returns:
a pointer to the first sheet in this map.

Definition at line 130 of file kspread_map.h.

Sheet* KSpread::Map::lastSheet (  )  [inline]

Use the previousSheet() function to get all the other sheets.

Attention: Function is not reentrant.

Returns:
a pointer to the last sheet in this map.

Definition at line 138 of file kspread_map.h.

Sheet* KSpread::Map::nextSheet (  )  [inline]

Call firstSheet first.

This will set the list pointer to the first sheet. Attention: Function is not reentrant.

Returns:
a pointer to the next sheet in this map.

Definition at line 146 of file kspread_map.h.

int KSpread::Map::count (  )  const [inline]

Returns:
amount of sheets in this map.

Definition at line 153 of file kspread_map.h.

DCOPObject * Map::dcopObject (  )  [virtual]

Needed for the printing Extension KOffice::Print.

Definition at line 468 of file kspread_map.cc.

void KSpread::Map::sig_addSheet ( Sheet _table  )  [signal]

Emitted if a new table is added to the document.


The documentation for this class was generated from the following files:
KDE Home | KDE Accessibility Home | Description of Access Keys