IMMulticontext

Description

Constructors

this
this(GtkIMMulticontext* gtkIMMulticontext)

Sets our main struct and passes it to the parent class

Members

Functions

appendMenuitems
void appendMenuitems(MenuShell menushell)

Add menuitems for various available input methods to a menu; the menuitems, when selected, will switch the input method for the context and the global default input method.

getContextId
string getContextId()

Gets the id of the currently active slave of the context. Since 2.16

getIMMulticontextStruct
GtkIMMulticontext* getIMMulticontextStruct()
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*

setContextId
void setContextId(string contextId)

Sets the context id for context. This causes the currently active slave of context to be replaced by the slave corresponding to the new context id. Since 2.16

setStruct
void setStruct(GObject* obj)
Undocumented in source. Be warned that the author may not have intended to support it.

Static functions

newIMMulticontext
IMContext newIMMulticontext()

Creates a new GtkIMMulticontext.

Variables

gtkIMMulticontext
GtkIMMulticontext* gtkIMMulticontext;

the main Gtk struct

Inherited Members

From IMContext

gtkIMContext
GtkIMContext* gtkIMContext;

the main Gtk struct

getIMContextStruct
GtkIMContext* getIMContextStruct()
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.
connectedSignals
int[string] connectedSignals;
onCommitListeners
void delegate(string, IMContext)[] onCommitListeners;
Undocumented in source.
addOnCommit
void addOnCommit(void delegate(string, IMContext) dlg, ConnectFlags connectFlags)

The ::commit signal is emitted when a complete input sequence has been entered by the user. This can be a single character immediately after a key press or the final result of preediting.

callBackCommit
void callBackCommit(GtkIMContext* contextStruct, gchar* str, IMContext _iMContext)
Undocumented in source. Be warned that the author may not have intended to support it.
onDeleteSurroundingListeners
bool delegate(gint, gint, IMContext)[] onDeleteSurroundingListeners;
Undocumented in source.
addOnDeleteSurrounding
void addOnDeleteSurrounding(bool delegate(gint, gint, IMContext) dlg, ConnectFlags connectFlags)

The ::delete-surrounding signal is emitted when the input method needs to delete all or part of the context surrounding the cursor. TRUE if the signal was handled.

callBackDeleteSurrounding
gboolean callBackDeleteSurrounding(GtkIMContext* contextStruct, gint offset, gint nChars, IMContext _iMContext)
Undocumented in source. Be warned that the author may not have intended to support it.
onPreeditChangedListeners
void delegate(IMContext)[] onPreeditChangedListeners;
Undocumented in source.
addOnPreeditChanged
void addOnPreeditChanged(void delegate(IMContext) dlg, ConnectFlags connectFlags)

The ::preedit-changed signal is emitted whenever the preedit sequence currently being entered has changed. It is also emitted at the end of a preedit sequence, in which case gtk_im_context_get_preedit_string() returns the empty string.

callBackPreeditChanged
void callBackPreeditChanged(GtkIMContext* contextStruct, IMContext _iMContext)
Undocumented in source. Be warned that the author may not have intended to support it.
onPreeditEndListeners
void delegate(IMContext)[] onPreeditEndListeners;
Undocumented in source.
addOnPreeditEnd
void addOnPreeditEnd(void delegate(IMContext) dlg, ConnectFlags connectFlags)

The ::preedit-end signal is emitted when a preediting sequence has been completed or canceled.

callBackPreeditEnd
void callBackPreeditEnd(GtkIMContext* contextStruct, IMContext _iMContext)
Undocumented in source. Be warned that the author may not have intended to support it.
onPreeditStartListeners
void delegate(IMContext)[] onPreeditStartListeners;
Undocumented in source.
addOnPreeditStart
void addOnPreeditStart(void delegate(IMContext) dlg, ConnectFlags connectFlags)

The ::preedit-start signal is emitted when a new preediting sequence starts.

callBackPreeditStart
void callBackPreeditStart(GtkIMContext* contextStruct, IMContext _iMContext)
Undocumented in source. Be warned that the author may not have intended to support it.
onRetrieveSurroundingListeners
bool delegate(IMContext)[] onRetrieveSurroundingListeners;
Undocumented in source.
addOnRetrieveSurrounding
void addOnRetrieveSurrounding(bool delegate(IMContext) dlg, ConnectFlags connectFlags)

The ::retrieve-surrounding signal is emitted when the input method requires the context surrounding the cursor. The callback should set the input method surrounding context by calling the gtk_im_context_set_surrounding() method. TRUE if the signal was handled.

callBackRetrieveSurrounding
gboolean callBackRetrieveSurrounding(GtkIMContext* contextStruct, IMContext _iMContext)
Undocumented in source. Be warned that the author may not have intended to support it.
setClientWindow
void setClientWindow(Window window)

Set the client window for the input context; this is the GdkWindow in which the input appears. This window is used in order to correctly position status windows, and may also be used for purposes internal to the input method.

getPreeditString
void getPreeditString(string str, PangoAttrList* attrs, int cursorPos)

Retrieve the current preedit string for the input context, and a list of attributes to apply to the string. This string should be displayed inserted at the insertion point.

filterKeypress
int filterKeypress(GdkEventKey* event)

Allow an input method to internally handle key press and release events. If this function returns TRUE, then no further processing should be done for this key event.

focusIn
void focusIn()

Notify the input method that the widget to which this input context corresponds has gained focus. The input method may, for example, change the displayed feedback to reflect this change.

focusOut
void focusOut()

Notify the input method that the widget to which this input context corresponds has lost focus. The input method may, for example, change the displayed feedback or reset the contexts state to reflect this change.

reset
void reset()

Notify the input method that a change such as a change in cursor position has been made. This will typically cause the input method to clear the preedit state.

setCursorLocation
void setCursorLocation(Rectangle area)

Notify the input method that a change in cursor position has been made. The location is relative to the client window.

setUsePreedit
void setUsePreedit(int usePreedit)

Sets whether the IM context should use the preedit string to display feedback. If use_preedit is FALSE (default is TRUE), then the IM context may use some other method to display feedback, such as displaying it in a child of the root window.

setSurrounding
void setSurrounding(string text, int len, int cursorIndex)

Sets surrounding context around the insertion point and preedit string. This function is expected to be called in response to the GtkIMContext::retrieve_surrounding signal, and will likely have no effect if called at other times.

getSurrounding
int getSurrounding(string text, int cursorIndex)

Retrieves context around the insertion point. Input methods typically want context in order to constrain input text based on existing text; this is important for languages such as Thai where only some sequences of characters are allowed. This function is implemented by emitting the GtkIMContext::retrieve_surrounding signal on the input method; in response to this signal, a widget should provide as much context as is available, up to an entire paragraph, by calling gtk_im_context_set_surrounding(). Note that there is no obligation for a widget to respond to the ::retrieve_surrounding signal, so input methods must be prepared to function without context.

deleteSurrounding
int deleteSurrounding(int offset, int nChars)

Asks the widget that the input context is attached to to delete characters around the cursor position by emitting the GtkIMContext::delete_surrounding signal. Note that offset and n_chars are in characters not in bytes which differs from the usage other places in GtkIMContext. In order to use this function, you should first call gtk_im_context_get_surrounding() to get the current context, and call this function immediately afterwards to make sure that you know what you are deleting. You should also account for the fact that even if the signal was handled, the input context might not have deleted all the characters that were requested to be deleted. This function is used by an input method that wants to make subsitutions in the existing text in response to new input. It is not useful for applications.

Meta