kivio

KivioMap Class Reference

List of all members.

Detailed Description

Definition at line 43 of file kivio_map.h.


Public Member Functions

 KivioMap (KivioDoc *doc, const char *name=0)
virtual ~KivioMap ()
QDomElement save (QDomDocument &doc)
void saveOasis (KoStore *store, KoXmlWriter *docWriter, KoGenStyles *styles)
bool loadXML (const QDomElement &mymap)
void addPage (KivioPage *)
void takePage (KivioPage *page)
void insertPage (KivioPage *page)
void movePage (const QString &_from, const QString &_to, bool _before=true)
KivioPage * findPage (const QString &name)
KivioPage * firstPage ()
KivioPage * lastPage ()
KivioPage * nextPage ()
QPtrList< KivioPage > & pageList ()
QStringList visiblePages () const
QStringList hiddenPages () const
int count () const
void update ()
KivioDoc * doc () const
virtual DCOPObject * dcopObject ()
void clear ()

Constructor & Destructor Documentation

KivioMap::KivioMap (  KivioDoc *  doc,
const char *  name = 0
) 
 

Created an empty map.

Definition at line 37 of file kivio_map.cpp.

KivioMap::~KivioMap (   )  [virtual]
 

This deletes all pages contained in this map.

Definition at line 46 of file kivio_map.cpp.

Member Function Documentation

void KivioMap::addPage (  KivioPage *   ) 
 

Parameters:
_page becomes added to the map.

Definition at line 67 of file kivio_map.cpp.

int KivioMap::count (   )  const
 

Returns:
amount of pages in this map.

Definition at line 192 of file kivio_map.cpp.

KivioPage * KivioMap::firstPage (   ) 
 

Use the nextPage function to get all the other pages.

Attention: Function is not reentrant.

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

Definition at line 177 of file kivio_map.cpp.

QStringList KivioMap::hiddenPages (   )  const
 

Returns list of hidden pages as stringlist.

Definition at line 220 of file kivio_map.cpp.

KivioPage * KivioMap::lastPage (   ) 
 

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

Definition at line 182 of file kivio_map.cpp.

void KivioMap::movePage (  const QString &  _from,
const QString &  _to,
bool  _before = true
) 
 

The page named.

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

Definition at line 72 of file kivio_map.cpp.

KivioPage * KivioMap::nextPage (   ) 
 

Call firstPage first.

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

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

Definition at line 187 of file kivio_map.cpp.

QStringList KivioMap::visiblePages (   )  const
 

Returns list of visible pages as stringlist.

Definition at line 205 of file kivio_map.cpp.

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

kivio

API Dox
KDE Home | KDE Accessibility Home | Description of Access Keys