Mercurial > pidgin
annotate src/protocols/msn/page.h @ 8718:6ab61697426e
[gaim-migrate @ 9473]
simguy wants this
committer: Tailor Script <tailor@pidgin.im>
author | Luke Schierer <lschiere@pidgin.im> |
---|---|
date | Tue, 20 Apr 2004 04:04:41 +0000 |
parents | 1e211dde3cae |
children | bbd8cdaf0ad5 |
rev | line source |
---|---|
5370 | 1 /** |
2 * @file page.h Paging functions | |
3 * | |
4 * gaim | |
5 * | |
8475
06f57183e29f
[gaim-migrate @ 9208]
Christian Hammond <chipx86@chipx86.com>
parents:
6701
diff
changeset
|
6 * Copyright (C) 2003-2004 Christian Hammond <chipx86@gnupdate.org> |
6701
b7e113a59b51
[gaim-migrate @ 7227]
Christian Hammond <chipx86@chipx86.com>
parents:
5370
diff
changeset
|
7 * |
5370 | 8 * This program is free software; you can redistribute it and/or modify |
9 * it under the terms of the GNU General Public License as published by | |
10 * the Free Software Foundation; either version 2 of the License, or | |
11 * (at your option) any later version. | |
12 * | |
13 * This program is distributed in the hope that it will be useful, | |
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
16 * GNU General Public License for more details. | |
17 * | |
18 * You should have received a copy of the GNU General Public License | |
19 * along with this program; if not, write to the Free Software | |
20 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA | |
21 */ | |
22 #ifndef _MSN_PAGE_H_ | |
23 #define _MSN_PAGE_H_ | |
24 | |
25 typedef struct _MsnPage MsnPage; | |
26 | |
27 #include "session.h" | |
28 #include "user.h" | |
29 | |
30 /** | |
31 * A page. | |
32 */ | |
33 struct _MsnPage | |
34 { | |
35 char *from_location; | |
36 char *from_phone; | |
37 | |
38 size_t size; | |
39 | |
40 char *body; | |
41 }; | |
42 | |
43 /** | |
44 * Creates a new, empty page. | |
45 * | |
46 * @return A new page. | |
47 */ | |
48 MsnPage *msn_page_new(void); | |
49 | |
50 /** | |
51 * Destroys a page. | |
52 */ | |
53 void msn_page_destroy(MsnPage *page); | |
54 | |
55 /** | |
8646
1e211dde3cae
[gaim-migrate @ 9398]
Christian Hammond <chipx86@chipx86.com>
parents:
8475
diff
changeset
|
56 * Converts a page to a payload string. |
5370 | 57 * |
8646
1e211dde3cae
[gaim-migrate @ 9398]
Christian Hammond <chipx86@chipx86.com>
parents:
8475
diff
changeset
|
58 * @param page The page. |
1e211dde3cae
[gaim-migrate @ 9398]
Christian Hammond <chipx86@chipx86.com>
parents:
8475
diff
changeset
|
59 * @param ret_size The returned size of the payload. |
5370 | 60 * |
8646
1e211dde3cae
[gaim-migrate @ 9398]
Christian Hammond <chipx86@chipx86.com>
parents:
8475
diff
changeset
|
61 * @return The payload string of a page. |
5370 | 62 */ |
8646
1e211dde3cae
[gaim-migrate @ 9398]
Christian Hammond <chipx86@chipx86.com>
parents:
8475
diff
changeset
|
63 char *msn_page_gen_payload(const MsnPage *page, size_t *ret_size); |
5370 | 64 |
65 /** | |
66 * Sets the body of a page. | |
67 * | |
68 * @param page The page. | |
69 * @param body The body of the page. | |
70 */ | |
71 void msn_page_set_body(MsnPage *page, const char *body); | |
72 | |
73 /** | |
74 * Returns the body of the page. | |
75 * | |
76 * @param page The page. | |
77 * | |
78 * @return The body of the page. | |
79 */ | |
80 const char *msn_page_get_body(const MsnPage *page); | |
81 | |
82 #endif /* _MSN_PAGE_H_ */ |