path: root/sip/kio/kprotocolinfo.sip

//
//     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 QString&);
    virtual bool         isValid () const;
    virtual QString      name () const;
    static QStringList   protocols ();
    static bool          isKnownProtocol (const KURL&);
    static bool          isKnownProtocol (const QString&);
    static QString       exec (const QString&)  /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 QStringList   listing (const KURL&);

%If ( KDE_3_2_0 -  )

    class ExtraField
    {

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

    };  // class ExtraField


public:
%End


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

    static bool          isSourceProtocol (const KURL&);
    static bool          isHelperProtocol (const KURL&);
    static bool          isHelperProtocol (const QString&);
    static bool          isFilterProtocol (const KURL&);
    static bool          isFilterProtocol (const QString&);
    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 QString       defaultMimetype (const KURL&);
    static QString       icon (const QString&);
    static QString       config (const QString&);
    static int           maxSlaves (const QString&);
    static bool          determineMimetypeFromExtension (const QString&);

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

%If ( KDE_3_3_0 -  )
    static QStringList   capabilities (const QString&);
    static QString       proxiedBy (const QString&);
%End

%End


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

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 QDataStream&         operator >> (QDataStream&, KProtocolInfo::ExtraField&);
//igx QDataStream&         operator << (QDataStream&, 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 QValueList<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;

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

    // Get it.
    QValueList<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);

    QValueList<KProtocolInfo::ExtraField> *cpplist = new QValueList<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