kio Module Reference

KIO.AuthInfo

KIO.AuthInfo is fully implemented.

KIO.NetRC (KDE2.2.0+)

KIO.NetRC is fully implemented. *** EXCEPT

NetRC has no public constructor - use the following method to obtain a NetRC object instance:

static KIO::NetRC*   self ();

-----

int openf (const QString&);
void parse (int);
QString extract (const char*, const char*, int&);

NOT Implemented

KIO.NetRC.AutoLogin (KDE2.2.0+)

KIO.NetRC.AutoLogin is fully implemented.

KStringListMap macdef;

RETURNS a Python dictionary with key:QString, value:QStringList

KIO.ChmodJob

KIO.ChmodJob is fully implemented.

KIO::ChmodJob * KIO.chmodJob(const KFileItemList&, int, int,
                      QString, QString,
                      bool, bool = 1);

GLOBAL function (renamed from 'chmod' in C++)

KIO.Connection

KIO.Connection is fully implemented. *** EXCEPT

int read (int* _cmd, QByteArray&);

TAKES a QByteArray and RETURNS a Python tuple of (int, int)

KIO.Task (KDE3.0+)

KIO.Task is fully implemented.

DefaultProgress

DefaultProgress is fully implemented.

enum ModeType { Copy, Move, Delete, Create };

NOT Implemented

KIO.UDSAtom

KIO.UDSAtom is fully implemented.

job

job is fully implemented.

The following GLOBAL functions available. Some are renamed for PyKDE2 by adding 'Job' or 'SimpleJob' to the end of the cpp name as indicated.

KIO::SimpleJob * KIO.mkdir(const KURL&, int = -1);
KIO::SimpleJob * KIO.rmdir(const KURL&);
KIO::SimpleJob * KIO.chmodSimpleJob(const KURL&, int);
KIO::SimpleJob * KIO.rename(const KURL&, const KURL&, bool);
KIO::SimpleJob * KIO.symlinkJob(const QString &, const KURL&, bool, bool = 1);
KIO::SimpleJob * KIO.specialJob(const KURL&, const QByteArray &, bool = 1);
KIO::SimpleJob * KIO.mount(bool, const char *, const QString&, const QString&, bool = 1);
KIO::SimpleJob * KIO.unmount(const QString &, bool = 1);
KIO::SimpleJob * KIO.http_update_cache(const KURL&, bool, time_t);
KIO::StatJob   * KIO.statJob(const KURL&, bool = 1);
KIO::TransferJob * KIO.get(const KURL&, bool = 0, bool = 1);
KIO::TransferJob * KIO.put(const KURL&, int, bool, bool, bool = 1);
KIO::TransferJob * KIO.http_post(const KURL&, const QByteArray &,
                            bool = 1);
KIO::MimetypeJob * KIO.mimetypeJob(const KURL&, bool = 1);
KIO::FileCopyJob * KIO.file_copy(const KURL&, const KURL&, int = -1,
                            bool = 0, bool = 0,
                            bool = 1);
KIO::FileCopyJob * KIO.file_move(const KURL&, const KURL&, int = -1,
                            bool = 0, bool = 0,
                            bool = 1);
KIO::SimpleJob * KIO.file_delete(const KURL&, bool = 1);
KIO::ListJob   * KIO.listDirJob(const KURL&, bool = 1);
KIO::ListJob   * KIO.listRecursive(const KURL&, bool = 1);
KIO::CopyJob   * KIO.copy(const KURL&, const KURL&, bool = 1);
KIO::CopyJob   * KIO.copyAs(const KURL&, const KURL&, bool = 1);
KIO::CopyJob   * KIO.copy(const KURL::List&, const KURL&, bool = 1);
KIO::CopyJob   * KIO.move(const KURL&, const KURL&, bool = 1);
KIO::CopyJob   * KIO.moveAs(const KURL&, const KURL&, bool = 1);
KIO::CopyJob   * KIO.move(const KURL::List&, const KURL&, bool = 1);
KIO::CopyJob   * KIO.link(const KURL&, const KURL&, bool = 1);
KIO::CopyJob   * KIO.link(const KURL::List&, const KURL&, bool = 1);
KIO::CopyJob   * KIO.linkAs(const KURL&, const KURL&, bool = 1);
KIO::DeleteJob * KIO.delJob(const KURL&, bool = 0, bool = 1);
KIO::DeleteJob * KIO.delJob(const KURL::List&, bool  = 0, bool = 1);

KIO.Job

KIO.Job is fully implemented.

    void                 mergeMetaData (const KStringMap&);
    void                 addMetaData (const KStringMap&);

TAKES a Python dict with key=QString, value=QString as first parameter

KIO.SimpleJob

KIO.SimpleJob is fully implemented.

KIO.StatJob

KIO.StatJob is fully implemented.

KIO.TransferJob

KIO.TransferJob is fully implemented.

KIO.MimetypeJob

KIO.MimetypeJob is fully implemented.

KIO.FileCopyJob

KIO.FileCopyJob is fully implemented.

KIO.ListJob

KIO.ListJob is fully implemented.

KIO.CopyJob

KIO.CopyJob is fully implemented.

KIO.DeleteJob

KIO.DeleteJob is fully implemented.

KArchive

KArchive is fully implemented.

*** EXCEPT

This class is ABSTRACT; all pure virtual methods must be overloaded before using

virtual bool doneWriting (uint size) = 0;

PURE VIRTUAL method

virtual bool prepareWriting (const QString& name, const QString& user, const QString& group, uint size) = 0;

PURE VIRTUAL method

virtual bool writeDir (const QString& name, const QString& user, const QString& group) = 0;

PURE VIRTUAL method

bool writeFile (const QString& name, const QString& user, const QString& group, uint size, const char* data);

Has member code or mapped type

virtual bool closeArchive () = 0;

PURE VIRTUAL method

virtual bool openArchive (int mode) = 0;

PURE VIRTUAL method

KArchiveDirectory (KDE3.0+)

KArchiveDirectory is fully implemented.

KArchiveEntry (KDE3.0+)

KArchiveEntry is fully implemented.

KArchiveFile (KDE3.0+)

KArchiveFile is fully implemented.

KAutoMount

KAutoMount is fully implemented.

KAutoUnmount

KAutoUnmount is fully implemented.

KDataTool (KDE3.0+)

KDataTool is fully implemented.

*** EXCEPT

This class is ABSTRACT; all pure virtual methods must be overloaded before using

virtual bool run (const QString& command, void* data, const QString& datatype, const QString& mimetype) = 0;

PURE VIRTUAL method

KDataToolAction (KDE3.0+)

KDataToolAction is fully implemented.

*** EXCEPT

static KActionQPtrList dataToolActionList (KDataToolInfoVList&, SIP_RXOBJ_CON, SIP_SLOT_CON());

TAKES a Python list of KDataToolInfo and a slot and returns a Python list of KAction

KDataToolInfo (KDE3.0+)

KDataToolInfo is fully implemented.

*** EXCEPT

static KDataToolInfoVList query (const QString& datatype, const QString& mimetype, KInstance* instance);

RETURNS a Python list of KDataToolInfo

KDirLister

KDirLister is fully implemented.

KDirNotify

KDirNotify is fully implemented.

KDirWatch

KDirWatch is fully implemented.

KEMailSettings

KEMailSettings is fully implemented. *** EXCEPT

QString getExtendedSetting (KEMailSettings::Extension e, const QString& s);

NOT Implemented

void setExtendedSetting (KEMailSettings::Extension e, const QString& s, const QString& v);

NOT Implemented

KFileItem

KFileItem is fully implemented. *** EXCEPT

SvcMimePtr determineMimeType ();

RETURNS KMimeType

SvcMimePtr mimeTypePtr ();

RETURNS KMimeType

virtual const void*  extraData (const void*) const;

NOT Implemented

KFileMetaInfo (KDE3.0+)

KFileMetaInfo is fully implemented.

KFileMetaInfo.Internal (KDE3.0beta2 only)

KFileMetaInfo::Internal is fully implemented.

*** EXCEPT

Methods inherited from KFileMetaInfo are NOT implemented - only KFileMetaInfo.Internal specific methods are available.

QMap<QString,KFileMetaInfoItem>* map ();
KFileMetaInfoMap* map () const;

RETURNS a Python dict with key:QString and value:KFileMetaInfoItem

KFileMetaInfoItem (KDE3.0+)

KFileMetaInfoItem is fully implemented.

KFileMetaInfoProvider (KDE3.0+)

KFileMetaInfoProvider is NOT implemented.

KFilePlugin

KFilePlugin is fully implemented.

*** EXCEPT

This class is ABSTRACT; all pure virtual methods must be overloaded before using

virtual bool readInfo (KFileMetaInfo::Internal& info) = 0;

PURE VIRTUAL method

KFilterBase

KFilterBase is fully implemented. *** EXCEPT

This class is ABSTRACT; all pure virtual methods must be overloaded before using

KFilterBase ();

NOT Implemented - private (KDE2.2.0+)

virtual Result compress (bool) = 0;

PURE VIRTUAL method (KDE2.2.0+)

virtual bool writeHeader (const QCString&) = 0;

PURE VIRTUAL method (KDE2.2.0+)

virtual int mode () const = 0;
void setDevice (QIODevice*, bool = 0);
virtual void init (int) = 0;

PURE VIRTUAL method (KDE2.2.0+)

void setDevice (QIODevice*, bool = 0);
virtual void init (int) = 0;

PURE VIRTUAL method (KDE2.2.0+)

virtual void init (int) = 0;

PURE VIRTUAL method (KDE2.2.0+)

virtual bool readHeader () = 0;

PURE VIRTUAL method

virtual void setOutBuffer (char*, uint) = 0;

PURE VIRTUAL method

virtual void setInBuffer (char*, uint) = 0;

PURE VIRTUAL method

virtual int inBufferAvailable () const = 0;

PURE VIRTUAL method

virtual int outBufferAvailable () const = 0;

PURE VIRTUAL method

virtual Result uncompress () = 0;

PURE VIRTUAL method

KFilterDev

KFilterDev is fully implemented.

NOTE the following typedefs:

typedef kiofilesize_t Q_LONG;
typedef kiofilesize_t Q_ULONG;

KImageIO

KImageIO is fully implemented.

KMessageBoxWrapper

KMessageBoxWrapper is fully implemented.

KMimeMagicResult

KMimeMagicResult is fully implemented.

KMimeMagic

KMimeMagic is fully implemented. *** EXCEPT

static void initStatic ();

NOT Implemented

KMimeType

KMimeType is fully implemented. *** EXCEPT

static Ptr mimeType (const QString& _name);

RETURNS a Python instance of KService

static Ptr findByURL (const KURL& _url,
     mode_t _mode = 0,
     bool _is_local_file = 0,
     bool _fast_mode = 0);

RETURNS a Python instance of KService

static void errorMissingMimeType (const QString& _type);

NOT Implemented

static void buildDefaultType ();

NOT Implemented

static void checkEssentialMimeTypes ();

NOT Implemented

KFolderType

KFolderType is fully implemented.

KDEDesktopMimeType

KDEDesktopMimeType is fully implemented. *** EXCEPT

static pid_t runFSDevice (const KURL& _url, const KSimpleConfig& cfg);

NOT Implemented

static pid_t runApplication (const KURL& _url, const QString& _serviceFile);

NOT Implemented

static pid_t runLink (const KURL& _url, const KSimpleConfig& cfg);

NOT Implemented

static pid_t runMimeType (const KURL& _url, const KSimpleConfig& cfg);

NOT Implemented

KExecMimeType

KExecMimeType is fully implemented.

KMimeTypeResolverBase

KMimeTypeResolverBase is fully implemented.

*** EXCEPT

This class is ABSTRACT; all pure virtual methods must be overloaded before using

virtual void slotProcessMimeIcons () = 0;

PURE VIRTUAL method

virtual void slotViewportAdjusted () = 0;

PURE VIRTUAL method

KMimeTypeResolverHelper

KMimeTypeResolverHelper is fully implemented.

KPAC

KPAC is fully implemented.

KProtocolInfo

KProtocolInfo is fully implemented.

KProtocolManager

KProtocolManager is fully implemented.

static int defaultConnectTimeout ();

NOT Implemented (not found in libkio)

KRun

KRun is fully implemented. *** EXCEPT

static pid_t runOldApplication (const QString& _exec, const KURL::List& _urls, bool _allow_multiple);

NOT Implemented

static pid_t run (const QString& _cmd);

NOT Implemented

static void clientStarted (const QString& name,
     const QString& iconName,
     pid_t pid,
     const QString& resName,
     bool compliant,
     int screen_number = 0);

NOT Implemented

static QString binaryName (const QString& execLine, bool removePath = 1);

NOT Implemented

static pid_t runCommandInternal (KProcess*, const QString&, const QString&, const QString&);

NOT Implemented

KOpenWithHandler

KOpenWithHandler is fully implemented.

KProcessRunner

KProcessRunner is fully implemented. *** EXCEPT

KProcessRunner (KProcess*, const QString& binName);

NOT Implemented

KOCRDialog (KDE2.2.0+)

KOCRDialog is fully implemented.

KOCRDialogFactory (KDE2.2.0+)

KOCRDialogFactory is fully implemented. *** EXCEPT

This class is ABSTRACT; all pure virtual methods must be overloaded before using

virtual KOCRDialog* createDialog (QWidget* /TransferThis/ parent = 0, const char* name = 0, bool modal = 0) = 0;

PURE VIRTUAL method

KScanDialog (KDE2.2.0+)

KScanDialog is fully implemented.

KScanDialogFactory (KDE2.2.0+)

KScanDialogFactory is fully implemented. *** EXCEPT

This class is ABSTRACT; all pure virtual methods must be overloaded before using

virtual KScanDialog* createDialog (QWidget* /Transfer/ parent = 0, const char* name = 0, bool modal = 0) = 0;

PURE VIRTUAL method

KService

KService is fully implemented. *** EXCEPT

static Ptr serviceByName (const QString& _name);

RETURNS a KService instance

static Ptr serviceByDesktopPath (const QString& _name);

RETURNS a KService instance

static Ptr serviceByDesktopName (const QString& _name);

RETURNS a KService instance

static SvcList allServices ();

RETURNS a Python list of KService instances

static SvcList allInitServices ();

RETURNS a Python list of KService instances

KServiceGroup

KServiceGroup is fully implemented.

static Ptr baseGroup (const QString& baseGroupName);

RETURNS a Python instance of KService

 static Ptr root

RETURNS a Python instance of KService

static Ptr group (const QString& relPath);

RETURNS a Python instance of KService

KServiceType

KServiceType is fully implemented. *** EXCEPT

virtual const QMap<QString,QVariant::Type>& propertyDefs ()

NOT Implemented

static Ptr serviceType (const QString& _name);

RETURNS a Python instance of KService

KShellCompletion

KShellCompletion is fully implemented.

KShred

KShred is fully implemented.

static bool shred(QString)

RENAMED staticShred

KTar

KTarBase is fully implemented. *** EXCEPT

KTarBase (QIODevice*);

NOT Implementer (not in lib)

KTarGZ

KTarGZ is fully implemented.

KTarData

KTarData is fully implemented.

KTarEntry

KTarEntry is fully implemented.

KTarFile

KTarFile is fully implemented.

KTarDirectory

KTarDirectory is fully implemented.

KTrader

KTrader is fully implemented.

The KTrader constructor is protected. Use the static KTrader *self () method to obtain an instance of KTrader

KURIFilterData

KURIFilterData is fully implemented.

KURIFilterPlugin

KURIFilterPlugin is fully implemented. *** EXCEPT

This class is ABSTRACT- all pure virtual methods must be overloaded before using

virtual bool filterURI (KURIFilterData& data) = 0;

PURE VIRTUAL method

KURIFilter

KURIFilter is fully implemented. *** EXCEPT

QListIterator<KURIFilterPlugin> pluginsIterator ();

NOT Implemented

KURIFilterPluginList

KURIFilterPluginList is fully implemented. *** EXCEPT

virtual int compareItems (Item a, Item b);

NOT Implemented

KURLCompletion

KURLCompletion is fully implemented.

KServiceOffer

KServiceOffer is fully implemented. *** EXCEPT

KServiceOffer (KService::Ptr _service, int _pref, bool _default);

RETURNS a Python instance of KService

KService::Ptr service ();

RETURNS a Python instance of KService

KServiceTypeProfile

KServiceTypeProfile is fully implemented. *** EXCEPT

static const QList<KServiceTypeProfile>& serviceTypeProfiles ()

NOT Implemented

static KService::Ptr preferredService (const QString& serviceType, bool needApp);

RETURNS a Python instance of KService

static KService::Ptr preferredService (const QString& serviceType, const QString& genericServiceType);

RETURNS a Python instance of KService

OfferList offers ();

NOT Implemented

static OfferList offers (const QString&);

NOT Implemented

static OfferList offers (const QString&, const QString&);

NOT Implemented

static const QList>KServiceTypeProfile<& serviceTypeProfiles ();

NOT Implemented

KIO.NetAccess

KIO.NetAccess is fully implemented.

static QString mimetype (const KURL&);

NOT Implemented

Observer

Observer is fully implemented. *** EXCEPT

void slotCanResume (KIO::Job*, ulong);

NOT Implemented

KIO.PasswordDialog

KIO.PasswordDialog is fully implemented. *** EXCEPT

static int getNameAndPassword (QString& user,
     QString& pass,
     bool* keep,
     const QString& prompt = QString::null,
     bool readOnly = 0,
     const QString& caption = QString::null,
     const QString& comment = QString::null,
     const QString& label  = QString::null);

TAKES QString, QString, QString, QString and RETURNS a Python tuple of (int, int)

Paste

Paste is fully implemented.

KIO::Job *KIO.pasteClipboard(const KURL&, bool = 0);
void KIO.pasteData( const KURL&, const QByteArray&);
bool KIO.isClipboardEmpty();

GLOBAL functions

PreviewJob (KDE2.2.0+)

PreviewJob is fully implemented.

ProgressBase

ProgressBase is fully implemented.

KIO.RenameDlg

KIO.RenameDlg NOT implemented *** EXCEPT

enum KIO.RenameDlg_Mode { M_OVERWRITE = 1, M_OVERWRITE_ITSELF = 2, M_SKIP = 4,
        M_SINGLE = 8, M_MULTI = 16, M_RESUME = 32, M_NORENAME = 64 };

enum KIO.RenameDlg_Result { R_RESUME = 6, R_RESUME_ALL = 7, R_OVERWRITE = 4,
        R_OVERWRITE_ALL = 5, R_SKIP = 2, R_AUTO_SKIP = 3, R_RENAME = 1, R_CANCEL = 0 };

GLOBAL enums (not class members)

RenameDlgPlugin

RenameDlgPlugin is fully implemented.

SessionData (KDE 2.2.0+)

SessionData is fully implemented.

KIO.SkipDlg

KIO.SkipDlg NOT implemented ***EXCEPT

enum SkipDlg_Result { S_SKIP = 1, S_AUTO_SKIP = 2, S_CANCEL = 0 };

GLOBAL enum (not method or class member)

KIO.Slave

KIO.Slave is fully implemented. *** EXCEPT

static KIO::Slave* createSlave (const QString&, const KURL&, int&, QString&);  (KDE2.2.0+)

TAKES a QString, KURL and QString and RETURNS a tuple (KIO.Slave, int)

static KIO::Slave* createSlave (const KURL&, int&, QString&);

TAKES a KURL and QString and RETURNS a tuple (KIO.Slave, int)

KIO.SlaveBase

KIO.SlaveBase is fully implemented.

SlaveConfig (KDE2.2.0+)

SlaveConfig is fully implemented.

KIO.SlaveInterface

KIO.SlaveInterface is fully implemented. *** EXCEPT

static void sigpipe_handler (int);

NOT Implemented

StatusbarProgress

StatusbarProgress is fully implemented.

KIO.TCPSlaveBase

KIO.TCPSlaveBase is fully implemented.

kiofilesize_t - mapped type

Mapped type - cannot be instantiated. Whenever kiofilesize_t is the return type of a function or the type of an argument, a Python long integer is used instead. Allows the equivalent of C/C+ 'long long' or 64 bit integers

KDataToolInfoVList - mapped type

Mapped type - cannot be instantiated. Whenever KDataToolInfoVList is the return type of a function or the type of an argument, a Python list of KDataToolInfo is used instead.

KActionQPtrList - mapped type

Mapped type - cannot be instantiated. Whenever KActionQPtrList is the return type of a function or the type of an argument, a Python list of KAction is used instead.

KFileItemList

This class isn't implemented. Whenever a KFileItemList is the return type of a function or the type of an argument, a Python list is returned or passed instead

KFileMetaInfoMap - mapped type

Mapped type - cannot be instantiated. Whenever a KFileMetaInfoMap is the return type of a function or the type of an argument, a Python dictionary with key: QString, value: KFileMetaInfoItem is used instead.

KStringListMap

This class isn't implemented. Whenever a KStringListMap is the return type of a function or the type of an argument, a Python dictionary with key:QString and value:QStringList is returned instead

KIO::MetaData - mapped type

Mapped type - cannot be instantiated. Whenever a KIO.MetaData is the return type of a function or the type of an argument, a Python dictionary with key: QString, value: QString is used instead.

SvcPtr - mapped type

Mapped type - cannot be instantiated. Whenever KService::Ptr is the return type of a function or the type of an argument, a Python list of KService is used instead.

SvcList - mapped type

Mapped type - cannot be instantiated. Whenever KService::List is the return type of a function or the type of an argument, a Python list of KService is used instead.

SvcOfferList - mapped type

Mapped type - cannot be instantiated. Whenever QValueList<KServiceOffer> is the return type of a function or the type of an argument, a Python list of KServiceOffer is used instead.

SvcTypeProfileList - mapped type

Mapped type - cannot be instantiated. Whenever QValueList<KServiceTypeProfile> is the return type of a function or the type of an argument, a Python list of KServiceTypeProfile is used instead.

SvcGroupPtr - mapped type

Mapped type - cannot be instantiated. Whenever KService::Ptr is the return type of a function or the type of an argument, a Python list of KServiceGroup is used instead.

SvcTypePtr - mapped type

Mapped type - cannot be instantiated. Whenever KServiceType::Ptr is the return type of a function or the type of an argument, a Python list of KServiceType is used instead.

SvcTypeList - mapped type

Mapped type - cannot be instantiated. Whenever KServiceType::List is the return type of a function or the type of an argument, a Python list of KServiceType is used instead.

SvcMimePtr - mapped type

Mapped type - cannot be instantiated. Whenever KMimeType::Ptr is the return type of a function or the type of an argument, an object of KMimeType is used instead.

SvcMimeList - mapped type

Mapped type - cannot be instantiated. Whenever KMimeType::List is the return type of a function or the type of an argument, a Python list of KMimeType is used instead.

SycocaEntryList - mapped type

Mapped type - cannot be instantiated. Whenever KServiceGroup::List is the return type of a function or the type of an argument, a Python list of KSycocaEntry is used instead.