summaryrefslogtreecommitdiffstats
path: root/src/pluginloader/pluginloaderbase.h
blob: 2ed9f4f90382613e8ee10e89d98e2b9de69ba339 (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


#ifndef PLUGINLOADERBASE_H
#define PLUGINLOADERBASE_H

#include <tqobject.h>
#include <tqstringlist.h>
#include <tqdom.h>

#include "config.h"

// TODO implement rank everywhere

/**
 * @short The base for all pluginloaders
 * @author Daniel Faust <hessijames@gmail.com>
 * @version 0.3
 */
class PluginLoaderBase : public TQObject
{
    TQ_OBJECT
  
public:
    /**
     * Do we recommend this backend to the user
     */
    enum FeatureLevel
    {
        Full, // the backend provides full support
        Most, // most features are supported
        Basic // we'll have just basic support
    };

    /**
     * Just a small enum for our sampling rate units
     */
    enum Unit
    {
        Hz,
        KHz
    };

    /**
     * Constructor
     */
    PluginLoaderBase();

    /**
     * Destructor
     */
    virtual ~PluginLoaderBase();

    /** a list of all plugin files that are loaded at the moment */
//     TQStringList openPluginFiles;

    /** the dom tree for loading the xml file */
    TQDomDocument domTree;

public slots:
    /**
     * Unload all plugins
     */
    void unloadAll();

    /**
     * Unoad a specific plugin with name @p pluginName
     */
    void unload( TQString pluginName );

    /**
     * Unoad a specific plugin with name @p pluginName and delete the plugin file
     */
    void remove( TQString pluginName );
};

#endif // PLUGINLOADERBASE_H


/**

Each plugin package contains 3 files:
 - The plugin file ( $KDE_DIR/share/apps/soundkonverter/plugins/'filename' )
 - The format info file ( $KDE_DIR/share/apps/soundkonverter/format_infos/'lang'/'plugin'_'filename' )
 - The service menu ( $KDE_DIR/share/apps/konqueror/servicemenus/'filename' )

*/