Mercurial > pidgin
view src/protocols/novell/nmuserrecord.h @ 8748:13d592f485d1
[gaim-migrate @ 9503]
The window icon for conversation windows is no longer 15x15. This prevents
the icon from being scaled up and appearing ugly in window lists, alt-tab
dialogs, etc.
committer: Tailor Script <tailor@pidgin.im>
author | Christian Hammond <chipx86@chipx86.com> |
---|---|
date | Wed, 21 Apr 2004 23:40:39 +0000 |
parents | 046dd8ef2920 |
children | 6663ad2386d9 |
line wrap: on
line source
/* * nmuserrecord.h * * Copyright © 2004 Unpublished Work of Novell, Inc. All Rights Reserved. * * THIS WORK IS AN UNPUBLISHED WORK OF NOVELL, INC. NO PART OF THIS WORK MAY BE * USED, PRACTICED, PERFORMED, COPIED, DISTRIBUTED, REVISED, MODIFIED, * TRANSLATED, ABRIDGED, CONDENSED, EXPANDED, COLLECTED, COMPILED, LINKED, * RECAST, TRANSFORMED OR ADAPTED WITHOUT THE PRIOR WRITTEN CONSENT OF NOVELL, * INC. ANY USE OR EXPLOITATION OF THIS WORK WITHOUT AUTHORIZATION COULD SUBJECT * THE PERPETRATOR TO CRIMINAL AND CIVIL LIABILITY. * * AS BETWEEN [GAIM] AND NOVELL, NOVELL GRANTS [GAIM] THE RIGHT TO REPUBLISH * THIS WORK UNDER THE GPL (GNU GENERAL PUBLIC LICENSE) WITH ALL RIGHTS AND * LICENSES THEREUNDER. IF YOU HAVE RECEIVED THIS WORK DIRECTLY OR INDIRECTLY * FROM [GAIM] AS PART OF SUCH A REPUBLICATION, YOU HAVE ALL RIGHTS AND LICENSES * GRANTED BY [GAIM] UNDER THE GPL. IN CONNECTION WITH SUCH A REPUBLICATION, IF * ANYTHING IN THIS NOTICE CONFLICTS WITH THE TERMS OF THE GPL, SUCH TERMS * PREVAIL. * */ #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