KIPI Namespace Reference

Classes
class	ConfigWidget
class	EditHintScope
class	FileReadLocker
class	FileReadWriteLock
class	FileWriteLocker
class	ImageCollection
class	ImageCollectionSelector
class	ImageCollectionShared
class	ImageInfo
class	ImageInfoShared
class	Interface
class	Plugin
class	PluginCheckBox
class	PluginListView
class	PluginLoader
class	UploadWidget

Enumerations
enum	Category {   InvalidCategory = -1, ImagesPlugin = 0, ToolsPlugin, ImportPlugin,   ExportPlugin, BatchPlugin, CollectionsPlugin }
enum	EditHint {   UndefinedEditHint = 0, HintPixelContentChanged = 1 << 0, HintMetadataChanged = 1 << 1, HintChangeReflectedByAttributes = 1 << 2,   HintEditAborted = 1 << 3, HintMetadataOnlyChange = HintMetadataChanged | HintChangeReflectedByAttributes }
enum	Features {   CollectionsHaveComments = 1 << 0, ImagesHasComments = 1 << 1, ImagesHasTime = 1 << 2, HostSupportsDateRanges = 1 << 3,   HostAcceptNewImages = 1 << 4, ImagesHasTitlesWritable = 1 << 5, CollectionsHaveCategory = 1 << 6, CollectionsHaveCreationDate = 1 << 7,   HostSupportsProgressBar = 1 << 8, HostSupportsTags = 1 << 9, HostSupportsRating = 1 << 10, HostSupportsThumbnails = 1 << 11,   HostSupportsReadWriteLock = 1 << 12, HostSupportsPickLabel = 1 << 13, HostSupportsColorLabel = 1 << 14, HostSupportsItemReservation = 1 << 15 }

Variables
static PluginLoader *	s_instance = 0
static bool	s_loaded = false

Enumeration Type Documentation

enum KIPI::Category

Enumerator
InvalidCategory
ImagesPlugin
ToolsPlugin
ImportPlugin
ExportPlugin
BatchPlugin
CollectionsPlugin

Definition at line 63 of file plugin.h.

enum KIPI::EditHint

Enumerator
UndefinedEditHint
HintPixelContentChanged	The image data (pixels) have been edited.
HintMetadataChanged	Metadata have been edited.
HintChangeReflectedByAttributes	All changes done (typically, to the metadata) are also communicated via image attributes. In other words, if the host updates its internal storage from attribute changes and ignores changes on disk, it already has all information.
HintEditAborted	The operation indicated as "about to be done" has been aborted / did not result in a change.
HintMetadataOnlyChange	Short name, implies that only metadata changed, and all metadata changes are communicated via attributes.

Definition at line 100 of file interface.h.

enum KIPI::Features

Not all host applications support the full subset of features that KIPI allows access to. As an example digiKam support comments for albums. Thus before a plugin expect a decant value for the comment, it should check whether KIPI::CollectionsHaveComments are set. It does so using KIPI::Interface::hasFeature().

Enumerator
CollectionsHaveComments
ImagesHasComments	This feature specifies that albums have descriptions associated to them.
ImagesHasTime	This feature specifies that images in the host application has descriptions associated to them.
HostSupportsDateRanges	This feature specifies that images has a date associated with it, which the host application can display and set.
HostAcceptNewImages	This feature specifies whether the host application supports that the user can specify a date range for images, like 1998-2000.
ImagesHasTitlesWritable	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.
CollectionsHaveCategory	This feature specifies whether the plugin can change the title for images.
CollectionsHaveCreationDate	This feature specifies that collections are category associated to them ('travels', 'friends', 'monuments', etc.).
HostSupportsProgressBar	This feature specifies that collections are a creation date associated to them.
HostSupportsTags	This feature specifies whether the host application has a progress manager available to report progress information from plugins.
HostSupportsRating	This feature specifies whether the host application supports keywords for images.
HostSupportsThumbnails	This feature specifies whether the host application supports rating values for images.
HostSupportsReadWriteLock	This feature specifies that host application can provide image thumbnails.
HostSupportsPickLabel	This feature specifies that host application has mechanism to lock/unlock items to prevent concurent operations.
HostSupportsColorLabel	This feature specifies whether the host application supports pick label values for images, used for photograph workflow.
HostSupportsItemReservation	This feature specifies whether the host application supports color label values for images, used to sort item with color flag.

Definition at line 77 of file interface.h.

Variable Documentation

PluginLoader* KIPI::s_instance = 0

static

Definition at line 220 of file pluginloader.cpp.

bool KIPI::s_loaded = false

static

Definition at line 221 of file pluginloader.cpp.