Rename capture_combo_utils.{c,h} to capture_ui_utils.{c,h}, as the code

in there is for UI functions including, but not limited to, the combo
box in capture dialogs.


git-svn-id: http://anonsvn.wireshark.org/wireshark/trunk@13061 f5534014-38df-0310-8fa8-9805f1628bb7

1 files changed, 70 insertions, 0 deletions

diff --git a/capture_ui_utils.h b/capture_ui_utils.h
new file mode 100644
index 0000000000..f97defa890
--- /dev/null
+++ b/capture_ui_utils.h
@@ -0,0 +1,70 @@
+/* capture_ui_utils.c
+ * Declarations of utilities for capture user interfaces
+ *
+ * $Id$
+ *
+ * Ethereal - Network traffic analyzer
+ * By Gerald Combs <gerald@ethereal.com>
+ * 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 __CAPTURE_UI_UTILS_H__
+#define __CAPTURE_UI_UTILS_H__
+
+/** @file
+ *  GList of available capture interfaces.
+ */
+
+/** Return as descriptive a name for an interface as we can get.
+ * If the user has specified a comment, use that.  Otherwise,
+ * if get_interface_list() supplies a description, use that,
+ * otherwise use the interface name.
+ *
+ * @param if_name The name if the interface.
+ *
+ * @return The descriptive name.
+ */
+char *get_interface_descriptive_name(const char *if_name);
+
+/** Build the GList of available capture interfaces.
+ *
+ * @param if_list An interface list from get_interface_list().
+ * @param do_hide Hide the "hidden" interfaces.
+ *
+ * @return A list of if_info_t structs.
+ */
+GList *build_capture_combo_list(GList *if_list, gboolean do_hide);
+
+/** Free the GList from build_capture_combo_list().
+ *
+ * @param combo_list the interface list from build_capture_combo_list()
+ */
+void free_capture_combo_list(GList *combo_list);
+
+
+/** Given text that contains an interface name possibly prefixed by an
+ * interface description, extract the interface name.
+ *
+ * @param if_text A string containing the interface description + name.
+ * This is usually the data from one of the list elements returned by
+ * build_capture_combo_list().
+ *
+ * @return The raw interface name, sans description.
+ */
+char *get_if_name(char *if_text);
+
+#endif