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