doxygen: various warning fixes
[midnight-commander.git] / src / viewer / mcviewer.h
blob3233de961a287099594d7d73a8f78b44f08b6dc5
1 /** \file mcviewer.h
2 * \brief Header: internal file viewer
3 */
5 #ifndef MC_VIEWER_H
6 #define MC_VIEWER_H
8 /*** typedefs(not structures) and defined constants ********************/
10 struct mcview_struct;
12 /*** enums *************************************************************/
14 /*** structures declarations (and typedefs of structures)***************/
16 /*** global variables defined in .c file *******************************/
18 extern int mcview_default_hex_mode;
19 extern int mcview_default_nroff_flag;
20 extern int mcview_global_wrap_mode;
21 extern int mcview_default_magic_flag;
23 extern int mcview_altered_hex_mode;
24 extern int mcview_altered_magic_flag;
25 extern int mcview_altered_nroff_flag;
27 extern int mcview_remember_file_position;
28 extern int mcview_max_dirt_limit;
30 extern int mcview_mouse_move_pages;
32 /*** declarations of public functions **********************************/
35 /* Creates a new mcview_t object with the given properties. Caveat: the
36 * origin is in y-x order, while the extent is in x-y order. */
37 extern struct mcview_struct *mcview_new (int, int, int, int, int);
40 /* Shows {file} or the output of {command} in the internal viewer,
41 * starting in line {start_line}. {move_dir_p} may be NULL or
42 * point to a variable that will receive the direction in which the user
43 * wants to move (-1 = previous file, 1 = next file, 0 = do nothing).
45 extern int mcview_viewer (const char *command, const char *file,
46 int *move_dir_p, int start_line);
48 extern gboolean mcview_load (struct mcview_struct *, const char *, const char *, int);
50 #endif