summaryrefslogtreecommitdiffstats
path: root/tdeabc/formatfactory.h
blob: 0994fe109ba0a546e4d3b30ed8743f1fd4d47115 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
/*
    This file is part of libkabc.
    Copyright (c) 2002 Tobias Koenig <[email protected]>

    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Library General Public
    License as published by the Free Software Foundation; either
    version 2 of the License, or (at your option) any later version.

    This library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    Library General Public License for more details.

    You should have received a copy of the GNU Library General Public License
    along with this library; see the file COPYING.LIB.  If not, write to
    the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
    Boston, MA 02110-1301, USA.
*/

#ifndef KABC_FORMATFACTORY_H
#define KABC_FORMATFACTORY_H

#include <tqdict.h>
#include <tqstring.h>

#include <tdeconfig.h>
#include <klibloader.h>

#include "formatplugin.h"

namespace TDEABC {

struct FormatInfo
{
  TQString library;
  TQString nameLabel;
  TQString descriptionLabel;
};

/**
 * Class for loading format plugins.
 *
 * Example:
 *
 * \code
 * TDEABC::FormatFactory *factory = TDEABC::FormatFactory::self();
 *
 * TQStringList list = factory->formats();
 * TQStringList::Iterator it;
 * for ( it = list.begin(); it != list.end(); ++it ) {
 *   TDEABC::FormatPlugin *format = factory->format( (*it) );
 *   // do something with format
 * }
 * \endcode
 */
class KABC_EXPORT FormatFactory
{
  public:
    
    /**
      Destructor.
     */
    ~FormatFactory();

    /**
     * Returns the global format factory.
     */
    static FormatFactory *self();

    /**
     * Returns a pointer to a format object or a null pointer
     * if format type doesn't exist.
     *
     * @param type   The type of the format, returned by formats()
     */
    FormatPlugin *format( const TQString &type );

    /**
     * Returns a list of all available format types.
     */
    TQStringList formats();

    /**
     * Returns the info structure for a special type.
     */
    FormatInfo *info( const TQString &type );

  protected:
    FormatFactory();

  private:
    KLibrary *openLibrary( const TQString& libName );

    static FormatFactory *mSelf;

    TQDict<FormatInfo> mFormatList;
};

}
#endif