summaryrefslogtreecommitdiffstats
path: root/sip/kio/kprotocolinfo.sip
blob: f3fdcb30394addb40f5db12e9f39ab282b80c4de (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
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
//
//     Copyright 2006 Jim Bublitz <jbublitz@nwinternet.com>
//     Earlier copyrights 1998 - 2005 Jim Bublitz and/or Phil Thompson
//     may also apply


//                 Generated by preSip
//            module kio  version KDE 3.5.3


// This software 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 software 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 General Public License for more details.
//
// You should have received a copy of the GNU General Public
// License along with this library; see the file COPYING.
// If not, write to the Free Software Foundation, Inc.,
// 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.


class KProtocolInfo : KSycocaEntry
{
%TypeHeaderCode
#include <kprotocolinfo.h>
%End


public:
    typedef KSharedPtr<KProtocolInfo> Ptr;

public:
                         KProtocolInfo (const TQString&);
    virtual bool         isValid () const;
    virtual TQString      name () const;
    static TQStringList   protocols ();
    static bool          isKnownProtocol (const KURL&);
    static bool          isKnownProtocol (const TQString&);
    static TQString       exec (const TQString&)  /PyName=exec_/;

    enum Type
    {
        T_STREAM, 
        T_FILESYSTEM, 
        T_NONE, 
        T_ERROR
    };

    static KProtocolInfo::Type inputType (const KURL&);
    static KProtocolInfo::Type outputType (const KURL&);
    static TQStringList   listing (const KURL&);

%If ( KDE_3_2_0 -  )

    class ExtraField
    {

    public:
                             ExtraField ();
                             ExtraField (const TQString&, const TQString&);
        TQString              name;
        TQString              type;

    };  // class ExtraField


public:
%End


%If ( KDE_3_2_0 -  )
    typedef TQValueList<KProtocolInfo::ExtraField> ExtraFieldList;
    static KProtocolInfo::ExtraFieldList extraFields (const KURL&);
%End

    static bool          isSourceProtocol (const KURL&);
    static bool          isHelperProtocol (const KURL&);
    static bool          isHelperProtocol (const TQString&);
    static bool          isFilterProtocol (const KURL&);
    static bool          isFilterProtocol (const TQString&);
    static bool          supportsListing (const KURL&);
    static bool          supportsReading (const KURL&);
    static bool          supportsWriting (const KURL&);
    static bool          supportsMakeDir (const KURL&);
    static bool          supportsDeleting (const KURL&);
    static bool          supportsLinking (const KURL&);
    static bool          supportsMoving (const KURL&);
    static bool          canCopyFromFile (const KURL&);
    static bool          canCopyToFile (const KURL&);

%If ( KDE_3_4_0 -  )
    static bool          canRenameFromFile (const KURL&);
    static bool          canRenameToFile (const KURL&);
    static bool          canDeleteRecursive (const KURL&);

    enum FileNameUsedForCopying
    {
        Name, 
        FromURL
    };

    static KProtocolInfo::FileNameUsedForCopying fileNameUsedForCopying (const KURL&);
%End

    static TQString       defaultMimetype (const KURL&);
    static TQString       icon (const TQString&);
    static TQString       config (const TQString&);
    static int           maxSlaves (const TQString&);
    static bool          determineMimetypeFromExtension (const TQString&);

%If ( KDE_3_2_0 -  )
    static TQString       docPath (const TQString&);
    static TQString       protocolClass (const TQString&);
    static bool          showFilePreview (const TQString&);
    static KURL::URIMode uriParseMode (const TQString&);

%If ( KDE_3_3_0 -  )
    static TQStringList   capabilities (const TQString&);
    static TQString       proxiedBy (const TQString&);
%End

%End


public:
                         KProtocolInfo (TQDataStream&, int);
    virtual void         load (TQDataStream&);
    virtual void         save (TQDataStream&);
    static Type          inputType (const TQString&);
    static Type          outputType (const TQString&);
    static TQStringList   listing (const TQString&);
    static bool          isSourceProtocol (const TQString&);
    static bool          supportsListing (const TQString&);
    static bool          supportsReading (const TQString&);
    static bool          supportsWriting (const TQString&);
    static bool          supportsMakeDir (const TQString&);
    static bool          supportsDeleting (const TQString&);
    static bool          supportsLinking (const TQString&);
    static bool          supportsMoving (const TQString&);
    static bool          canCopyFromFile (const TQString&);
    static bool          canCopyToFile (const TQString&);
    static TQString       defaultMimetype (const TQString&);

protected:

%If ( KDE_3_5_1 -  )
    bool                 canRenameFromFile () const;
    bool                 canRenameToFile () const;
    bool                 canDeleteRecursive () const;
    KProtocolInfo::FileNameUsedForCopying fileNameUsedForCopying () const;
%End


%If ( KDE_3_4_0 -  )
    static KProtocolInfo* findProtocol (const KURL&);
%End


protected:
//igx     virtual void         virtual_hook (int, void*);

};  // class KProtocolInfo


%If ( KDE_3_2_0 -  )
//igx TQDataStream&         operator >> (TQDataStream&, KProtocolInfo::ExtraField&);
//igx TQDataStream&         operator << (TQDataStream&, const KProtocolInfo::ExtraField&);
%End


%MappedType KProtocolInfo::Ptr
//converts KProtocolInfo
{
%TypeHeaderCode
#include <ksharedptr.h>
#include <kprotocolinfo.h>
%End

%ConvertFromTypeCode
    // Convert to a Python instance

    if (!sipCpp)
        return NULL;

    KSharedPtr<KProtocolInfo> *cPtr = new KSharedPtr<KProtocolInfo>(*(KSharedPtr<KProtocolInfo> *)sipCpp);
    KProtocolInfo *cpp = cPtr->data ();
    PyObject *obj = sipConvertFromInstance (cpp, sipClass_KProtocolInfo, sipTransferObj);

    return obj;
%End

%ConvertToTypeCode
    // Convert a Python instance to a Ptr on the heap.

    if (sipIsErr == NULL)
        return sipCanConvertToType(sipPy, sipType_KProtocolInfo, SIP_NO_CONVERTORS);

    int iserr = 0;
    KProtocolInfo *cpp = (KProtocolInfo *)sipConvertToType(sipPy, sipType_KProtocolInfo, sipTransferObj, SIP_NO_CONVERTORS, NULL, &iserr);

    if (iserr)
    {
        *sipIsErr = 1;
        return 0;
    }

    *sipCppPtr = new KSharedPtr<KProtocolInfo> (cpp);

    return 1;
%End
};


%If (KDE_3_2_0 - )
%MappedType TQValueList<KProtocolInfo::ExtraField>
//converts a Python list of KProtocolInfo::ExtraField
{
%TypeHeaderCode
#include <qvaluelist.h>
%End

%ConvertFromTypeCode
    if (!sipCpp)
        return PyList_New(0);

    // Create the list
    PyObject *pylist;
    if ((pylist = PyList_New(0)) == NULL)
        return NULL;

    TQValueList<KProtocolInfo::ExtraField> *cpplist = (TQValueList<KProtocolInfo::ExtraField> *)sipCpp;
    PyObject *inst;

    // Get it.
    TQValueList<KProtocolInfo::ExtraField>::Iterator it;
    for( it = cpplist->begin(); it != cpplist->end(); ++it )
    {
        if (((inst = sipConvertFromNewType(new KProtocolInfo::ExtraField(*it), sipType_KProtocolInfo_ExtraField, sipTransferObj)) == NULL)
            || PyList_Append (pylist, inst) < 0)
        {
            Py_DECREF (pylist);
            return NULL;
        }
    }

    return pylist;
%End


%ConvertToTypeCode
    if (sipIsErr == NULL)
        return PyList_Check(sipPy);

    TQValueList<KProtocolInfo::ExtraField> *cpplist = new TQValueList<KProtocolInfo::ExtraField>;

    PyObject *elem;
    KProtocolInfo::ExtraField *cpp;
    int iserr = 0;

    for (int i = 0; i < PyList_Size (sipPy); i++)
    {
        elem = PyList_GET_ITEM (sipPy, i);
        cpp = (KProtocolInfo::ExtraField *)sipForceConvertToType(elem, sipType_KProtocolInfo_ExtraField, sipTransferObj, SIP_NOT_NONE|SIP_NO_CONVERTORS, NULL, &iserr);

        if (iserr)
        {
            *sipIsErr = 1;
            delete cpplist;
            return 0;
        }

        cpplist->append (*cpp);
    }

    *sipCppPtr = cpplist;

    return 1;
%End
};
%End