kdecore Module Reference

Display - mapped type

Mapped type - cannot be instantiated. Whenever a Display is the return type of a function, None is returned. When Display is the type of an argument,this code sends the result of qt_xdisplay () to the Qt lib function being called. (NOTE: Display may be treated differently in PyQt - future versions of PyKDE2 may sync to the PyQt usage)

IntValueList - mapped type

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

KAboutPerson

KAboutPerson is fully implemented. *** EXCEPT

KAboutPerson ();

NOT Implemented

KAboutTranslator

KAboutTranslator is fully implemented.

KAboutData

KAboutData is fully implemented. *** EXCEPT

const QValueList<KAboutPerson> authors ();

RETURNS a Python list

const QValueList<KAboutPerson> credits ();

RETURNS a Python list

const QValueList<KAboutTranslator> translators ();

RETURNS a Python list

KAccel

KAccel is fully implemented.

KKeyEntry

KAccel is fully implemented.

KZoneAllocator

KZoneAllocator is fully implemented.

KApplication

KApplication is fully implemented. *** EXCEPT

KApplication (int& argc,
     char** argv,
     const QCString& rAppName,
     bool allowStyles = 1,
     bool GUIenabled = 1);

TAKES a Python list (which is modified) and QCString, bool, bool

static int  startServiceByName (const QString& _name,
     const QString& URL,
     QString* error = 0,
     QCString* dcopService = 0,
     int* pid  = 0);

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

static int startServiceByName (const QString& _name,
      const QStringList& URLs = QStringList(),
      QString* error = 0,
      QCString* dcopService = 0,
      int* pid = 0);

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

static int startServiceByDesktopPath (const QString& _name,
     const QString& URL,
     QString* error = 0,
     QCString* dcopService = 0,
     int* pid = 0);

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

static int  startServiceByDesktopPath (const QString& _name,
     const QStringList& URLs = QStringList(),
     QString* error = 0,
     QCString* dcopService = 0,
     int* pid = 0);

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

static int  startServiceByDesktopName (const QString& _name,
     const QString& URL,
     QString* error = 0,
     QCString* dcopService = 0,
     int*  pid = 0);

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

static int  startServiceByDesktopName (const QString& _name,
     const QStringList& URLs = QStringList(),
     QString*  error = 0,
     QCString* dcopService = 0,
     int* pid = 0);

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

static int  kdeinitExec (const QString& name,
     const QStringList& args = QStringList(),
     QString* error = 0,
     int* pid = 0);

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

static int  kdeinitExecWait (const QString& name,
     const QStringList& args = QStringList(),
     QString* error = 0,
     int* pid = 0);

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

QString  checkRecoverFile (const QString& pFilename, bool& bRecover);

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

KApplication (Display*  display,
     int& argc,
     char** argv,
     const QCString& rAppName,
     bool allowStyles = 1,
     bool GUIenabled = 1);

NOT Implemented

Display*  getDisplay ();

NOT Implemented

void  iceIOErrorHandler (_IceConn* conn);

NOT Implemented

bool  x11EventFilter (XEvent*);

NOT Implemented

KApplication (const KApplication&);

NOT Implemented

KApplication *kapp;

GLOBAL variable

KSessionManaged

KSessionManaged is fully implemented.

KAudioPlayer

KAudioPlayer is fully implemented.

slot play () RENAMED to playSlot ()

KCharsets

KCharset is fully implemented.

QTextCodec *codecForName (const QString &, bool &) const

TAKES a single parameter and RETURNS a Python tuple

QChar fromEntity (const QString &, int &) const

TAKES a single parameter and RETURNS a Python tuple

QList <QFont::CharSet> availableCharsets (QString = QString::null);

RETURNS a Python list

KCmdLineArgs

KCmdLineArgs is fully implemented. *** EXCEPT

static void init (int _argc,
     char** _argv,
     const char* _appname,
     const char* _description,
     const char* _version,
     bool noKApp = 0);

TAKES a Python list as the second (char **) parameter

static void init (int _argc,
     char** _argv,
     const KAboutData* about,
     bool noKApp = 0);

TAKES a Python list as the second (char **) parameter; RENAMED init1

static void addCmdLineOptions (const _KCmdLineOptions*,
     const char* = 0,
     const char* = 0,
     const char* = 0);

TAKES a Pytbon list of tuples (name, description, default) as the first parameter; NULL parameters to mark end of list are not required

QCStringList getOptionList (const char* option);

RETURNS a Python list

KCompletion

KCompletion is fully implemented.

KCompletionBase

KCompletionBase is fully implemented.

KeyBindingMap getKeyBindingMap ()

RETURNS a Python dictionary

KConfig

KConfig is fully implemented. *** EXCEPT

KConfig (const KConfig&);

NOT Implemented

KEntryKey

KEntry is fully implemented.

KConfigBackEnd

KConfigBackEnd is fully implemented. This class is ABSTRACT; all pure virtual methods must be overloaded before using

*** EXCEPT

virtual bool parseConfigFiles () = 0;

PURE VIRTUAL method

virtual void sync (bool bMerge = 1) = 0;

PURE VIRTUAL method

KConfigINIBackEnd

KConfigINIBackEnd is fully implemented.

KConfigBase

KConfigBase is fully implemented. *** EXCEPT

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

virtual bool hasGroup (const QString& _pGroup) = 0;

PURE VIRTUAL method

virtual QStringList groupList () = 0;

PURE VIRTUAL method

IntValueList readIntListEntry (const QString& pKey);

RETURNS a Python list

IntValueList readIntListEntry (const char* pKey);

RETURNS a Python list

void writeEntry (const QString& pKey,
     const IntValueList& rValue,
     bool bPersistent = 1,
     bool bGlobal = 0,
     bool bNLS = 0);

TAKES a Python list as the second parameter

virtual bool hasKey (const QString& pKey) = 0;

PURE VIRTUAL method

virtual KStringMap entryMap (const QString&) = 0;

PURE VIRTUAL method

virtual void reparseConfiguration () = 0;

PURE VIRTUAL method

virtual bool hasGroup (const QCString& _pGroup) = 0;

PURE VIRTUAL method

virtual bool hasGroup (const char* _pGroup) = 0;

PURE VIRTUAL method

virtual bool hasKey (const char* pKey) = 0;

PURE VIRTUAL method

void writeEntry (const char* pKey,
     const QValueList<int>& rValue,
     bool bPersistent = 1,
     bool bGlobal = 0,
     bool bNLS = 0);

NOT Implemented

QString writeEntry (const char* pKey,
     const char* pValue,
     bool bPersistent = 1,
     bool bGlobal = 0,
     bool bNLS = 0);

NOT Implemented

QString writeEntry (const QString& pKey,
     int nValue,
     bool bPersistent = 1,
     bool bGlobal = 0,
     bool bNLS = 0);

NOT Implemented

QString writeEntry (const char* pKey,
     int nValue,
     bool bPersistent = 1,
     bool bGlobal = 0,
     bool bNLS = 0);

NOT Implemented

QString writeEntry (const char* pKey,
     uint nValue,
     bool bPersistent = 1,
     bool bGlobal = 0,
     bool bNLS = 0);

NOT Implemented

QString writeEntry (const QString& pKey,
     long nValue,
     bool bPersistent = 1,
     bool bGlobal = 0,
     bool bNLS = 0);

NOT Implemented

QString writeEntry (const char* pKey,
     long nValue,
     bool bPersistent = 1,
     bool bGlobal = 0,
     bool bNLS = 0);

NOT Implemented

QString writeEntry (const QString& pKey,
     ulong nValue,
     bool bPersistent = 1,
     bool bGlobal = 0,
     bool bNLS = 0);

NOT Implemented

QString writeEntry (const char* pKey,
     ulong nValue,
     bool bPersistent = 1,
     bool bGlobal = 0,
     bool bNLS = 0);

NOT Implemented

QString writeEntry (const char* pKey,
     double nValue,
     bool bPersistent = 1,
     bool bGlobal = 0,
     char format = 'g',
     int precision = 6,
     bool bNLS = 0);

NOT Implemented

QString writeEntry (const QString& pKey,
     bool bValue,
     bool bPersistent = 1,
     bool bGlobal = 0,
     bool bNLS = 0);

NOT Implemented

QString writeEntry (const char* pKey,
     bool bValue,
     bool bPersistent = 1,
     bool bGlobal = 0,
     bool bNLS = 0);

NOT Implemented

QString writeEntry (const char* pKey,
     const QFont& rFont,
     bool bPersistent = 1,
     bool bGlobal = 0,
     bool bNLS = 0);

NOT Implemented

void writeEntry (const char* pKey,
     const QColor& rColor,
     bool bPersistent = 1,
     bool bGlobal = 0,
     bool bNLS = 0);

NOT Implemented

void writeEntry (const char* pKey,
     const QDateTime& rDateTime,
     bool bPersistent = 1,
     bool bGlobal = 0,
     bool bNLS = 0);

NOT Implemented

void writeEntry (const char* pKey,
     const QRect& rValue
     bool bPersistent = 1,
     bool bGlobal = 0,
     bool bNLS = 0);

NOT Implemented

void writeEntry (const char* pKey,
     const QPoint& rValue,
     bool bPersistent = 1,
     bool bGlobal = 0,
     bool bNLS = 0);

NOT Implemented

void writeEntry (const char* pKey,
     const QSize& rValue,
     bool bPersistent = 1,
     bool bGlobal = 0,
     bool bNLS = 0);

NOT Implemented

virtual KEntryMap internalEntryMap (const QString& pGroup) = 0;

PURE VIRTUAL method

virtual KEntryMap internalEntryMap () = 0;

PURE VIRTUAL method

virtual void putData (const KEntryKey& _key, const KEntry& _data) = 0;

PURE VIRTUAL method

virtual KEntry lookupData (const KEntryKey& _key) = 0;

PURE VIRTUAL method

KConfigGroupSaver

KConfigGroupSaver is fully implemented.

KCrash

KCrash is fully implemented. *** EXCEPT

static void setCrashHandler (HandlerType handler  = defaultCrashHandler);

NOT Implemented

static HandlerType crashHandler ();

NOT Implemented

static void setEmergencySave (HandlerType save = 0);

NOT Implemented

static HandlerType emergencySave ();  

NOT Implemented

KDCOPPropertyProxy

KDCOPPropertyProxy is fully implemented.

QValueList<QCString> functions();

RETURNS a Python list

static QValueList<QCString> functions(QObject *object)

RENAMED functionsObj and RETURNS a Python list

static bool isPropertyRequest (const QCString &, QObject *)

REANMED isPropRequest

static bool processPropertyRequest (const QCString &,
     const QByteArray &,
     QCString &,QByteArray &,
     QObject *)

RENAMED procPropRequest

KDesktopFile

KDesktopFile is fully implemented. *** EXCEPT

KDesktopFile (const KDesktopFile&);

NOT Implemented

KDEAniMenu

KDEAniMenu is fully implemented.

KDEStyle

KDEStyle is fully implemented. *** EXCEPT

void scrollBarMetrics (const QScrollBar* sb,
     int& sliderMin,
     int& sliderMax,
     int& sliderLength,
     int& buttonDim);

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

void tabbarMetrics (const QTabBar* t,
     int& hFrame,
     int& vFrame,
     int& overlap);

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

void drawKMenuItem (QPainter* p,
     int x,
     int y,
     int w,
     int h,
     const QColorGroup& g,
     bool active,
     QMenuItem* item,
     QBrush* fill  = NULL);

NOT Implemented

void drawPopupMenuItem (QPainter* p,
     bool checkable,
     int maxpmw,
     int tab,
     QMenuItem* mi,
     const QPalette& pal,
     bool act,
     bool enabled,
     int x,
     int y,
     int w,
     int h);

NOT Implemented

int popupMenuItemHeight (bool c, QMenuItem* mi, const QFontMetrics& fm);

NOT Implemented

KEntry - mapped type

Mapped type - cannot be instantiated. Whenever a KEntry is the return type of a function or the type of an argument, a Python tuple (QCString, int, int, int) is used instead. (may be converted to class in future version of PyKDE2)

KEntryMap - mapped type

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

KeyBindingMap - mapped type

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

KGlobal

KGlobal is fully implemented. *** EXCEPT

The following are internal variables - use methods instead (for example KInstance *instance (); )

static KStringDict*        _stringDict;
static KInstance*          _instance;
static KLocale*            _locale;
static KCharsets*          _charsets;
static KStaticDeleterList* _staticDeleters;
static KInstance*          _activeInstance;

NOT Implemented

KGlobalAccel

KGlobalAccel is fully implemented. *** EXCEPT

bool x11EventFilter (const XEvent*);

NOT Implemented

KGlobalSettings

KGlobalSettings is fully implemented. *** EXCEPT

static KMouseSettings& mouseSettings ();

RETURNS an int

KIconEffect

KIconEffect is fully implemented.

KIconLoader

KIconLoader is fully implemented.

KInstance

KInstance is fully implemented.

KIPC

KIPC is fully implemented.

KKeyEntryMap - mapped type

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

KLibFactory

KLibFactory is fully implemented.

KLibrary

KLibrary is fully implemented.

KLibLoader

KLibLoader is fully implemented.

KLocale

KLocale is fully implemented. *** EXCEPT

double readMoney (const QString& numStr, bool* ok  = 0);

TAKES a QString and RETURNS a Python tuple of (double, bool)

double readNumber (const QString& numStr, bool* ok  = 0);

TAKES a QString and RETURNS a Python tuple of (double, bool)

KLocale (const KLocale&);

NOT Implemented

QString i18n(const char *);

GLOBAL function (not class method) available

QString i18n(const char *, const char *);

GLOBAL function (not class method) available

KMimeSourceFactory

KMimeSourceFactory is fully implemented.

Instance

Instance is fully implemented.

KPalette

KPalette is fully implemented.

KPixmap

KPixmap is fully implemented

KPixmapProvider

KPixmapProvider is fully implemented.

KPixmapSplitter

KPixmapSplitter is fully implemented.

KProcess

KProcess is fully implemented. *** EXCEPT

KProcess (const KProcess&);

NOT Implemented

void receivedStdout (int, int&);

NOT Implemented

KShellProcess

KShellProcess is fully implemented. *** EXCEPT

KShellProcess (const KShellProcess&);

NOT Implemented

KRandomSequence

KRandomSequence is fully implemented. *** EXCEPT

void randomize (QGList* list);

NOT Implemented

KRegExp

KRegExp is fully implemented.

KRFCDate

KRFCDate is fully implemented.

KRootProp

KRootProp is fully implemented.

KSaveFile

KSaveFile is fully implemented. *** EXCEPT

FILE* fstream ();  

NOT Implemented

KShared

KShared is fully implemented.

KSimpleConfig

KSimpleConfig is fully implemented. *** EXCEPT

KSimpleConfig (const KSimpleConfig&);

NOT Implemented

KSocket

KSocket is fully implemented. *** EXCEPT

KSocket (const KSocket&);

NOT Implemented

KServerSocket

KServerSocket is fully implemented. *** EXCEPT

KServerSocket (const KServerSocket&);

NOT Implemented

KStaticDeleterBase

KStaticDeleterBase is fully implemented. *** EXCEPT

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

virtual void destructObject () = 0;

PURE VIRTUAL method

KStdAccel

KStdAccel is fully implemented.

KStandardDirs

KStandardDirs is fully implemented.

QString locate(const char *, const QString&, const KInstance* = KGlobal::instance());

GLOBAL function (not class method)

QString locateLocal(const char *, const QString&, const KInstance* = KGlobal::instance());

GLOBAL function (not class method)

KStringHandler

KStringHandler is fully implemented. *** EXCEPT

static QString word ( const QString & text , const char *range);

RENAMED words

static QString remword (const QString & text , const QString & word);

RENAMED remwordmatch

static QStringList capwords (const QStringList & list);

RENAMED capwordlist

static QStringList perlSplit (const QString & sep, const QString & s, uint max = 0);

NOT Implemented

static QStringList perlSplit (const QChar & sep, const QString & s, uint max = 0);

NOT Implemented

static QStringList perlSplit (const QRegExp & sep, const QString & s, uint max = 0);

NOT Implemented

KStringMap

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

KStyle

KStyle is fully implemented. *** EXCEPT

virtual void drawKMenuItem (QPainter* p,
     int x,
     int y,
     int w,
     int h,
     const QColorGroup& g,
     bool active,
     QMenuItem* item,
     QBrush* fill  = NULL);

NOT Implemented

KTempFile

KTempFile is fully implemented. *** EXCEPT

FILE* fstream ();  

NOT Implemented

KUniqueApplication

KUniqueApplication is fully implemented.

KURL

KURL is fully implemented.

KURLDrag

KURLDrag is fully implemented.

KWin

KWin is fully implemented.

KWin.Info

KWin.Info is fully implemented.

KWinModule

KWinModule is fully implemented.

const UIntValueLis& windows ()
const UIntValueList& stackingOrder ()
const UIntValueList& systemTrayWindows ()

all RETURN a Python list of int (WId is typedef'd from uint)

QRect workArea (const UIntValueList&, int = -1) const;

TAKES a Python list of int as the first parameter

NETIcon - mapped type

Mapped type - cannot be instantiated. Whenever NETIcon is the return type of a function or the type of an argument, a Python tuple (NETSize, Python string) is used instead. (may be converted to class in future version of PyKDE2)

NETRootInfo

NETRootInfo is fully implemented. *** EXCEPT

NETRootInfo (Display* display,
     Window supportWindow,
     const char* wmName,
     ulong properties,
     int screen = -1,
     bool doActivate = 1);

Use 0 for first parameter; use only after kapp intialized.

NETRootInfo (Display* display,
    ulong properties,
    int screen = -1,
    bool doActivate = 1);

Use 0 for first parameter; use only after kapp intialized.

const Window* clientList ();

RETURNS a Python list

const Window* clientListStacking ();

RETURNS a Python list

const Window* kdeSystemTrayWindows ();

RETURNS a Python list

const Window* virtualRoots ();

RETURNS a Python list

void setClientList (Window* windows, uint count);

TAKES a Python list as its ONLY argument

void setClientListStacking (Window* windows, uint count);

TAKES a Python list as its ONLY argument

void setKDESystemTrayWindows (Window* windows, uint count);

TAKES a Python list as its ONLY argument

void setVirtualRoots (Window* windows, uint count);

TAKES a Python list as its ONLY argument

ulong event (XEvent* event);

NOT Implemented

NETWinInfo

NETWinInfo is fully implemented. *** EXCEPT

NETWinInfo (Display* display,
     Window window,
     Window rootWindow,
     ulong properties,
     Role role = Client);

Use 0 for first parameter; use only after kapp intialized.

ulong event (XEvent* event);

NOT Implemented

NET

NET is fully implemented.

NETPoint

NETPoint is fully implemented.

NETSize

NETSize is fully implemented.

NETRect

NETRect is fully implemented.

NETStrut

NETStrut is fully implemented.

UIntValueList - mapped type

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