Preparations for using the latest GTK 2.8 files for now only gettext is updated.

[obnox/wireshark/wip.git] / capture_ui_utils.h

diff --git a/capture_ui_utils.h b/capture_ui_utils.h
index f97defa890229443d18bc217c344a42b110b23a0..637c6ccc28f25bb46bc63d7687a900a26541c36a 100644 (file)
--- a/capture_ui_utils.h
+++ b/capture_ui_utils.h
@@ -3,8 +3,8 @@
  *
  * $Id$
  *
- * Ethereal - Network traffic analyzer
- * By Gerald Combs <gerald@ethereal.com>
+ * Wireshark - Network traffic analyzer
+ * By Gerald Combs <gerald@wireshark.org>
  * Copyright 1998 Gerald Combs
  *
  * This program is free software; you can redistribute it and/or
@@ -34,9 +34,9 @@
  * if get_interface_list() supplies a description, use that,
  * otherwise use the interface name.
  *
- * @param if_name The name if the interface.
+ * @param if_name The name of the interface.
  *
- * @return The descriptive name.
+ * @return The descriptive name (must be g_free'd later)
  */
 char *get_interface_descriptive_name(const char *if_name);
 
@@ -45,7 +45,7 @@ char *get_interface_descriptive_name(const char *if_name);
  * @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.
+ * @return A list of if_info_t structs (use free_capture_combo_list() later).
  */
 GList *build_capture_combo_list(GList *if_list, gboolean do_hide);
 
@@ -63,8 +63,17 @@ void free_capture_combo_list(GList *combo_list);
  * This is usually the data from one of the list elements returned by
  * build_capture_combo_list().
  *
- * @return The raw interface name, sans description.
+ * @return The raw interface name, without description (must NOT be g_free'd later)
  */
-char *get_if_name(char *if_text);
+const char *get_if_name(const char *if_text);
+
+/** Convert plain interface name to the displayed name in the combo box.
+ *
+ * @param if_list The list of interfaces returned by build_capture_combo_list()
+ * @param if_name The name of the interface.
+ *
+ * @return The descriptive name (must be g_free'd later)
+ */
+char * build_capture_combo_name(GList *if_list, gchar *if_name);
 
 #endif