kdeui Module Reference

KAboutApplication

KAboutApplication is fully implemented.

KAboutDialog

KAboutDialog is fully implemented.

KAboutContainer

KAboutDialog is fully implemented.

KAboutWidget

KAboutDialog is fully implemented.

KAboutContributor

KAboutDialog is fully implemented.

KAboutKDE

KAboutKDE is fully implemented.

KAction

KAction is fully implemented.

KToggleAction

KToggleAction is fully implemented.

KRadioAction

KRadioAction is fully implemented.

KSelectAction

KSelectAction is fully implemented.

KListAction

KListAction is fully implemented.

KRecentFilesAction

KRecentFilesAction is fully implemented.

KFontAction

KFontAction is fully implemented.

KFontSizeAction

KFontSizeAction is fully implemented.

KActionMenu

KActionMenu is fully implemented.

KToolBarPopupAction

KAction is fully implemented.

KActionSeparator

KActionSeparator is fully implemented.

KActionCollection

KActionCollection is fully implemented.

virtual KActionVList actions(const QString&) const; (KDE2.1.1-KDE2.2.2)
virtual KActionPtrList actions (const QString&) const; (KDE3.0.0)

RETURNS a Python list of KAction

virtual KActionVList actions() const; (KDE2.1.1-KDE2.2.2)
virtual KActionPtrList actions () const; (KDE3.0.0)

RETURNS a Python list of KAction

KActionPtrShortcutList

KActionPtrShortcutList is fully implemented.

KActionPtrShortcutList (KActionPtrList&);

TAKES a Python list of KAction

KActionShortcutList

KActionShortcutList is fully implemented.

KActiveLabel (KDE3.0+)

KActiveLabel is fully implemented.

KAnimWidget

KAnimWidget is fully implemented. *** EXCEPT

KAnimWidget (QWidget* /TransferThis/ = 0, const char* = 0);

NOT Implemented

KArrowButton (KDE2.2.0+)

KArrowButton is fully implemented.

KAuthIcon

KAuthIcon is fully implemented.

KRootPermsIcon

KRootPermsIcon is fully implemented.

KWritePermsIcon

KWritePermsIcon is fully implemented.

KBugReport

KBugReport is fully implemented.

KButtonBox

KButtonBox is fully implemented.

KCharSelectTable

KCharSelectTable is fully implemented.

KCharSelect

KCharSelect is fully implemented. *** EXCEPT

static void cleanupFontDatabase ();

NOT Implemented

KContextMenuManager

KContextMenuManager is fully implemented.

KCModule

KCModule is fully implemented.

KColorButton

KColorButton is fully implemented.

KColorCombo

KColorCombo is fully implemented.

KColorDialog

KColorDialog is fully implemented.

KHSSelector

KHSSelector is fully implemented.

KValueSelector

KValueSelector is fully implemented.

KColor

KColor is fully implemented.

void rgb(int *, int *, int *);

TAKES no arguments and RETURNS a tuple (int, int, int)

void hsv(int *, int *, int *);

TAKES no arguments and RETURNS a tuple (int, int, int)

KPaletteTable

KPaletteTable is fully implemented.

KColorCells

KColorCells is fully implemented.

KColorPatch

KColorPatch is fully implemented.

KColorDrag

KColorDrag is fully implemented.

KComboBox

KComboBox is fully implemented.

KHistoryCombo

KHistoryCombo is fully implemented.

KCommand

KCommand is fully implemented.

KMacroCommand

KMacroCommand is fully implemented.

KCommandHistory

KCommandHistory is fully implemented.

KNamedCommand

KNamedCommand is fully implemented.

KCompletionBox

KCompletionBox is fully implemented.

KCursor

KCursor is fully implemented.

KDatePicker

KDatePicker is fully implemented.

KDateTable

KDateTable is fully implemented.

KDateInternalMonthPicker

KDateInternalMonthPicker is fully implemented.

KDateInternalYearSelector

KDateInternalYearSelector is fully implemented.

KPopupFrame

KPopupFrame is fully implemented.

KDateValidator

KDateValidator is fully implemented.

KDateWidget

KDateWidget is fully implemented.

KDCOPActionProxy

KDCOPActionProxy is fully implemented.

*** EXCEPT

virtual QValueList<KAction *> actions() const;

RETURNS a Python list of KAction

KDialog

KDialog is fully implemented.

KDialogQueue (KDE 2.2.0+)

KDialogQueue is fully implemented. *** EXCEPT

static KDialogQueue* self ();

NOT Implemented

KDialogBase

KDialogBase is fully implemented.

KDialogBaseTile (KDE3.0+)

KDialogBase is fully implemented.

KDockWidgetAbstractHeader

KDockWidgetAbstractHeader is fully implemented.

KDockWidgetAbstractHeaderDrag

KDockWidgetAbstractHeaderDrag is fully implemented.

KDockWidgetHeaderDrag

KDockWidgetHeaderDrag is fully implemented.

KDockWidgetHeader

KDockWidgetHeader is fully implemented.

KDockTabGroup

KDockTabGroup is fully implemented.

KDockWidget

KDockWidget is fully implemented.

KDockManager

KDockManager is fully implemented.

KDockMainWindow

KDockMainWindow is fully implemented.

KDockArea (KDE2.2.0+)

KDockMainWindow is fully implemented.

KDockWindow

KDockWindow is fully implemented.

KDualColorButton

KDualColorButton is fully implemented.

KEdGotoLine

KEdGotoLine is fully implemented.

KEdFind

KEdFind is fully implemented.

KEdReplace

KEdReplace is fully implemented.

KEdit

KEdit is fully implemented. *** EXCEPT

void posToRowCol (uint pos, uint& line, uint& col);

TAKES a uint and RETURNS a Python tuple of (uint, uint)

KEditListBox

KEditListBox is fully implemented.

void insertStrList(const char **, int = -1, int = -1);

TAKES a Python list and a single int (index)

KEditToolbar

KEditToolbar is fully implemented.

KEditToolbarWidget

KEditToolbarWidget is fully implemented.

KFontCombo (KDE2.2.0+)

KFontCombo is fully implemented.

KFontDialog

KFontDialog is fully implemented.

KFontDialog (QWidget* /TransferThis/ = 0, const char* = 0, bool = 0, bool = 0, const QStringList& = QStringList(), bool = 1, bool = 0, QButton::ToggleState* = 0);

If the final parameter is used, it should be -1 to disable the checkbox, or a QButton.ToggleState value

KFontChooser

KFontChooser is fully implemented.

KFontDialog (QWidget* /TransferThis/ = 0, const char* = 0, bool = 0, bool = 0, const QStringList& = QStringList(), bool = 1, bool = 0, QButton::ToggleState* = 0);

If the final parameter is used, it should be -1 to disable the checkbox, or a QButton.ToggleState value

static int getFont (QFont&, bool = 0, QWidget* = 0, bool = 1, QButton::ToggleState* = 0);

TAKES an int, QWidget, int and int, and RETURNS a Python tuple of (int, QFont) If the final parameter is used, it should be -1 to disable the checkbox, or a QButton.ToggleState value

static int getFontAndText (QFont&, QString&, bool = 0, QWidget* = 0, bool = 1, QButton::ToggleState* = 0);

TAKES a QString, int, QWidget, int, and int and RETURNS a Python tuple of (int, QFont) If the final parameter is used, it should be -1 to disable the checkbox, or a QButton.ToggleState value

static int getFontDiff (QFont&, int&, bool = 0, QWidget* = 0, bool = 1, QButton::ToggleState* = 0);

TAKES an int, QWidget, int and int and RETURNS a Python tuple of (int, QFont, int) If the final parameter is used, it should be -1 to disable the checkbox, or a QButton.ToggleState value

KGuiItem (KDE3.0+)

KGuiItem is fully implemented.

KHelpMenu

KHelpMenu is fully implemented.

KIconView

KIconView is fully implemented.

KIconViewItem (KDE3.0+)

KIconViewItem is fully implemented.

KJanusWidget

KJanusWidget is fully implemented.

KJanusWidget.IconListBox

KJanusWidget.IconListBox is NOT implemented (private member class).

KKeyButton

KKeyButton is fully implemented.

KKeyDialog

KKeyDialog is fully implemented.

KKeyChooser

KKeyChooser is fully implemented. *** EXCEPT

IntDict globalDict ();

RETURNS a Python dictionary with key:QString and value:int

IntDict stdDict ();

RETURNS a Python dictionary with key:QString and value:int

void readKeysInternal (QDict<int> *, const QString&);

NOT Implemented - Internal

KLed

KLed is fully implemented.

NOTE: classRef doc does not show most methods - see KLed.h for complete list of available methods

KLed(const QColor &, QWidget */TransferThis/ = 0, const char * = 0);

NOTE: no default value for first argument in Python

KLineEdit

KLineEdit is fully implemented.

KLineEditDlg

KLineEditDlg is fully implemented.

static QString getText(const QString &, const QString&, bool *, QWidget *);

RETURNS a tuple (QString, int) (the int is the bool * argument)

static QString getText (const QString&, const QString&, bool*, QWidget*, QValidator* = 0);

RETURNS a tuple (QString, int) (the int is the bool * argument)

static QString getText (const QString&, const QString&, const QString& = QString::null, bool* = 0, QWidget* = 0, QValidator* = 0);

RETURNS a tuple (QString, int) (the int is the bool * argument)

KListBox

KListBox is fully implemented.

KListView

KListView is fully implemented.

KLVItemList selectedItems() const;

RETURNS a Python list of QListViewItem

void moved(KLVItemList, KLVItemList, KLVItemList);

signal - PASSES 3 Python lists of QListViewItem to slot

void findDrop(const QPoint &, QListViewItem *&, QListViewItem *&);

TAKES a QPoint and RETURNS a tuple (QListViewItem, QListViewItem)

KListViewItem (KDE2.2.0+)

KListView is fully implemented.

KListViewLineEdit

KListViewLineEdit is fully implemented.

KMainWindow

KMainWindow is fully implemented. *** EXCEPT

QListIterator<KToolBar> toolBarIterator ();

NOT Implemented

KMainWindowList* memberList;

RETURNS a Python list of KMainWindow (variable)

KMainWindowInterface (KDE3.0+)

KMainWindowInterface is fully implemented.

*** EXCEPT

QMap<QCString,DCOPRef> actionMap ();
KActionMap actionMap ();

RETURNS a Python dict with key:QCString, value:DCOPRef

QCStringList         actions ();

RETURNS a Python list of QCString

QCStringList functionsDynamic ();

RETURNS a Python list of QCString

KMenuBar

KMenuBar is fully implemented.

KMessageBox.sip

KMessageBox.sip is fully implemented.

KNumInput

KNumInput is fully implemented. *** EXCEPT

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

virtual void doLayout () = 0;

PURE VIRTUAL method

KIntNumInput

KIntNumInput is fully implemented.

KDoubleNumInput

KDoubleNumInput is fully implemented.

KIntSpinBox

KIntSpinBox is fully implemented. *** EXCEPT

virtual int mapTextToValue (bool*)

NOT Implemented

KIntValidator

KIntValidator is fully implemented.

virtual State validate (QString&, int&) const;

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

KFloatValidator

KFloatValidator is fully implemented.

virtual State validate (QString&, int&) const;

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

KPanelApplet

KPanelApplet is fully implemented.

KPanelAppMenu (KDE3.0+)

KPanelAppMenu is fully implemented.

KPanelExtension

KPanelExtension is fully implemented.

KPanelMenu

KPanelMenu is fully implemented.

KPasswordDialog

KPasswordDialog is fully implemented.

static int getPassword(QCString &, QString, int * = 0);

TAKES a QString and an int (keep chkbox enable) and RETURNS a tuple of the password (QCString), result code, and the keep status

static int getNewPassword(QCString &, QString);

TAKES a QString and RETURNS a tuple (int, QString) of the new password (QCString), and result code

KPasswordEdit

KPasswordEdit is fully implemented. *** EXCEPT

static const int PassLen = 100;

NOT Implemented

KPixmapIO

KPixmapIO is fully implemented.

KPopupMenu

KPopupMenu is fully implemented.

KPopupTitle

KPopupTitle is fully implemented.

KProgress

KProgress is fully implemented.

KProgressDialog (KDE3.0+)

KProgress is fully implemented.

KButton

KButton is fully implemented.

KRestrictedLine

KRestrictedLine is fully implemented.

KRootPixmap

KRootPixmap is fully implemented. *** EXCEPT

virtual void updateBackground (KSharedPixmap*);

NOT Implemented

KRuler

KRuler is fully implemented.

KSelector

KSelector is fully implemented.

KXYSelector

KXYSelector is fully implemented.

KGradientSelector

KGradientSelector is fully implemented.

KSeparator

KSeparator is fully implemented.

KSharedPixmap

KSharedPixmap is fully implemented. *** EXCEPT

bool x11Event (XEvent*);

NOT Implemented

KSqueezedTextLabel

KSqueezedTextLabel is fully implemented.

KStatusBar

KStatusBar is fully implemented.

KStatusBarLabel

KStatusBarLabel is fully implemented.

KStdAction - class (KDE 2.1.1 - KDE 2.2.2)

KStdAction is fully implemented.

KStdAction - namespace (KDE3.0+)

KStdAction namespace is fully implemented.

See classref for KDE3.0 for list of functions included in the KStdAction namespace

In KDE3, the KStdAction functions are global functions declared within the 'KStdAction' namespace, and are accessed as:

action = KStdAction.create (id, parent, self.slotName, actionName)

Note also that the C++ arguments:

        const QObject *recvr, const char *slot

        or

        SIP_RXOBJ_CON, SIP_SLOT_CON()

are replaced by a single slot reference (self.slotName in the example)

KDE 2.1.1 - KDE 2.2.2:
  static KAction*  print (SIP_RXOBJ_CON, SIP_SLOT_CON(), QObject* = 0, const char* = 0);
KDE 3.0.0+
  KAction* print(SIP_RXOBJ_CON, SIP_SLOT_CON(), KActionCollection*, const char* = 0);

RENAMED printAction in PyKDE ('print' is a reserved word in Python)

KStdGuiItem (KDE3.0+)

KStdGuiItem is fully implemented.

static QPair<KGuiItem,KGuiItem> backAndForward ();

RETURNS a Python tuple (KGuiItem, KGuiItem)

KMimeTypeValidator (KDE3.0+)

KMimeTypeValidator is fully implemented.

*** EXCEPT

virtual State validate (QString& input, int& pos);

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

KStringListValidator (KDE3.0+)

KStringListValidator is fully implemented.

*** EXCEPT

virtual State validate (QString& input, int& pos);

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

KSystemTray

KSystemTray is fully implemented.

KTabCtl

KTabCtl is fully implemented.

KTextBrowser

KTextBrowser is fully implemented.

KTipDatabase (KDE2.2.0 +)

KTipDatabase is fully implemented.

KTipDialog (KDE2.2.0 +)

KTipDialog is fully implemented.

KToolBarSeparator

KToolBarSeparator is fully implemented.

KToolBar

KToolBar is fully implemented.

KToolBarButton

KToolBarButton is fully implemented.

KToolBarButtonList

KToolBarButtonList is NOT implemented.

KToolBarRadioGroup

KToolBarRadioGroup is fully implemented.

KURLLabel

KURLLabel is fully implemented.

KWindowListMenu

KWindowListMenu is fully implemented.

KWizard

KWizard is fully implemented.

KWordWrap (KDE3.0+)

KWordWrap is fully implemented.

KXMLGUI

KXMLGUI is fully implemented.

KXMLGUIClientList clients() const;

RETURNS a Python list

void plugActionList(KXMLGUIClient *, const QString &, const KActionList&actionList);

TAKES a Python list for the third argument

KWidgetList containers(const QString&tagName);

RETURNS a Python list

KXMLGUIBuilder

KXMLGUIBuilder is fully implemented. *** EXCEPT

virtual QWidget* createContainer (QWidget* parent,
     int index,
     const QDomElement& element,
     int& id);

NOT Implemented

KXMLGUIClient

KXMLGUIClient is fully implemented.

void plugActionList(const QString &, const KActionList& actionList); takes a Python list of KAction

const KXMLGUIClientList *childClients(); returns a Python list of KXMLGUIClient

KXMLGUIClient.StateChange

KXMLGUIClient.StateChange is fully implemented.

KXMLGUIClient.DocStruct

KXMLGUIClient.DocStruct is NOT implemented.

KXMLGUIFactory

KXMLGUIFactory is fully implemented.

*** EXCEPT

KXMLGUIClientList clients() const;

RETURNS a Python list

KWidgetList containers(const QString&tagName);

RETURNS a Python list

void plugActionList(KXMLGUIClient *, const QString &, const KActionList&actionList);

TAKES a Python list for the third argument

QXEmbed

QXEmbed is fully implemented. *** EXCEPT

static bool processClientCmdline (QWidget* client, int& argc, char** argv);

TAKES a QWidget and a Python list and returns a Python tuple of (int, int)

bool x11Event (XEvent*);

NOT Implemented

IntDict - mapped type

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

KAccelMenu

KAccelMenu is fully implemented.

KActionMap - mapped type

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

KActionVList - mapped type

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

KAlphaPainter

KAlphaPainter is fully implemented.

static bool draw(QPainter *p,
     const QImage & icon,
     QImage & amp background,
     int x,
     int y,
     bool copyOnBg = 0,
     int bgx = 0,
     int bgy = 0);

RENAMED draw0

static bool draw(QPainter *p,
     const QImage & icon,
     const QPixmap & background,
     int x,
     int y,
     bool copyOnBg = 0,
     int bgx = 0,
     int bgy = 0);

RENAMED draw1

static bool draw(QPainter *p,
     const QPixmap & icon,
     QImage & background,
     int x,
     int y,
     bool copyOnBg = 0,
     int bgx = 0,
     int bgy = 0);

RENAMED draw2

static bool draw(QPainter *p,
     const QPixmap & icon,
     const QPixmap & background,
     int x,
     int y,
     int bgx = 0,
     int bgy = 0);

RENAMED draw3

KContainerLayout

KContainerLayout is fully implemented.

KContainerLayout.KContainerLayoutItem

KContainerLayout.KContainerLayoutItem is NOT implemented.

KDirectionButton

KDirectionButton is fully implemented.

KTabButton

KTabButton is fully implemented.

KDockTabBar

KDockTabBar is fully implemented.

KDockTabBarPainter

KDockTabBarPainter is fully implemented.

KDockTabCtl

KDockTabCtl is fully implemented.

*** EXCEPT

_KDockTabCtl_PrivateStruct* findData (QWidget*);

RETURNS a Python tuple

_KDockTabCtl_PrivateStruct* findData (int);

RETURNS a Python tuple

KLVItemList - mapped type

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

KMainWindowList

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

KThemePixmap ( <= KDE2.2.2 )

KThemePixmap is fully implemented.

KThemeCache ( <= KDE2.2.2 )

KThemeCache is fully implemented.

KThemeBase ( <= KDE2.2.2 )

KThemeBase is fully implemented. *** EXCEPT

void readWidgetConfig (int i,
     KConfig* config,
     QString* pixnames,
     QString* brdnames,
     bool* loadArray);

NOT Implemented

void readResourceGroup (int i,
     QString* pixnames,
     QString* brdnames,
     bool* loadArray);

TAKES an int, QString, QString and RETURNS an int

KThemeStyle ( <= KDE2.2.2 )

KThemeStyle is fully implemented. *** EXCEPT

virtual void getButtonShift (int& x, int& y);

NOT Implemented

virtual void scrollBarMetrics (const QScrollBar*,
     int&,
     int&,
     int&,
     int&);

NOT Implemented

virtual void tabbarMetrics (const QTabBar*,
     int&,
     int&,
     int&);

NOT Implemented

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

virtual 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 checkable, QMenuItem* mi, const QFontMetrics& fm);

NOT Implemented

void drawSliderGrooveMask (QPainter*,
     int,
     int,
     int,
     int,
     QCOORD,
     Orientation);

NOT Implemented

KTMainWindow (<= KDE2.2.0)

KTMainWindow is fully implemented.

KActionList - mapped type

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

KXMLGUIClientList - mapped type

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

KWidgetList - mapped type

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