annotate src/editors.h @ 757:eb2e2dac712d

Tidy up: indentation fixes, typo fixes, ...
author zas_
date Sun, 25 May 2008 20:17:07 +0000
parents 477f48ba28d8
children 7148e125bf23
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
9
d907d608745f Sync to GQview 1.5.9 release.
gqview
parents:
diff changeset
1 /*
196
f6e307c7bad6 rename GQview -> Geeqie over the code
nadvornik
parents: 140
diff changeset
2 * Geeqie
9
d907d608745f Sync to GQview 1.5.9 release.
gqview
parents:
diff changeset
3 * (C) 2004 John Ellis
475
48c8e49b571c updated copyright in source files
nadvornik
parents: 446
diff changeset
4 * Copyright (C) 2008 The Geeqie Team
9
d907d608745f Sync to GQview 1.5.9 release.
gqview
parents:
diff changeset
5 *
d907d608745f Sync to GQview 1.5.9 release.
gqview
parents:
diff changeset
6 * Author: John Ellis
d907d608745f Sync to GQview 1.5.9 release.
gqview
parents:
diff changeset
7 *
d907d608745f Sync to GQview 1.5.9 release.
gqview
parents:
diff changeset
8 * This software is released under the GNU General Public License (GNU GPL).
d907d608745f Sync to GQview 1.5.9 release.
gqview
parents:
diff changeset
9 * Please read the included file COPYING for more information.
d907d608745f Sync to GQview 1.5.9 release.
gqview
parents:
diff changeset
10 * This software comes with no warranty of any kind, use at your own risk!
d907d608745f Sync to GQview 1.5.9 release.
gqview
parents:
diff changeset
11 */
d907d608745f Sync to GQview 1.5.9 release.
gqview
parents:
diff changeset
12
d907d608745f Sync to GQview 1.5.9 release.
gqview
parents:
diff changeset
13
d907d608745f Sync to GQview 1.5.9 release.
gqview
parents:
diff changeset
14 #ifndef EDITORS_H
d907d608745f Sync to GQview 1.5.9 release.
gqview
parents:
diff changeset
15 #define EDITORS_H
d907d608745f Sync to GQview 1.5.9 release.
gqview
parents:
diff changeset
16
140
e57b0207e180 editors.c was almost completely rewritten:
nadvornik
parents: 138
diff changeset
17 enum {
e57b0207e180 editors.c was almost completely rewritten:
nadvornik
parents: 138
diff changeset
18 EDITOR_KEEP_FS = 0x00000001,
e57b0207e180 editors.c was almost completely rewritten:
nadvornik
parents: 138
diff changeset
19 EDITOR_VERBOSE = 0x00000002,
e57b0207e180 editors.c was almost completely rewritten:
nadvornik
parents: 138
diff changeset
20 EDITOR_VERBOSE_MULTI = 0x00000004,
442
4b2d7f9af171 Big whitespaces cleanup:
zas_
parents: 234
diff changeset
21
140
e57b0207e180 editors.c was almost completely rewritten:
nadvornik
parents: 138
diff changeset
22 EDITOR_DEST = 0x00000100,
e57b0207e180 editors.c was almost completely rewritten:
nadvornik
parents: 138
diff changeset
23 EDITOR_FOR_EACH = 0x00000200,
e57b0207e180 editors.c was almost completely rewritten:
nadvornik
parents: 138
diff changeset
24 EDITOR_SINGLE_COMMAND = 0x00000400,
442
4b2d7f9af171 Big whitespaces cleanup:
zas_
parents: 234
diff changeset
25
140
e57b0207e180 editors.c was almost completely rewritten:
nadvornik
parents: 138
diff changeset
26 EDITOR_ERROR_EMPTY = 0x00020000,
e57b0207e180 editors.c was almost completely rewritten:
nadvornik
parents: 138
diff changeset
27 EDITOR_ERROR_SYNTAX = 0x00040000,
e57b0207e180 editors.c was almost completely rewritten:
nadvornik
parents: 138
diff changeset
28 EDITOR_ERROR_INCOMPATIBLE = 0x00080000,
e57b0207e180 editors.c was almost completely rewritten:
nadvornik
parents: 138
diff changeset
29 EDITOR_ERROR_NO_FILE = 0x00100000,
e57b0207e180 editors.c was almost completely rewritten:
nadvornik
parents: 138
diff changeset
30 EDITOR_ERROR_CANT_EXEC = 0x00200000,
e57b0207e180 editors.c was almost completely rewritten:
nadvornik
parents: 138
diff changeset
31 EDITOR_ERROR_STATUS = 0x00400000,
e57b0207e180 editors.c was almost completely rewritten:
nadvornik
parents: 138
diff changeset
32 EDITOR_ERROR_SKIPPED = 0x00800000,
e57b0207e180 editors.c was almost completely rewritten:
nadvornik
parents: 138
diff changeset
33
e57b0207e180 editors.c was almost completely rewritten:
nadvornik
parents: 138
diff changeset
34 EDITOR_ERROR_MASK = 0xffff0000
442
4b2d7f9af171 Big whitespaces cleanup:
zas_
parents: 234
diff changeset
35
140
e57b0207e180 editors.c was almost completely rewritten:
nadvornik
parents: 138
diff changeset
36 };
e57b0207e180 editors.c was almost completely rewritten:
nadvornik
parents: 138
diff changeset
37
e57b0207e180 editors.c was almost completely rewritten:
nadvornik
parents: 138
diff changeset
38 /* return values from callback function */
e57b0207e180 editors.c was almost completely rewritten:
nadvornik
parents: 138
diff changeset
39 enum {
e57b0207e180 editors.c was almost completely rewritten:
nadvornik
parents: 138
diff changeset
40 EDITOR_CB_CONTINUE = 0, /* continue multiple editor execution on remaining files*/
e57b0207e180 editors.c was almost completely rewritten:
nadvornik
parents: 138
diff changeset
41 EDITOR_CB_SKIP, /* skip the remaining files */
e57b0207e180 editors.c was almost completely rewritten:
nadvornik
parents: 138
diff changeset
42 EDITOR_CB_SUSPEND /* suspend execution, one of editor_resume or editor_skip
442
4b2d7f9af171 Big whitespaces cleanup:
zas_
parents: 234
diff changeset
43 must be called later */
140
e57b0207e180 editors.c was almost completely rewritten:
nadvornik
parents: 138
diff changeset
44 };
e57b0207e180 editors.c was almost completely rewritten:
nadvornik
parents: 138
diff changeset
45
e57b0207e180 editors.c was almost completely rewritten:
nadvornik
parents: 138
diff changeset
46
e57b0207e180 editors.c was almost completely rewritten:
nadvornik
parents: 138
diff changeset
47 /*
442
4b2d7f9af171 Big whitespaces cleanup:
zas_
parents: 234
diff changeset
48 Callback is called even on skipped files, with the EDITOR_ERROR_SKIPPED flag set.
140
e57b0207e180 editors.c was almost completely rewritten:
nadvornik
parents: 138
diff changeset
49 It is a good place to call file_data_change_info_free().
e57b0207e180 editors.c was almost completely rewritten:
nadvornik
parents: 138
diff changeset
50
e57b0207e180 editors.c was almost completely rewritten:
nadvornik
parents: 138
diff changeset
51 ed - pointer that can be used for editor_resume/editor_skip or NULL if all files were already processed
e57b0207e180 editors.c was almost completely rewritten:
nadvornik
parents: 138
diff changeset
52 flags - flags above
e57b0207e180 editors.c was almost completely rewritten:
nadvornik
parents: 138
diff changeset
53 list - list of procesed FileData structures, typically single file or whole list passed to start_editor_*
e57b0207e180 editors.c was almost completely rewritten:
nadvornik
parents: 138
diff changeset
54 data - generic pointer
e57b0207e180 editors.c was almost completely rewritten:
nadvornik
parents: 138
diff changeset
55 */
e57b0207e180 editors.c was almost completely rewritten:
nadvornik
parents: 138
diff changeset
56 typedef gint (*EditorCallback) (gpointer ed, gint flags, GList *list, gpointer data);
e57b0207e180 editors.c was almost completely rewritten:
nadvornik
parents: 138
diff changeset
57
e57b0207e180 editors.c was almost completely rewritten:
nadvornik
parents: 138
diff changeset
58
e57b0207e180 editors.c was almost completely rewritten:
nadvornik
parents: 138
diff changeset
59
e57b0207e180 editors.c was almost completely rewritten:
nadvornik
parents: 138
diff changeset
60 void editor_resume(gpointer ed);
e57b0207e180 editors.c was almost completely rewritten:
nadvornik
parents: 138
diff changeset
61 void editor_skip(gpointer ed);
e57b0207e180 editors.c was almost completely rewritten:
nadvornik
parents: 138
diff changeset
62
e57b0207e180 editors.c was almost completely rewritten:
nadvornik
parents: 138
diff changeset
63
e57b0207e180 editors.c was almost completely rewritten:
nadvornik
parents: 138
diff changeset
64 gint editor_command_parse(const gchar *template, GList *list, gchar **output);
9
d907d608745f Sync to GQview 1.5.9 release.
gqview
parents:
diff changeset
65
d907d608745f Sync to GQview 1.5.9 release.
gqview
parents:
diff changeset
66 void editor_reset_defaults(void);
138
71e1ebee420e replaced gchar* path with FileData *fd
nadvornik
parents: 136
diff changeset
67 gint start_editor_from_file(gint n, FileData *fd);
234
39262b9ce195 Fix typos in functions names: file_list -> filelist.
zas_
parents: 196
diff changeset
68 gint start_editor_from_filelist(gint n, GList *list);
140
e57b0207e180 editors.c was almost completely rewritten:
nadvornik
parents: 138
diff changeset
69 gint start_editor_from_file_full(gint n, FileData *fd, EditorCallback cb, gpointer data);
234
39262b9ce195 Fix typos in functions names: file_list -> filelist.
zas_
parents: 196
diff changeset
70 gint start_editor_from_filelist_full(gint n, GList *list, EditorCallback cb, gpointer data);
60
9c0c402b0ef3 Mon Jun 13 17:31:46 2005 John Ellis <johne@verizon.net>
gqview
parents: 9
diff changeset
71 gint editor_window_flag_set(gint n);
753
477f48ba28d8 rewritten utilops.h:
nadvornik
parents: 731
diff changeset
72 gint editor_is_filter(gint n);
140
e57b0207e180 editors.c was almost completely rewritten:
nadvornik
parents: 138
diff changeset
73 const gchar *editor_get_error_str(gint flags);
9
d907d608745f Sync to GQview 1.5.9 release.
gqview
parents:
diff changeset
74
731
fa8f7d7396cf Introduce an helper function that returns the name of an editor.
zas_
parents: 475
diff changeset
75 const gchar *editor_get_name(gint n);
fa8f7d7396cf Introduce an helper function that returns the name of an editor.
zas_
parents: 475
diff changeset
76
9
d907d608745f Sync to GQview 1.5.9 release.
gqview
parents:
diff changeset
77 #endif