SCIM Bridge 0.4.x

◆ get_surrounding_string()

virtual retval_t ScimBridgeAgentClientListener::get_surrounding_string ( scim_bridge_imcontext_id_t imcontext_id,
int before_max,
int after_max,
scim::WideString & wstring,
int & cursor_position )
pure virtual

Get the surrounding string of the preedit cursor.

@parm imcontext_id The id of the IMContext.

Parameters
before_maxThe maximum characters (in wstr) to fetch before the cursor.
before_maxThe maximum characters (in wstr) to fetch after the cursor.
wstringThe surrounding string.
cursor_positionThe cursor position in the preedit string gotten by this function.
Returns
REVAL_FAILED when a serious error has occurred, or RETVAL_IGNORED if an timeout has happened. Otherwise it returns RETVAL_SUCCEEDED.