diff options
| author | Simon McVittie <simon.mcvittie@collabora.co.uk> | 2010-08-12 13:36:25 +0100 |
|---|---|---|
| committer | Simon McVittie <simon.mcvittie@collabora.co.uk> | 2010-08-12 13:44:02 +0100 |
| commit | 0e7854c637287a3a2418540682e7c5f3e3ad80a6 (patch) | |
| tree | 8b57fc7da549475b1b2a4d3a5f0956dc43b37e4f /telepathy-glib/account-channel-request.c | |
| parent | b5a3c1de22416194ad21e10ab94fac2041e36679 (diff) | |
| download | telepathy-glib-0e7854c637287a3a2418540682e7c5f3e3ad80a6.tar.gz | |
Centralize user action time docs in TpAccountChannelRequest:user-action-time
Diffstat (limited to 'telepathy-glib/account-channel-request.c')
| -rw-r--r-- | telepathy-glib/account-channel-request.c | 20 |
1 files changed, 15 insertions, 5 deletions
diff --git a/telepathy-glib/account-channel-request.c b/telepathy-glib/account-channel-request.c index ac48c81e4..be73d51ce 100644 --- a/telepathy-glib/account-channel-request.c +++ b/telepathy-glib/account-channel-request.c @@ -305,10 +305,23 @@ tp_account_channel_request_class_init ( * values %TP_USER_ACTION_TIME_NOT_USER_ACTION or * %TP_USER_ACTION_TIME_CURRENT_TIME. * + * If %TP_USER_ACTION_TIME_NOT_USER_ACTION, the action doesn't involve any + * user action. Clients should avoid stealing focus when presenting the + * channel. + * + * If %TP_USER_ACTION_TIME_CURRENT_TIME, clients SHOULD behave as though the + * user action happened at the current time, e.g. a client may + * request that its window gains focus. + * * On X11-based systems, Gdk 2.x, Clutter 1.0 etc., * tp_user_action_time_from_x11() can be used to convert an X11 timestamp to * a Telepathy user action time. * + * If the channel request succeeds, this user action time will be passed on + * to the channel's handler. If the handler is a GUI, it may use + * tp_user_action_time_should_present() to decide whether to bring its + * window to the foreground. + * * Since: 0.11.12 */ param_spec = g_param_spec_int64 ("user-action-time", "user action time", @@ -324,7 +337,8 @@ tp_account_channel_request_class_init ( * @channel: the #TpChannel being re-handled * @user_action_time: the time at which user action occurred, or one of the * special values %TP_USER_ACTION_TIME_NOT_USER_ACTION or - * %TP_USER_ACTION_TIME_CURRENT_TIME + * %TP_USER_ACTION_TIME_CURRENT_TIME; see + * #TpAccountChannelRequest:user-action-time * @context: a #TpHandleChannelsContext representing the context of * the HandleChannels() call. * @@ -336,10 +350,6 @@ tp_account_channel_request_class_init ( * still exists. Instead of creating a new channel, the channel dispatcher * notifies the existing handler of @channel, resulting in this signal. * - * If the handler is a GUI, it may use @user_action_time and - * tp_user_action_time_should_present() to decide whether to bring its - * window to the foreground. - * * Since: 0.11.12 */ signals[SIGNAL_RE_HANDLED] = g_signal_new ( |