KIPI::ImageCollection Class Reference

#include <imagecollection.h>

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

Detailed Description

Holds info about the collection from KIPI host application.

NOTE: Plugins should never create an instance of ImageCollection, only the host application should do that.

Definition at line 58 of file imagecollection.h.

Constructor & Destructor Documentation

KIPI::ImageCollection::ImageCollection

(

ImageCollectionShared * const

data

)

Definition at line 53 of file imagecollection.cpp.

KIPI::ImageCollection::ImageCollection

(

const ImageCollection &

other

)

Definition at line 58 of file imagecollection.cpp.

KIPI::ImageCollection::ImageCollection

(

)

Definition at line 71 of file imagecollection.cpp.

KIPI::ImageCollection::~ImageCollection

(

)

Definition at line 76 of file imagecollection.cpp.

Member Function Documentation

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 139 of file imagecollection.cpp.

QString KIPI::ImageCollection::comment

(

)

const

Returns the comment for the collection of images or QString::null if that doesn't make any sense.

A comment makes sense for an album, but not for a KIPI::Interface::currentSelection().

Definition at line 113 of file imagecollection.cpp.

QDate KIPI::ImageCollection::date

(

)

const

Returns the Creation date of the image collection.

The default implementation return a null date.

Definition at line 152 of file imagecollection.cpp.

KUrl::List KIPI::ImageCollection::images

(

)

const

Returns a list of image urls hosted by collection.

Definition at line 165 of file imagecollection.cpp.

bool KIPI::ImageCollection::isDirectory

(

)

const

Returns whether an imagecollection is a physical folder on the filesystem or not.

It is important to check this, if your plugin needs to do folder based operations for an image collection.

Definition at line 230 of file imagecollection.cpp.

bool KIPI::ImageCollection::isValid

(

)

const

Returns true if this Collection is valid.

Definition at line 243 of file imagecollection.cpp.

QString KIPI::ImageCollection::name

(

)

const

Collection properties ---------------------------------------------------------------------——.

Returns the name of collection.

Definition at line 126 of file imagecollection.cpp.

ImageCollection & KIPI::ImageCollection::operator=

(

const ImageCollection &

rhs

)

Definition at line 82 of file imagecollection.cpp.

bool KIPI::ImageCollection::operator==

(

const ImageCollection &

ic

)

const

Definition at line 103 of file imagecollection.cpp.

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 178 of file imagecollection.cpp.

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 191 of file imagecollection.cpp.

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 KPhotoAlbum), then this function may return this directory unconditionally. The root directory returned by uploadPath() (which is the default implementation for this method) will be the directory returned by uploadPath().

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

Definition at line 204 of file imagecollection.cpp.

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 Kphotoalbum or "My Albums" for digiKam).

Definition at line 217 of file imagecollection.cpp.

---

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

• imagecollection.h
• imagecollection.cpp