KDE 4.5 PyKDE API Reference

- KDE's Python API

# PyKDE4.kdeui Module

## The KDE User Interface Library

This library provides standard user interface elements for use in KDE applications. If your KDE application has a GUI, you will almost certainly link to libkdeui.

Most applications with single or multiple toplevel widgets should use the KMainWindow class in this library, which automatically provides features like session management and simplified toolbar/menubar/statusbar creation.

A spell-checker library is also provided. Sonnet offers easy access to International ISpell or ASpell (at the user's option) as well as a spell-checker GUI ("Add", "Replace", etc.).

You can use Sonnet to automatically spell-check an ASCII file as well as to implement online spell-checking and to spell-check proprietary format and marked up (e.g. HTML, TeX) documents. The relevant methods for these three procedures are check(), checkWord(), and checkList(), respectively.

SonnetConfig holds configuration information about Sonnet as well as acting as an options-setting dialog.

Sonnet usually works asynchronously. If you do not need that, you should simply use Sonnet.modalCheck(). It won't return until the passed string is processed or the spell checking canceled. During modal spell checking your GUI is still repainted, but the user may only interact with the Sonnet dialog.

See also:
  Sonnet, SonnetConfig

Author(s):
  Various: see the copyright headers of the individual files.

Maintainer(s):
  See the MAINTAINERS file.

License(s):
  LGPLv2

## Namespaces

A | G | KStandardAction
KAccelGen | global | KStandardGuiItem
C | I | KStandardShortcut
KColorMimeData | KInputDialog | W
KColorUtils | K | KWallet
KCrash | KKeyServer | X
D | S | KXUtils
KdePrint | Sonnet |

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