view src/protocols/msn/page.h @ 8442:3d0178c4f390

[gaim-migrate @ 9172] " This is that thing Sean told me to do. Well part of it. We now are careful to send html to gtkimhtml when sending a message, while still sending plain text to those protocols that need it. We send the fancy html on all the signals we emit though. Sean didn't say what to do about those. I figure always sending html on signals sounds good. I'm not sure I like how I did this exactly, especially with respect to whether it's the core or ui's job to make sure the html prpl flag gets honored. But it should be good enough for now. Anyway, this fixes the "sending someone <> on IRC/ICQ/MSN/etc shows up blank on my end!" problem. All prpls need to pass html to the core now, as Sean said in his email. I made msn, and gg comply. IRC was cool enough to already be complying. Jabber is so cool it actually takes html and isn't effected by this. ICQ, OSCAR, Trepia, zephyr, and napster still need to be fixed. (Note that it's not this patch that breaks them, they're already broken in CVS). I think TOC uses html and isn't effected. I'm not bothering with the old ICQ prpl. I'm not sure what's going on in trepia. I'm even less sure what's going on in zephyr. I didn't even check if napster used html or not. For OSCAR, I'm hoping I can get KingAnt to fix it. Normally I'd say, ICQ messages all need gaim_escape_html called on them. But what about receiving an ICQ messagefrom an AIM account, or vise versa?" -- marv yet again (00:48:48) LSchiere: marv: should i apply the patch sean asked for or should i wait for him to look at it? (00:49:17) marv: LSchiere: he talked like I should get it applied by someone not him (00:49:21) LSchiere: kay (00:49:29) marv: he said i knew the appropriate people to talk to (00:50:16) LSchiere: KingAnt: marv is making work for you committer: Tailor Script <[e-mail]>

/**
 * @file page.h Paging functions
 *
 * gaim
 *
 * Copyright (C) 2003 Christian Hammond <[e-mail]>
 *
 * 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 _MSN_PAGE_H_
#define _MSN_PAGE_H_

typedef struct _MsnPage MsnPage;

#include "session.h"
#include "user.h"

/**
 * A page.
 */
struct _MsnPage
{
	MsnUser *sender;
	MsnUser *receiver;

	char *from_location;
	char *from_phone;

	gboolean incoming;

	unsigned int trId;

	size_t size;

	char *body;
};

/**
 * Creates a new, empty page.
 *
 * @return A new page.
 */
MsnPage *msn_page_new(void);

/**
 * Creates a new page based off a string.
 *
 * @param session The MSN session.
 * @param str     The string.
 *
 * @return The new page.
 */
MsnPage *msn_page_new_from_str(MsnSession *session, const char *str);

/**
 * Destroys a page.
 */
void msn_page_destroy(MsnPage *page);

/**
 * Converts a page to a string.
 *
 * @param page The page.
 *
 * @return The string representation of a page.
 */
char *msn_page_build_string(const MsnPage *page);

/**
 * Returns TRUE if the page is outgoing.
 *
 * @param page The page.
 *
 * @return @c TRUE if the page is outgoing, or @c FALSE otherwise.
 */
gboolean msn_page_is_outgoing(const MsnPage *page);

/**
 * Returns TRUE if the page is incoming.
 *
 * @param page The page.
 *
 * @return @c TRUE if the page is incoming, or @c FALSE otherwise.
 */
gboolean msn_page_is_incoming(const MsnPage *page);

/**
 * Sets the page's sender.
 *
 * @param page  The page.
 * @param user The sender.
 */
void msn_page_set_sender(MsnPage *page, MsnUser *user);

/**
 * Returns the page's sender.
 *
 * @param page The page.
 *
 * @return The sender.
 */
MsnUser *msn_page_get_sender(const MsnPage *page);

/**
 * Sets the page's receiver.
 *
 * @param page  The page.
 * @param user The receiver.
 */
void msn_page_set_receiver(MsnPage *page, MsnUser *user);

/**
 * Returns the page's receiver.
 *
 * @param page The page.
 *
 * @return The receiver.
 */
MsnUser *msn_page_get_receiver(const MsnPage *page);

/**
 * Sets the page transaction ID.
 *
 * @param page The page.
 * @param tid  The transaction ID.
 */
void msn_page_set_transaction_id(MsnPage *page, unsigned int tid);

/**
 * Returns the page transaction ID.
 *
 * @param page The page.
 *
 * @return The transaction ID.
 */
unsigned int msn_page_get_transaction_id(const MsnPage *page);


/**
 * Sets the body of a page.
 *
 * @param page  The page.
 * @param body The body of the page.
 */
void msn_page_set_body(MsnPage *page, const char *body);

/**
 * Returns the body of the page.
 *
 * @param page The page.
 *
 * @return The body of the page.
 */
const char *msn_page_get_body(const MsnPage *page);

#endif /* _MSN_PAGE_H_ */