KDE 4.5 PyKDE API Reference

- KDE's Python API

# global Namespace Reference

`from PyKDE4.kdeui import *`

## Detailed Description

## Class Index

3 | KGlobalShortcutInfo | KProgressDialog
K3Icon | KGradientSelector | KPushButton
A | KGuiItem | R
KAboutApplicationDialog | H | KRecentFilesAction
KAbstractWidgetJobTracker | KHBox | KRecursiveFilterProxyModel
KAcceleratorManager | KHelpMenu | KReplace
KAction | Highlighter (Sonnet) | KReplaceDialog
KActionCategory | KHistoryComboBox | KRestrictedLine
KActionCollection | KHueSaturationSelector | KRichTextEdit
KActionMenu | I | KRichTextWidget
KActionSelector | KIcon | KRockerGesture
KAnimatedButton | KIconCache | KRuler
KApplication | KIconEffect | S
KArrowButton | KIconLoader | KSelectAction
KAssistantDialog | KIconTheme | KSelectionOwner
B | KIntNumInput | KSelectionProxyModel
KBreadcrumbSelectionModel | KIntSpinBox | KSelectionWatcher
KBugReport | KIntValidator | KSelector
KButtonGroup | ItemColor (KConfigSkeleton) | KSeparator
C | ItemFont (KConfigSkeleton) | KSessionManager
KCapacityBar | K | KShapeGesture
KCategorizedSortFilterProxyModel | KKeySequenceWidget | KShortcut
KCategorizedView | L | KShortcutsDialog
KCategoryDrawer | KLanguageButton | KShortcutsEditor
KCategoryDrawerV2 | KLed | KShortcutWidget
KCategoryDrawerV3 | KLineEdit | KSplashScreen
KCharSelect | KLinkItemSelectionModel | 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 | KStatusNotifierItem
KColorScheme | KMimeTypeValidator | KStringListValidator
KColorValueSelector | KModelIndexProxyMapper | KStyle
KComboBox | KModifierKeyInfo | KSvgRenderer
KCompletion | KMouseSettings (KGlobalSettings) | KSystemTrayIcon
KCompletionBase | KMultiTabBar | T
KCompletionBox | KMultiTabBarButton | KTabBar
ConfigDialog (Sonnet) | KMultiTabBarTab | KTabWidget
KConfigDialog | N | KTextBrowser
KConfigDialogManager | NET | KTextEdit
KConfigSkeleton | NETExtendedStrut | KTextEditSpellInterface
ConfigWidget (Sonnet) | 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 | KNewPasswordDialog | KToolBarLabelAction
Dialog (Sonnet) | KNotification | KToolBarPopupAction
KDialog | KNotificationRestrictions | KToolBarSpacerAction
KDialogButtonBox | KNumInput | KTreeWidgetSearchLine
KDialogJobUiDelegate | P | KTreeWidgetSearchLineWidget
DictionaryComboBox (Sonnet) | KPageDialog | U
KDoubleNumInput | KPageModel | KUiServerJobTracker
KDoubleValidator | KPageView | KUndoStack
E | KPageWidget | KUniqueApplication
KEditListBox | KPageWidgetItem | KUrlLabel
KEditToolBar | KPageWidgetModel | V
KExtendableItemDelegate | KPassivePopup | KVBox
F | KPassivePopupMessageHandler | KViewStateSaver
KFadeWidgetEffect | KPasswordDialog | W
KFilterProxySearchLine | KPasteTextAction | Wallet (KWallet)
KFind | KPixmapCache | KWidgetItemDelegate
KFindDialog | KPixmapProvider | KWidgetJobTracker
KFloatValidator | KPixmapRegionSelectorDialog | KWindowInfo
KFontAction | KPixmapRegionSelectorWidget | KWindowSystem
KFontChooser | KPixmapSequence | KWordWrap
KFontComboBox | KPixmapSequenceOverlayPainter | X
KFontDialog | KPixmapSequenceWidget | KXMessages
KFontRequester | KPlotAxis | KXMLGUIBuilder
KFontSizeAction | KPlotObject | KXMLGUIClient
G | KPlotPoint | KXMLGUIFactory
KGlobalAccel | KPlotWidget | KXmlGuiWindow
KGlobalSettings | KPopupFrame | KXYSelector

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

Load a desktop icon.

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

Represents a keyboard shortcut

The KShortcut class is used to represent a keyboard shortcut to an action. A shortcut is normally a single key with modifiers, such as Ctrl+V. A KShortcut object may also contain an alternate key sequence which will also activate the action it's associated with, as long as no other actions have defined that key as their primary key. Ex: Ctrl+V;Shift+Insert.

This can be used to add additional accelerators to a KAction. For example, the below code binds the escape key to the close action.

      KAction *closeAction = KStandardAction.close(this, SLOT( close() ), actionCollection());
      KShortcut closeShortcut = closeAction->shortcut();
      closeShortcut.setAlternate(Qt.Key_Escape);
      closeAction->setShortcut(closeShortcut);

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

Represents a keyboard shortcut

The KShortcut class is used to represent a keyboard shortcut to an action. A shortcut is normally a single key with modifiers, such as Ctrl+V. A KShortcut object may also contain an alternate key sequence which will also activate the action it's associated with, as long as no other actions have defined that key as their primary key. Ex: Ctrl+V;Shift+Insert.

This can be used to add additional accelerators to a KAction. For example, the below code binds the escape key to the close action.

      KAction *closeAction = KStandardAction.close(this, SLOT( close() ), actionCollection());
      KShortcut closeShortcut = closeAction->shortcut();
      closeShortcut.setAlternate(Qt.Key_Escape);
      closeAction->setShortcut(closeShortcut);

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

Represents a keyboard shortcut

The KShortcut class is used to represent a keyboard shortcut to an action. A shortcut is normally a single key with modifiers, such as Ctrl+V. A KShortcut object may also contain an alternate key sequence which will also activate the action it's associated with, as long as no other actions have defined that key as their primary key. Ex: Ctrl+V;Shift+Insert.

This can be used to add additional accelerators to a KAction. For example, the below code binds the escape key to the close action.

      KAction *closeAction = KStandardAction.close(this, SLOT( close() ), actionCollection());
      KShortcut closeShortcut = closeAction->shortcut();
      closeShortcut.setAlternate(Qt.Key_Escape);
      closeAction->setShortcut(closeShortcut);

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

Represents a keyboard shortcut

The KShortcut class is used to represent a keyboard shortcut to an action. A shortcut is normally a single key with modifiers, such as Ctrl+V. A KShortcut object may also contain an alternate key sequence which will also activate the action it's associated with, as long as no other actions have defined that key as their primary key. Ex: Ctrl+V;Shift+Insert.

This can be used to add additional accelerators to a KAction. For example, the below code binds the escape key to the close action.

      KAction *closeAction = KStandardAction.close(this, SLOT( close() ), actionCollection());
      KShortcut closeShortcut = closeAction->shortcut();
      closeShortcut.setAlternate(Qt.Key_Escape);
      closeAction->setShortcut(closeShortcut);

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

Represents a keyboard shortcut

The KShortcut class is used to represent a keyboard shortcut to an action. A shortcut is normally a single key with modifiers, such as Ctrl+V. A KShortcut object may also contain an alternate key sequence which will also activate the action it's associated with, as long as no other actions have defined that key as their primary key. Ex: Ctrl+V;Shift+Insert.

This can be used to add additional accelerators to a KAction. For example, the below code binds the escape key to the close action.

      KAction *closeAction = KStandardAction.close(this, SLOT( close() ), actionCollection());
      KShortcut closeShortcut = closeAction->shortcut();
      closeShortcut.setAlternate(Qt.Key_Escape);
      closeAction->setShortcut(closeShortcut);

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

Represents a keyboard shortcut

The KShortcut class is used to represent a keyboard shortcut to an action. A shortcut is normally a single key with modifiers, such as Ctrl+V. A KShortcut object may also contain an alternate key sequence which will also activate the action it's associated with, as long as no other actions have defined that key as their primary key. Ex: Ctrl+V;Shift+Insert.

This can be used to add additional accelerators to a KAction. For example, the below code binds the escape key to the close action.

      KAction *closeAction = KStandardAction.close(this, SLOT( close() ), actionCollection());
      KShortcut closeShortcut = closeAction->shortcut();
      closeShortcut.setAlternate(Qt.Key_Escape);
      closeAction->setShortcut(closeShortcut);