KIPI::Interface Class Reference

#include <interface.h>

List of all members.

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
< ImageCollection
allAlbums ()=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)

Protected Member Functions

virtual int features () const =0

Friends

class PluginLoader


Detailed Description

class Interface

Definition at line 59 of file interface.h.


Constructor & Destructor Documentation

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

Definition at line 98 of file interface.cpp.

KIPI::Interface::~Interface (  )  [virtual]

Definition at line 103 of file interface.cpp.


Member Function Documentation

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.

Definition at line 173 of file interface.cpp.

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

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.

Definition at line 184 of file interface.cpp.

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

Returns a list of albums.

Definition at line 193 of file interface.cpp.

Referenced by KIPI::ImageDialog::ImageDialog(), and KIPI::UploadWidget::UploadWidget().

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

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.

Definition at line 156 of file interface.cpp.

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

Definition at line 164 of file interface.cpp.

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

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

Definition at line 110 of file interface.cpp.

QString KIPI::Interface::fileExtensions (  )  [virtual]

Return a list of images file extention 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.

Definition at line 214 of file interface.cpp.

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.

Definition at line 118 of file interface.cpp.

References features().

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

Here is the call graph for this function:

int KIPI::Interface::features (  )  const [protected, pure virtual]

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

Definition at line 203 of file interface.cpp.

Referenced by hasFeature().

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

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


Friends And Related Function Documentation

friend class PluginLoader [friend]

Definition at line 85 of file interface.h.


The documentation for this class was generated from the following files:
Generated on Tue Sep 25 22:34:29 2007 for libKipi by  doxygen 1.5.3