KDE 4.2 PyKDE API Reference

- KDE's Python API

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