EntryCompletion is an auxiliary object to be used in conjunction
with Entry to provide the completion functionality. To add
completion functionality to an Entry, use setCompletion(). In
addition to regular completion matches, which will be inserted
into the entry when they are selected, EntryCompletion also allows
to display "actions" in the popup window. Their appearance is
similar to menuitems, to differentiate them clearly from completion
strings. When an action is selected, the ::action-activated signal
is emitted.
complete
public void complete()
Requests a completion operation, or in other words a refiltering
of the current list with completions, using the current key.
deleteAction
public void deleteAction(int index)
Remove an action for the EntryCompletions action list.
index
-
findListener
protected int findListener(Vector list,
Object listener)
Give us a way to locate a specific listener in a Vector.
list
- The Vector of listeners to search.listener
- The object that is to be located in the Vector.
- Returns the index of the listener in the Vector, or -1 if
the listener is not contained in the Vector.
getEntry
public Entry getEntry()
Returns the Entry this completion is attached to.
getEventListenerClass
public Class getEventListenerClass(String signal)
- getEventListenerClass in interface GObject
getEventType
public EventType getEventType(String signal)
- getEventType in interface GObject
getInlineCompletion
public boolean getInlineCompletion()
Returns whether the common prefix of the possible completion should
be automatically inserted into the entry.
getMinimumKeyLength
public int getMinimumKeyLength()
Returns the minimum key length as set for completion.
getModel
public TreeModel getModel()
Returns the model that the EntryCompletion is using as a data
source.
getPopupCompletion
public boolean getPopupCompletion()
Returns whether the completion should be presented in a popup window.
getTextColumn
public int getTextColumn()
Returns the column in the model of completion to get strings from.
gtk_entry_completion_complete
protected static final void gtk_entry_completion_complete(Handle completion)
gtk_entry_completion_delete_action
protected static final void gtk_entry_completion_delete_action(Handle completion,
int index)
gtk_entry_completion_get_entry
protected static final Handle gtk_entry_completion_get_entry(Handle completion)
gtk_entry_completion_get_inline_completion
protected static final boolean gtk_entry_completion_get_inline_completion(Handle completion)
gtk_entry_completion_get_minimum_key_length
protected static final int gtk_entry_completion_get_minimum_key_length(Handle completion)
gtk_entry_completion_get_model
protected static final Handle gtk_entry_completion_get_model(Handle completion)
gtk_entry_completion_get_popup_completion
protected static final boolean gtk_entry_completion_get_popup_completion(Handle completion)
gtk_entry_completion_get_text_column
protected static final int gtk_entry_completion_get_text_column(Handle completion)
gtk_entry_completion_get_type
protected static final int gtk_entry_completion_get_type()
gtk_entry_completion_insert_action_markup
protected static final void gtk_entry_completion_insert_action_markup(Handle completion,
int index,
String markup)
gtk_entry_completion_insert_action_text
protected static final void gtk_entry_completion_insert_action_text(Handle completion,
int index,
String text)
gtk_entry_completion_insert_prefix
protected static final void gtk_entry_completion_insert_prefix(Handle completion)
gtk_entry_completion_new
protected static final Handle gtk_entry_completion_new()
gtk_entry_completion_set_inline_completion
protected static final void gtk_entry_completion_set_inline_completion(Handle completion,
boolean inline)
gtk_entry_completion_set_minimum_key_length
protected static final void gtk_entry_completion_set_minimum_key_length(Handle completion,
int length)
gtk_entry_completion_set_model
protected static final void gtk_entry_completion_set_model(Handle completion,
Handle model)
gtk_entry_completion_set_popup_completion
protected static final void gtk_entry_completion_set_popup_completion(Handle completion,
boolean popup)
gtk_entry_completion_set_text_column
protected static final void gtk_entry_completion_set_text_column(Handle completion,
int column)
insertActionMarkup
public void insertActionMarkup(int index,
String markup)
Inserts an action in the EntryCompletion's action list with the
position and text provided. If this item is selected an event
will be triggered of type ACTION_ACTIVATED. You can get the
index value from the EntryCompletionEvent object.
index
- markup
-
insertActionText
public void insertActionText(int index,
String text)
Inserts an action in the EntryCompletion's action list with the
position and text provided. If this item is selected an event
will be triggered of type ACTION_ACTIVATED. You can get the
index value from the EntryCompletionEvent object.
index
- text
-
insertPrefix
public void insertPrefix()
Request a prefix insertion.
setInlineCompletion
public void setInlineCompletion(boolean inlineCompletion)
Sets whether the common prefix of the possible completion should be
automatically inserted into the entry.
inlineCompletion
-
setMinimumKeyLength
public void setMinimumKeyLength(int length)
Requires the length of the search key for the EntryCompletion to be
at least length. This is useful for long lists where completing
using a small key takes a lot of time and will come up with meaningless
results.
length
-
setModel
public void setModel(TreeModel model)
Sets the model for this EntryCompletion. If there is already
a model set it will remove it before setting the new mode.
model
-
setPopupCompletion
public void setPopupCompletion(boolean popupCompletion)
Sets whether the completion should be presented in a popup window.
popupCompletion
-
setTextColumn
public void setTextColumn(int column)
Specify which column in the model to use to display the strings.
column
-