lib
KoPictureCollection Class Reference
#include <KoPictureCollection.h>
Detailed Description
A collection of pictures (a key and the picture itself).
Definition at line 40 of file KoPictureCollection.h.
Public Types | |
typedef QMap< KoPictureKey, QString > | StoreMap |
CollectionPicture = 0 | |
CollectionImage | |
CollectionClipart | |
enum | Type { CollectionPicture = 0, CollectionImage, CollectionClipart } |
Public Member Functions | |
KoPicture | findPicture (const KoPictureKey &key) const |
KoPicture | insertPicture (const KoPictureKey &key, const KoPicture &picture) |
KoPicture | insertPicture (const KoPicture &picture) |
KoPicture | downloadPicture (const KURL &url, QWidget *window) |
KoPicture | loadPicture (const QString &fileName) |
bool | saveToStore (const Type pictureType, KoStore *store, const QValueList< KoPictureKey > &keys) |
QDomElement | saveXML (const Type pictureType, QDomDocument &doc, QValueList< KoPictureKey > keys) |
bool | saveOasisToStore (KoStore *store, QValueList< KoPictureKey > keys, KoXmlWriter *manifestWriter) |
StoreMap | readXML (QDomElement &pixmapsElem) |
void | readXML (QDomElement &pixmapsElem, QMap< KoPictureKey, QString > &map) |
void | readFromStore (KoStore *store, const StoreMap &storeMap) |
KoPicture | findOrLoad (const QString &fileName, const QDateTime &dateTime) |
QString | getOasisFileName (const KoPicture &picture) const |
void | assignUniqueIds () |
Member Enumeration Documentation
- Enumerator:
-
CollectionPicture collection with mixed pictures CollectionImage collection with images only CollectionClipart collection with cliparts only
Definition at line 43 of file KoPictureCollection.h.
Member Function Documentation
void KoPictureCollection::assignUniqueIds | ( | ) |
KoPicture KoPictureCollection::downloadPicture | ( | const KURL & | url, | |
QWidget * | window | |||
) |
Download a possibly remote file.
If this file is really remote, it is always downloaded. If the file is local, it acts as loadPicture.
- Parameters:
-
url the URL to download from window the parent window for the download. You can pass NULL (0) if you absolutely cannot find anything to use.
Definition at line 75 of file KoPictureCollection.cpp.
KoPicture KoPictureCollection::findOrLoad | ( | const QString & | fileName, | |
const QDateTime & | dateTime | |||
) |
- Deprecated:
- KPresenter needs to use the same code for loading images from a collection and for loading images from disk.
- Parameters:
-
fileName the name of the file to read from disk if needed dateTime the date and time
Definition at line 305 of file KoPictureCollection.cpp.
KoPicture KoPictureCollection::findPicture | ( | const KoPictureKey & | key | ) | const |
Looks for a clipart in the collection, returns a new KoPicture with that key if not found.
Definition at line 35 of file KoPictureCollection.cpp.
QString KoPictureCollection::getOasisFileName | ( | const KoPicture & | picture | ) | const |
Inserts a picture into the collection, if not already there Same as above, but takes the key from the picture
.
Definition at line 70 of file KoPictureCollection.cpp.
KoPicture KoPictureCollection::insertPicture | ( | const KoPictureKey & | key, | |
const KoPicture & | picture | |||
) |
Inserts a picture into the collection, if not already there.
Definition at line 52 of file KoPictureCollection.cpp.
KoPicture KoPictureCollection::loadPicture | ( | const QString & | fileName | ) |
Load a clipart from a file (and insert into the collection).
The modification date of the file is checked, to create the key for this clipart. If this key maps to an existing clipart in the collection, then this picture is returned, otherwise the file is loaded.
Definition at line 102 of file KoPictureCollection.cpp.
Read all pictures from the store, into this collection The map comes from readXML, and is used to find which pictures to load, and which key to associate them.
Definition at line 254 of file KoPictureCollection.cpp.
void KoPictureCollection::readXML | ( | QDomElement & | pixmapsElem, | |
QMap< KoPictureKey, QString > & | map | |||
) |
KoPictureCollection::StoreMap KoPictureCollection::readXML | ( | QDomElement & | pixmapsElem | ) |
Read the <PICTURES>, <PIXMAPS> or <CLIPARTS> tag, and save the result (key<->store-filename associations) into the QMap.
You may want to 'new' a QMap in loadXML, and to use and then delete it in completeLoading (to save memory).
- Parameters:
-
pixmapsElem the <PICTURES>, <PIXMAPS> or <CLIPARTS> element
Definition at line 247 of file KoPictureCollection.cpp.
bool KoPictureCollection::saveToStore | ( | const Type | pictureType, | |
KoStore * | store, | |||
const QValueList< KoPictureKey > & | keys | |||
) |
Save the used picturess from the collection into the store Usually called from completeSaving().
- Parameters:
-
pictureType type for the stored picture store the store in which to save the pictures keys the list of keys corresponding to the pictures to save
- Returns:
- true on success, false on failure (e.g. disk full)
- Todo:
- Reduce lameness of dox for pictureType.
Definition at line 151 of file KoPictureCollection.cpp.
QDomElement KoPictureCollection::saveXML | ( | const Type | pictureType, | |
QDomDocument & | doc, | |||
QValueList< KoPictureKey > | keys | |||
) |
Generate the <PICTURES>, <PIXMAPS> or <CLIPARTS> tag, that saves the key and the related relative path in the store (e.g.
pictures/picture1.png) for each picture.
- Parameters:
-
pictureType the type of the collection doc the DOM document in which the tags are to be generated keys the list of keys
Definition at line 202 of file KoPictureCollection.cpp.
The documentation for this class was generated from the following files: