Mercurial > pidgin
view src/protocols/novell/nmuserrecord.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 | 6663ad2386d9 |
children | fc464a0abccc |
line wrap: on
line source
/* * nmuserrecord.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_USER_RECORD_H__ #define __NM_USER_RECORD_H__ #include <glib.h> typedef struct _NMUserRecord NMUserRecord; typedef struct _NMProperty NMProperty; #include "nmfield.h" #include "nmuser.h" /** * Creates an NMUserRecord * * The NMUserRecord should be released by calling * nm_release_user_record * * @return The new user record * */ NMUserRecord *nm_create_user_record(); /** * Creates an NMUserRecord * * The NMUserRecord should be released by calling * nm_release_user_record * * @param details Should be a NM_A_FA_USER_DETAILS * * * @return The new user record * */ NMUserRecord *nm_create_user_record_from_fields(NMField * details); /** * Add a reference to an existing user_record * * The reference should be released by calling * nm_release_user_record * * @param user_record The contact to addref * */ void nm_user_record_add_ref(NMUserRecord * user_record); /** * Release a reference to the user record * * @param user_record The user record * */ void nm_release_user_record(NMUserRecord * user_record); /** * Set the status for the user record * * @param user_record The user record * @param status The status for the user * @param text The status text for the user * */ void nm_user_record_set_status(NMUserRecord * user_record, NMSTATUS_T status, const char *text); /** * Get the status for the user record * * @param user_record The user record * * @return The status for the user record */ NMSTATUS_T nm_user_record_get_status(NMUserRecord * user_record); /** * Get the status text for the user record * * @param user_record The user record * * @return The status text if there is any, NULL otherwise * */ const char *nm_user_record_get_status_text(NMUserRecord * user_record); /** * Set the DN for the user record * * @param user_record The user record * @param dn The new DN for the user record * */ void nm_user_record_set_dn(NMUserRecord * user_record, const char *dn); /** * Get the DN for the user record * * @param user_record The user record * * @return The DN for the user record */ const char *nm_user_record_get_dn(NMUserRecord * user_record); /** * Set the user id for the * * @param user_record The user record * @param userid The userid (CN) for the user record * */ void nm_user_record_set_userid(NMUserRecord * user_record, const char *userid); /** * Get the user id for the user record * * @param user_record The user record * * @return The user id for the user record */ const char *nm_user_record_get_userid(NMUserRecord * user_record); /** * Set the display id for the user record * * @param user_record The user record * @param display_id The new display id for the user * */ void nm_user_record_set_display_id(NMUserRecord * user_record, const char *display_id); /** * Get the display id for the user record * * @param user_record The user record * * @return The display id for the user record */ const char *nm_user_record_get_display_id(NMUserRecord * user_record); /** * Return whether or not the display id is an auth attribute or not. * * @param user_record The user record * * @return TRUE if display_id is an auth attribute, FALSE otherwise. */ gboolean nm_user_record_get_auth_attr(NMUserRecord *user_record); /** * Get the full name for the user record * * @param user_record The user record * * @return The full name for the user */ const char *nm_user_record_get_full_name(NMUserRecord * user_record); /** * Get the first name for the user record * * @param user_record The user record * * @return The first name for the user */ const char *nm_user_record_get_first_name(NMUserRecord * user_record); /** * Get the last name for the user record * * @param user_record The user record * * @return The last name for the user */ const char *nm_user_record_get_last_name(NMUserRecord * user_record); /** * Set the user defined data for the user record * * @param user_record The user record * @param data The user defined data for the user record * */ void nm_user_record_set_data(NMUserRecord * user_record, gpointer data); /** * Get the user defined data for the user record * * @param user_record The user record * * @return The user defined data for the user record */ gpointer nm_user_record_get_data(NMUserRecord * user_record); /** * Get the property count for the user record * * @param user_record The user record * * @return The number of information properties for the user record * */ int nm_user_record_get_property_count(NMUserRecord * user_record); /** * Get an info property for the user record. The property must be released * by calling nm_release_property() * * @param user_record The user record * @param index The index of the property to get (zero based) * * @return The property */ NMProperty *nm_user_record_get_property(NMUserRecord * user_record, int index); /** * Release a property object * * @param property The property * */ void nm_release_property(NMProperty * property); /** * Get the tag for the property * * @param property The property * * @return The tag of the property (i.e. "Email Address") */ const char *nm_property_get_tag(NMProperty * property); /** * Get the value for the property * * @param property The property * * @return The value of the property (i.e. "nobody@nowhere.com") */ const char *nm_property_get_value(NMProperty * property); /** * Copy a user record (deep copy). The dest user record must have already been * created (nm_create_user_record) * * @param dest The destination of the copy * @param src The source of the copy * */ void nm_user_record_copy(NMUserRecord * dest, NMUserRecord * src); #endif