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
|
/*
* This file is part of the KFTPGrabber project
*
* Copyright (C) 2004 by the KFTPGrabber developers
* Copyright (C) 2004 Jernej Kos <kostko@jweb-network.net>
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License as
* published by the Free Software Foundation; either version 2 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful, but
* is provided AS IS, WITHOUT ANY WARRANTY; without even the implied
* warranty of MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, and
* NON-INFRINGEMENT. See the GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Steet, Fifth Floor, Boston,
* MA 02110-1301, USA.
*
* In addition, as a special exception, the copyright holders give
* permission to link the code of portions of this program with the
* OpenSSL library under certain conditions as described in each
* individual source file, and distribute linked combinations
* including the two.
* You must obey the GNU General Public License in all respects
* for all of the code used other than OpenSSL. If you modify
* file(s) with this exception, you may extend this exception to your
* version of the file(s), but you are not obligated to do so. If you
* do not wish to do so, delete this exception statement from your
* version. If you delete this exception statement from all source
* files in the program, then also delete it here.
*/
#ifndef KFTPBOOKMARKIMPORTPLUGIN_H
#define KFTPBOOKMARKIMPORTPLUGIN_H
#include <tdeparts/plugin.h>
/**
* This class is the base class for all bookmark import plugins.
*
* @author Jernej Kos
*/
class KDE_EXPORT KFTPBookmarkImportPlugin : public KParts::Plugin {
TQ_OBJECT
public:
KFTPBookmarkImportPlugin(TQObject *parent, const char *name = 0);
virtual ~KFTPBookmarkImportPlugin();
/**
* This method should return the properly formated XML for KFTPGrabber
* bookmarks that is generated from the import.
*
* @return The @ref TQDomDocument representation of XML
*/
virtual TQDomDocument getImportedXml() = 0;
/**
* This method should start the import procedure.
*
* @param fileName is the path to the file that will be imported
*/
virtual void import(const TQString &fileName) = 0;
/**
* This method should return the default path where the bookmarks could
* be located. The path must be relative to the user's home directory.
*
* @return The default path where bookmarks are located
*/
virtual TQString getDefaultPath() = 0;
protected:
TQString userPath(const TQString &path);
signals:
/**
* Progress of bookmark importing (in percent).
*/
void progress(int percent);
};
#endif
|
