KIPI::ImageCollection Class Reference

#include <imagecollection.h>

Collaboration diagram for KIPI::ImageCollection:

[legend]

List of all members.

Public Member Functions
QString	name () const
QString	comment () const
QString	category () const
QDate	date () const
KURL::List	images () const
KURL	path () const
KURL	uploadPath () const
KURL	uploadRoot () const
QString	uploadRootName () const
bool	isDirectory () const
bool	isValid () const
	ImageCollection (ImageCollectionShared *)
	ImageCollection (const ImageCollection &other)
	~ImageCollection ()
	ImageCollection ()
ImageCollection &	operator= (const ImageCollection &)
bool	operator== (const ImageCollection &) const

---

Detailed Description

Holds info about the collection

Definition at line 46 of file imagecollection.h.

---

Constructor & Destructor Documentation

KIPI::ImageCollection::ImageCollection

(

ImageCollectionShared *

data

)

Definition at line 102 of file imagecollection.cpp.

KIPI::ImageCollection::ImageCollection

(

const ImageCollection &

other

)

Definition at line 113 of file imagecollection.cpp.

References _data, and KIPI::ImageCollectionShared::addRef().

Here is the call graph for this function:

KIPI::ImageCollection::~ImageCollection

(

)

Definition at line 107 of file imagecollection.cpp.

References KIPI::ImageCollectionShared::removeRef().

Here is the call graph for this function:

KIPI::ImageCollection::ImageCollection

(

)

Definition at line 123 of file imagecollection.cpp.

---

Member Function Documentation

QString KIPI::ImageCollection::name

(

)

const

PENDING(blackie) document

Definition at line 51 of file imagecollection.cpp.

References KIPI::ImageCollectionShared::name().

Here is the call graph for this function:

QString KIPI::ImageCollection::comment

(

)

const

Definition at line 38 of file imagecollection.cpp.

References KIPI::ImageCollectionShared::comment().

Here is the call graph for this function:

QString KIPI::ImageCollection::category

(

)

const

Return the category of the image collection. For example in Digikam, a category is a sorting class like 'travels', 'friends', 'monuments', etc.

Definition at line 65 of file imagecollection.cpp.

References KIPI::ImageCollectionShared::category().

Here is the call graph for this function:

QDate KIPI::ImageCollection::date

(

)

const

Return the Creation date of the image collection. The default implementation return a null date.

Definition at line 79 of file imagecollection.cpp.

References KIPI::ImageCollectionShared::date().

Here is the call graph for this function:

KURL::List KIPI::ImageCollection::images

(

)

const

PENDING(blackie) document

Definition at line 92 of file imagecollection.cpp.

References KIPI::ImageCollectionShared::images().

Here is the call graph for this function:

KURL KIPI::ImageCollection::path

(

)

const

Returns the directory for the image collection. The host application may, however, return anything in case this imagecollection is not a directory (check isDirectory()), or may return the directory of the first image in the collection, the root of the image collection (in case all images has a common root), or even an empty URL.

Definition at line 154 of file imagecollection.cpp.

References KIPI::ImageCollectionShared::path().

Here is the call graph for this function:

KURL KIPI::ImageCollection::uploadPath

(

)

const

Returns the directory to place images into. This function should only be called if KIPI::Features AcceptNewImages is available.

The function may choose to return the directory for the image collection or if images from the collection are not available in a common directory, then instead a common upload directory. In contrast to path, this function must return a valid url.

IMPORTANT: uploadRoot() must be a subpath of uploadPath()

Definition at line 176 of file imagecollection.cpp.

References KIPI::ImageCollectionShared::uploadPath().

Referenced by KIPI::UploadWidget::UploadWidget().

Here is the call graph for this function:

KURL KIPI::ImageCollection::uploadRoot

(

)

const

When a plugin wants to upload images, it may choose to display an upload widget, which gives the user the possible to show a directory from a tree view.

This tree view widget needs to starts at some URL. This function specifies that location. Here are a couble of possible return value different host applications may choose.

• If all images are stored rooted at some tree (which is the case for KimDaBa), then this function may return this directory unconditionally.
• The root directory returned by uploadPath() (which is the default implementation for this method)
• The directory returned by uploadPath().

IMPORTANT: uploadRoot() must be a subpath of uploadPath()

Definition at line 201 of file imagecollection.cpp.

References KIPI::ImageCollectionShared::uploadRoot().

Referenced by KIPI::UploadWidget::UploadWidget().

Here is the call graph for this function:

QString KIPI::ImageCollection::uploadRootName

(

)

const

This fonction return the name of the upload root path used by the the KIPI::UploadWidget. This name can be different for each host app (like "Images" for Kimdaba or "My Albums" for Digikam).

Definition at line 216 of file imagecollection.cpp.

References KIPI::ImageCollectionShared::uploadRootName().

Referenced by KIPI::UploadWidget::UploadWidget().

Here is the call graph for this function:

bool KIPI::ImageCollection::isDirectory

(

)

const

Definition at line 231 of file imagecollection.cpp.

References KIPI::ImageCollectionShared::isDirectory().

Referenced by KIPI::UploadWidget::UploadWidget().

Here is the call graph for this function:

bool KIPI::ImageCollection::isValid

(

)

const

Definition at line 241 of file imagecollection.cpp.

Referenced by KIPI::UploadWidget::UploadWidget().

KIPI::ImageCollection & KIPI::ImageCollection::operator=

(

const ImageCollection &

rhs

)

Definition at line 128 of file imagecollection.cpp.

References _data, KIPI::ImageCollectionShared::addRef(), and KIPI::ImageCollectionShared::removeRef().

Here is the call graph for this function:

bool KIPI::ImageCollection::operator==

(

const ImageCollection &

ic

)

const

Definition at line 255 of file imagecollection.cpp.

References _data.

---

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

• imagecollection.h
• imagecollection.cpp

---