lib Library API Documentation

KoPictureKey Class Reference

KoPictureKey is the structure describing a picture in a unique way.Structure describing a picture on disk. More...

#include <koPictureKey.h>

Collaboration diagram for KoPictureKey:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 KoPictureKey ()
 KoPictureKey (const QString &fn, const QDateTime &mod)
 KoPictureKey (const QString &fn)
 KoPictureKey (const KoPictureKey &key)
KoPictureKeyoperator= (const KoPictureKey &key)
bool operator== (const KoPictureKey &key) const
bool operator< (const KoPictureKey &key) const
QString toString () const
void saveAttributes (QDomElement &elem) const
void loadAttributes (const QDomElement &elem)
QString filename () const
QDateTime lastModified () const
void setKeyFromFile (const QString &filename)

Protected Attributes

QString m_filename
QDateTime m_lastModified

Detailed Description

KoPictureKey is the structure describing a picture in a unique way.Structure describing a picture on disk.

It currently includes the original path to the picture and the modification date.

Note:
We use the *nix epoch (1970-01-01) as a time base because it is a valid date. That way we do not depend on a behaviour of the current QDateTime that might change in future versions of Qt and we are also nice to non-Qt programs wanting to read KOffice's files.

This behaviour is also needed for re-saving KWord files having <FORMAT id="2">. When saving again, these files get a <KEY> element as child of <PIXMAPS> but not one as child of <FORMAT> and <IMAGE>. Therefore we need to be careful that the key remains compatible to default values (another good reason for the *NIX epoch)

In case of a remote path, the "original path" is the name of the temporary file that was used to download the file.

Definition at line 75 of file koPictureKey.h.


Constructor & Destructor Documentation

KoPictureKey::KoPictureKey  ) 
 

Default constructor.

Creates a null key

Definition at line 38 of file koPictureKey.cc.

KoPictureKey::KoPictureKey const QString fn,
const QDateTime mod
 

Constructs a key, from a filename and a modification date.

Storing the modification date as part of the key allows the user to update the file and import it into the application again, without the application reusing the old copy from the collection.

Definition at line 43 of file koPictureKey.cc.

KoPictureKey::KoPictureKey const QString fn  ) 
 

Constructs a key from a filename.

Note:
The modification date is set to 1970-01-01

Definition at line 53 of file koPictureKey.cc.

KoPictureKey::KoPictureKey const KoPictureKey key  ) 
 

Copy constructor.

Definition at line 59 of file koPictureKey.cc.


Member Function Documentation

KoPictureKey & KoPictureKey::operator= const KoPictureKey key  ) 
 

Assignment operator.

Definition at line 64 of file koPictureKey.cc.

References m_filename, and m_lastModified.

bool KoPictureKey::operator== const KoPictureKey key  )  const
 

Comparison operator.

Definition at line 71 of file koPictureKey.cc.

References m_filename, and m_lastModified.

bool KoPictureKey::operator< const KoPictureKey key  )  const
 

Comparison operator.

Note:
Used for sorting in the collection's map

Definition at line 77 of file koPictureKey.cc.

References toString().

QString KoPictureKey::toString  )  const
 

Convert this key into a string representation of it.

Definition at line 139 of file koPictureKey.cc.

Referenced by KoPictureCollection::findPicture(), loadAttributes(), and operator<().

void KoPictureKey::saveAttributes QDomElement elem  )  const
 

Save this key in XML (as KOffice 1.3).

Definition at line 82 of file koPictureKey.cc.

void KoPictureKey::loadAttributes const QDomElement elem  ) 
 

Load this key from XML (as KOffice 1.3).

Definition at line 96 of file koPictureKey.cc.

References toString().

Referenced by KoPictureCollection::readXML().

QString KoPictureKey::filename  )  const [inline]
 

First part of the key: the filename.

Definition at line 137 of file koPictureKey.h.

QDateTime KoPictureKey::lastModified  )  const [inline]
 

Second part of the key: the modification date.

Definition at line 142 of file koPictureKey.h.

void KoPictureKey::setKeyFromFile const QString filename  ) 
 

Sets the key according to filename, including modification time.

Definition at line 146 of file koPictureKey.cc.

Referenced by KoPictureCollection::loadPicture(), and KoPicture::setKeyAndDownloadPicture().


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