1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
|
/**
* @file gtkft.h GTK+ File Transfer UI
* @ingroup pidgin
*/
/* pidgin
*
* Pidgin is the legal property of its developers, whose names are too numerous
* to list here. Please refer to the COPYRIGHT file distributed with this
* source distribution.
*
* 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., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
*/
#ifndef _PIDGINFT_H_
#define _PIDGINFT_H_
#include "ft.h"
/**
* A file transfer dialog.
*
* The structure is opaque, as nobody should be touching anything inside of
* it.
*/
typedef struct _PidginXferDialog PidginXferDialog;
/**************************************************************************/
/** @name GTK+ File Transfer Dialog API */
/**************************************************************************/
/*@{*/
/**
* Creates a new file transfer dialog.
*
* @return The new dialog.
*/
PidginXferDialog *pidgin_xfer_dialog_new(void);
/**
* Destroys a file transfer dialog.
*
* @param dialog The file transfer dialog.
*/
void pidgin_xfer_dialog_destroy(PidginXferDialog *dialog);
/**
* Displays the file transfer dialog given.
* If dialog is @c NULL, displays the default dialog, creating one if necessary
*
* @param dialog The file transfer dialog to show.
*/
void pidgin_xfer_dialog_show(PidginXferDialog *dialog);
/**
* Hides the file transfer dialog.
*
* @param dialog The file transfer dialog to hide.
*/
void pidgin_xfer_dialog_hide(PidginXferDialog *dialog);
/**
* Adds a file transfer to the dialog.
*
* @param dialog The file transfer dialog.
* @param xfer The file transfer.
*/
void pidgin_xfer_dialog_add_xfer(PidginXferDialog *dialog, PurpleXfer *xfer);
/**
* Removes a file transfer from the dialog.
*
* @param dialog The file transfer dialog.
* @param xfer The file transfer.
*/
void pidgin_xfer_dialog_remove_xfer(PidginXferDialog *dialog,
PurpleXfer *xfer);
/**
* Indicate in a file transfer dialog that a transfer was canceled.
*
* @param dialog The file transfer dialog.
* @param xfer The file transfer that was canceled.
*/
void pidgin_xfer_dialog_cancel_xfer(PidginXferDialog *dialog,
PurpleXfer *xfer);
/**
* Updates the information for a transfer in the dialog.
*
* @param dialog The file transfer dialog.
* @param xfer The file transfer.
*/
void pidgin_xfer_dialog_update_xfer(PidginXferDialog *dialog,
PurpleXfer *xfer);
/*@}*/
/**************************************************************************/
/** @name GTK+ File Transfer API */
/**************************************************************************/
/*@{*/
/**
* Initializes the GTK+ file transfer system.
*/
void pidgin_xfers_init(void);
/**
* Uninitializes the GTK+ file transfer system.
*/
void pidgin_xfers_uninit(void);
/**
* Sets pidgin's main file transfer dialog.
*
* @param dialog The main dialog.
*/
void pidgin_set_xfer_dialog(PidginXferDialog *dialog);
/**
* Returns pirgin's main file transfer dialog.
*
* @return The main dialog.
*/
PidginXferDialog *pidgin_get_xfer_dialog(void);
/**
* Returns the UI operations structure for the GTK+ file transfer UI.
*
* @return The GTK+ file transfer UI operations structure.
*/
PurpleXferUiOps *pidgin_xfers_get_ui_ops(void);
/*@}*/
#endif /* _PIDGINFT_H_ */
|
