libKipi
KIPI Namespace Reference

Classes

struct  AlbumLVI
class  BatchProgressDialog
class  BatchProgressItem
class  ConfigWidget
class  ImageCollection
class  ImageCollectionItem
class  ImageCollectionSelector
class  ImageCollectionShared
class  ImageDialog
class  ImageInfo
class  ImageInfoShared
struct  ImageLVI
class  Interface
class  Plugin
class  PluginCheckBox
class  PluginLoader
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 , HostSupportsTags = 1 << 9
}
enum  Category {
  IMAGESPLUGIN = 0 , EFFECTSPLUGIN , TOOLSPLUGIN , IMPORTPLUGIN ,
  EXPORTPLUGIN , BATCHPLUGIN , COLLECTIONSPLUGIN
}

Detailed Description

This is the namespace

Enumeration Type Documentation

◆ ActionMessageType

Enumerator
StartingMessage 
SuccessMessage 
WarningMessage 
ErrorMessage 
ProgressMessage 

◆ Category

Enumerator
IMAGESPLUGIN 
EFFECTSPLUGIN 
TOOLSPLUGIN 
IMPORTPLUGIN 
EXPORTPLUGIN 
BATCHPLUGIN 
COLLECTIONSPLUGIN 

◆ 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() When adding new items, remember to update "hasFeature( const QString& feature )" and the hello world plugin.

Enumerator
AlbumsHaveComments 
ImagesHasComments 
ImagesHasTime 
SupportsDateRanges 
AcceptNewImages 
ImageTitlesWritable 
AlbumsHaveCategory 
AlbumsHaveCreationDate 
AlbumsUseFirstImagePreview 
HostSupportsTags 

◆ TimeSpec

Enumerator
FromInfo 
ToInfo