Mercurial > pidgin
view src/protocols/novell/nmrequest.h @ 12116:e75ef7aa913e
[gaim-migrate @ 14416]
" This patch implements a replacement for the queuing
system from 1.x. It also obsoletes a previous patch
[#1338873] I submitted to prioritize the unseen states
in gtk conversations.
The attached envelope.png is ripped from the
msgunread.png already included in gaim. It should be
dropped in the pixmaps directory (Makefile.am is
updated accordingly in this patch).
The two separate queuing preferences from 1.x, queuing
messages while away and queuing all new messages (from
docklet), are replaced with a single 3-way preference
for conversations. The new preference is "Hide new IM
conversations". This preference can be set to never,
away and always.
When a gtk conversation is created, it may be placed in
a hidden conversation window instead of being placed
normally. This decision is based upon the preference
and possibly the away state of the account the
conversation is being created for. This *will* effect
conversations the user explicitly requests to be
created, so in these cases the caller must be sure to
present the conversation to the user, using
gaim_gtkconv_present_conversation(). This is done
already in gtkdialogs.c which handles creating
conversations requested by the user from gaim proper
(menus, double-clicking on budy in blist, etc.).
The main advantage to not queuing messages is that the
conversations exist, the message is written to the
conversation (and logged if appropriate) and the unseen
state is set on the conversation. This means no
additional features are needed to track whether there
are queued messages or not, just use the unseen state
on conversations.
Since conversations may not be visible (messages
"queued"), gaim proper needs some notification that
there are messages waiting. I opted for a menutray icon
that shows up when an im conversation has an unseen
message. Clicking this icon will focus (and show if
hidden) the first conversation with an unseen message.
This is essentially the same behavior of the docklet in
cvs right now, except that the icon is only visible
when there is a conversation with an unread message.
The api that is added is flexible enough to allow
either the docklet or the new blist menutray icon to be
visible for conversations of any/all types and for
unseen messages >= any state. Currently they are set to
only IM conversations and only unseen states >= TEXT
(system messages and no log messages will not trigger
blinking the docklet or showing the blist tray icon),
but these could be made preferences relatively easily
in the future. Other plugins could probably benefit as
well: gaim_gtk_conversations_get_first_unseen().
There is probably some limit to comment size, so I'll
stop rambling now. If anyone has more
questions/comments, catch me in #gaim, here or on
gaim-devel."
committer: Tailor Script <tailor@pidgin.im>
author | Luke Schierer <lschiere@pidgin.im> |
---|---|
date | Wed, 16 Nov 2005 18:17:01 +0000 |
parents | d77537e8bfe5 |
children |
line wrap: on
line source
/* * nmrequest.h * * Copyright (c) 2004 Novell, Inc. All Rights Reserved. * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; version 2 of the License. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA * */ #ifndef __NM_REQUEST_H__ #define __NM_REQUEST_H__ typedef struct _NMRequest NMRequest; #include "nmuser.h" /** * Create a new request object. Object must be release with nm_release_object. * * @param cmd The request command string (e.g. "login") * @param trans_id The request transaction id * @param gmt The time in seconds that the request was created * * @return The new request object */ NMRequest *nm_create_request(const char *cmd, int trans_id, int gmt, nm_response_cb cb, gpointer resp_data, gpointer user_define); /** * Release a request object. * * @param req The request to release */ void nm_release_request(NMRequest * req); /** * Add a new reference to this object. This reference must be released by * a call to nm_release_object. * * @param req The request object */ void nm_request_add_ref(NMRequest * req); /** * Set the response callback for this request object. This is the callback * that will be made when we get a response from the server. * * @param req The request object * @param callback The response callback * */ void nm_request_set_callback(NMRequest * req, nm_response_cb callback); /** * Set the response data. This will be set differently depending on * the request type (for example to nm_send_get_details will set this * to be the newly create NMUserRecord object). * * @param req The request object * @param data Pointer to some data * */ void nm_request_set_data(NMRequest * req, gpointer data); /** * Set the user defined data. This is the data that the client * passes to the various nm_send_* functions. We will pass it * back when we make the callback. * * @param req The request object * @param user_define Pointer to some data * */ void nm_request_set_user_define(NMRequest * req, gpointer user_define); /** * Set the return code. This is the return code that we received in * the server response fields. * * @param req The request object * @param rc The return code to set */ void nm_request_set_ret_code(NMRequest * req, NMERR_T rc); /** * Get the transaction id for this request. * * @param req The request object * * @return The transaction id. */ int nm_request_get_trans_id(NMRequest * req); /** * Get the command (request type) for this request. * * @param req The request object * * @return The request cmd */ const char *nm_request_get_cmd(NMRequest * req); /** * Get the response data for this request * * @param req The request object * * @return The response data */ gpointer nm_request_get_data(NMRequest * req); /** * Get the user defined data for this request * * @param req The request object * * @return The user defined data */ gpointer nm_request_get_user_define(NMRequest * req); /** * Get the response callback for this request * * @param req The request object * * @return The response callback */ nm_response_cb nm_request_get_callback(NMRequest * req); /** * Get the return code * * @param req The request object * * @return The return code (from the response fields) */ NMERR_T nm_request_get_ret_code(NMRequest * req); #endif