KIPI Namespace Reference

Classes
class	BatchProgressItem
class	BatchProgressDialog
class	ImageCollection
class	ImageCollectionItem
class	ImageCollectionSelector
class	ImageCollectionShared
struct	AlbumLVI
struct	ImageLVI
class	ImageDialog
class	ImageInfo
class	ImageInfoShared
class	Interface
class	Plugin
class	PluginCheckBox
class	PluginLoader
class	ConfigWidget
class	UploadWidget
Enumerations
enum	ActionMessageType {   StartingMessage = 0, SuccessMessage, WarningMessage, ErrorMessage,   ProgressMessage }
enum	TimeSpec { FromInfo, ToInfo }
enum	Features {   AlbumsHaveComments = 1 << 0, ImagesHasComments = 1 << 1, ImagesHasTime = 1 << 2, SupportsDateRanges = 1 << 3,   AcceptNewImages = 1 << 4, ImageTitlesWritable = 1 << 5, AlbumsHaveCategory = 1 << 6, AlbumsHaveCreationDate = 1 << 7,   AlbumsUseFirstImagePreview = 1 << 8 }
enum	Category {   IMAGESPLUGIN = 0, EFFECTSPLUGIN, TOOLSPLUGIN, IMPORTPLUGIN,   EXPORTPLUGIN, BATCHPLUGIN, COLLECTIONSPLUGIN }

---

Enumeration Type Documentation

enum KIPI::ActionMessageType

Enumerator: StartingMessage  SuccessMessage  WarningMessage  ErrorMessage  ProgressMessage

enum KIPI::Category

Enumerator: IMAGESPLUGIN  EFFECTSPLUGIN  TOOLSPLUGIN  IMPORTPLUGIN  EXPORTPLUGIN  BATCHPLUGIN  COLLECTIONSPLUGIN

enum KIPI::Features

Not all host applications support the full subset of features that KIPI allows access to. As an example KimDaBa do not support comments for albums. Thus before a plugin expect a decant value for the comment, it should check whether KIPI::AlbumsHaveComments are set. It does so using KIPI::Interface::hasFeature() Enumerator: AlbumsHaveComments  This feature specify that albums have descriptions associated to them. ImagesHasComments  This feature specifies that images in the host application has descriptions associated to them. ImagesHasTime  This feature specifies that images has a date associated with it, which the host application can display and set SupportsDateRanges  This feature specify whether the host application supports that the user can specify a date range for images, like 1998-2000. AcceptNewImages  This feature specifies that the host application do accept new images. Use ImageCollection::uploadPath to find the location to place the image, and KIPI::Interface::addImage() to tell the host application about the new image. ImageTitlesWritable  This features specifies whether the plugin can change the title for images AlbumsHaveCategory  This feature specify that albums are category associated to them ('travels', 'friends', 'monuments', etc.). AlbumsHaveCreationDate  This feature specify that albums are a creation date associated to them. AlbumsUseFirstImagePreview  This feature specify that albums use the first image of the collection like preview. This flag is used in ImageGallery, CDArchiving, and FinDuplicateImages dialog for to lauch a preview of the album.

enum KIPI::TimeSpec

Enumerator: FromInfo  ToInfo

---