kspread Library API Documentation

KSpreadMap Class Reference

A map is a simple container for all sheets. More...

#include <kspread_map.h>

Inheritance diagram for KSpreadMap:

Inheritance graph
[legend]
Collaboration diagram for KSpreadMap:

Collaboration graph
[legend]
List of all members.

Signals

void sig_addSheet (KSpreadSheet *_table)

Public Member Functions

 KSpreadMap (KSpreadDoc *doc, const char *name=0)
virtual ~KSpreadMap ()
KSpreadDocdoc ()
QDomElement save (QDomDocument &doc)
void saveOasisSettings (KoXmlWriter &settingsWriter)
void loadOasisSettings (KoOasisSettings &settings)
bool saveOasis (KoXmlWriter &xmlWriter, KoGenStyles &mainStyles)
bool loadOasis (const QDomElement &mymap, KoOasisStyles &oasisStyles)
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)
KSpreadSheet * findSheet (const QString &_name)
KSpreadSheet * nextSheet (KSpreadSheet *)
KSpreadSheet * previousSheet (KSpreadSheet *)
KSpreadSheet * initialActiveSheet () const
int initialMarkerColumn () const
int initialMarkerRow () const
KSpreadSheet * createSheet ()
void addSheet (KSpreadSheet *_sheet)
KSpreadSheet * addNewSheet ()
KSpreadSheet * firstSheet ()
KSpreadSheet * lastSheet ()
KSpreadSheet * nextSheet ()
QPtrList< KSpreadSheet > & sheetList ()
int count () const
void update ()
virtual DCOPObject * dcopObject ()
void takeSheet (KSpreadSheet *sheet)
void insertSheet (KSpreadSheet *sheet)
QStringList visibleSheets () const
QStringList hiddenSheets () const

Static Public Attributes

static bool respectCase = true

Detailed Description

A map is a simple container for all sheets.

Usually a complete map is saved in one file.

Definition at line 50 of file kspread_map.h.


Constructor & Destructor Documentation

KSpreadMap::KSpreadMap KSpreadDoc doc,
const char *  name = 0
 

Created an empty map.

Definition at line 41 of file kspread_map.cc.

KSpreadMap::~KSpreadMap  )  [virtual]
 

This deletes all sheets contained in this map.

Definition at line 53 of file kspread_map.cc.


Member Function Documentation

void KSpreadMap::moveSheet const QString _from,
const QString _to,
bool  _before = true
 

The sheet named.

Parameters:
_from is being moved to the sheet
_to. If
_before is true
_from is inserted before (after otherwise) *
_to. 

Definition at line 93 of file kspread_map.cc.

KSpreadSheet * KSpreadMap::createSheet  ) 
 

Returns:
a pointer to a new KSpreadSheet. The KSpreadSheet is not added to the map nor added to the GUI.

Definition at line 68 of file kspread_map.cc.

Referenced by addNewSheet().

void KSpreadMap::addSheet KSpreadSheet *  _sheet  ) 
 

add sheet to the map, making it active

Definition at line 77 of file kspread_map.cc.

References sig_addSheet().

Referenced by addNewSheet().

KSpreadSheet * KSpreadMap::addNewSheet  ) 
 

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

Definition at line 86 of file kspread_map.cc.

References addSheet(), and createSheet().

KSpreadSheet* KSpreadMap::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 114 of file kspread_map.h.

KSpreadSheet* KSpreadMap::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 122 of file kspread_map.h.

KSpreadSheet* KSpreadMap::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 130 of file kspread_map.h.

int KSpreadMap::count  )  const [inline]
 

Returns:
amount of sheets in this map.

Definition at line 137 of file kspread_map.h.

DCOPObject * KSpreadMap::dcopObject  )  [virtual]
 

Needed for the printing Extension KOffice::Print.

Definition at line 440 of file kspread_map.cc.

void KSpreadMap::sig_addSheet KSpreadSheet *  _table  )  [signal]
 

Emitted if a new table is added to the document.

Referenced by addSheet().


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for kspread Library Version 1.4.2.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Mon Feb 13 09:43:47 2006 by doxygen 1.4.2 written by Dimitri van Heesch, © 1997-2003