SourceCompletion

Description

class SourceCompletion : ObjectGtk {}

Constructors

this
this(GtkSourceCompletion* gtkSourceCompletion)

Sets our main struct and passes it to the parent class

Members

Functions

addOnActivateProposal
void addOnActivateProposal(void delegate(SourceCompletion) dlg, ConnectFlags connectFlags)

The ::activate-proposal signal is a keybinding signal which gets emitted when the user initiates a proposal activation. Applications should not connect to it, but may emit it with g_signal_emit_by_name if they need to control the proposal activation programmatically.

addOnHide
void addOnHide(void delegate(SourceCompletion) dlg, ConnectFlags connectFlags)

Emitted when the completion window is hidden. The default handler will actually hide the window.

addOnMoveCursor
void addOnMoveCursor(void delegate(GtkScrollStep, gint, SourceCompletion) dlg, ConnectFlags connectFlags)

The ::move-cursor signal is a keybinding signal which gets emitted when the user initiates a cursor movement. Applications should not connect to it, but may emit it with g_signal_emit_by_name if they need to control the cursor programmatically.

addOnMovePage
void addOnMovePage(void delegate(GtkScrollStep, gint, SourceCompletion) dlg, ConnectFlags connectFlags)

The ::move-page signal is a keybinding signal which gets emitted when the user initiates a page movement (i.e. switches between provider pages). Applications should not connect to it, but may emit it with g_signal_emit_by_name if they need to control the page selection programmatically.

addOnPopulateContext
void addOnPopulateContext(void delegate(SourceCompletionContext, SourceCompletion) dlg, ConnectFlags connectFlags)

Emitted just before starting to populate the completion with providers. You can use this signal to add additional attributes in the context.

addOnShow
void addOnShow(void delegate(SourceCompletion) dlg, ConnectFlags connectFlags)

Emitted when the completion window is shown. The default handler will actually show the window.

addProvider
int addProvider(SourceCompletionProviderIF provider)

Add a new GtkSourceCompletionProvider to the completion object. This will add a reference provider, so make sure to unref your own copy when you no longer need it.

blockInteractive
void blockInteractive()
createContext
SourceCompletionContext createContext(TextIter position)

Create a new GtkSourceCompletionContext for completion. The position at which the completion using the new context will consider completion can be provider by position. If position is NULL, the current cursor position will be used.

getInfoWindow
SourceCompletionInfo getInfoWindow()

The info widget is the window where the completion displays optional extra information of the proposal.

getProviders
ListG getProviders()

Get list of providers registered on completion. The returned list is owned by the completion and should not be freed.

getSourceCompletionStruct
GtkSourceCompletion* getSourceCompletionStruct()
Undocumented in source. Be warned that the author may not have intended to support it.
getStruct
void* getStruct()

the main Gtk struct as a void*

getView
SourceView getView()

The GtkSourceView associated with completion.

hide
void hide()

Hides the completion if it is active (visible).

moveWindow
void moveWindow(TextIter iter)

Move the completion window to a specific iter.

removeProvider
int removeProvider(SourceCompletionProviderIF provider)

Remove provider from the completion.

setStruct
void setStruct(GObject* obj)
Undocumented in source. Be warned that the author may not have intended to support it.
show
int show(ListG providers, SourceCompletionContext context)

Starts a new completion with the specified GtkSourceCompletionContext and a list of potential candidate providers for completion.

unblockInteractive
void unblockInteractive()

Static functions

callBackActivateProposal
void callBackActivateProposal(GtkSourceCompletion* completionStruct, SourceCompletion _sourceCompletion)
Undocumented in source. Be warned that the author may not have intended to support it.
callBackHide
void callBackHide(GtkSourceCompletion* completionStruct, SourceCompletion _sourceCompletion)
Undocumented in source. Be warned that the author may not have intended to support it.
callBackMoveCursor
void callBackMoveCursor(GtkSourceCompletion* completionStruct, GtkScrollStep step, gint num, SourceCompletion _sourceCompletion)
Undocumented in source. Be warned that the author may not have intended to support it.
callBackMovePage
void callBackMovePage(GtkSourceCompletion* completionStruct, GtkScrollStep step, gint num, SourceCompletion _sourceCompletion)
Undocumented in source. Be warned that the author may not have intended to support it.
callBackPopulateContext
void callBackPopulateContext(GtkSourceCompletion* completionStruct, GtkSourceCompletionContext* context, SourceCompletion _sourceCompletion)
Undocumented in source. Be warned that the author may not have intended to support it.
callBackShow
void callBackShow(GtkSourceCompletion* completionStruct, SourceCompletion _sourceCompletion)
Undocumented in source. Be warned that the author may not have intended to support it.

Variables

connectedSignals
int[string] connectedSignals;
gtkSourceCompletion
GtkSourceCompletion* gtkSourceCompletion;

the main Gtk struct

onActivateProposalListeners
void delegate(SourceCompletion)[] onActivateProposalListeners;
Undocumented in source.
onHideListeners
void delegate(SourceCompletion)[] onHideListeners;
Undocumented in source.
onMoveCursorListeners
void delegate(GtkScrollStep, gint, SourceCompletion)[] onMoveCursorListeners;
Undocumented in source.
onMovePageListeners
void delegate(GtkScrollStep, gint, SourceCompletion)[] onMovePageListeners;
Undocumented in source.
onPopulateContextListeners
void delegate(SourceCompletionContext, SourceCompletion)[] onPopulateContextListeners;
Undocumented in source.
onShowListeners
void delegate(SourceCompletion)[] onShowListeners;
Undocumented in source.

Inherited Members

From ObjectGtk

gtkObject
GtkObject* gtkObject;

the main Gtk struct

getObjectGtkStruct
GtkObject* getObjectGtkStruct()
Undocumented in source. Be warned that the author may not have intended to support it.
getStruct
void* getStruct()

the main Gtk struct as a void*

setStruct
void setStruct(GObject* obj)
Undocumented in source. Be warned that the author may not have intended to support it.
getId
string getId(StockID id)
connectedSignals
int[string] connectedSignals;
onDestroyListeners
void delegate(ObjectGtk)[] onDestroyListeners;
Undocumented in source.
addOnDestroy
void addOnDestroy(void delegate(ObjectGtk) dlg, ConnectFlags connectFlags)

Signals that all holders of a reference to the GtkObject should release the reference that they hold. May result in finalization of the object if all references are released. See Also GObject

callBackDestroy
void callBackDestroy(GtkObject* objectStruct, ObjectGtk _objectGtk)
Undocumented in source. Be warned that the author may not have intended to support it.
sink
void sink()

Warning gtk_object_sink has been deprecated since version 2.10 and should not be used in newly-written code. Use g_object_ref_sink() instead Removes the floating reference from a GtkObject, if it exists; otherwise does nothing. See the GtkObject overview documentation at the top of the page.

weakref
void weakref(GDestroyNotify notify, void* data)

Warning gtk_object_weakref is deprecated and should not be used in newly-written code. Use g_object_weak_ref() instead. Adds a weak reference callback to an object. Weak references are used for notification when an object is finalized. They are called "weak references" because they allow you to safely hold a pointer to an object without calling g_object_ref() (g_object_ref() adds a strong reference, that is, forces the object to stay alive).

weakunref
void weakunref(GDestroyNotify notify, void* data)

Warning gtk_object_weakunref is deprecated and should not be used in newly-written code. Use g_object_weak_unref() instead. Removes a weak reference callback to an object.

destroy
void destroy()

Warning gtk_object_destroy has been deprecated since version 2.24 and should not be used in newly-written code. Use gtk_widget_destroy() instead (if object is a widget) Emits the "destroy" signal notifying all reference holders that they should release the GtkObject. See the overview documentation at the top of the page for more details. The memory for the object itself won't be deleted until its reference count actually drops to 0; gtk_object_destroy() merely asks reference holders to release their references, it does not free the object.

removeNoNotify
void removeNoNotify(string key)

Warning gtk_object_remove_no_notify is deprecated and should not be used in newly-written code. Use g_object_steal_data() instead. Remove a specified datum from the object's data associations (the object_data), without invoking the association's destroy handler. Just like gtk_object_remove_data() except that any destroy handler will be ignored. Therefore this only affects data set using gtk_object_set_data_full().

setUserData
void setUserData(void* data)

Warning gtk_object_set_user_data is deprecated and should not be used in newly-written code. Use g_object_set_data() instead. For convenience, every object offers a generic user data pointer. This function sets it.

getUserData
void* getUserData()

Warning gtk_object_get_user_data is deprecated and should not be used in newly-written code. Use g_object_get_data() instead. Get the object's user data pointer. This is intended to be a pointer for your convenience in writing applications.

addArgType
void addArgType(string argName, GType argType, uint argFlags, uint argId)

Warning gtk_object_add_arg_type is deprecated and should not be used in newly-written code. Deprecated in favor of the GObject property system including GParamSpec. Add a new type of argument to an object class. Usually this is called when registering a new type of object.

setDataById
void setDataById(GQuark dataId, void* data)

Warning gtk_object_set_data_by_id is deprecated and should not be used in newly-written code. Use g_object_set_qdata() instead. Just like gtk_object_set_data() except that it takes a GQuark instead of a string, so it is slightly faster. Use gtk_object_data_try_key() and gtk_object_data_force_id() to get an id from a string.

setDataByIdFull
void setDataByIdFull(GQuark dataId, void* data, GDestroyNotify destroy)

Warning gtk_object_set_data_by_id_full is deprecated and should not be used in newly-written code. Use g_object_set_qdata_full() instead. Just like gtk_object_set_data_full() except that it takes a GQuark instead of a string, so it is slightly faster. Use gtk_object_data_try_key() and gtk_object_data_force_id() to get an id from a string.

getDataById
void* getDataById(GQuark dataId)

Warning gtk_object_get_data_by_id is deprecated and should not be used in newly-written code. Use g_object_get_qdata() instead. Just like gtk_object_get_data() except that it takes a GQuark instead of a string, so it is slightly faster. Use gtk_object_data_try_key() and gtk_object_data_force_id() to get an id from a string.

removeDataById
void removeDataById(GQuark dataId)

Warning gtk_object_remove_data_by_id is deprecated and should not be used in newly-written code. Use g_object_set_qdata() with data of NULL instead. Just like gtk_object_remove_data() except that it takes a GQuark instead of a string, so it is slightly faster. Remove a specified datum from the object's data associations. Subsequent calls to gtk_object_get_data() will return NULL. Use gtk_object_data_try_key() and gtk_object_data_force_id() to get an id from a string.

removeNoNotifyById
void removeNoNotifyById(GQuark keyId)

Warning gtk_object_remove_no_notify_by_id is deprecated and should not be used in newly-written code. Use g_object_steal_qdata() instead. Just like gtk_object_remove_no_notify() except that it takes a GQuark instead of a string, so it is slightly faster. Use gtk_object_data_try_key() and gtk_object_data_force_id() to get an id from a string.

Meta