summaryrefslogtreecommitdiffstats
path: root/kftpgrabber/src/misc/configbase.h
blob: 994635196acd10f1ebdf6a080f3499cb83f9a93d (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
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
/*
 * This file is part of the KFTPGrabber project
 *
 * Copyright (C) 2003-2005 by the KFTPGrabber developers
 * Copyright (C) 2003-2005 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 KFTPCORECONFIGBASE_H
#define KFTPCORECONFIGBASE_H

#include <ntqobject.h>

#include <tdeconfigskeleton.h>

#include "kftpfileexistsactions.h"

#define PRIO_SKIP 0
#define PRIO_NOT_FOUND -999

namespace KFTPCore {

/**
 * This is a base class for KFTPGrabber's configuration. It is inherited by
 * auto-generated TDEConfigXT class KFTPCore::Config that adds all the configuration
 * options.
 *
 * @author Jernej Kos
 */
class ConfigBase : public TQObject, public TDEConfigSkeleton
{
Q_OBJECT
public:
    ConfigBase(const TQString &fileName);
    
    /**
     * Does some post initialization stuff that couldn't be done in the constructor due
     * to use of Config singleton.
     */
    void postInit();
    
    /**
     * Does some pre write stuff (eg. exporting the actions).
     */
    void saveConfig();
    
    /**
     * Returns a proper mode for the requested file. If the current mode is set to AUTO
     * the list of ascii file patterns is consulted.
     *
     * @param filename The filename for which the mode should be returned
     * @return A valid FTP transfer mode
     */
    char ftpMode(const TQString &filename);
    
    /**
     * Set the global transfer mode.
     *
     * @param mode Transfer mode
     */
    void setGlobalMode(char mode) { m_transMode = mode; }
    
    /**
     * Get the global transfer mode.
     *
     * @return The transfer mode currently in use
     */
    char getGlobalMode() { return m_transMode; }
    
    /**
     * Get the download actions object.
     *
     * @return The FileExistsActions object for download actions
     */
    KFTPQueue::FileExistsActions *dActions() { return &m_fileExistsDownActions; }
    
    /**
     * Get the upload actions object.
     *
     * @return The FileExistsActions object for upload actions
     */
    KFTPQueue::FileExistsActions *uActions() { return &m_fileExistsUpActions; }
    
    /**
     * Get the fxp actions object.
     *
     * @return The FileExistsActions object for fxp actions
     */
    KFTPQueue::FileExistsActions *fActions() { return &m_fileExistsFxpActions; }
public slots:
    /**
     * Emits the configChanged() signal.
     */
    void emitChange();
protected:
    TQString getGlobalMail();
private:
    KFTPQueue::FileExistsActions m_fileExistsDownActions;
    KFTPQueue::FileExistsActions m_fileExistsUpActions;
    KFTPQueue::FileExistsActions m_fileExistsFxpActions;
    
    char m_transMode;
signals:
    void configChanged();
};

}

#endif