format

KABC::FormatFactory(3)      Library Functions Manual      KABC::FormatFactory(3)



NAME
       KABC::FormatFactory - Class for loading format plugins.


SYNOPSIS
       #include <formatfactory.h>

   Public Member Functions
       FormatPlugin * format (const  QString &type)
           Returns a pointer to a format object or a null pointer if format type
           doesn't exist.
       QStringList formats ()
           Returns a list of all available format types.
       FormatInfo * info (const  QString &type)
           Returns the info structure for a special type.

   Static Public Member Functions
       FormatFactory * self ()
           Returns the global format factory.

Detailed Description
       Class for loading format plugins.

       Example:

        KABC::FormatFactory *factory = KABC::FormatFactory::self();

        QStringList list = factory->formats();
        QStringList::Iterator it;
        for ( it = list.begin(); it != list.end(); ++it ) {
          KABC::FormatPlugin *format = factory->format( (*it) );
          // do something with format
        }


       Definition at line 57 of file formatfactory.h.

Member Function Documentation
   FormatFactory * FormatFactory::self () [static]
       Returns the global format factory. Definition at line 36 of file
       formatfactory.cpp.

   FormatPlugin * FormatFactory::format (const QString & type)
       Returns a pointer to a format object or a null pointer if format type
       doesn't exist. Parameters:
           type The type of the format, returned by formats()

       Definition at line 108 of file formatfactory.cpp.

       References format(), QString::isEmpty(), and KLibrary::symbol().

       Referenced by format(), and KABC::ResourceIMAP::ResourceIMAP().

   QStringList FormatFactory::formats ()
       Returns a list of all available format types. Definition at line 85 of
       file formatfactory.cpp.

       References QDictIterator::current(), and QDictIterator::currentKey().

   FormatInfo * FormatFactory::info (const QString & type)
       Returns the info structure for a special type. Definition at line 100 of
       file formatfactory.cpp.

       References QString::isEmpty().


Author
       Generated automatically by Doxygen for kabc Library from the source code.




kabc Library                       28 Jan 2004            KABC::FormatFactory(3)