KIPI::ImageCollection

Search for usage in LXR

KIPI::ImageCollection Class Reference

#include <KIPI/ImageCollection>

Public Member Functions

 ImageCollection (ImageCollectionShared *const)
 
 ImageCollection (const ImageCollection &other)
 
QString category () const
 
QString comment () const
 
QDate date () const
 
QList< QUrlimages () const
 
bool isDirectory () const
 
bool isValid () const
 
QString name () const
 
ImageCollectionoperator= (const ImageCollection &)
 
bool operator== (const ImageCollection &) const
 
QString uploadRootName () const
 
QUrl uploadRootUrl () const
 
QUrl uploadUrl () const
 
QUrl url () 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 34 of file imagecollection.h.

Member Function Documentation

QString KIPI::ImageCollection::category ( ) const

Return the category of the image collection.

For example, a category can be a sorting class like 'travels', 'friends', 'monuments', etc.

Definition at line 113 of file imagecollection.cpp.

QString KIPI::ImageCollection::comment ( ) const

Returns the comment for the collection of images or QString() if that does not make any sense.

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

Definition at line 87 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 126 of file imagecollection.cpp.

QList< QUrl > KIPI::ImageCollection::images ( ) const

Returns a list of image URLs hosted by collection.

Definition at line 139 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 204 of file imagecollection.cpp.

bool KIPI::ImageCollection::isValid ( ) const

Returns true if this Collection is valid.

Definition at line 217 of file imagecollection.cpp.

QString KIPI::ImageCollection::name ( ) const

Returns the name of collection.

Definition at line 100 of file imagecollection.cpp.

QString KIPI::ImageCollection::uploadRootName ( ) const

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

Definition at line 191 of file imagecollection.cpp.

QUrl KIPI::ImageCollection::uploadRootUrl ( ) 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 couple 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 uploadUrl() (which is the default implementation for this method) will be the directory returned by uploadUrl().

Note
uploadRootUrl() must be a subpath of uploadUrl()

Definition at line 178 of file imagecollection.cpp.

QUrl KIPI::ImageCollection::uploadUrl ( ) 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.

Note
uploadRootUrl() must be a subpath of uploadUrl()

Definition at line 165 of file imagecollection.cpp.

QUrl KIPI::ImageCollection::url ( ) 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 152 of file imagecollection.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2022 The KDE developers.
Generated on Sat Jan 22 2022 22:32:07 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.