org.kde.koala
Class KSpell

java.lang.Object
  extended by org.kde.qt.Qt
      extended by org.kde.qt.QObject
          extended by org.kde.koala.KSpell
All Implemented Interfaces:
org.kde.qt.QtSupport

public class KSpell
extends org.kde.qt.QObject

%KDE Spellchecker A %KDE programmer's interface to International ISpell 3.1, ASpell, HSpell and ZPSpell.. A static method, modalCheck() is provided for convenient access to the spellchecker. See KSpellSignals for signals emitted by KSpell

Author:
David Sweet
See Also:
KSpellConfig, KSyntaxHighlighter

Field Summary
static int Cleaning
           
static int Crashed
           
static int Error
           
static int Finished
           
static int FinishedNoMisspellingsEncountered
           
static int HTML
           
static int Nroff
           
static int Running
           
static int Starting
          Possible states of the spell checker.
static int TeX
           
static int Text
          These are possible types of documents which the spell checker can check.
 
Fields inherited from class org.kde.qt.Qt
AlignAuto, AlignBottom, AlignCenter, AlignHCenter, AlignHorizontal_Mask, AlignJustify, AlignLeft, AlignRight, AlignTop, AlignVCenter, AlignVertical_Mask, AlphaDither_Mask, ALT, AltButton, AnchorHref, AnchorName, AndNotROP, AndROP, ArrowCursor, Ascending, ASCII_ACCEL, AutoColor, AutoDither, AutoText, AvoidDither, BDiagPattern, BeginsWith, BevelJoin, BitmapCursor, BlankCursor, Bottom, BottomLeft, BottomRight, BreakAnywhere, BusyCursor, CaseSensitive, ClearROP, ColorMode_Mask, ColorOnly, Contains, ControlButton, CopyROP, CrossCursor, CrossPattern, CTRL, CustomPattern, DashDotDotLine, DashDotLine, DashLine, Dense1Pattern, Dense2Pattern, Dense3Pattern, Dense4Pattern, Dense5Pattern, Dense6Pattern, Dense7Pattern, Descending, DiagCrossPattern, DiffuseAlphaDither, DiffuseDither, Dither_Mask, DitherMode_Mask, DockBottom, DockLeft, DockMinimized, DockRight, DockTop, DockTornOff, DockUnmanaged, DontClip, DontPrint, DotLine, DownArrow, EndsWith, EraseROP, ExactMatch, ExpandTabs, FDiagPattern, FixedColor, FixedPixmap, FlatCap, ForbiddenCursor, HiEnglishUnit, HiMetricUnit, Horizontal, HorPattern, IbeamCursor, Identical, IncludeTrailingSpaces, ISODate, Key_0, Key_1, Key_2, Key_3, Key_4, Key_5, Key_6, Key_7, Key_8, Key_9, Key_A, Key_aacute, Key_Aacute, Key_acircumflex, Key_Acircumflex, Key_acute, Key_adiaeresis, Key_Adiaeresis, Key_ae, Key_AE, Key_agrave, Key_Agrave, Key_Alt, Key_Ampersand, Key_Any, Key_Apostrophe, Key_aring, Key_Aring, Key_AsciiCircum, Key_AsciiTilde, Key_Asterisk, Key_At, Key_atilde, Key_Atilde, Key_B, Key_Back, Key_Backslash, Key_Backspace, Key_BackSpace, Key_Backtab, Key_BackTab, Key_Bar, Key_BassBoost, Key_BassDown, Key_BassUp, Key_BraceLeft, Key_BraceRight, Key_BracketLeft, Key_BracketRight, Key_brokenbar, Key_C, Key_CapsLock, Key_ccedilla, Key_Ccedilla, Key_cedilla, Key_cent, Key_Clear, Key_Colon, Key_Comma, Key_Control, Key_copyright, Key_currency, Key_D, Key_degree, Key_Delete, Key_diaeresis, Key_Direction_L, Key_Direction_R, Key_division, Key_Dollar, Key_Down, Key_E, Key_eacute, Key_Eacute, Key_ecircumflex, Key_Ecircumflex, Key_ediaeresis, Key_Ediaeresis, Key_egrave, Key_Egrave, Key_End, Key_Enter, Key_Equal, Key_Escape, Key_eth, Key_ETH, Key_Exclam, Key_exclamdown, Key_F, Key_F1, Key_F10, Key_F11, Key_F12, Key_F13, Key_F14, Key_F15, Key_F16, Key_F17, Key_F18, Key_F19, Key_F2, Key_F20, Key_F21, Key_F22, Key_F23, Key_F24, Key_F25, Key_F26, Key_F27, Key_F28, Key_F29, Key_F3, Key_F30, Key_F31, Key_F32, Key_F33, Key_F34, Key_F35, Key_F4, Key_F5, Key_F6, Key_F7, Key_F8, Key_F9, Key_Favorites, Key_Forward, Key_G, Key_Greater, Key_guillemotleft, Key_guillemotright, Key_H, Key_Help, Key_Home, Key_HomePage, Key_Hyper_L, Key_Hyper_R, Key_hyphen, Key_I, Key_iacute, Key_Iacute, Key_icircumflex, Key_Icircumflex, Key_idiaeresis, Key_Idiaeresis, Key_igrave, Key_Igrave, Key_Insert, Key_J, Key_K, Key_L, Key_Launch0, Key_Launch1, Key_Launch2, Key_Launch3, Key_Launch4, Key_Launch5, Key_Launch6, Key_Launch7, Key_Launch8, Key_Launch9, Key_LaunchA, Key_LaunchB, Key_LaunchC, Key_LaunchD, Key_LaunchE, Key_LaunchF, Key_LaunchMail, Key_LaunchMedia, Key_Left, Key_Less, Key_M, Key_macron, Key_masculine, Key_MediaLast, Key_MediaNext, Key_MediaPlay, Key_MediaPrev, Key_MediaRecord, Key_MediaStop, Key_Menu, Key_Meta, Key_Minus, Key_mu, Key_multiply, Key_N, Key_Next, Key_nobreakspace, Key_notsign, Key_ntilde, Key_Ntilde, Key_NumberSign, Key_NumLock, Key_O, Key_oacute, Key_Oacute, Key_ocircumflex, Key_Ocircumflex, Key_odiaeresis, Key_Odiaeresis, Key_ograve, Key_Ograve, Key_onehalf, Key_onequarter, Key_onesuperior, Key_Ooblique, Key_OpenUrl, Key_ordfeminine, Key_oslash, Key_otilde, Key_Otilde, Key_P, Key_PageDown, Key_PageUp, Key_paragraph, Key_ParenLeft, Key_ParenRight, Key_Pause, Key_Percent, Key_Period, Key_periodcentered, Key_Plus, Key_plusminus, Key_Print, Key_Prior, Key_Q, Key_Question, Key_questiondown, Key_QuoteDbl, Key_QuoteLeft, Key_R, Key_Refresh, Key_registered, Key_Return, Key_Right, Key_S, Key_ScrollLock, Key_Search, Key_section, Key_Semicolon, Key_Shift, Key_Slash, Key_Space, Key_ssharp, Key_Standby, Key_sterling, Key_Stop, Key_Super_L, Key_Super_R, Key_SysReq, Key_T, Key_Tab, Key_thorn, Key_THORN, Key_threequarters, Key_threesuperior, Key_TrebleDown, Key_TrebleUp, Key_twosuperior, Key_U, Key_uacute, Key_Uacute, Key_ucircumflex, Key_Ucircumflex, Key_udiaeresis, Key_Udiaeresis, Key_ugrave, Key_Ugrave, Key_Underscore, Key_unknown, Key_Up, Key_V, Key_VolumeDown, Key_VolumeMute, Key_VolumeUp, Key_W, Key_X, Key_Y, Key_yacute, Key_Yacute, Key_ydiaeresis, Key_yen, Key_Z, KeyButtonMask, Keypad, LastCursor, LastROP, Left, LeftArrow, LeftButton, LocalDate, LocalTime, LoEnglishUnit, LogText, LoMetricUnit, MacStyle, META, MetaButton, MidButton, Minimized, MiterJoin, MODIFIER_MASK, MonoOnly, MotifStyle, MouseButtonMask, MPenCapStyle, MPenJoinStyle, MPenStyle, MV_10_DOT_0, MV_10_DOT_1, MV_10_DOT_2, MV_10_DOT_3, MV_10_DOT_4, MV_9, MV_CHEETAH, MV_JAGUAR, MV_PANTHER, MV_PUMA, MV_TIGER, MV_Unknown, NandROP, NoAccel, NoAlpha, NoBackground, NoBrush, NoButton, NoMatch, NoPen, NopROP, NorROP, NotAndROP, NotCopyROP, NotEraseROP, NotOrROP, NotROP, NotXorROP, OpaqueMode, OrderedAlphaDither, OrderedDither, OrNotROP, OrROP, Overline, PaletteBackground, PaletteBase, PaletteBrightText, PaletteButton, PaletteButtonText, PaletteDark, PaletteForeground, PaletteHighlight, PaletteHighlightedText, PaletteLight, PaletteLink, PaletteLinkVisited, PaletteMid, PaletteMidlight, PaletteShadow, PaletteText, PartialMatch, PixelUnit, PlainText, PMStyle, PointingHandCursor, PreferDither, RichText, Right, RightArrow, RightButton, RoundCap, RoundJoin, SetROP, SHIFT, ShiftButton, ShowPrefix, SingleLine, SizeAllCursor, SizeBDiagCursor, SizeFDiagCursor, SizeHorCursor, SizeVerCursor, SolidLine, SolidPattern, SplitHCursor, SplitVCursor, SquareCap, StrikeOut, TextDate, ThresholdAlphaDither, ThresholdDither, Top, TopLeft, TopRight, TornOff, TransparentMode, TwipsUnit, UI_AnimateCombo, UI_AnimateMenu, UI_AnimateToolBox, UI_AnimateTooltip, UI_FadeMenu, UI_FadeTooltip, UI_General, Underline, UNICODE_ACCEL, Unmanaged, UpArrow, UpArrowCursor, UTC, VerPattern, Vertical, WaitCursor, WDestructiveClose, WGroupLeader, WhatsThisCursor, Win3Style, WindowActive, WindowFullScreen, WindowMaximized, WindowMinimized, WindowNoState, WindowsStyle, WMacDrawer, WMacNoSheet, WMouseNoMask, WNoAutoErase, WNoMousePropagation, WNorthWestGravity, WordBreak, WPaintClever, WPaintDesktop, WPaintUnclipped, WRepaintNoErase, WResizeNoErase, WShowModal, WState_AutoMask, WState_BlockUpdates, WState_CompressKeys, WState_ConfigPending, WState_Created, WState_CreatedHidden, WState_Disabled, WState_DND, WState_Exposed, WState_ForceDisabled, WState_ForceHide, WState_FullScreen, WState_HasMouse, WState_InPaintEvent, WState_Maximized, WState_Minimized, WState_MouseTracking, WState_OwnCursor, WState_OwnSizePolicy, WState_Polished, WState_Reparented, WState_Reserved0, WState_Resized, WState_Visible, WStaticContents, WStyle_ContextHelp, WStyle_Customize, WStyle_Dialog, WStyle_DialogBorder, WStyle_Mask, WStyle_Maximize, WStyle_Minimize, WStyle_MinMax, WStyle_NoBorder, WStyle_NoBorderEx, WStyle_NormalBorder, WStyle_Reserved, WStyle_Splash, WStyle_StaysOnTop, WStyle_SysMenu, WStyle_Title, WStyle_Tool, WSubWindow, WType_Desktop, WType_Dialog, WType_Mask, WType_Modal, WType_Popup, WType_TopLevel, WV_2000, WV_2003, WV_32s, WV_95, WV_98, WV_CE, WV_CE_based, WV_CENET, WV_DOS_based, WV_Me, WV_NT, WV_NT_based, WV_XP, WWinOwnDC, WX11BypassWM, X11ParentRelative, XorROP
 
Constructor Summary
protected KSpell(java.lang.Class dummy)
           
  KSpell(org.kde.qt.QWidget parent, java.lang.String caption, org.kde.qt.QObject receiver, java.lang.String slot)
           
  KSpell(org.kde.qt.QWidget parent, java.lang.String caption, org.kde.qt.QObject receiver, java.lang.String slot, KSpellConfig kcs)
           
  KSpell(org.kde.qt.QWidget parent, java.lang.String caption, org.kde.qt.QObject receiver, java.lang.String slot, KSpellConfig kcs, boolean progressbar)
           
  KSpell(org.kde.qt.QWidget parent, java.lang.String caption, org.kde.qt.QObject receiver, java.lang.String slot, KSpellConfig kcs, boolean progressbar, boolean modal)
          Starts the spellchecker.
  KSpell(org.kde.qt.QWidget parent, java.lang.String caption, org.kde.qt.QObject receiver, java.lang.String slot, KSpellConfig kcs, boolean progressbar, boolean modal, int type)
          Starts the spellchecker.
 
Method Summary
 boolean addPersonal(java.lang.String word)
          Adds a word to the user's personal dictionary.
 boolean check(java.lang.String _buffer)
           
 boolean check(java.lang.String _buffer, boolean usedialog)
          Spellchecks a buffer of many words in plain text format.
protected  void check2(KProcIO arg1)
           
protected  void check3()
           
 boolean checkList(java.lang.String[] _wordlist)
           
 boolean checkList(java.lang.String[] _wordlist, boolean usedialog)
          Spellchecks a list of words.
protected  void checkList2()
           
protected  void checkList3a(KProcIO arg1)
           
protected  void checkList4()
           
protected  void checkListReplaceCurrent()
           
protected  void checkNext()
           
 boolean checkWord(java.lang.String _buffer)
           
 boolean checkWord(java.lang.String _buffer, boolean usedialog)
          Spellchecks a single word.
 boolean checkWord(java.lang.String buffer, boolean _usedialog, boolean suggest)
           
protected  void checkWord2(KProcIO arg1)
           
protected  void checkWord3()
           
 java.lang.String className()
           
protected  boolean cleanFputs(java.lang.String s)
           
protected  boolean cleanFputs(java.lang.String s, boolean appendCR)
           
protected  boolean cleanFputsWord(java.lang.String s)
           
protected  boolean cleanFputsWord(java.lang.String s, boolean appendCR)
           
 void cleanUp()
          Cleans up ISpell.
protected  void dialog(java.lang.String word, java.lang.String[] sugg, java.lang.String _slot)
           
protected  void dialog2(int dlgresult)
           
 void dispose()
          Delete the wrapped C++ instance ahead of finalize()
 int dlgResult()
          Gets the result code of the dialog box.
protected  void emitDeath()
           
protected  void emitProgress()
           
protected  void finalize()
          Deletes the wrapped C++ instance
protected  java.lang.String funnyWord(java.lang.String word)
           
 int heightDlg()
          Returns the height of the dialog box.
 void hide()
          Hides the dialog box.
 boolean ignore(java.lang.String word)
          Tells ISpell/ASpell to ignore this word for the life of this KSpell instance.
protected  void initialize(org.kde.qt.QWidget _parent, java.lang.String _caption, org.kde.qt.QObject arg3, java.lang.String slot, KSpellConfig _ksc, boolean _progressbar, boolean _modal, int type)
           
 java.lang.String intermediateBuffer()
          Returns the partially spellchecked buffer.
 boolean isDisposed()
          Has the wrapped C++ instance been deleted?
protected  void ispellErrors(KProcess arg1, java.lang.String arg2, int arg3)
           
protected  void ispellExit(KProcess arg1)
           
 KSpellConfig ksConfig()
           
protected  void KSpell2(KProcIO arg1)
           
 int lastPosition()
          Returns the position (when using check()) or word number (when using checkList()) of the last word checked.
 org.kde.qt.QMetaObject metaObject()
           
static int modalCheck(java.lang.StringBuffer text, KSpellConfig kcs)
          Performs a synchronous spellcheck.
 void moveDlg(int x, int y)
          Moves the dialog.
protected  int parseOneResponse(java.lang.String _buffer, java.lang.StringBuffer word, java.lang.String[] sugg)
           
protected  java.lang.String replacement()
           
 void setAutoDelete(boolean _autoDelete)
          Sets the auto-delete flag.
 void setIgnoreTitleCase(boolean b)
          Call setIgnoreTitleCase(true) to tell the spell-checker to ignore words with a 'title' case, i.e.
 void setIgnoreUpperWords(boolean b)
          Call setIgnoreUpperWords(true) to tell the spell-checker to ignore words that are completely uppercase.
 void setProgressResolution(int res)
          Sets the resolution (in percent) of the progress() signals.
protected  void setUpDialog()
           
protected  void setUpDialog(boolean reallyusedialogbox)
           
protected  void slotStopCancel(int arg1)
           
protected  void startIspell()
           
 int status()
          Returns the status of KSpell.
 java.util.ArrayList suggestions()
          Returns list of suggested word replacements.
protected  void suggestWord(KProcIO arg1)
           
 int widthDlg()
          Returns the width of the dialog box.
protected  boolean writePersonalDictionary()
           
 
Methods inherited from class org.kde.qt.QObject
activate_filters, activate_signal_bool, activate_signal, activate_signal, activate_signal, activate_signal, blockSignals, checkConnectArgs, child, child, child, childEvent, children, connect, connect, connectInternal, connectNotify, customEvent, deleteLater, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnectInternal, disconnectNotify, dumpObjectInfo, dumpObjectTree, emit, emit, emit, emit, emit, emit, emit, emit, emit, emit, emit, emit, emit, emit, emit, emit, emit, emit, emit, emit, emit, emit, event, eventFilter, highPriority, i18n, inherits, insertChild, installEventFilter, isA, isWidgetType, killTimer, killTimers, name, name, normalizeSignalSlot, objectTrees, parent, property, queryList, queryList, queryList, queryList, queryList, registerUserData, removeChild, removeEventFilter, sender, setName, setProperty, signalsBlocked, startTimer, timerEvent, tr, tr
 
Methods inherited from class org.kde.qt.Qt
arrowCursor, bin, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, black, blankCursor, blue, color0, color1, copyBlt, copyBlt, copyBlt, copyBlt, copyBlt, crossCursor, cyan, darkBlue, darkCyan, darkGray, darkGreen, darkMagenta, darkRed, darkYellow, dec, dynamicCast, endl, flush, forbiddenCursor, fromUtf8, gray, green, hex, ibeamCursor, lightGray, magenta, oct, op_div, op_div, op_div, op_div, op_equals, op_equals, op_equals, op_equals, op_minus, op_minus, op_minus, op_mult, op_mult, op_mult, op_mult, op_mult, op_mult, op_mult, op_mult, op_mult, op_not_equals, op_not_equals, op_not_equals, op_not_equals, op_plus, op_plus, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, pointingHandCursor, qAlpha, qApp, qAppName, qBlue, qCompress, qCompress, qDebug, qDebug, qDrawArrow, qDrawItem, qDrawItem, qDrawItem, qDrawPlainRect, qDrawPlainRect, qDrawPlainRect, qDrawPlainRect, qDrawPlainRect, qDrawPlainRect, qDrawShadeLine, qDrawShadeLine, qDrawShadeLine, qDrawShadeLine, qDrawShadeLine, qDrawShadeLine, qDrawShadeLine, qDrawShadeLine, qDrawShadePanel, qDrawShadePanel, qDrawShadePanel, qDrawShadePanel, qDrawShadePanel, qDrawShadePanel, qDrawShadePanel, qDrawShadePanel, qDrawShadeRect, qDrawShadeRect, qDrawShadeRect, qDrawShadeRect, qDrawShadeRect, qDrawShadeRect, qDrawShadeRect, qDrawShadeRect, qDrawShadeRect, qDrawShadeRect, qDrawWinButton, qDrawWinButton, qDrawWinButton, qDrawWinButton, qDrawWinButton, qDrawWinButton, qDrawWinPanel, qDrawWinPanel, qDrawWinPanel, qDrawWinPanel, qDrawWinPanel, qDrawWinPanel, qFatal, qFatal, qGLVersion, qGray, qGray, qGreen, qInitNetworkProtocols, qInstallPath, qInstallPathBins, qInstallPathData, qInstallPathDocs, qInstallPathHeaders, qInstallPathLibs, qInstallPathPlugins, qInstallPathSysconf, qInstallPathTranslations, qItemRect, qItemRect, qObsolete, qObsolete, qObsolete, qRed, qRgb, qRgba, qRound, qSharedBuild, qSuppressObsoleteWarnings, qSuppressObsoleteWarnings, qSysInfo, qSystemWarning, qSystemWarning, qUncompress, qUncompress, qVersion, qWarning, qWarning, red, reset, SIGNAL, sizeAllCursor, sizeBDiagCursor, sizeFDiagCursor, sizeHorCursor, sizeVerCursor, SLOT, splitHCursor, splitVCursor, upArrowCursor, waitCursor, whatsThisCursor, white, ws, yellow
 
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

Starting

public static final int Starting
Possible states of the spell checker.
  • Starting - After creation of KSpell.
  • Running - After the ready signal has been emitted.
  • Cleaning - After cleanUp() has been called.
  • Finished - After cleanUp() has been completed.
  • The following error states exist:
  • Error - An error occurred in the Starting state.
  • Crashed - An error occurred in the Running state.
  • See Also:
    Constant Field Values

    Running

    public static final int Running
    See Also:
    Constant Field Values

    Cleaning

    public static final int Cleaning
    See Also:
    Constant Field Values

    Finished

    public static final int Finished
    See Also:
    Constant Field Values

    Error

    public static final int Error
    See Also:
    Constant Field Values

    Crashed

    public static final int Crashed
    See Also:
    Constant Field Values

    FinishedNoMisspellingsEncountered

    public static final int FinishedNoMisspellingsEncountered
    See Also:
    Constant Field Values

    Text

    public static final int Text
    These are possible types of documents which the spell checker can check.
  • Text - The default type, checks every word
  • HTML - For HTML/SGML/XML documents, will skip the tags,
  • TeX - For TeX/LaTeX documents, will skip commands,
  • Nroff - For nroff/troff documents.
  • Please note that not every option is supported on every type of checker (e.g. ASpell doesn't support Nroff). In case a type of a document is not supported the default Text option will be used.

    See Also:
    Constant Field Values

    HTML

    public static final int HTML
    See Also:
    Constant Field Values

    TeX

    public static final int TeX
    See Also:
    Constant Field Values

    Nroff

    public static final int Nroff
    See Also:
    Constant Field Values
    Constructor Detail

    KSpell

    protected KSpell(java.lang.Class dummy)

    KSpell

    public KSpell(org.kde.qt.QWidget parent,
                  java.lang.String caption,
                  org.kde.qt.QObject receiver,
                  java.lang.String slot,
                  KSpellConfig kcs,
                  boolean progressbar,
                  boolean modal)
    Starts the spellchecker. KSpell emits ready() when it has verified that ISpell/ASpell is working properly. Pass the name of a slot -- do not pass zero! Be sure to call cleanUp() when you are done with KSpell. If KSpell could not be started correctly, death() is emitted.

    Parameters:
    parent - Parent of KSpellConfig dialog..
    caption - Caption of KSpellConfig dialog.
    receiver - Receiver object for the ready(KSpell ) signal.
    slot - Receiver's slot, will be connected to the ready(KSpell ) signal.
    kcs - Configuration for KSpell.
    progressbar - Indicates if progress bar should be shown.
    modal - Indicates modal or non-modal dialog.

    KSpell

    public KSpell(org.kde.qt.QWidget parent,
                  java.lang.String caption,
                  org.kde.qt.QObject receiver,
                  java.lang.String slot,
                  KSpellConfig kcs,
                  boolean progressbar)

    KSpell

    public KSpell(org.kde.qt.QWidget parent,
                  java.lang.String caption,
                  org.kde.qt.QObject receiver,
                  java.lang.String slot,
                  KSpellConfig kcs)

    KSpell

    public KSpell(org.kde.qt.QWidget parent,
                  java.lang.String caption,
                  org.kde.qt.QObject receiver,
                  java.lang.String slot)

    KSpell

    public KSpell(org.kde.qt.QWidget parent,
                  java.lang.String caption,
                  org.kde.qt.QObject receiver,
                  java.lang.String slot,
                  KSpellConfig kcs,
                  boolean progressbar,
                  boolean modal,
                  int type)
    Starts the spellchecker. KSpell emits ready() when it has verified that ISpell/ASpell is working properly. Pass the name of a slot -- do not pass zero! Be sure to call cleanUp() when you are done with KSpell. If KSpell could not be started correctly, death() is emitted.

    Parameters:
    parent - Parent of KSpellConfig dialog..
    caption - Caption of KSpellConfig dialog.
    receiver - Receiver object for the ready(KSpell ) signal.
    slot - Receiver's slot, will be connected to the ready(KSpell ) signal.
    kcs - Configuration for KSpell.
    progressbar - Indicates if progress bar should be shown.
    modal - Indicates modal or non-modal dialog.
    type - Type of the document to check
    Method Detail

    metaObject

    public org.kde.qt.QMetaObject metaObject()
    Overrides:
    metaObject in class org.kde.qt.QObject

    className

    public java.lang.String className()
    Overrides:
    className in class org.kde.qt.QObject

    status

    public int status()
    Returns the status of KSpell.

    See Also:
    #spellStatus

    cleanUp

    public void cleanUp()
    Cleans up ISpell. Write out the personal dictionary and close ISpell's stdin. A death() signal will be emitted when the cleanup is complete, but this method will return immediately.


    setAutoDelete

    public void setAutoDelete(boolean _autoDelete)
    Sets the auto-delete flag. If this is set, the KSpell object is automatically deleted after emitting death().


    check

    public boolean check(java.lang.String _buffer,
                         boolean usedialog)
    Spellchecks a buffer of many words in plain text format. The _buffer is not modified. The signal done() will be sent when check() is finished and the argument will be a spell-corrected version of _buffer. The spell check may be stopped by the user before the entire buffer has been checked. You can check lastPosition() to see how far in _buffer check() reached before stopping.


    check

    public boolean check(java.lang.String _buffer)

    lastPosition

    public int lastPosition()
    Returns the position (when using check()) or word number (when using checkList()) of the last word checked.


    checkList

    public boolean checkList(java.lang.String[] _wordlist,
                             boolean usedialog)
    Spellchecks a list of words. checkList() is more flexible than check(). You could parse any type of document (HTML, TeX, etc.) into a list of spell-checkable words and send the list to checkList(). Sending a marked-up document to check() would result in the mark-up tags being spell checked.


    checkList

    public boolean checkList(java.lang.String[] _wordlist)

    checkWord

    public boolean checkWord(java.lang.String _buffer,
                             boolean usedialog)
    Spellchecks a single word. checkWord() is the most flexible function. Some applications might need this flexibility but will sacrifice speed when checking large numbers of words. Consider checkList() for checking many words. Use this method for implementing "online" spellchecking (i.e., spellcheck as-you-type). checkWord() returns false if buffer is not a single word (e.g. if it contains white space), otherwise it returns true; If usedialog is set to true, KSpell will open the standard dialog if the word is not found. The dialog results can be queried by using dlgResult() and replacement(). The signal corrected() is emitted when the check is complete. You can look at suggestions() to see what the suggested replacements were.


    checkWord

    public boolean checkWord(java.lang.String _buffer)

    checkWord

    public boolean checkWord(java.lang.String buffer,
                             boolean _usedialog,
                             boolean suggest)

    hide

    public void hide()
    Hides the dialog box. You'll need to do this when you are done with checkWord();


    suggestions

    public java.util.ArrayList suggestions()
    Returns list of suggested word replacements. After calling checkWord() (an in response to a misspelled() signal you can use this to get the list of suggestions (if any were available).


    dlgResult

    public int dlgResult()
    Gets the result code of the dialog box. After calling checkWord, you can use this to get the dialog box's result code. The possible values are (from kspelldlg.h):
  • KS_CANCEL
  • KS_REPLACE
  • KS_REPLACEALL
  • KS_IGNORE
  • KS_IGNOREALL
  • KS_ADD
  • KS_STOP

  • moveDlg

    public void moveDlg(int x,
                        int y)
    Moves the dialog. If the dialog is not currently visible, it will be placed at this position when it becomes visible. Use this to get the dialog out of the way of a highlighted misspelled word in a document.


    heightDlg

    public int heightDlg()
    Returns the height of the dialog box.


    widthDlg

    public int widthDlg()
    Returns the width of the dialog box.


    intermediateBuffer

    public java.lang.String intermediateBuffer()
    Returns the partially spellchecked buffer. You might want the full buffer in its partially-checked state.


    ignore

    public boolean ignore(java.lang.String word)
    Tells ISpell/ASpell to ignore this word for the life of this KSpell instance.

    Returns:
    false if word is not a word or there was an error communicating with ISpell/ASpell.

    addPersonal

    public boolean addPersonal(java.lang.String word)
    Adds a word to the user's personal dictionary.

    Returns:
    false if word is not a word or there was an error communicating with ISpell/ASpell.

    ksConfig

    public KSpellConfig ksConfig()
    Returns:
    the KSpellConfig object being used by this KSpell instance.

    setProgressResolution

    public void setProgressResolution(int res)
    Sets the resolution (in percent) of the progress() signals. E.g. setProgressResolution (10) instructs KSpell to send progress signals (at most) every 10% (10%, 20%, 30%...). The default is 10%.


    setIgnoreUpperWords

    public void setIgnoreUpperWords(boolean b)
    Call setIgnoreUpperWords(true) to tell the spell-checker to ignore words that are completely uppercase. They are spell-checked by default.


    setIgnoreTitleCase

    public void setIgnoreTitleCase(boolean b)
    Call setIgnoreTitleCase(true) to tell the spell-checker to ignore words with a 'title' case, i.e. starting with an uppercase letter. They are spell-checked by default.


    modalCheck

    public static int modalCheck(java.lang.StringBuffer text,
                                 KSpellConfig kcs)
    Performs a synchronous spellcheck. This method does not return until spellchecking is done or canceled. Your application's GUI will still be updated, however. This overloaded method uses the spell-check configuration passed as parameter.


    parseOneResponse

    protected int parseOneResponse(java.lang.String _buffer,
                                   java.lang.StringBuffer word,
                                   java.lang.String[] sugg)

    funnyWord

    protected java.lang.String funnyWord(java.lang.String word)

    dialog

    protected void dialog(java.lang.String word,
                          java.lang.String[] sugg,
                          java.lang.String _slot)

    replacement

    protected java.lang.String replacement()

    setUpDialog

    protected void setUpDialog(boolean reallyusedialogbox)

    setUpDialog

    protected void setUpDialog()

    emitProgress

    protected void emitProgress()

    cleanFputs

    protected boolean cleanFputs(java.lang.String s,
                                 boolean appendCR)

    cleanFputs

    protected boolean cleanFputs(java.lang.String s)

    cleanFputsWord

    protected boolean cleanFputsWord(java.lang.String s,
                                     boolean appendCR)

    cleanFputsWord

    protected boolean cleanFputsWord(java.lang.String s)

    startIspell

    protected void startIspell()

    writePersonalDictionary

    protected boolean writePersonalDictionary()

    initialize

    protected void initialize(org.kde.qt.QWidget _parent,
                              java.lang.String _caption,
                              org.kde.qt.QObject arg3,
                              java.lang.String slot,
                              KSpellConfig _ksc,
                              boolean _progressbar,
                              boolean _modal,
                              int type)

    KSpell2

    protected void KSpell2(KProcIO arg1)

    checkWord2

    protected void checkWord2(KProcIO arg1)

    checkWord3

    protected void checkWord3()

    check2

    protected void check2(KProcIO arg1)

    checkList2

    protected void checkList2()

    checkList3a

    protected void checkList3a(KProcIO arg1)

    checkListReplaceCurrent

    protected void checkListReplaceCurrent()

    checkList4

    protected void checkList4()

    dialog2

    protected void dialog2(int dlgresult)

    check3

    protected void check3()

    suggestWord

    protected void suggestWord(KProcIO arg1)

    slotStopCancel

    protected void slotStopCancel(int arg1)

    ispellExit

    protected void ispellExit(KProcess arg1)

    emitDeath

    protected void emitDeath()

    ispellErrors

    protected void ispellErrors(KProcess arg1,
                                java.lang.String arg2,
                                int arg3)

    checkNext

    protected void checkNext()

    finalize

    protected void finalize()
                     throws java.lang.InternalError
    Deletes the wrapped C++ instance

    Overrides:
    finalize in class org.kde.qt.QObject
    Throws:
    java.lang.InternalError

    dispose

    public void dispose()
    Delete the wrapped C++ instance ahead of finalize()

    Overrides:
    dispose in class org.kde.qt.QObject

    isDisposed

    public boolean isDisposed()
    Has the wrapped C++ instance been deleted?

    Overrides:
    isDisposed in class org.kde.qt.QObject