Frameworks/libpurple.framework/Versions/0.6.2/Headers/page.h
changeset 2592 e8d15275025e
parent 1739 8b0daad9656c
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/Frameworks/libpurple.framework/Versions/0.6.2/Headers/page.h	Fri Aug 21 13:25:11 2009 -0700
     1.3 @@ -0,0 +1,81 @@
     1.4 +/**
     1.5 + * @file page.h Paging functions
     1.6 + *
     1.7 + * purple
     1.8 + *
     1.9 + * Purple is the legal property of its developers, whose names are too numerous
    1.10 + * to list here.  Please refer to the COPYRIGHT file distributed with this
    1.11 + * source distribution.
    1.12 + *
    1.13 + * This program is free software; you can redistribute it and/or modify
    1.14 + * it under the terms of the GNU General Public License as published by
    1.15 + * the Free Software Foundation; either version 2 of the License, or
    1.16 + * (at your option) any later version.
    1.17 + *
    1.18 + * This program is distributed in the hope that it will be useful,
    1.19 + * but WITHOUT ANY WARRANTY; without even the implied warranty of
    1.20 + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    1.21 + * GNU General Public License for more details.
    1.22 + *
    1.23 + * You should have received a copy of the GNU General Public License
    1.24 + * along with this program; if not, write to the Free Software
    1.25 + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02111-1301  USA
    1.26 + */
    1.27 +#ifndef _MSN_PAGE_H_
    1.28 +#define _MSN_PAGE_H_
    1.29 +
    1.30 +typedef struct _MsnPage MsnPage;
    1.31 +
    1.32 +#include "session.h"
    1.33 +
    1.34 +/**
    1.35 + * A page.
    1.36 + */
    1.37 +struct _MsnPage
    1.38 +{
    1.39 +	char *from_location;
    1.40 +	char *from_phone;
    1.41 +
    1.42 +	char *body;
    1.43 +};
    1.44 +
    1.45 +/**
    1.46 + * Creates a new, empty page.
    1.47 + *
    1.48 + * @return A new page.
    1.49 + */
    1.50 +MsnPage *msn_page_new(void);
    1.51 +
    1.52 +/**
    1.53 + * Destroys a page.
    1.54 + */
    1.55 +void msn_page_destroy(MsnPage *page);
    1.56 +
    1.57 +/**
    1.58 + * Generates the payload data of a page.
    1.59 + *
    1.60 + * @param page     The page.
    1.61 + * @param ret_size The returned size of the payload.
    1.62 + *
    1.63 + * @return The payload data of a page.
    1.64 + */
    1.65 +char *msn_page_gen_payload(const MsnPage *page, size_t *ret_size);
    1.66 +
    1.67 +/**
    1.68 + * Sets the body of a page.
    1.69 + *
    1.70 + * @param page  The page.
    1.71 + * @param body The body of the page.
    1.72 + */
    1.73 +void msn_page_set_body(MsnPage *page, const char *body);
    1.74 +
    1.75 +/**
    1.76 + * Returns the body of the page.
    1.77 + *
    1.78 + * @param page The page.
    1.79 + *
    1.80 + * @return The body of the page.
    1.81 + */
    1.82 +const char *msn_page_get_body(const MsnPage *page);
    1.83 +
    1.84 +#endif /* _MSN_PAGE_H_ */