libgxim Reference Manual | ||||
---|---|---|---|---|
Top | Description | Object Hierarchy | Properties | Signals |
GXimCore; struct GXimCoreClass; #define G_XIM_CORE_ERROR void g_xim_core_add_client_message_filter (GXimCore *core
,GdkAtom atom
); GType g_xim_core_get_connection_gtype (GXimCore *core
); GdkDisplay * g_xim_core_get_display (GXimCore *core
); GQuark g_xim_core_get_error_quark (void
); GSList * g_xim_core_get_protocol_signal_connector (GXimCore *core
); GdkWindow * g_xim_core_get_selection_window (GXimCore *core
); gboolean g_xim_core_lookup_client_message_filter (GXimCore *core
,GdkAtom atom
); void g_xim_core_remove_client_message_filter (GXimCore *core
,GdkAtom atom
); void g_xim_core_setup_connection (GXimCore *core
,GXimConnection *conn
); void g_xim_core_unwatch_event (GXimCore *core
,GdkWindow *window
); void g_xim_core_watch_event (GXimCore *core
,GdkWindow *window
);
"connection-gtype" GType* : Read / Write / Construct Only "display" GdkDisplay* : Read / Write / Construct Only "proto-signals" gpointer : Read / Write "selection-window" GdkWindow* : Read
"client-event" :Run Last
"destroy-event" :Run Last
"expose-event" :Run Last
"selection-clear-event" :Run Last
"selection-notify-event" :Run Last
"selection-request-event" :Run Last
GXimCore provides a common functionality to deal with XIM protocol for both server side and client side. You usually don't need to use most functions described here because any chance to do something with them is well hidden by the higher-level APIs, except if you want to make any classes that inherited from GXimCore, or to do any particular thing with them.
typedef struct _GXimCore GXimCore;
An abstract implementation of XIM protocol event handling class.
#define G_XIM_CORE_ERROR g_xim_core_get_error_quark()
G_XIM_CORE_ERROR
is deprecated and should not be used in newly-written code.
void g_xim_core_add_client_message_filter (GXimCore *core
,GdkAtom atom
);
Deals with the event when atom
is specified as the message_type in
"client-event".
GType g_xim_core_get_connection_gtype (GXimCore *core
);
Obtains a GType of the class inherited from GXimConnection. This function is typically used to create an instance of the connection.
|
a GXimCore |
Returns : |
"connection-gtype" in core . |
GdkDisplay * g_xim_core_get_display (GXimCore *core
);
Obtains the GdkDisplay that currently use.
|
a GXimCore |
Returns : |
a display to use. |
GQuark g_xim_core_get_error_quark (void
);
g_xim_core_get_error_quark
is deprecated and should not be used in newly-written code.
GSList * g_xim_core_get_protocol_signal_connector
(GXimCore *core
);
Obtains a list of the signal callbacks. This function is typically used to initialize the signal connectioon after creating an instance of the connection.
|
a GXimCore |
Returns : |
a list of GXimLazySignalConnector. |
GdkWindow * g_xim_core_get_selection_window (GXimCore *core
);
Obtains a selection window. this function may be necessary when you want to communicate the XIM server or clients through XIM protocol.
|
a GXimCore |
Returns : |
"selection-window" in core . |
gboolean g_xim_core_lookup_client_message_filter (GXimCore *core
,GdkAtom atom
);
Looks up atom
if it's registered to deal with it in "client-event".
void g_xim_core_remove_client_message_filter (GXimCore *core
,GdkAtom atom
);
Removes atom
from the table and the event filter won't deals with it
even when it's specified to the message_type in "client-event".
void g_xim_core_setup_connection (GXimCore *core
,GXimConnection *conn
);
Initialize a conn
's connection to get it working.
|
a GXimCore |
|
a GXimConnection to be initialized |
void g_xim_core_unwatch_event (GXimCore *core
,GdkWindow *window
);
Removes the event filter from window
and finishes watching events at core
.
This has to be done after finishing the protocol connection.
otherwise some events will be lost and another application may be frozen
in worst case.
void g_xim_core_watch_event (GXimCore *core
,GdkWindow *window
);
Adds the event filter to window
and catches up events with core
's event
handler. This has to be done before starting the protocol negotiation.
otherwise it will be lost and another application may be frozen in worst case.
"connection-gtype"
property "connection-gtype" GType* : Read / Write / Construct Only
a GType inherited from GXimConnection. this will be a instance and determines the connection type when the connection is requested.
Allowed values: GXimConnection
"proto-signals"
property "proto-signals" gpointer : Read / Write
a set of GXimLazySignalConnector to connect signals to a instance of "connection-gtype" when the connection is negothating.
"client-event"
signalgboolean user_function (GXimCore *core,
GdkEvent *event,
gpointer user_data) : Run Last
The ::client-event signal will be emitted when the core
's window
receives a message (via ClientMessage event) from another application.
all of XIM protocol is delivered with this signal.
|
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. |
"destroy-event"
signalgboolean user_function (GXimCore *core,
GdkEvent *event,
gpointer user_data) : Run Last
The ::destroy-event signal will be emitted when a GdkWindow is destroyed. typically you will see that when the client connection is disconnected from the client side.
|
the object which received the signal. |
|
the GdkEvent 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. |
"expose-event"
signalgboolean user_function (GXimCore *gximcore,
GdkEvent *arg1,
gpointer user_data) : Run Last
|
the object which received the signal. |
|
user data set when the signal handler was connected. |
"selection-clear-event"
signalgboolean user_function (GXimCore *core,
GdkEvent *event,
gpointer user_data) : Run Last
The ::selection-clear-event signal will be emitted when the
core
's window has lost ownership of a selection. this signal
won't appears in the client instance, such as inherited from
GXimClientTemplate.
|
the object which received the signal. |
|
the GdkEventSelection 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. |
"selection-notify-event"
signalgboolean user_function (GXimCore *core,
GdkEvent *event,
gpointer user_data) : Run Last
The ::selection-notify-event signal will be emitted when the the XIM server responded requests to get the supported locales and the transport-specific names. this signal won't appears in the server instance, such as inherited from GXimServerTemplate.
|
the object which received the signal. |
|
the GdkEventSelection 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. |
"selection-request-event"
signalgboolean user_function (GXimCore *core,
GdkEvent *event,
gpointer user_data) : Run Last
The ::selection-request-event signal will be emitted when the client applications requests a set of names of the supported locales and the preregistered formats for transport-specific names. this signal won't appears in the client instance, such as inherited from GXimClientTemplate.
|
the object which received the signal. |
|
the GdkEventSelection 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. |