Mercurial > pidgin
view src/protocols/yahoo/yahoo_doodle.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 | 2219f4bf4a57 |
children |
line wrap: on
line source
/** * @file yahoo_doodle.h The Yahoo! protocol plugin Doodle IMVironment object * * gaim * * Gaim is the legal property of its developers, whose names are too numerous * to list here. Please refer to the COPYRIGHT file distributed with this * source distribution. * * 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; either version 2 of the License, or * (at your option) any later version. * * 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 _YAHOO_DOODLE_H_ #define _YAHOO_DOODLE_H_ /****************************************************************************** * Includes *****************************************************************************/ #include "whiteboard.h" #include "cmds.h" /****************************************************************************** * Defines *****************************************************************************/ /* Doodle communication commands */ /* TODO: Should be an enum. */ #define DOODLE_CMD_REQUEST 0 #define DOODLE_CMD_READY 1 #define DOODLE_CMD_CLEAR 2 #define DOODLE_CMD_DRAW 3 #define DOODLE_CMD_EXTRA 4 #define DOODLE_CMD_CONFIRM 5 /* Doodle communication command for shutting down (also 0) */ #define DOODLE_CMD_SHUTDOWN 0 #define DOODLE_EXTRA_NONE "\"1\"" #define DOODLE_EXTRA_TICTACTOE "\"3\"" #define DOODLE_EXTRA_DOTS "\"2\"" /* Doodle session states */ /* TODO: Should be an enum. */ #define DOODLE_STATE_REQUESTING 0 #define DOODLE_STATE_REQUESTED 1 #define DOODLE_STATE_ESTABLISHED 2 /* Doodle canvas dimensions */ #define DOODLE_CANVAS_WIDTH 368 #define DOODLE_CANVAS_HEIGHT 256 /* Doodle color codes (most likely RGB) */ /* TODO: Should be an enum and sorted by color name. */ #define DOODLE_COLOR_RED 13369344 #define DOODLE_COLOR_ORANGE 16737792 #define DOODLE_COLOR_YELLOW 15658496 #define DOODLE_COLOR_GREEN 52224 #define DOODLE_COLOR_CYAN 52428 #define DOODLE_COLOR_BLUE 204 #define DOODLE_COLOR_VIOLET 5381277 #define DOODLE_COLOR_PURPLE 13369548 #define DOODLE_COLOR_TAN 12093547 #define DOODLE_COLOR_BROWN 5256485 #define DOODLE_COLOR_BLACK 0 #define DOODLE_COLOR_GREY 11184810 #define DOODLE_COLOR_WHITE 16777215 #define PALETTE_NUM_OF_COLORS 12 /* Doodle brush sizes (most likely variable) */ #define DOODLE_BRUSH_SMALL 2 #define DOODLE_BRUSH_MEDIUM 5 #define DOODLE_BRUSH_LARGE 10 #define DOODLE_MAX_BRUSH_MOTIONS 100 /****************************************************************************** * Datatypes *****************************************************************************/ typedef struct _doodle_session { int brush_size; /* Size of drawing brush */ int brush_color; /* Color of drawing brush */ } doodle_session; /****************************************************************************** * API *****************************************************************************/ GaimCmdRet yahoo_doodle_gaim_cmd_start(GaimConversation *conv, const char *cmd, char **args, char **error, void *data); void yahoo_doodle_process(GaimConnection *gc, const char *me, const char *from, const char *command, const char *message); void yahoo_doodle_initiate(GaimConnection *gc, const char *to); void yahoo_doodle_command_got_request(GaimConnection *gc, const char *from); void yahoo_doodle_command_got_ready(GaimConnection *gc, const char *from); void yahoo_doodle_command_got_draw(GaimConnection *gc, const char *from, const char *message); void yahoo_doodle_command_got_clear(GaimConnection *gc, const char *from); void yahoo_doodle_command_got_extra(GaimConnection *gc, const char *from, const char *message); void yahoo_doodle_command_got_confirm(GaimConnection *gc, const char *from); void yahoo_doodle_command_got_shutdown(GaimConnection *gc, const char *from); void yahoo_doodle_command_send_request(GaimConnection *gc, const char *to); void yahoo_doodle_command_send_ready(GaimConnection *gc, const char *to); void yahoo_doodle_command_send_draw(GaimConnection *gc, const char *to, const char *message); void yahoo_doodle_command_send_clear(GaimConnection *gc, const char *to); void yahoo_doodle_command_send_extra(GaimConnection *gc, const char *to, const char *message); void yahoo_doodle_command_send_confirm(GaimConnection *gc, const char *to); void yahoo_doodle_command_send_shutdown(GaimConnection *gc, const char *to); void yahoo_doodle_start(GaimWhiteboard *wb); void yahoo_doodle_end(GaimWhiteboard *wb); void yahoo_doodle_get_dimensions(GaimWhiteboard *wb, int *width, int *height); void yahoo_doodle_send_draw_list(GaimWhiteboard *wb, GList *draw_list); void yahoo_doodle_clear(GaimWhiteboard *wb); void yahoo_doodle_draw_stroke(GaimWhiteboard *wb, GList *draw_list); void yahoo_doodle_get_brush(GaimWhiteboard *wb, int *size, int *color); void yahoo_doodle_set_brush(GaimWhiteboard *wb, int size, int color); #endif /* _YAHOO_DOODLE_H_ */