ui/packet_list_utils.h

   1 /** @file
   2  *
   3  * Wireshark - Network traffic analyzer
   4  * By Gerald Combs <gerald@wireshark.org>
   5  * Copyright 1998 Gerald Combs
   6  *
   7  * SPDX-License-Identifier: GPL-2.0-or-later
   8  */
   9
  10 #ifndef __PACKET_LIST_UTILS_H__
  11 #define __PACKET_LIST_UTILS_H__
  12
  13 #include "cfile.h"
  14
  15 #ifdef __cplusplus
  16 extern "C" {
  17 #endif /* __cplusplus */
  18
  19 /**
  20  * Check to see if a column should be right justified.
  21  *
  22  * @param [in] col The column number.
  23  * @param [in] cf The capture file containing the packet data.
  24  *
  25  * @return true if the column should be right justified, false otherwise.
  26  */
  27 bool right_justify_column (int col, capture_file *cf);
  28
  29 /**
  30  * Check to see if a column's data can be displayed as strings.
  31  *
  32  * @param [in] col The column number.
  33  * @param [in] cf The capture file containing the packet data.
  34  *
  35  * @return true if name displayed as strings is allowed, false otherwise.
  36  */
  37 bool display_column_strings (int col, capture_file *cf);
  38
  39 /**
  40  * Check to see if a column's data can be displayed as packet details.
  41  *
  42  * @param [in] col The column number.
  43  * @param [in] cf The capture file containing the packet data.
  44  *
  45  * @return true if displayed as details is allowed, false otherwise.
  46  */
  47 bool display_column_details (int col, capture_file *cf);
  48
  49 /**
  50  * @brief The following methods have to be implemented by any class that
  51  * whishes to represent a packet list.
  52  */
  53
  54 /** Write all packet list geometry values to the recent file.
  55  *
  56  *  @param rf recent file handle from caller
  57  */
  58 extern void packet_list_recent_write_all(FILE *rf);
  59
  60 extern void packet_list_clear(void);
  61 extern void packet_list_freeze(void);
  62 extern void packet_list_recreate_visible_rows(void);
  63 extern void packet_list_thaw(void);
  64 extern unsigned packet_list_append(column_info *cinfo, frame_data *fdata);
  65 extern void packet_list_queue_draw(void);
  66 extern bool packet_list_select_row_from_data(frame_data *fdata_needle);
  67 extern bool packet_list_select_finfo(field_info *fi);
  68 extern bool packet_list_multi_select_active(void);
  69
  70 #ifdef __cplusplus
  71 }
  72 #endif /* __cplusplus */
  73
  74 #endif /* __PACKET_LIST_UTILS_H__ */