KDE 4.9 PyKDE API Reference

- KDE's Python API

# global Namespace Reference

`from PyKDE4.kdeui import *`

## Detailed Description

## Class Index

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

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