Frameworks/libpurple.framework/Versions/0.6.2/Headers/page.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/page.h@8b0daad9656c
permissions -rw-r--r--
im.pidgin.adium.1-4 at 267c6165e02e34318a1823960bd04c0639952f73
Evan@653
     1
/**
Evan@653
     2
 * @file page.h Paging functions
Evan@653
     3
 *
Evan@653
     4
 * purple
Evan@653
     5
 *
Evan@653
     6
 * Purple is the legal property of its developers, whose names are too numerous
Evan@653
     7
 * to list here.  Please refer to the COPYRIGHT file distributed with this
Evan@653
     8
 * source distribution.
Evan@653
     9
 *
Evan@653
    10
 * This program is free software; you can redistribute it and/or modify
Evan@653
    11
 * it under the terms of the GNU General Public License as published by
Evan@653
    12
 * the Free Software Foundation; either version 2 of the License, or
Evan@653
    13
 * (at your option) any later version.
Evan@653
    14
 *
Evan@653
    15
 * This program is distributed in the hope that it will be useful,
Evan@653
    16
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
Evan@653
    17
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
Evan@653
    18
 * GNU General Public License for more details.
Evan@653
    19
 *
Evan@653
    20
 * You should have received a copy of the GNU General Public License
Evan@653
    21
 * along with this program; if not, write to the Free Software
Evan@653
    22
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02111-1301  USA
Evan@653
    23
 */
Evan@653
    24
#ifndef _MSN_PAGE_H_
Evan@653
    25
#define _MSN_PAGE_H_
Evan@653
    26
Evan@653
    27
typedef struct _MsnPage MsnPage;
Evan@653
    28
Evan@653
    29
#include "session.h"
Evan@653
    30
Evan@653
    31
/**
Evan@653
    32
 * A page.
Evan@653
    33
 */
Evan@653
    34
struct _MsnPage
Evan@653
    35
{
Evan@653
    36
	char *from_location;
Evan@653
    37
	char *from_phone;
Evan@653
    38
Evan@653
    39
	char *body;
Evan@653
    40
};
Evan@653
    41
Evan@653
    42
/**
Evan@653
    43
 * Creates a new, empty page.
Evan@653
    44
 *
Evan@653
    45
 * @return A new page.
Evan@653
    46
 */
Evan@653
    47
MsnPage *msn_page_new(void);
Evan@653
    48
Evan@653
    49
/**
Evan@653
    50
 * Destroys a page.
Evan@653
    51
 */
Evan@653
    52
void msn_page_destroy(MsnPage *page);
Evan@653
    53
Evan@653
    54
/**
Evan@653
    55
 * Generates the payload data of a page.
Evan@653
    56
 *
Evan@653
    57
 * @param page     The page.
Evan@653
    58
 * @param ret_size The returned size of the payload.
Evan@653
    59
 *
Evan@653
    60
 * @return The payload data of a page.
Evan@653
    61
 */
Evan@653
    62
char *msn_page_gen_payload(const MsnPage *page, size_t *ret_size);
Evan@653
    63
Evan@653
    64
/**
Evan@653
    65
 * Sets the body of a page.
Evan@653
    66
 *
Evan@653
    67
 * @param page  The page.
Evan@653
    68
 * @param body The body of the page.
Evan@653
    69
 */
Evan@653
    70
void msn_page_set_body(MsnPage *page, const char *body);
Evan@653
    71
Evan@653
    72
/**
Evan@653
    73
 * Returns the body of the page.
Evan@653
    74
 *
Evan@653
    75
 * @param page The page.
Evan@653
    76
 *
Evan@653
    77
 * @return The body of the page.
Evan@653
    78
 */
Evan@653
    79
const char *msn_page_get_body(const MsnPage *page);
Evan@653
    80
Evan@653
    81
#endif /* _MSN_PAGE_H_ */