163 lines
4.7 KiB
C
163 lines
4.7 KiB
C
/* prefs.h
|
|
* Definitions for preference handling routines
|
|
*
|
|
* $Id: prefs.h,v 1.20 2000/08/17 21:02:10 deniel Exp $
|
|
*
|
|
* Ethereal - Network traffic analyzer
|
|
* By Gerald Combs <gerald@zing.org>
|
|
* Copyright 1998 Gerald Combs
|
|
*
|
|
*
|
|
* 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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
|
|
*/
|
|
|
|
#ifndef __PREFS_H__
|
|
#define __PREFS_H__
|
|
|
|
#define PR_DEST_CMD 0
|
|
#define PR_DEST_FILE 1
|
|
|
|
#ifndef __GTK_H__
|
|
#include <gtk/gtk.h>
|
|
#endif
|
|
|
|
typedef struct _e_prefs {
|
|
gint pr_format;
|
|
gint pr_dest;
|
|
gchar *pr_file;
|
|
gchar *pr_cmd;
|
|
GList *col_list;
|
|
gint num_cols;
|
|
GdkColor st_client_fg, st_client_bg, st_server_fg, st_server_bg;
|
|
gboolean gui_scrollbar_on_right;
|
|
gboolean gui_plist_sel_browse;
|
|
gboolean gui_ptree_sel_browse;
|
|
gint gui_ptree_line_style;
|
|
gint gui_ptree_expander_style;
|
|
} e_prefs;
|
|
|
|
extern e_prefs prefs;
|
|
|
|
/*
|
|
* Routines to let modules that have preference settings register
|
|
* themselves by name, and to let them register preference settings
|
|
* by name.
|
|
*/
|
|
struct pref_module;
|
|
|
|
typedef struct pref_module module_t;
|
|
|
|
/*
|
|
* Register a module that will have preferences.
|
|
* Specify the name used for the module in the preferences file, the
|
|
* title used in the tab for it in a preferences dialog box, and a
|
|
* routine to call back when we apply the preferences.
|
|
* Note:
|
|
* In case of dissectors, the specified name should be the protocol
|
|
* name specified at the proto_register_protocol() call in order to
|
|
* make the "Protocol Properties..." menu item work.
|
|
*/
|
|
module_t *prefs_register_module(const char *name, const char *title,
|
|
void (*apply_cb)(void));
|
|
|
|
typedef void (*module_cb)(module_t *module, gpointer user_data);
|
|
|
|
/*
|
|
* Call a callback function, with a specified argument, for each module.
|
|
*/
|
|
void prefs_module_foreach(module_cb callback, gpointer user_data);
|
|
|
|
/*
|
|
* Call the "apply" callback function for each module if any of its
|
|
* preferences have changed, and then clear the flag saying its
|
|
* preferences have changed, as the module has been notified of that
|
|
* fact.
|
|
*/
|
|
void prefs_apply_all(void);
|
|
|
|
struct preference;
|
|
|
|
typedef struct preference pref_t;
|
|
|
|
/*
|
|
* Returns TRUE if the given protocol has registered preferences
|
|
*/
|
|
gboolean prefs_is_registered_protocol(char *name);
|
|
|
|
/*
|
|
* Returns the module title of a registered protocol (or NULL if unknown)
|
|
*/
|
|
const char *prefs_get_title_by_name(char *name);
|
|
|
|
/*
|
|
* Register a preference with an unsigned integral value.
|
|
*/
|
|
void prefs_register_uint_preference(module_t *module, const char *name,
|
|
const char *title, const char *description, guint base, guint *var);
|
|
|
|
/*
|
|
* Register a preference with an Boolean value.
|
|
*/
|
|
void prefs_register_bool_preference(module_t *module, const char *name,
|
|
const char *title, const char *description, gboolean *var);
|
|
|
|
/*
|
|
* Register a preference with an enumerated value.
|
|
*/
|
|
typedef struct {
|
|
char *name;
|
|
gint value;
|
|
} enum_val;
|
|
|
|
void prefs_register_enum_preference(module_t *module, const char *name,
|
|
const char *title, const char *description, gint *var,
|
|
const enum_val *enumvals, gboolean radio_buttons);
|
|
|
|
/*
|
|
* Register a preference with a character-string value.
|
|
*/
|
|
void prefs_register_string_preference(module_t *module, const char *name,
|
|
const char *title, const char *description, char **var);
|
|
|
|
typedef void (*pref_cb)(pref_t *pref, gpointer user_data);
|
|
|
|
/*
|
|
* Call a callback function, with a specified argument, for each preference
|
|
* in a given module.
|
|
*/
|
|
void prefs_pref_foreach(module_t *module, pref_cb callback, gpointer user_data);
|
|
|
|
/*
|
|
* Register all non-dissector modules' preferences.
|
|
*/
|
|
void prefs_register_modules(void);
|
|
|
|
e_prefs *read_prefs(int *, char **, int *, char **);
|
|
int write_prefs(char **);
|
|
|
|
/*
|
|
* Given a string of the form "<pref name>:<pref value>", as might appear
|
|
* as an argument to a "-o" option, parse it and set the preference in
|
|
* question. Return an indication of whether it succeeded or failed
|
|
* in some fashion.
|
|
*/
|
|
#define PREFS_SET_OK 0 /* succeeded */
|
|
#define PREFS_SET_SYNTAX_ERR 1 /* syntax error in string */
|
|
#define PREFS_SET_NO_SUCH_PREF 2 /* no such preference */
|
|
|
|
int prefs_set_pref(char *prefarg);
|
|
|
|
#endif /* prefs.h */
|