libKipi
Public Member Functions | List of all members
KIPI::ImageCollection Class Reference

#include <imagecollection.h>

Collaboration diagram for KIPI::ImageCollection:
Collaboration graph

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 ()
 
ImageCollectionoperator= (const ImageCollection &)
 
bool operator== (const ImageCollection &) const
 

Detailed Description

Holds info about the collection

Constructor & Destructor Documentation

◆ ImageCollection() [1/3]

KIPI::ImageCollection::ImageCollection ( ImageCollectionShared data)

◆ ImageCollection() [2/3]

KIPI::ImageCollection::ImageCollection ( const ImageCollection other)

◆ ~ImageCollection()

KIPI::ImageCollection::~ImageCollection ( )

◆ ImageCollection() [3/3]

KIPI::ImageCollection::ImageCollection ( )

Member Function Documentation

◆ category()

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.

◆ comment()

QString KIPI::ImageCollection::comment ( ) const

References KIPI::ImageCollectionShared::comment().

Here is the call graph for this function:

◆ date()

QDate KIPI::ImageCollection::date ( ) const

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

◆ images()

KURL::List KIPI::ImageCollection::images ( ) const

PENDING(blackie) document

◆ isDirectory()

bool KIPI::ImageCollection::isDirectory ( ) const

◆ isValid()

bool KIPI::ImageCollection::isValid ( ) const

◆ name()

QString KIPI::ImageCollection::name ( ) const

PENDING(blackie) document

◆ operator=()

KIPI::ImageCollection & KIPI::ImageCollection::operator= ( const ImageCollection rhs)

◆ operator==()

bool KIPI::ImageCollection::operator== ( const ImageCollection ic) const

◆ path()

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.

◆ uploadPath()

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()

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

◆ uploadRoot()

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)
  • The directory returned by uploadPath().

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

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

◆ uploadRootName()

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).

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


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