KDE 4.6 PyKDE API Reference

- KDE's Python API

# global Namespace Reference

`from PyKDE4.kdeui import *`

## Detailed Description

## Class Index

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