KSpread::Map Class Reference

#include <kspread_map.h>

Signals
void	sig_addSheet (Sheet *_table)

Public Member Functions
	Map (Doc *doc, const char *name=0)
virtual	~Map ()
Doc *	doc () const
TQDomElement	save (TQDomDocument &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 TQDomElement &mymap, KoOasisLoadingContext &oasisContext)
bool	loadXML (const TQDomElement &mymap)
bool	loadChildren (KoStore *_store)
bool	saveChildren (KoStore *_store)
void	password (TQCString &passwd) const
bool	isProtected () const
void	setProtected (TQCString const &passwd)
bool	checkPassword (TQCString const &passwd) const
void	moveSheet (const TQString &_from, const TQString &_to, bool _before=true)
Sheet *	findSheet (const TQString &_name)
Sheet *	nextSheet (Sheet *)
Sheet *	previousSheet (Sheet *)
Sheet *	initialActiveSheet () const
int	initialMarkerColumn () const
int	initialMarkerRow () const
double	initialXOffset () const
double	initialYOffset () const
Sheet *	createSheet ()
void	addSheet (Sheet *_sheet)
Sheet *	addNewSheet ()
Sheet *	firstSheet ()
Sheet *	lastSheet ()
Sheet *	nextSheet ()
TQPtrList< Sheet > &	sheetList ()
int	count () const
void	update ()
virtual DCOPObject *	dcopObject ()
void	takeSheet (Sheet *sheet)
void	insertSheet (Sheet *sheet)
TQStringList	visibleSheets () const
TQStringList	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 58 of file kspread_map.h.

Constructor & Destructor Documentation

Map()

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

Created an empty map.

Definition at line 51 of file kspread_map.cpp.

~Map()

Map::~Map ( )

virtual

This deletes all sheets contained in this map.

Definition at line 65 of file kspread_map.cpp.

Member Function Documentation

addNewSheet()

Sheet * Map::addNewSheet

(

)

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

Definition at line 98 of file kspread_map.cpp.

addSheet()

void Map::addSheet

(

Sheet *

_sheet

)

add sheet to the map, making it active

Definition at line 89 of file kspread_map.cpp.

checkPassword()

bool KSpread::Map::checkPassword ( TQCString const & passwd ) const

inline

Definition at line 90 of file kspread_map.h.

count()

int KSpread::Map::count ( ) const

inline

Returns

amount of sheets in this map.

Definition at line 154 of file kspread_map.h.

createSheet()

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.cpp.

dcopObject()

DCOPObject * Map::dcopObject ( )

virtual

Needed for the printing Extension KOffice::Print.

Definition at line 468 of file kspread_map.cpp.

doc()

Doc * Map::doc

(

)

const

Definition at line 70 of file kspread_map.cpp.

findSheet()

Sheet * Map::findSheet

(

const TQString &

_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.cpp.

firstSheet()

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 131 of file kspread_map.h.

hiddenSheets()

TQStringList Map::hiddenSheets

(

)

const

Definition at line 508 of file kspread_map.cpp.

initialActiveSheet()

Sheet * KSpread::Map::initialActiveSheet ( ) const

inline

Definition at line 107 of file kspread_map.h.

initialMarkerColumn()

int KSpread::Map::initialMarkerColumn ( ) const

inline

Definition at line 108 of file kspread_map.h.

initialMarkerRow()

int KSpread::Map::initialMarkerRow ( ) const

inline

Definition at line 109 of file kspread_map.h.

initialXOffset()

double KSpread::Map::initialXOffset ( ) const

inline

Definition at line 110 of file kspread_map.h.

initialYOffset()

double KSpread::Map::initialYOffset ( ) const

inline

Definition at line 111 of file kspread_map.h.

insertSheet()

void Map::insertSheet

(

Sheet *

sheet

)

Definition at line 483 of file kspread_map.cpp.

isProtected()

bool KSpread::Map::isProtected ( ) const

inline

Definition at line 88 of file kspread_map.h.

lastSheet()

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 139 of file kspread_map.h.

loadChildren()

bool Map::loadChildren

(

KoStore *

_store

)

Definition at line 458 of file kspread_map.cpp.

loadOasis()

bool Map::loadOasis	(	const TQDomElement &	mymap,
		KoOasisLoadingContext &	oasisContext )

Definition at line 276 of file kspread_map.cpp.

loadOasisSettings()

void Map::loadOasisSettings

(

KoOasisSettings &

settings

)

Definition at line 132 of file kspread_map.cpp.

loadXML()

bool Map::loadXML

(

const TQDomElement &

mymap

)

Definition at line 345 of file kspread_map.cpp.

moveSheet()

void Map::moveSheet	(	const TQString &	_from,
		const TQString &	_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.cpp.

nextSheet() [1/2]

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 147 of file kspread_map.h.

nextSheet() [2/2]

Sheet * Map::nextSheet

(

Sheet *

currentSheet

)

Definition at line 414 of file kspread_map.cpp.

password()

void KSpread::Map::password ( TQCString & passwd ) const

inline

Definition at line 87 of file kspread_map.h.

previousSheet()

Sheet * Map::previousSheet

(

Sheet *

currentSheet

)

Definition at line 430 of file kspread_map.cpp.

save()

TQDomElement Map::save

(

TQDomDocument &

doc

)

Definition at line 238 of file kspread_map.cpp.

saveChildren()

bool Map::saveChildren

(

KoStore *

_store

)

Definition at line 446 of file kspread_map.cpp.

saveOasis()

bool Map::saveOasis	(	KoXmlWriter &	xmlWriter,
		KoGenStyles &	mainStyles,
		KoStore *	store,
		KoXmlWriter *	manifestWriter,
		int &	_indexObj,
		int &	_partIndexObj )

Definition at line 198 of file kspread_map.cpp.

saveOasisSettings()

void Map::saveOasisSettings

(

KoXmlWriter &

settingsWriter

)

Definition at line 160 of file kspread_map.cpp.

setProtected()

void Map::setProtected

(

TQCString const &

passwd

)

Definition at line 75 of file kspread_map.cpp.

sheetList()

TQPtrList< Sheet > & KSpread::Map::sheetList ( )

inline

Definition at line 149 of file kspread_map.h.

sig_addSheet

void KSpread::Map::sig_addSheet ( Sheet * _table )

signal

Emitted if a new table is added to the document.

takeSheet()

void Map::takeSheet

(

Sheet *

sheet

)

Definition at line 476 of file kspread_map.cpp.

update()

void Map::update

(

)

Definition at line 394 of file kspread_map.cpp.

visibleSheets()

TQStringList Map::visibleSheets

(

)

const

Definition at line 492 of file kspread_map.cpp.

Member Data Documentation

respectCase

bool Map::respectCase = true

static

Definition at line 172 of file kspread_map.h.

---

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

• kspread_map.h
• kspread_map.cpp