libKipi
Signals | Public Member Functions | Static Public Member Functions | Protected Member Functions | Friends | List of all members
KIPI::Interface Class Referenceabstract

#include <interface.h>

Inheritance diagram for KIPI::Interface:
Inheritance graph
Collaboration diagram for KIPI::Interface:
Collaboration graph

Signals

void selectionChanged (bool hasSelection)
 
void currentAlbumChanged (bool anyAlbum)
 

Public Member Functions

 Interface (QObject *parent, const char *name=0)
 
virtual ~Interface ()
 
virtual ImageCollection currentAlbum ()=0
 
virtual ImageCollection currentSelection ()=0
 
virtual QValueList< ImageCollectionallAlbums ()=0
 
virtual ImageInfo info (const KURL &)=0
 
virtual bool addImage (const KURL &, QString &err)
 
virtual void delImage (const KURL &)
 
virtual void refreshImages (const KURL::List &)
 
virtual QString fileExtensions ()
 
bool hasFeature (KIPI::Features feature)
 

Static Public Member Functions

static QString version ()
 

Protected Member Functions

virtual int features () const =0
 

Friends

class PluginLoader
 

Detailed Description

class Interface

Constructor & Destructor Documentation

◆ Interface()

KIPI::Interface::Interface ( QObject *  parent,
const char *  name = 0 
)

◆ ~Interface()

KIPI::Interface::~Interface ( )
virtual

Member Function Documentation

◆ addImage()

bool KIPI::Interface::addImage ( const KURL &  ,
QString &  err 
)
virtual

Tell the host application that a new image has been made available to it. Returns true if the host application did accept the new image, otherwise err will be filled with an error description.

References endl().

Here is the call graph for this function:

◆ allAlbums()

QValueList< KIPI::ImageCollection > KIPI::Interface::allAlbums ( )
pure virtual

Returns a list of albums.

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

◆ currentAlbum()

KIPI::ImageCollection KIPI::Interface::currentAlbum ( )
pure virtual

Returns list of all images in current album. If there are no current album, the returned KIPI::ImageCollection::isValid() will return false.

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

◆ currentAlbumChanged

void KIPI::Interface::currentAlbumChanged ( bool  anyAlbum)
signal

◆ currentSelection()

KIPI::ImageCollection KIPI::Interface::currentSelection ( )
pure virtual

Current selection in a thumbnail view for example. If there are no current selection, the returned KIPI::ImageCollection::isValid() will return false.

◆ delImage()

void KIPI::Interface::delImage ( const KURL &  )
virtual

◆ features()

int KIPI::Interface::features ( ) const
protectedpure virtual

Return a bitwise or of the KIPI::Features that thus application support.

◆ fileExtensions()

QString KIPI::Interface::fileExtensions ( )
virtual

Return a list of images file extension will be used in the plugins for to sort the files list before a treatment. The default implementation return, the supported images formats by KDE.

◆ hasFeature()

bool KIPI::Interface::hasFeature ( KIPI::Features  feature)

Tells whether the host application under which the plugin currently executes a given feature. See KIPI::Features for details on the individual features.

Referenced by KIPI::ImageCollectionSelector::ImageCollectionSelector(), and KIPI::PluginLoader::PluginLoader().

◆ info()

virtual ImageInfo KIPI::Interface::info ( const KURL &  )
pure virtual

◆ refreshImages()

void KIPI::Interface::refreshImages ( const KURL::List &  )
virtual

Tells the host app that the following images has changed on disk

◆ selectionChanged

void KIPI::Interface::selectionChanged ( bool  hasSelection)
signal

◆ version()

QString KIPI::Interface::version ( )
static

Return a string version of libkipi release

Returns a string version of libkipi release

Friends And Related Function Documentation

◆ PluginLoader

friend class PluginLoader
friend

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