Frameworks/libpurple.framework/Versions/0.6.2/Headers/state.h
author Zachary West <zacw@adium.im>
Fri Aug 21 13:25:11 2009 -0700 (2009-08-21)
changeset 2592 e8d15275025e
parent 1739 Frameworks/libpurple.framework/Versions/0.6.0/Headers/state.h@8b0daad9656c
permissions -rw-r--r--
im.pidgin.adium.1-4 at 267c6165e02e34318a1823960bd04c0639952f73
     1 /**
     2  * @file state.h State functions and definitions
     3  *
     4  * purple
     5  *
     6  * Purple is the legal property of its developers, whose names are too numerous
     7  * to list here.  Please refer to the COPYRIGHT file distributed with this
     8  * source distribution.
     9  *
    10  * This program is free software; you can redistribute it and/or modify
    11  * it under the terms of the GNU General Public License as published by
    12  * the Free Software Foundation; either version 2 of the License, or
    13  * (at your option) any later version.
    14  *
    15  * This program is distributed in the hope that it will be useful,
    16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
    17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    18  * GNU General Public License for more details.
    19  *
    20  * You should have received a copy of the GNU General Public License
    21  * along with this program; if not, write to the Free Software
    22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02111-1301  USA
    23  */
    24 #ifndef _MSN_STATE_H_
    25 #define _MSN_STATE_H_
    26 
    27 /**
    28  * Away types.
    29  */
    30 typedef enum
    31 {
    32 	MSN_ONLINE  = 1,
    33 	MSN_BUSY    = 2,
    34 	MSN_IDLE    = 3,
    35 	MSN_BRB     = 4,
    36 	MSN_AWAY    = 5,
    37 	MSN_PHONE   = 6,
    38 	MSN_LUNCH   = 7,
    39 	MSN_OFFLINE = 8,
    40 	MSN_HIDDEN  = 9
    41 
    42 } MsnAwayType;
    43 
    44 /**
    45  * Changes the status of the user.
    46  *
    47  * @param session The MSN session.
    48  */
    49 void msn_change_status(MsnSession *session);
    50 
    51 /**
    52  * Returns the string representation of an away type.
    53  *
    54  * @param type The away type.
    55  *
    56  * @return The string representation of the away type.
    57  */
    58 const char *msn_away_get_text(MsnAwayType type);
    59 
    60 const char *msn_state_get_text(MsnAwayType state);
    61 
    62 void msn_set_psm(MsnSession *session);
    63 
    64 /* Parse CurrentMedia string */
    65 gboolean msn_parse_currentmedia(const char *cmedia, CurrentMedia *media);
    66 
    67 /* Get the CurrentMedia info from the XML string */
    68 char * msn_get_currentmedia(char *xml_str,gsize len);
    69 
    70 /*get the PSM info from the XML string*/
    71 char * msn_get_psm(char *xml_str,gsize len);
    72 
    73 MsnAwayType msn_state_from_account(PurpleAccount *account);
    74 
    75 #endif /* _MSN_STATE_H_ */