libgxim Reference Manual | ||||
---|---|---|---|---|
Top | Description | Object Hierarchy | Properties | Signals |
#define GXC_ESTABLISHED #define GXC_NEGOTIATING #define GXC_NONE GXimClientTemplate; struct GXimClientTemplateClass; enum GXimClientTemplateError; #define G_XIM_CL_TMPL_ERROR gboolean g_xim_cl_tmpl_connect_to_server (GXimClientTemplate *cltmpl
,GError **error
); GQuark g_xim_cl_tmpl_get_error_quark (void
); gboolean g_xim_cl_tmpl_is_initialized (GXimClientTemplate *cltmpl
); gboolean g_xim_cl_tmpl_is_pending_negotiation (GXimClientTemplate *cltmpl
); gboolean g_xim_cl_tmpl_send_selection_request (GXimClientTemplate *cltmpl
,GdkAtom atom
,GError **error
); gboolean g_xim_cl_tmpl_start_negotiation (GXimClientTemplate *cltmpl
,GError **error
);
GXimClientTemplate provides a common facility to deal with XIM protocol events, particularly to be working on XIM client.
#define GXC_ESTABLISHED 2
the connection has been established and ready to do something with XIM protocol.
#define GXC_NEGOTIATING 1
a statte that is negotiating the connection to XIM server.
typedef struct _GXimClientTemplate GXimClientTemplate;
An implementation of XIM client class
typedef enum { G_XIM_CL_TMPL_ERROR_BEGIN = 128, G_XIM_CL_TMPL_ERROR_INVALID_CONNECTION_TYPE, } GXimClientTemplateError;
Error codes returned by GXimClientTemplate functions.
Unused. | |
The connection type isn't inherited from GXimConnection. |
#define G_XIM_CL_TMPL_ERROR (g_xim_cl_tmpl_get_error_quark())
Error domain for GXimClientTemplate. Errors in this domain will be from the GXimClientTemplateError or GXimStandardError enumeration. See GError for more information on error domains.
gboolean g_xim_cl_tmpl_connect_to_server (GXimClientTemplate *cltmpl
,GError **error
);
Connects to XIM server. you have to call this function before doing something with XIM protocols.
|
a GXimClientTemplate. |
|
a location to store error, or NULL . |
Returns : |
TRUE to be starting the negotiation to be connected successfully. |
gboolean g_xim_cl_tmpl_is_initialized (GXimClientTemplate *cltmpl
);
Checks if an instance of cltmpl
is ready to process XIM protocols.
|
a GXimClientTemplate. |
Returns : |
TRUE to be initialized the instance properly. |
gboolean g_xim_cl_tmpl_is_pending_negotiation
(GXimClientTemplate *cltmpl
);
Checks if an instance of cltmpl
is waiting for finish the negotiation.
|
a GXimClientTemplate. |
Returns : |
TRUE to be pending in any negotiation state. |
gboolean g_xim_cl_tmpl_send_selection_request (GXimClientTemplate *cltmpl
,GdkAtom atom
,GError **error
);
Sends a request of atom
to the XIM server with SelectionRequest
event.
|
a GXimClientTemplate. |
|
a GdkAtom to determine which request would be sent. |
|
a location to store error, or NULL . |
Returns : |
TRUE to be sent a request successfully. |
gboolean g_xim_cl_tmpl_start_negotiation (GXimClientTemplate *cltmpl
,GError **error
);
Starts the transaction to negotiate a connection between XIM server and the client.
This is a convenience function to send a request with
g_xim_cl_tmpl_send_selection_request()
.
|
a GXimClientTemplate. |
|
a location to store error, or NULL . |
Returns : |
TRUE to be sent a request for first negotiation successfully. |
"atom-server"
property "atom-server" gpointer : Read / Write / Construct Only
the GdkAtom where the client instance should connects to. the atom
name would be something what you specify with XMODIFIERS=im
=.
"notify-locales"
signalvoid user_function (GXimClientTemplate *cltmpl,
GStrv locales,
gpointer user_data) : Run First
The ::notify-locales signal will be emitted when the cltmpl
received
a reply of acquiring the supported locales in XIM server.
This is a convenience signal to deal with
"selection-notify-event" for a reply of LOCALES
request.
|
the object which received the signal. |
|
an array of the string contains the locale names with
NULL -terminated. |
|
user data set when the signal handler was connected. |
"notify-transport"
signalvoid user_function (GXimClientTemplate *cltmpl,
GStrv transport,
gpointer user_data) : Run First
The ::notify-transport signal will be emitted when the cltmpl
received a reply of acquiring the supported transport-specific names
in XIM server.
This is a convenience signal to deal with
"selection-notify-event" for a reply of TRANSPORT
request.
|
the object which received the signal. |
|
an array of the string contains the transport-specific
names with NULL -terminated. |
|
user data set when the signal handler was connected. |
"xconnect"
signalgboolean user_function (GXimClientTemplate *cltmpl,
GdkEvent *event,
gpointer user_data) : Run Last
The ::xconnect signal will be emitted when XIM_XCONNECT
event is
dispatched from the XIM server in order to respond to XIM_XCONNECT
event from the client.
See The Input Method Protocol, XIM specification document for more
details about XIM_XCONNECT
.
|
the object which received the signal. |
|
the GdkEventClient which triggered this signal. |
|
user data set when the signal handler was connected. |
Returns : |
TRUE to stop other handlers from being invoked for
the event. FALSE to propagate the event further. |