aboutsummaryrefslogtreecommitdiffstats
path: root/epan/prefs-int.h
diff options
context:
space:
mode:
authorMichael Mann <mmann78@netscape.net>2018-01-06 19:03:36 -0500
committerAnders Broman <a.broman58@gmail.com>2018-01-09 13:09:18 +0000
commit3f2f16411fb2f9582294227594549fb8fdd9a227 (patch)
treedc36813894b0668eee2bbbb10b02a72c6e377440 /epan/prefs-int.h
parent4e87f6c01a7bd0dc29959492e758eb6fae0a9fc9 (diff)
Convert GUI layout preferences to use preference effects.
Another simple example of how to use preference effects to limit the times a capture file is redissected unnecessarily. Also clean up some of the grammar of preference effect descriptions. Change-Id: I2db92e8e3ee913d3b37162916bd0ef7ac8ecd794 Reviewed-on: https://code.wireshark.org/review/25175 Reviewed-by: Michael Mann <mmann78@netscape.net> Petri-Dish: Michael Mann <mmann78@netscape.net> Tested-by: Petri Dish Buildbot Reviewed-by: Anders Broman <a.broman58@gmail.com>
Diffstat (limited to 'epan/prefs-int.h')
-rw-r--r--epan/prefs-int.h11
1 files changed, 6 insertions, 5 deletions
diff --git a/epan/prefs-int.h b/epan/prefs-int.h
index deddad2c3f..edfadfce0e 100644
--- a/epan/prefs-int.h
+++ b/epan/prefs-int.h
@@ -148,14 +148,15 @@ gui_type_t prefs_get_gui_type(pref_t *pref);
WS_DLL_PUBLIC guint32 prefs_get_max_value(pref_t *pref);
-/* Bitmask of flags for how a preference could affect changes in Wireshark */
+/* Bitmask of flags for the effect of a preference in Wireshark */
#define PREF_EFFECT_DISSECTION (1u << 0)
#define PREF_EFFECT_CAPTURE (1u << 1)
#define PREF_EFFECT_GUI (1u << 2)
#define PREF_EFFECT_FONT (1u << 3)
+#define PREF_EFFECT_GUI_LAYOUT (1u << 4)
#define PREF_EFFECT_CUSTOM (1u << 31)
-/** Fetch flags that show preference effect
+/** Fetch flags that show the effect of the preference
*
* @param pref A preference.
*
@@ -165,11 +166,11 @@ WS_DLL_PUBLIC guint32 prefs_get_max_value(pref_t *pref);
WS_DLL_PUBLIC
unsigned int prefs_get_effect_flags(pref_t *pref);
-/** Set flags for preference effect
+/** Set flags for the effect of the preference
* The intention is to distinguish preferences that affect
* dissection from those that don't. A bitmask was added to
- * provide great flexibility in the types of things that a
- * preference could affect.
+ * provide greater flexibility in the types of effects
+ * preferences can have.
*
* @param pref A preference.
* @param flags Bitmask of flags to apply to preference. Note that flags