KDE 4.6 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 | KSystemEventFilter
KColorUtils | K | W
KCrash | KKeyServer | KWallet
D | S | X
KdePrint | Sonnet | KXUtils

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