GtkIMContextClass

struct GtkIMContextClass {}

Members

Variables

GtkReserved2
void function() GtkReserved2;
GtkReserved3
void function() GtkReserved3;
GtkReserved4
void function() GtkReserved4;
activateOsk
void function(GtkIMContext* context) activateOsk;
activateOskWithEvent
bool function(GtkIMContext* context, GdkEvent* event) activateOskWithEvent;
commit
void function(GtkIMContext* context, const(char)* str) commit;

Default handler of the gtk.imcontext.IMContext.commit signal.

deleteSurrounding
bool function(GtkIMContext* context, int offset, int nChars) deleteSurrounding;

Default handler of the signal@Gtk.IMContext::delete-surrounding signal.

filterKeypress
bool function(GtkIMContext* context, GdkEvent* event) filterKeypress;

Called via gtk.imcontext.IMContext.filterKeypress on every key press or release event. Every non-trivial input method needs to override this in order to implement the mapping from key events to text. A return value of true indicates to the caller that the event was consumed by the input method. In that case, the gtk.imcontext.IMContext.commit signal should be emitted upon completion of a key sequence to pass the resulting text back to the input widget. Alternatively, false may be returned to indicate that the event wasn’t handled by the input method. If a builtin mapping exists for the key, it is used to produce a character.

focusIn
void function(GtkIMContext* context) focusIn;

Called via gtk.imcontext.IMContext.focusIn when the input widget has gained focus. May be overridden to keep track of the current focus.

focusOut
void function(GtkIMContext* context) focusOut;

Called via gtk.imcontext.IMContext.focusOut when the input widget has lost focus. May be overridden to keep track of the current focus.

getPreeditString
void function(GtkIMContext* context, char** str, PangoAttrList** attrs, int* cursorPos) getPreeditString;

Called via gtk.imcontext.IMContext.getPreeditString to retrieve the text currently being preedited for display at the cursor position. Any input method which composes complex characters or any other compositions from multiple sequential key presses should override this method to provide feedback.

getSurrounding
bool function(GtkIMContext* context, char** text, int* cursorIndex) getSurrounding;

Called via gtk.imcontext.IMContext.getSurrounding to update the context around the cursor location. It is not necessary to override this method even with input methods which implement context-dependent behavior. The base implementation emits signal@Gtk.IMContext::retrieve-surrounding and records the context received by the subsequent invocation of vfunc@Gtk.IMContext.get_surrounding.

getSurroundingWithSelection
bool function(GtkIMContext* context, char** text, int* cursorIndex, int* anchorIndex) getSurroundingWithSelection;

Called via gtk.imcontext.IMContext.getSurroundingWithSelection to update the context around the cursor location. It is not necessary to override this method even with input methods which implement context-dependent behavior. The base implementation emits signal@Gtk.IMContext::retrieve-surrounding and records the context received by the subsequent invocation of vfunc@Gtk.IMContext.get_surrounding.

parentClass
GObjectClass parentClass;
preeditChanged
void function(GtkIMContext* context) preeditChanged;

Default handler of the signal@Gtk.IMContext::preedit-changed signal.

preeditEnd
void function(GtkIMContext* context) preeditEnd;

Default handler of the signal@Gtk.IMContext::preedit-end signal.

preeditStart
void function(GtkIMContext* context) preeditStart;

Default handler of the signal@Gtk.IMContext::preedit-start signal.

reset
void function(GtkIMContext* context) reset;

Called via gtk.imcontext.IMContext.reset to signal a change such as a change in cursor position. An input method that implements preediting should override this method to clear the preedit state on reset.

retrieveSurrounding
bool function(GtkIMContext* context) retrieveSurrounding;

Default handler of the signal@Gtk.IMContext::retrieve-surrounding signal.

setClientWidget
void function(GtkIMContext* context, GtkWidget* widget) setClientWidget;

Called via gtk.imcontext.IMContext.setClientWidget when the input window where the entered text will appear changes. Override this to keep track of the current input window, for instance for the purpose of positioning a status display of your input method.

setCursorLocation
void function(GtkIMContext* context, GdkRectangle* area) setCursorLocation;

Called via gtk.imcontext.IMContext.setCursorLocation to inform the input method of the current cursor location relative to the client window. May be overridden to implement the display of popup windows at the cursor position.

setSurrounding
void function(GtkIMContext* context, const(char)* text, int len, int cursorIndex) setSurrounding;

Called via gtk.imcontext.IMContext.setSurrounding in response to signal@Gtk.IMContext::retrieve-surrounding signal to update the input method’s idea of the context around the cursor. It is not necessary to override this method even with input methods which implement context-dependent behavior. The base implementation is sufficient for gtk.imcontext.IMContext.getSurrounding to work.

setSurroundingWithSelection
void function(GtkIMContext* context, const(char)* text, int len, int cursorIndex, int anchorIndex) setSurroundingWithSelection;

Called via gtk.imcontext.IMContext.setSurroundingWithSelection in response to the signal@Gtk.IMContext::retrieve-surrounding signal to update the input method’s idea of the context around the cursor. It is not necessary to override this method even with input methods which implement context-dependent behavior. The base implementation is sufficient for gtk.imcontext.IMContext.getSurrounding to work.

setUsePreedit
void function(GtkIMContext* context, bool usePreedit) setUsePreedit;

Called via gtk.imcontext.IMContext.setUsePreedit to control the use of the preedit string. Override this to display feedback by some other means if turned off.