KDE 4.2 PyKDE API Reference

- KDE's Python API

# global Namespace Reference

`from PyKDE4.kdeui import *`

## Detailed Description

## Class Index

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

## 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
| ) |  |  |