ui/preference_utils.h

   1 /** @file
   2  *
   3  * Routines for handling preferences
   4  *
   5  * Wireshark - Network traffic analyzer
   6  * By Gerald Combs <gerald@wireshark.org>
   7  * Copyright 1998 Gerald Combs
   8  *
   9  * SPDX-License-Identifier: GPL-2.0-or-later
  10  */
  11
  12 #ifndef __PREFERENCE_UTILS_H__
  13 #define __PREFERENCE_UTILS_H__
  14
  15 #include <glib.h>
  16
  17 #ifdef __cplusplus
  18 extern "C" {
  19 #endif /* __cplusplus */
  20
  21 /** @file
  22  * Preference utility routines.
  23  *  @ingroup prefs_group
  24  */
  25
  26 /** If autoscroll in live captures is active or not
  27  */
  28 extern bool auto_scroll_live;
  29
  30 /** Fill in capture options with values from the preferences
  31  */
  32 extern void prefs_to_capture_opts(void);
  33
  34 /** Save all preferences
  35  */
  36 extern void prefs_main_write(void);
  37
  38 /** Convenient function for plugin_if
  39  *
  40  * Note: The preferences must exist, it is not possible to create entries
  41  * using this function
  42  *
  43  * @param module the module for the preference
  44  * @param key the key for the preference
  45  * @param value the new value as string for the preference
  46  *
  47  * @return flags of types of preferences changed, non-zero if the value has been stored successfully
  48  */
  49 extern unsigned int prefs_store_ext(const char * module, const char * key, const char * value);
  50
  51 /** Convenient function for the writing of multiple preferences, without
  52  * explicitly having prefs_t variables.
  53  *
  54  * Note: The preferences must exist, it is not possible to create entries
  55  * using this function
  56  *
  57  * @param module the module for the preference
  58  * @param pref_values a hash table
  59  *
  60  * @return true if the value has been stored successfully
  61  */
  62 extern bool prefs_store_ext_multiple(const char * module, GHashTable * pref_values);
  63
  64 /** Add a custom column.
  65  *
  66  * @param fmt column format
  67  * @param title column title
  68  * @param custom_field column custom field
  69  * @param position the intended position of the insert
  70  *
  71  * @return The index of the inserted column
  72  */
  73 int column_prefs_add_custom(int fmt, const char *title,
  74                              const char *custom_field,
  75                              int position);
  76
  77 /** Check if a custom column exists.
  78  *
  79  * @param custom_field column custom field
  80  *
  81  * @return The index of the column if existing, -1 if not existing
  82  */
  83 int column_prefs_has_custom(const char *custom_field);
  84
  85 /** Check if a custom column's data can be displayed differently
  86  * resolved or unresolved, e.g. it has a field with a value string.
  87  *
  88  * This is for when adding or editing custom columns. Compare with
  89  * display_column_strings() in packet_list_utils.h, which is for columns
  90  * that have already been added.
  91  *
  92  * @param custom_field column custom field
  93  *
  94  * @return true if a custom column with the field description
  95  * would support being displayed differently resolved or unresolved,
  96  * false otherwise.
  97  */
  98 bool column_prefs_custom_display_strings(const char *custom_field);
  99
 100 /** Check if a custom column's data can be displayed with details,
 101  * e.g. it has a field.
 102  *
 103  * This is for when adding or editing custom columns.
 104  *
 105  * @param custom_field column custom field
 106  *
 107  * @return true if a custom column has at least one single field.
 108  */
 109 bool column_prefs_custom_display_details(const char *custom_field);
 110
 111 /** Remove a column.
 112  *
 113  * @param col_link Column list entry
 114  */
 115 void column_prefs_remove_link(GList* col_link);
 116
 117 /** Remove a column.
 118  *
 119  * @param col Column number
 120  */
 121 void column_prefs_remove_nth(int col);
 122
 123 /** Save the UAT and complete migration of old preferences by writing the main
 124  * preferences file (if necessary).
 125  */
 126 void save_migrated_uat(const char *uat_name, bool *old_pref);
 127
 128 #ifdef __cplusplus
 129 }
 130 #endif /* __cplusplus */
 131
 132 #endif /* __PREFERENCE_UTILS_H__ */