summaryrefslogtreecommitdiffstats
path: root/kdejava/koala/org/kde/koala/KCompletionBox.java
blob: 171449ef51c56e94fb5eeb02b8a5dace27b14cc5 (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
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
//Auto-generated by kalyptus. DO NOT EDIT.
package org.kde.koala;

import org.kde.qt.Qt;
import org.kde.qt.TQListBoxItem;
import org.kde.qt.TQRect;
import org.kde.qt.TQMetaObject;
import org.kde.qt.QtSupport;
import org.kde.qt.TQObject;
import org.kde.qt.TQSize;
import java.util.ArrayList;
import org.kde.qt.TQEvent;
import org.kde.qt.TQWidget;

/**

 A little utility class for "completion-widgets", like KLineEdit or
 KComboBox. KCompletionBox is a listbox, displayed as a rectangle without
 any window decoration, usually directly under the lineedit or combobox.
 It is filled with all possible matches for a completion, so the user
 can select the one he wants.
 It is used when TDEGlobalSettings.Completion == CompletionPopup or CompletionPopupAuto.
 See {@link KCompletionBoxSignals} for signals emitted by KCompletionBox
		@author Carsten Pfeiffer <pfeiffer@kde.org>
 
		@short A helper widget for "completion-widgets" (KLineEdit, KComboBox)).

*/
public class KCompletionBox extends KListBox  {
	protected KCompletionBox(Class dummy){super((Class) null);}
	public native TQMetaObject metaObject();
	public native String className();
	/**	
		 Constructs a KCompletionBox.
			 The parent widget is used to give the focus back when pressing the
		 up-button on the very first item.
		     		@short    Constructs a KCompletionBox.
	*/
	public KCompletionBox(TQWidget parent, String name) {
		super((Class) null);
		newKCompletionBox(parent,name);
	}
	private native void newKCompletionBox(TQWidget parent, String name);
	public KCompletionBox(TQWidget parent) {
		super((Class) null);
		newKCompletionBox(parent);
	}
	private native void newKCompletionBox(TQWidget parent);
	public native TQSize sizeHint();
	/**	
				@return true if selecting an item results in the emition of the selected signal.

		@short
	*/
	public native boolean activateOnSelect();
	/**	
		 Returns a list of all items currently in the box.
		     		@short    Returns a list of all items currently in the box.
	*/
	public native ArrayList items();
	/**	
		 Inserts <code>items</code> into the box. Does not clear the items before.
		 <code>index</code> determines at which position <code>items</code> will be inserted.
		 (defaults to appending them at the end)
		     		@short    Inserts <code>items</code> into the box.
	*/
	public native void insertItems(String[] items, int index);
	public native void insertItems(String[] items);
	/**	
		 Clears the box and inserts <code>items.</code>
		     		@short    Clears the box and inserts <code>items.</code>
	*/
	public native void setItems(String[] items);
	/**	
		 Adjusts the size of the box to fit the width of the parent given in the
		 constructor and pops it up at the most appropriate place, relative to
		 the parent.
			 Depending on the screensize and the position of the parent, this may
		 be a different place, however the default is to pop it up and the
		 lower left corner of the parent.
			 Make sure to hide() the box when appropriate.
		     		@short    Adjusts the size of the box to fit the width of the parent given in the  constructor and pops it up at the most appropriate place, relative to  the parent.
	*/
	public native void popup();
	/**	
		 Makes this widget (when visible) capture Tab-key events to traverse the
		 items in the dropdown list.
			 Default off, as it conflicts with the usual behavior of Tab to traverse
		 widgets. It is useful for cases like Konqueror's Location Bar, though.
				@short    Makes this widget (when visible) capture Tab-key events to traverse the  items in the dropdown list.
		@see #isTabHandling
	*/
	public native void setTabHandling(boolean enable);
	/**	
			 Default is false.
				@return true if this widget is handling Tab-key events to traverse the
 items in the dropdown list, otherwise false.

		@short   
		@see #setTabHandling
	*/
	public native boolean isTabHandling();
	/**	
		 Sets the text to be emitted if the user chooses not to
		 pick from the available matches.
			 If the canceled text is not set through this function, the
		 userCancelled signal will not be emitted.
			@param txt the text to be emitted if the user cancels this box
		     		@short    Sets the text to be emitted if the user chooses not to  pick from the available matches.
		@see #userCancelled(
		@see #const
	*/
	public native void setCancelledText(String txt);
	/**	
				@return the text set via setCancelledText() or null.
     
		@short
	*/
	public native String cancelledText();
	/**	
		 Set whether or not the selected signal should be emitted when an
		 item is selected. By default the selected signal is emitted.
			@param state false if the signal should not be emitted.
				@short    Set whether or not the selected signal should be emitted when an  item is selected.
	*/
	public native void setActivateOnSelect(boolean state);
	/**	
		 Moves the selection one line down or select the first item if nothing is selected yet.
		     		@short    Moves the selection one line down or select the first item if nothing is selected yet.
	*/
	public native void down();
	/**	
		 Moves the selection one line up or select the first item if nothing is selected yet.
		     		@short    Moves the selection one line up or select the first item if nothing is selected yet.
	*/
	public native void up();
	/**	
		 Moves the selection one page down.
		     		@short    Moves the selection one page down.
	*/
	public native void pageDown();
	/**	
		 Moves the selection one page up.
		     		@short    Moves the selection one page up.
	*/
	public native void pageUp();
	/**	
		 Moves the selection up to the first item.
		     		@short    Moves the selection up to the first item.
	*/
	public native void home();
	/**	
		 Moves the selection down to the last item.
		     		@short    Moves the selection down to the last item.
	*/
	public native void end();
	/**	
		 Re-implemented for internal reasons.  API is unaffected.
		     		@short    Re-implemented for internal reasons.
	*/
	public native void show();
	/**	
		 Re-implemented for internal reasons.  API is unaffected.
		     		@short    Re-implemented for internal reasons.
	*/
	public native void hide();
	/**	
		 This calculates the size of the dropdown and the relative position of the top
		 left corner with respect to the parent widget. This matches the geometry and position
		 normally used by K/TQComboBox when used with one.
		     		@short    This calculates the size of the dropdown and the relative position of the top  left corner with respect to the parent widget.
	*/
	protected native TQRect calculateGeometry();
	/**	
		 This properly sizes and positions the listbox.
		     		@short    This properly sizes and positions the listbox.
	*/
	protected native void sizeAndPosition();
	/**	
		 Reimplemented from KListBox to get events from the viewport (to hide
		 this widget on mouse-click, Escape-presses, etc.
		     		@short    Reimplemented from KListBox to get events from the viewport (to hide  this widget on mouse-click, Escape-presses, etc.
	*/
	public native boolean eventFilter(TQObject arg1, TQEvent arg2);
	/**	
		 Called when an item was activated. Emits
		 activated() with the item.
		     		@short    Called when an item was activated.
	*/
	protected native void slotActivated(TQListBoxItem arg1);
	/** Deletes the wrapped C++ instance */
	protected native void finalize() throws InternalError;
	/** Delete the wrapped C++ instance ahead of finalize() */
	public native void dispose();
	/** Has the wrapped C++ instance been deleted? */
	public native boolean isDisposed();
}