KDE 4.7 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 | KFontUtils | KStandardAction
KAccelGen | G | KStandardGuiItem
C | global | KStandardShortcut
KColorMimeData | I | KSystemEventFilter
KColorUtils | KInputDialog | W
KCrash | K | KWallet
D | KKeyServer | X
KdePrint | S | KXUtils
F | Sonnet |

## 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 (KEditListWidget) | NETExtendedStrut | KTipDatabase
CustomEditor (KEditListBox) | 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 |