Mercurial > pidgin
view src/sound.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 | 58bc500cf226 |
children | 5bc3d67ceb24 |
line wrap: on
line source
/** * @file sound.h Sound API * @ingroup core * * 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 _GAIM_SOUND_H_ #define _GAIM_SOUND_H_ #include "account.h" /**************************************************************************/ /** Data Structures */ /**************************************************************************/ /** * A type of sound. */ typedef enum _GaimSoundEventID { GAIM_SOUND_BUDDY_ARRIVE = 0, /**< Buddy signs on. */ GAIM_SOUND_BUDDY_LEAVE, /**< Buddy signs off. */ GAIM_SOUND_RECEIVE, /**< Receive an IM. */ GAIM_SOUND_FIRST_RECEIVE, /**< Receive an IM that starts a conv. */ GAIM_SOUND_SEND, /**< Send an IM. */ GAIM_SOUND_CHAT_JOIN, /**< Someone joins a chat. */ GAIM_SOUND_CHAT_LEAVE, /**< Someone leaves a chat. */ GAIM_SOUND_CHAT_YOU_SAY, /**< You say something in a chat. */ GAIM_SOUND_CHAT_SAY, /**< Someone else says somthing in a chat. */ GAIM_SOUND_POUNCE_DEFAULT, /**< Default sound for a buddy pounce. */ GAIM_SOUND_CHAT_NICK, /**< Someone says your name in a chat. */ GAIM_NUM_SOUNDS /**< Total number of sounds. */ } GaimSoundEventID; typedef struct _GaimSoundUiOps { void (*init)(void); void (*uninit)(void); void (*play_file)(const char *filename); void (*play_event)(GaimSoundEventID event); } GaimSoundUiOps; #ifdef __cplusplus extern "C" { #endif /**************************************************************************/ /** @name Sound API */ /**************************************************************************/ /*@{*/ /** * Plays the specified sound file. * * @param filename The file to play. * @param account The account that this sound is associated with, or * NULL if the sound is not associated with any specific * account. This is needed for the "sounds while away?" * preference to work correctly. */ void gaim_sound_play_file(const char *filename, const GaimAccount *account); /** * Plays the sound associated with the specified event. * * @param event The event. * @param account The account that this sound is associated with, or * NULL if the sound is not associated with any specific * account. This is needed for the "sounds while away?" * preference to work correctly. */ void gaim_sound_play_event(GaimSoundEventID event, const GaimAccount *account); /** * Sets the UI sound operations * * @param ops The UI sound operations structure. */ void gaim_sound_set_ui_ops(GaimSoundUiOps *ops); /** * Gets the UI sound operations * * @return The UI sound operations structure. */ GaimSoundUiOps *gaim_sound_get_ui_ops(void); /** * Initializes the sound subsystem */ void gaim_sound_init(void); /** * Shuts down the sound subsystem */ void gaim_sound_uninit(void); /*@}*/ #ifdef __cplusplus } #endif #endif /* _GAIM_SOUND_H_ */