Back to Seed Clases

Gtk

Classes

Interfaces

Structs

Unions

DitherInfo

Enums

GObject.Object
parent-child marker Gtk.IMContext

Class Gtk.IMContext

Import line:	Gtk = imports.gi.Gtk;
GIR File:	Gtk-2.0.gir
C documentation:	GtkIMContext
Class :	IMContext
Extends:	GObject.Object
	Show / Hide Inherited methods, properties and signals

Properties
Properties		Defined By
	parent_instance : GObject.Object read only	Gtk.IMContext

Methods / Constructors
Method / Constructor		Defined By
	new Gtk.IMContext (Object *properties) Create a new Gtk.IMContext Create a new Gtk.IMContext Parameters: Object properties*
	delete_surrounding (Number *offset, Number n_chars) : Boolean Asks the widget that the input context is attached to to delete characters around the cursor position by emitting the GtkIMContext::delete_surrounding signal. 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. Parameters: Number offset Required (not null) a negative value means start before the cursor. Number n_chars Required (not null) Returns: Boolean	Gtk.IMContext
	filter_keypress (EventKey *event) : Boolean Allow an input method to internally handle key press and release events. 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. Parameters: Gdk.EventKey event* Required (not null) Returns: Boolean	Gtk.IMContext
	focus_in () : none Notify the input method that the widget to which this input context corresponds has gained focus. 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. Returns: none	Gtk.IMContext
	focus_out () : none Notify the input method that the widget to which this input context corresponds has lost focus. 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. Returns: none	Gtk.IMContext
	get_preedit_string (Array *str, AttrList attrs, Number cursor_pos) : none Retrieve the current preedit string for the input context, and a list of attributes to apply to the string. 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. Parameters: Array str* Required (not null) string retrieved must be freed with g_free (). Pango.AttrList attrs Required (not null) When you are done with this list, you must unreference it with pango_attr_list_unref(). Number cursor_pos Required (not null) within the preedit string. Returns: none	Gtk.IMContext
	get_surrounding (Array *text, Object out_values) : Boolean Retrieves context around the insertion point. 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. you must free the result stored in text. Parameters: Array text Required (not null) holding context around the insertion point. If the function returns TRUE, then you must free the result stored in this location with g_free(). Object out_values Number cursor_index Returns: Boolean	Gtk.IMContext
	reset () : none Notify the input method that a change such as a change in cursor position has been made. 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. Returns: none	Gtk.IMContext
	set_client_window (Window *window) : none Set the client window for the input context; this is the GdkWindow* in which the input appears. 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. Parameters: Gdk.Window window the client window. This may be NULL to indicate that the previous client window no longer exists. Returns: none	Gtk.IMContext
	set_cursor_location (Rectangle *area) : none Notify the input method that a change in cursor position has been made. Notify the input method that a change in cursor position has been made. The location is relative to the client window. Parameters: Gdk.Rectangle area* Required (not null) Returns: none	Gtk.IMContext
	set_surrounding (String *text, Number len, Number cursor_index) : none Sets surrounding context around the insertion point and preedit string. 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. Parameters: String text* Required (not null) the preedit string should not be included within Number len Required (not null) Number cursor_index Required (not null) Returns: none	Gtk.IMContext
	set_use_preedit (Boolean *use_preedit) : none Sets whether the IM context should use the preedit string to display feedback. 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. Parameters: Boolean use_preedit Required (not null) Returns: none	Gtk.IMContext

Events - usage syntax: this.signals.EVENTNAME.connect( Function )
Event		Defined By
	commit (IMContext *self, String str) : none The ::commit signal is emitted when a complete input sequence has been entered by the user. 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. Parameters: Gtk.IMContext self* String str Returns: {none}	Gtk.IMContext
	delete_surrounding (IMContext *self, Number offset, Number n_chars) : Boolean The ::delete-surrounding signal is emitted when the input method needs to delete all or part of the context surrounding the cursor. The ::delete-surrounding signal is emitted when the input method needs to delete all or part of the context surrounding the cursor. Parameters: Gtk.IMContext self* Number offset Number n_chars Returns: {Boolean}	Gtk.IMContext
	preedit_changed (IMContext *self) : none The ::preedit-changed signal is emitted whenever the preedit sequence currently being entered has changed. 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. Parameters: Gtk.IMContext self* Returns: {none}	Gtk.IMContext
	preedit_end (IMContext *self) : none The ::preedit-end signal is emitted when a preediting sequence has been completed or canceled. The ::preedit-end signal is emitted when a preediting sequence has been completed or canceled. Parameters: Gtk.IMContext self* Returns: {none}	Gtk.IMContext
	preedit_start (IMContext *self) : none The ::preedit-start signal is emitted when a new preediting sequence starts. The ::preedit-start signal is emitted when a new preediting sequence starts. Parameters: Gtk.IMContext self* Returns: {none}	Gtk.IMContext
	retrieve_surrounding (IMContext *self) : Boolean The ::retrieve-surrounding signal is emitted when the input method requires the context surrounding the cursor. 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. Parameters: Gtk.IMContext self* Returns: {Boolean}	Gtk.IMContext

Used by These Methods / Signals / Properties
Class / Namespace	Method / Signal / Properties
WebKit.WebView Property	im_context : Gtk.IMContext read only

Documentation generated by Introspection Doc Generator Loosely Based on JsDoc Toolkit on Tue Jun 22 2010 16:34:18 GMT+0800 (HKT)