← Back to branch summary

~ubuntu-branches/ubuntu/maverick/gwhere/maverick

« back to all changes in this revision

Viewing changes to src/plugins/gwdescr.h

  • Committer: Bazaar Package Importer
  • Author(s): Sébastien LECACHEUR
  • Date: 2004-09-27 00:41:00 UTC
  • Revision ID: james.westby@ubuntu.com-20040927004100-q23139ty7b94kryi
Tags: upstream-0.1.6
Import upstream version 0.1.6

Show diffs side-by-side

added added

removed removed

Lines of Context:
src/plugins/gwdescr.h
 
1
/*  GWhere.
 
2
 *  Copyright (C) 2000  S�bastien LECACHEUR
 
3
 *
 
4
 *  This program is free software; you can redistribute it and/or modify
 
5
 *  it under the terms of the GNU General Public License as published by
 
6
 *  the Free Software Foundation; either version 2 of the License, or
 
7
 *  (at your option) any later version.
 
8
 *
 
9
 *  This program is distributed in the hope that it will be useful,
 
10
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 
11
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
12
 *  GNU General Public License for more details.
 
13
 *
 
14
 *  You should have received a copy of the GNU General Public License
 
15
 *  along with this program; if not, write to the Free Software
 
16
 *  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 
17
 */
 
18
 
 
19
 
 
20
/*!
 
21
 * @header      gwdescr.h
 
22
 *              GWhere<br>
 
23
 *              Copyright (C) 2000  S�bastien LECACHEUR<br><br>
 
24
 *              This Distributed under the terms of the <a href="http://www.gnu.org/copyleft/gpl.html">GNU General Public Licence</a><br><br>
 
25
 *              This component was developed for the GWhere project.<br><br>
 
26
 * @abstract    This is the interface specification of description plugins.
 
27
 * @author      S�bastien LECACHEUR <zero@gwhere.org>
 
28
 * @version     1.0 2003/08/19
 
29
 * @see         gwsupport.h
 
30
 * @link        GWhere Web Site <http://www.gwhere.org>
 
31
 * @author      Author <zero@gwhere.org>
 
32
 */
 
33
 
 
34
 
 
35
#ifndef GW_PLUGINS_DESCR_H
 
36
#define GW_PLUGINS_DESCR_H
 
37
 
 
38
 
 
39
/*!
 
40
 * @typedef     func_get_author_t
 
41
 *              The function get the author of the plugin.
 
42
 * @abstract    Desription plugin functions specification
 
43
 * @return      The author name
 
44
 */
 
45
typedef gchar* (*func_get_author_t)(void);
 
46
 
 
47
 
 
48
/*!
 
49
 * @typedef     func_get_info_t
 
50
 *              The function get some information about the plugin.
 
51
 * @abstract    Desription plugin functions specification
 
52
 * @return      The information
 
53
 */
 
54
typedef gchar* (*func_get_info_t)(void);
 
55
 
 
56
 
 
57
/*!
 
58
 * @typedef     func_get_help_t
 
59
 *              The function get some help about the plugin.
 
60
 * @abstract    Desription plugin functions specification
 
61
 * @return      The help
 
62
 */
 
63
typedef gchar* (*func_get_help_t)(void);
 
64
 
 
65
 
 
66
/*!
 
67
 * @typedef     func_get_allowed_ext_t
 
68
 *              The function get a list for file extention supported by the plugin.
 
69
 * @abstract    Desription plugin functions specification
 
70
 * @return      The file extensions list separated by <i>"|"</i>.
 
71
 */
 
72
typedef gchar* (*func_get_allowed_ext_t)(void);
 
73
 
 
74
 
 
75
/*!
 
76
 * @typedef     func_get_allowed_name_t
 
77
 *              The function get a list for file name supported by the plugin.
 
78
 * @abstract    Desription plugin functions specification
 
79
 * @return      The file name list separated by <i>"|"</i>.
 
80
 */
 
81
typedef gchar* (*func_get_allowed_name_t)(void);
 
82
 
 
83
 
 
84
/*!
 
85
 * @typedef     func_get_file_descr_t
 
86
 *              The function get the file description.
 
87
 * @abstract    Desription plugin functions specification
 
88
 * @param       file_path       file path to make description
 
89
 * @param       mode            mode to build description
 
90
 * @return      The file description.
 
91
 */
 
92
typedef gchar* (*func_get_file_descr_t)(const char* file_path, const char* mode);
 
93
 
 
94
 
 
95
/*!
 
96
 * @typedef     func_get_files_descr_t
 
97
 *              The function get the files description.
 
98
 * @abstract    Desription plugin functions specification
 
99
 * @param       file_path       file path to make description
 
100
 * @param       mode            mode to build description
 
101
 * @return      The file description.
 
102
 */
 
103
typedef gchar*** (*func_get_files_descr_t)(const char* file_path, const char* mode);
 
104
 
 
105
 
 
106
/*!
 
107
 * @typedef     func_descr_t
 
108
 *              The function get the author of the plugin.
 
109
 * @abstract    Desription plugin functions specification
 
110
 * @param       file_name               file name to get description
 
111
 */
 
112
typedef gchar* (*func_get_parent_descr_t)(const char*, const char*);
 
113
 
 
114
 
 
115
 
 
116
#endif