Frameworks/libpurple.framework/Versions/2.10.12r8d2874a79747/Headers/page.h
branchadium-1.5.11
changeset 6014 fcb71cb71a3d
parent 5941 307f53385811
parent 6013 f8d0dc659e3f
child 6016 325e2ab3406f
equal deleted inserted replaced
5941:307f53385811 6014:fcb71cb71a3d
     1 /**
       
     2  * @file page.h Paging functions
       
     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_PAGE_H
       
    25 #define MSN_PAGE_H
       
    26 
       
    27 typedef struct _MsnPage MsnPage;
       
    28 
       
    29 #include "session.h"
       
    30 
       
    31 /**
       
    32  * A page.
       
    33  */
       
    34 struct _MsnPage
       
    35 {
       
    36 	char *from_location;
       
    37 	char *from_phone;
       
    38 
       
    39 	char *body;
       
    40 };
       
    41 
       
    42 /**
       
    43  * Creates a new, empty page.
       
    44  *
       
    45  * @return A new page.
       
    46  */
       
    47 MsnPage *msn_page_new(void);
       
    48 
       
    49 /**
       
    50  * Destroys a page.
       
    51  */
       
    52 void msn_page_destroy(MsnPage *page);
       
    53 
       
    54 /**
       
    55  * Generates the payload data of a page.
       
    56  *
       
    57  * @param page     The page.
       
    58  * @param ret_size The returned size of the payload.
       
    59  *
       
    60  * @return The payload data of a page.
       
    61  */
       
    62 char *msn_page_gen_payload(const MsnPage *page, size_t *ret_size);
       
    63 
       
    64 /**
       
    65  * Sets the body of a page.
       
    66  *
       
    67  * @param page  The page.
       
    68  * @param body The body of the page.
       
    69  */
       
    70 void msn_page_set_body(MsnPage *page, const char *body);
       
    71 
       
    72 /**
       
    73  * Returns the body of the page.
       
    74  *
       
    75  * @param page The page.
       
    76  *
       
    77  * @return The body of the page.
       
    78  */
       
    79 const char *msn_page_get_body(const MsnPage *page);
       
    80 
       
    81 #endif /* MSN_PAGE_H */