comparison finch/libgnt/gntfilesel.h @ 17928:8410511f4dbb

applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3 through e82c41f34ce5f7439b2f2971139efaf6ef7a54ff
author Eric Polino <aluink@pidgin.im>
date Wed, 06 Jun 2007 15:50:21 +0000
parents e05e5b148723
children 5c6f019e48f8
comparison
equal deleted inserted replaced
17927:f189497429c5 17928:8410511f4dbb
1 /**
2 * GNT - The GLib Ncurses Toolkit
3 *
4 * GNT is the legal property of its developers, whose names are too numerous
5 * to list here. Please refer to the COPYRIGHT file distributed with this
6 * source distribution.
7 *
8 * This library 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
1 #ifndef GNT_FILE_SEL_H 23 #ifndef GNT_FILE_SEL_H
2 #define GNT_FILE_SEL_H 24 #define GNT_FILE_SEL_H
3 25
4 #include "gntwindow.h" 26 #include "gntwindow.h"
5 #include "gnt.h" 27 #include "gnt.h"
69 unsigned long size; 91 unsigned long size;
70 }; 92 };
71 93
72 G_BEGIN_DECLS 94 G_BEGIN_DECLS
73 95
96 /**
97 *
98 *
99 * @return
100 */
74 GType gnt_file_sel_get_gtype(void); 101 GType gnt_file_sel_get_gtype(void);
75 102
76 GntWidget *gnt_file_sel_new(void); 103 /**
77 104 *
105 *
106 * @return
107 */
108 GntWidget * gnt_file_sel_new(void);
109
110 /**
111 *
112 * @param sel
113 * @param path
114 *
115 * @return
116 */
78 gboolean gnt_file_sel_set_current_location(GntFileSel *sel, const char *path); 117 gboolean gnt_file_sel_set_current_location(GntFileSel *sel, const char *path);
79 118
119 /**
120 *
121 * @param sel
122 * @param dirs
123 */
80 void gnt_file_sel_set_dirs_only(GntFileSel *sel, gboolean dirs); 124 void gnt_file_sel_set_dirs_only(GntFileSel *sel, gboolean dirs);
81 125
126 /**
127 *
128 * @param sel
129 *
130 * @return
131 */
82 gboolean gnt_file_sel_get_dirs_only(GntFileSel *sel); 132 gboolean gnt_file_sel_get_dirs_only(GntFileSel *sel);
83 133
134 /**
135 *
136 * @param sel
137 * @param must
138 */
84 void gnt_file_sel_set_must_exist(GntFileSel *sel, gboolean must); 139 void gnt_file_sel_set_must_exist(GntFileSel *sel, gboolean must);
85 140
141 /**
142 *
143 * @param sel
144 *
145 * @return
146 */
86 gboolean gnt_file_sel_get_must_exist(GntFileSel *sel); 147 gboolean gnt_file_sel_get_must_exist(GntFileSel *sel);
87 148
88 char *gnt_file_sel_get_selected_file(GntFileSel *sel); /* The returned value should be free'd */ 149 /**
89 150 *
90 GList *gnt_file_sel_get_selected_multi_files(GntFileSel *sel); 151 * @param sel
91 152 *
153 * @return
154 */
155 char * gnt_file_sel_get_selected_file(GntFileSel *sel);
156
157 /* The returned value should be free'd */
158
159 /**
160 *
161 * @param sel
162 *
163 * @return
164 */
165 GList * gnt_file_sel_get_selected_multi_files(GntFileSel *sel);
166
167 /**
168 *
169 * @param sel
170 * @param set
171 */
92 void gnt_file_sel_set_multi_select(GntFileSel *sel, gboolean set); 172 void gnt_file_sel_set_multi_select(GntFileSel *sel, gboolean set);
93 173
174 /**
175 *
176 * @param sel
177 * @param suggest
178 */
94 void gnt_file_sel_set_suggested_filename(GntFileSel *sel, const char *suggest); 179 void gnt_file_sel_set_suggested_filename(GntFileSel *sel, const char *suggest);
95 180
181 /**
182 *
183 * @param sel
184 * @param path
185 * @param files
186 * @param error)
187 */
96 void gnt_file_sel_set_read_fn(GntFileSel *sel, gboolean (*read_fn)(const char *path, GList **files, GError **error)); 188 void gnt_file_sel_set_read_fn(GntFileSel *sel, gboolean (*read_fn)(const char *path, GList **files, GError **error));
97 189
190 /**
191 *
192 * @param name
193 * @param size
194 *
195 * @return
196 */
98 GntFile* gnt_file_new(const char *name, unsigned long size); 197 GntFile* gnt_file_new(const char *name, unsigned long size);
99 198
199 /**
200 *
201 * @param name
202 *
203 * @return
204 */
100 GntFile* gnt_file_new_dir(const char *name); 205 GntFile* gnt_file_new_dir(const char *name);
101 206
102 G_END_DECLS 207 G_END_DECLS
103 208
104 #endif /* GNT_FILE_SEL_H */ 209 #endif /* GNT_FILE_SEL_H */