summaryrefslogtreecommitdiffstats
path: root/kdejava/koala/org/kde/koala/KSpellSignals.java
blob: f3df1e64ed692157ab70ace0752aabcaccfac6a3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
//Auto-generated by kalyptus. DO NOT EDIT.
package org.kde.koala;

import org.kde.qt.QMetaObject;
import org.kde.qt.QtSupport;
import org.kde.qt.QObject;
import java.util.ArrayList;
import org.kde.qt.QWidget;

public interface KSpellSignals {
	/**	
		 Emitted whenever a misspelled word is found by check() or
		   by checkWord().
		  If it is emitted by checkWord(), <code>pos</code>=0.
		  If it is emitted by check(), then <code>pos</code> indicates the position of
		   the misspelled word in the (original) <code>_buffer.</code>
		   (The first position is zero.)
		  If it is emitted by checkList(), <code>pos</code> is the index to
		  the misspelled
		   word in the ArrayList passed to checkList().
		  Note, that <code>originalword</code> can be only a word part, if it's
		  word with hyphens.
			  These are called _before_ the dialog is opened, so that the
		   calling program's GUI may be updated. (e.g. the misspelled word may
		   be highlighted).
		   		@short    Emitted whenever a misspelled word is found by check() or    by checkWord().
	*/
	void misspelling(String originalword, String[] suggestions, int pos);
	/**	
		 Emitted after the "Replace" or "Replace All" buttons of the dialog
		 was pressed, or if the word was
		 corrected without calling the dialog (i.e., the user previously chose
		 "Replace All" for this word).
			 Results from the dialog may be checked with dlgResult()
		  and replacement().
			 Note, that when using checkList() this signal can occur
		 more then once with same list position, when checking a word with
		 hyphens. In this case <code>originalword</code> is the last replacement.
				@short    Emitted after the "Replace" or "Replace All" buttons of the dialog  was pressed, or if the word was  corrected without calling the dialog (i.
		@see #check
	*/
	void corrected(String originalword, String newword, int pos);
	/**	
		 Emitted when the user pressed "Ignore All" in the dialog.
		 This could be used to make an application or file specific
		 user dictionary.
			   		@short    Emitted when the user pressed "Ignore All" in the dialog.
	*/
	void ignoreall(String originalword);
	/**	
		 Emitted when the user pressed "Ignore" in the dialog.
		 Don't know if this could be useful.
			   		@short    Emitted when the user pressed "Ignore" in the dialog.
	*/
	void ignoreword(String originalword);
	/**	
		 Emitted when the user pressed "Add" in the dialog.
		 This could be used to make an external user dictionary
		 independent of the ISpell personal dictionary.
			   		@short    Emitted when the user pressed "Add" in the dialog.
	*/
	void addword(String originalword);
	/**	
		 Emitted when the user pressed "ReplaceAll" in the dialog.
		   		@short    Emitted when the user pressed "ReplaceAll" in the dialog.
	*/
	void replaceall(String origword, String replacement);
	/**	
		 Emitted after KSpell has verified that ISpell/ASpell is running
		 and working properly.
		   		@short    Emitted after KSpell has verified that ISpell/ASpell is running  and working properly.
	*/
	void ready(KSpell arg1);
	/**	
		 Emitted during a check().
		 <code>i</code> is between 1 and 100.
		   		@short    Emitted during a check().
	*/
	void progress(int i);
	/**	
		 Emitted when check() is done.
			 Be sure to copy the results of <code>buffer</code> if you need them.
		  You can only rely
		  on the contents of buffer for the life of the slot which was signaled
		  by done().
		   		@short    Emitted when check() is done.
	*/
	void done(String buffer);
	/**	
		 Emitted when checkList() is done.
			 If the argument is
		 <code>true</code>, then you should update your text from the
		 wordlist, otherwise not.
		   		@short    Emitted when checkList() is done.
	*/
	void done(boolean arg1);
	/**	
		 Emitted on terminal errors and after clean up.
			 You can delete the KSpell object in this signal.
			 You can check status() to see what caused the death:
		
			<li>
			<code>Error</code> - KSpell could not start.
			</li>
			
			<li>
			<code>Crashed</code> - KSpell encountered an unexpected error during execution.
			</li>
			
			<li>
			<code>Finished</code> - Clean up finished.
			   
			</li>		@short    Emitted on terminal errors and after clean up.
	*/
	void death();
	void dialog3();
}