KDE 4.4 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 | KReplace
KAcceleratorManager | KHelpMenu | KReplaceDialog
KAction | Highlighter (Sonnet) | KRestrictedLine
KActionCategory | KHistoryComboBox | KRichTextEdit
KActionCollection | KHueSaturationSelector | KRichTextWidget
KActionMenu | I | KRockerGesture
KActionSelector | KIcon | KRuler
KAnimatedButton | KIconCache | S
KApplication | KIconEffect | KSelectAction
KArrowButton | KIconLoader | KSelectionOwner
KAssistantDialog | KIconTheme | KSelectionProxyModel
B | KIntNumInput | KSelectionWatcher
KBugReport | KIntSpinBox | KSelector
KButtonGroup | KIntValidator | KSeparator
C | ItemColor (KConfigSkeleton) | KSessionManager
KCapacityBar | ItemFont (KConfigSkeleton) | KShapeGesture
KCategorizedSortFilterProxyModel | K | KShortcut
KCategorizedView | KKeySequenceWidget | KShortcutsDialog
KCategoryDrawer | L | KShortcutsEditor
KCategoryDrawerV2 | KLanguageButton | KShortcutWidget
KCharSelect | KLed | KSplashScreen
KCModule | KLineEdit | KSqueezedTextLabel
KCodecAction | KListWidget | KStartupInfo
KColorButton | KListWidgetSearchLine | KStartupInfoData
KColorCells | M | KStartupInfoId
KColorCollection | KMainWindow | StateChange (KXMLGUIClient)
KColorCombo | KMenu | KStatefulBrush
KColorDialog | KMenuBar | KStatusBar
KColorPatch | KMessageBox | KStatusBarJobTracker
KColorScheme | KMessageBoxMessageHandler | KStatusNotifierItem
KColorValueSelector | KMimeTypeValidator | KStringListValidator
KComboBox | KModifierKeyInfo | KStyle
KCompletion | KMouseSettings (KGlobalSettings) | KSvgRenderer
KCompletionBase | KMultiTabBar | KSystemTrayIcon
KCompletionBox | KMultiTabBarButton | T
ConfigDialog (Sonnet) | KMultiTabBarTab | KTabBar
KConfigDialog | N | KTabWidget
KConfigDialogManager | NET | KTextBrowser
KConfigSkeleton | NETExtendedStrut | KTextEdit
ConfigWidget (Sonnet) | NETFullscreenMonitors | KTextEditSpellInterface
KCursor | NETIcon | KTimeZoneWidget
CustomEditor (KEditListBox) | NETPoint | KTipDatabase
D | NETRect | KTipDialog
KDatePicker | NETRootInfo | KTitleWidget
KDateTable | NETSize | KToggleAction
KDateTimeWidget | NETStrut | KToggleFullScreenAction
KDateValidator | NETWinInfo | KToggleToolBarAction
KDateWidget | KNewPasswordDialog | KToolBar
Dialog (Sonnet) | KNotification | KToolBarLabelAction
KDialog | KNotificationRestrictions | KToolBarPopupAction
KDialogButtonBox | KNumInput | KToolBarSpacerAction
KDialogJobUiDelegate | P | KTreeWidgetSearchLine
DictionaryComboBox (Sonnet) | KPageDialog | KTreeWidgetSearchLineWidget
KDoubleNumInput | KPageModel | U
KDoubleValidator | KPageView | KUiServerJobTracker
E | KPageWidget | KUndoStack
KEditListBox | KPageWidgetItem | KUniqueApplication
KEditToolBar | KPageWidgetModel | KUrlLabel
KExtendableItemDelegate | KPassivePopup | V
F | KPassivePopupMessageHandler | KVBox
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