Mercurial > pidgin
view src/gtkft.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 | 9fe9c7e00666 |
children | fc464a0abccc |
line wrap: on
line source
/** * @file gtkft.h GTK+ File Transfer UI * @ingroup gtkui * * 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_GTKFT_H_ #define _GAIM_GTKFT_H_ #include "ft.h" /** * A file transfer dialog. * * The structure is opaque, as nobody should be touching anything inside of * it. */ typedef struct _GaimGtkXferDialog GaimGtkXferDialog; /**************************************************************************/ /** @name GTK+ File Transfer Dialog API */ /**************************************************************************/ /*@{*/ /** * Creates a new file transfer dialog. * * @return The new dialog. */ GaimGtkXferDialog *gaim_gtkxfer_dialog_new(void); /** * Destroys a file transfer dialog. * * @param dialog The file transfer dialog. */ void gaim_gtkxfer_dialog_destroy(GaimGtkXferDialog *dialog); /** * Displays the file transfer dialog. * * @param dialog The file transfer dialog to show. */ void gaim_gtkxfer_dialog_show(GaimGtkXferDialog *dialog); /** * Hides the file transfer dialog. * * @param dialog The file transfer dialog to hide. */ void gaim_gtkxfer_dialog_hide(GaimGtkXferDialog *dialog); /** * Shows the file transfer dialog, creating a new one if necessary */ void gaim_show_xfer_dialog(); /** * Adds a file transfer to the dialog. * * @param dialog The file transfer dialog. * @param xfer The file transfer. */ void gaim_gtkxfer_dialog_add_xfer(GaimGtkXferDialog *dialog, GaimXfer *xfer); /** * Removes a file transfer from the dialog. * * @param dialog The file transfer dialog. * @param xfer The file transfer. */ void gaim_gtkxfer_dialog_remove_xfer(GaimGtkXferDialog *dialog, GaimXfer *xfer); /** * Indicate in a file transfer dialog that a transfer was canceled. * * @param dialog The file transfer dialog. * @param xfer The file transfer that was canceled. */ void gaim_gtkxfer_dialog_cancel_xfer(GaimGtkXferDialog *dialog, GaimXfer *xfer); /** * Updates the information for a transfer in the dialog. * * @param dialog The file transfer dialog. * @param xfer The file transfer. */ void gaim_gtkxfer_dialog_update_xfer(GaimGtkXferDialog *dialog, GaimXfer *xfer); /*@}*/ /**************************************************************************/ /** @name GTK+ File Transfer API */ /**************************************************************************/ /*@{*/ /** * Initializes the GTK+ file transfer system. */ void gaim_gtk_xfers_init(void); /** * Uninitializes the GTK+ file transfer system. */ void gaim_gtk_xfers_uninit(void); /** * Sets gaim's main file transfer dialog. * * @param dialog The main dialog. */ void gaim_set_gtkxfer_dialog(GaimGtkXferDialog *dialog); /** * Returns gaim's main file transfer dialog. * * @return The main dialog. */ GaimGtkXferDialog *gaim_get_gtkxfer_dialog(void); /** * Returns the UI operations structure for the GTK+ file transfer UI. * * @return The GTK+ file transfer UI operations structure. */ GaimXferUiOps *gaim_gtk_xfers_get_ui_ops(void); /*@}*/ #endif /* _GAIM_GTKFT_H_ */