KDE 4.3 PyKDE API Reference

- KDE's Python API

# global Namespace Reference

`from PyKDE4.kdeui import *`

## Detailed Description

## Class Index

3 | KGradientSelector | KPushButton
K3Icon | KGuiItem | R
A | H | KRecentFilesAction
KAboutApplicationDialog | KHBox | KReplace
KAbstractWidgetJobTracker | KHelpMenu | KReplaceDialog
KAcceleratorManager | KHistoryComboBox | KRestrictedLine
KAction | KHueSaturationSelector | KRichTextEdit
KActionCategory | I | KRichTextWidget
KActionCollection | KIcon | KRockerGesture
KActionMenu | KIconCache | KRuler
KActionSelector | KIconEffect | S
KAnimatedButton | KIconLoader | KSelectAction
KApplication | KIconTheme | KSelectionOwner
KArrowButton | KIntNumInput | KSelectionWatcher
KAssistantDialog | KIntSpinBox | KSelector
B | KIntValidator | KSeparator
KBugReport | ItemColor (KConfigSkeleton) | KSessionManager
KButtonGroup | ItemFont (KConfigSkeleton) | KShapeGesture
C | K | KShortcut
KCapacityBar | KKeySequenceWidget | KShortcutsDialog
KCategorizedSortFilterProxyModel | L | KShortcutsEditor
KCategorizedView | KLanguageButton | KShortcutWidget
KCategoryDrawer | KLed | KSplashScreen
KCharSelect | KLineEdit | KSqueezedTextLabel
KCModule | KListWidget | KStartupInfo
KCodecAction | KListWidgetSearchLine | KStartupInfoData
KColorButton | M | KStartupInfoId
KColorCells | KMainWindow | StateChange (KXMLGUIClient)
KColorCollection | KMenu | KStatefulBrush
KColorCombo | KMenuBar | KStatusBar
KColorDialog | KMessageBox | KStatusBarJobTracker
KColorPatch | KMessageBoxMessageHandler | KStringListValidator
KColorScheme | KMimeTypeValidator | KStyle
KColorValueSelector | KModifierKeyInfo | KSvgRenderer
KComboBox | KMouseSettings (KGlobalSettings) | KSystemTrayIcon
KCompletion | KMultiTabBar | T
KCompletionBase | KMultiTabBarButton | KTabBar
KCompletionBox | KMultiTabBarTab | KTabWidget
KConfigDialog | N | KTextBrowser
KConfigDialogManager | NET | KTextEdit
KConfigSkeleton | NETExtendedStrut | KTextEditSpellInterface
KCursor | NETFullscreenMonitors | KTimeZoneWidget
CustomEditor (KEditListBox) | NETIcon | KTipDatabase
D | NETPoint | KTipDialog
KDatePicker | NETRect | KTitleWidget
KDateTable | NETRootInfo | KToggleAction
KDateTimeWidget | NETSize | KToggleFullScreenAction
KDateValidator | NETStrut | KToggleToolBarAction
KDateWidget | NETWinInfo | KToolBar
KDialog | NETWinInfo2 | KToolBarLabelAction
KDialogButtonBox | KNewPasswordDialog | KToolBarPopupAction
KDialogJobUiDelegate | KNotification | KToolBarSpacerAction
KDoubleNumInput | KNotificationRestrictions | KTreeWidgetSearchLine
KDoubleValidator | KNumInput | KTreeWidgetSearchLineWidget
E | P | U
KEditListBox | KPageDialog | KUiServerJobTracker
KEditToolBar | KPageModel | KUndoStack
KExtendableItemDelegate | KPageView | KUniqueApplication
F | KPageWidget | KUrlLabel
KFadeWidgetEffect | KPageWidgetItem | V
KFilterProxySearchLine | KPageWidgetModel | KVBox
KFind | KPassivePopup | W
KFindDialog | KPassivePopupMessageHandler | KWidgetItemDelegate
KFloatValidator | KPasswordDialog | KWidgetJobTracker
KFontAction | KPasteTextAction | KWindowInfo
KFontChooser | KPixmapCache | KWindowSystem
KFontComboBox | KPixmapProvider | KWordWrap
KFontDialog | KPixmapRegionSelectorDialog | X
KFontRequester | KPixmapRegionSelectorWidget | KXMessages
KFontSizeAction | KPlotAxis | KXMLGUIBuilder
G | KPlotObject | KXMLGUIClient
KGlobalAccel | KPlotPoint | KXMLGUIFactory
KGlobalSettings | KPlotWidget | KXmlGuiWindow
KGlobalShortcutInfo | KPopupFrame | KXYSelector
KGlobalShortcutInfoPrivate | KProgressDialog |

## Enumerations

KColorChooserMode | { ChooserClassic, ChooserHue, ChooserSaturation, ChooserValue, ChooserRed, ChooserGreen, ChooserBlue }

## Functions

QPixmap | BarIcon (QString name, int size=0, int state=KIconLoader.DefaultState, QStringList overlays=QStringList())
QIcon | BarIconSet (QString name, int size=0)
QPixmap | DesktopIcon (QString name, int size=0, int state=KIconLoader.DefaultState, QStringList overlays=QStringList())
QIcon | DesktopIconSet (QString name, int size=0)
int | IconSize (KIconLoader.Group group)
QPixmap | MainBarIcon (QString name, int size=0, int state=KIconLoader.DefaultState, QStringList overlays=QStringList())
QIcon | MainBarIconSet (QString name, int size=0)
QPixmap | SmallIcon (QString name, int size=0, int state=KIconLoader.DefaultState, QStringList overlays=QStringList())
QIcon | SmallIconSet (QString name, int size=0)
QPixmap | UserIcon (QString name, int state=KIconLoader.DefaultState, QStringList overlays=QStringList())
QIcon | UserIconSet (QString name)
long | qHash (int a0)
long | qHash (KShapeGesture key)
long | qHash (KRockerGesture key)
long | qHash (int a0)
long | qHash (KShortcut key)
long | qHash (QKeySequence key)

## Enumeration Documentation

KColorChooserMode

Enumerator:

  ChooserClassic = 0x0000 |
  ChooserHue = 0x0001 |
  ChooserSaturation = 0x0002 |
  ChooserValue = 0x0003 |
  ChooserRed = 0x0004 |
  ChooserGreen = 0x0005 |
  ChooserBlue = 0x0006 |

## Function Documentation

QPixmap BarIcon | ( | QString | name,
|  | int | size=0,
|  | int | state=KIconLoader.DefaultState,
|  | QStringList | overlays=QStringList()
| ) |  |  |

Load a toolbar icon.

QIcon BarIconSet | ( | QString | name,
|  | int | size=0
| ) |  |  |

Load a toolbar icon, and apply the necessary effects to get an IconSet.

Deprecated:
  use KIcon(name) or KIcon(name,componentData.iconLoader()) instead

QPixmap DesktopIcon | ( | QString | name,
|  | int | size=0,
|  | int | state=KIconLoader.DefaultState,
|  | QStringList | overlays=QStringList()
| ) |  |  |

QIcon DesktopIconSet | ( | QString | name,
|  | int | size=0
| ) |  |  |

Load a desktop icon, and apply the necessary effects to get an IconSet.

Deprecated:
  use KIcon(name) or KIcon(name,componentData.iconLoader()) instead

int IconSize | ( | KIconLoader.Group | group
| ) |  |  |

Returns the current icon size for a specific group.

QPixmap MainBarIcon | ( | QString | name,
|  | int | size=0,
|  | int | state=KIconLoader.DefaultState,
|  | QStringList | overlays=QStringList()
| ) |  |  |

Load a main toolbar icon.

QIcon MainBarIconSet | ( | QString | name,
|  | int | size=0
| ) |  |  |

Load a main toolbar icon, and apply the effects to get an IconSet.

Deprecated:
  use KIcon(name) or KIcon(name,componentData.iconLoader()) instead

QPixmap SmallIcon | ( | QString | name,
|  | int | size=0,
|  | int | state=KIconLoader.DefaultState,
|  | QStringList | overlays=QStringList()
| ) |  |  |

Load a small icon.

QIcon SmallIconSet | ( | QString | name,
|  | int | size=0
| ) |  |  |

Load a small icon, and apply the necessary effects to get an IconSet.

Deprecated:
  use KIcon(name) or KIcon(name,componentData.iconLoader()) instead

QPixmap UserIcon | ( | QString | name,
|  | int | state=KIconLoader.DefaultState,
|  | QStringList | overlays=QStringList()
| ) |  |  |

Load a user icon. User icons are searched in $appdir/pics.

QIcon UserIconSet | ( | QString | name
| ) |  |  |

Load a user icon, and apply the effects to get an IconSet.

Deprecated:
  use KIcon(name) or KIcon(name,componentData.iconLoader()) instead

long qHash | ( | int | a0
| ) |  |  |

long qHash | ( | KShapeGesture | key
| ) |  |  |

long qHash | ( | KRockerGesture | key
| ) |  |  |

long qHash | ( | int | a0
| ) |  |  |

long qHash | ( | KShortcut | key
| ) |  |  |

long qHash | ( | QKeySequence | key
| ) |  |  |