KDE 4.0 API Reference kjots
KJotsBook Class Reference
#include <kjotsentry.h>
Detailed Description
Definition at line 79 of file kjotsentry.h.
Public Member Functions | |
| KJotsBook () | |
| ~KJotsBook () | |
| bool | openBook (const QString &) |
| void | saveBook () |
| void | deleteBook () |
| void | rename () |
| KJotsPage * | addPage (void) |
| void | generateXml (QDomDocument &, QDomElement &) |
| void | parseXml (QDomElement &, bool) |
| void | generateHtml (KJotsEntry *, bool, QTextCursor *) |
| QString | generateText (void) |
| void | generatePrintData (QTextCursor *) |
| bool | shouldBeOpened (void) const |
| void | setDirty (bool) |
| bool | dirty () |
| QString | fileName () const |
| QList< KJotsEntry * > | contents (void) |
| QList< KJotsEntry * > | children (void) |
Static Public Member Functions | |
| static KJotsBook * | createNewBook (void) |
Friends | |
| class | KJotsEntry |
Constructor & Destructor Documentation
| KJotsBook::KJotsBook | ( | ) |
Definition at line 192 of file kjotsentry.cpp.
| KJotsBook::~KJotsBook | ( | ) |
Definition at line 201 of file kjotsentry.cpp.
Member Function Documentation
| bool KJotsBook::openBook | ( | const QString & | filename | ) |
Reads a book in from a disk file. This function is only called for root-level books.
Definition at line 228 of file kjotsentry.cpp.
| void KJotsBook::saveBook | ( | void | ) |
Saves this book and everything in it to the data directory.
Definition at line 295 of file kjotsentry.cpp.
| void KJotsBook::deleteBook | ( | void | ) |
Deletes a book by removing the data file. This does not affect the list display, and can be called for reasons other than choosing to delete an entry from the list. If you want the object to dissappear from the list, then you have to delete it.
Definition at line 348 of file kjotsentry.cpp.
| void KJotsBook::rename | ( | ) | [virtual] |
| KJotsPage * KJotsBook::addPage | ( | void | ) |
| void KJotsBook::generateXml | ( | QDomDocument & | doc, | |
| QDomElement & | parent | |||
| ) | [virtual] |
Creates XML code and performs necessary tasks to save file. This function should ONLY be called when saving the file.
Reimplemented from KJotsEntry.
Definition at line 392 of file kjotsentry.cpp.
| void KJotsBook::parseXml | ( | QDomElement & | me, | |
| bool | oldBook | |||
| ) | [virtual] |
Parses through XML code from a file.
Reimplemented from KJotsEntry.
Definition at line 424 of file kjotsentry.cpp.
| void KJotsBook::generateHtml | ( | KJotsEntry * | top, | |
| bool | diskMode, | |||
| QTextCursor * | cursorOut | |||
| ) | [virtual] |
Returns HTML for the read-only "book" view.
- Parameters:
-
top Pointer to the "starting point" of this tree. diskMode Files saved to disk have a slightly different format.
Implements KJotsEntry.
Definition at line 490 of file kjotsentry.cpp.
| QString KJotsBook::generateText | ( | void | ) | [virtual] |
Returns Text when saving to a file.
This functions output moderately formatted text when the user chooses to save as a text file.
Implements KJotsEntry.
Definition at line 526 of file kjotsentry.cpp.
| void KJotsBook::generatePrintData | ( | QTextCursor * | cursor | ) | [virtual] |
Inserts data for printing.
- Parameters:
-
cursor Cursor pointing to the printing document.
Implements KJotsEntry.
Definition at line 551 of file kjotsentry.cpp.
| bool KJotsBook::shouldBeOpened | ( | void | ) | const [inline] |
Definition at line 99 of file kjotsentry.h.
| void KJotsBook::setDirty | ( | bool | dirty | ) |
| bool KJotsBook::dirty | ( | ) |
| QString KJotsBook::fileName | ( | ) | const [inline] |
Definition at line 103 of file kjotsentry.h.
| QList< KJotsEntry * > KJotsBook::contents | ( | void | ) |
Returns QList of all entries in this book. THis is recursive, as opposed to KJotsBook::children which is not.
Definition at line 568 of file kjotsentry.cpp.
| QList< KJotsEntry * > KJotsBook::children | ( | void | ) |
Returns QList of centries in this book. This is not recursive, as opposed to KJotsBook::contents which is.
Reimplemented from QObject.
Definition at line 587 of file kjotsentry.cpp.
| KJotsBook * KJotsBook::createNewBook | ( | void | ) | [static] |
Definition at line 598 of file kjotsentry.cpp.
Friends And Related Function Documentation
friend class KJotsEntry [friend] |
Definition at line 81 of file kjotsentry.h.
The documentation for this class was generated from the following files:
