epan/column.h

   1 /* column.h
   2  * Definitions for column handling routines
   3  *
   4  * Wireshark - Network traffic analyzer
   5  * By Gerald Combs <gerald@wireshark.org>
   6  * Copyright 1998 Gerald Combs
   7  *
   8  * SPDX-License-Identifier: GPL-2.0-or-later
   9  */
  10
  11 #ifndef __COLUMN_H__
  12 #define __COLUMN_H__
  13
  14 #include "ws_symbol_export.h"
  15 #include <epan/column-info.h>
  16
  17 #ifdef __cplusplus
  18 extern "C" {
  19 #endif /* __cplusplus */
  20
  21 typedef struct _fmt_data {
  22   gchar *title;            /* title of the column */
  23   int fmt;                 /* format of column */
  24   gchar *custom_fields;    /* fields names for COL_CUSTOM */
  25   gint custom_occurrence;  /* optional ordinal of occurrence of that field */
  26   gboolean visible;        /* if FALSE, hide this column */
  27   gboolean resolved;       /* if TRUE, show a more human-readable name */
  28 } fmt_data;
  29
  30 WS_DLL_PUBLIC
  31 const gchar         *col_format_to_string(const gint);
  32 WS_DLL_PUBLIC
  33 const gchar         *col_format_desc(const gint);
  34 WS_DLL_PUBLIC
  35 gint                 get_column_format(const gint);
  36 WS_DLL_PUBLIC
  37 void                 set_column_format(const gint, const gint);
  38 WS_DLL_PUBLIC
  39 void                 get_column_format_matches(gboolean *, const gint);
  40 WS_DLL_PUBLIC
  41 gint                 get_column_format_from_str(const gchar *);
  42 WS_DLL_PUBLIC
  43 gchar               *get_column_title(const gint);
  44 WS_DLL_PUBLIC
  45 void                 set_column_title(const gint, const gchar *);
  46 WS_DLL_PUBLIC
  47 gboolean             get_column_visible(const gint);
  48 WS_DLL_PUBLIC
  49 void                 set_column_visible(const gint, gboolean);
  50 WS_DLL_PUBLIC
  51 gboolean             get_column_resolved(const gint);
  52 WS_DLL_PUBLIC
  53 void                 set_column_resolved(const gint, gboolean);
  54 WS_DLL_PUBLIC
  55 const gchar         *get_column_custom_fields(const gint);
  56 WS_DLL_PUBLIC
  57 void                 set_column_custom_fields(const gint, const char *);
  58 WS_DLL_PUBLIC
  59 gint                 get_column_custom_occurrence(const gint);
  60 WS_DLL_PUBLIC
  61 void                 set_column_custom_occurrence(const gint, const gint);
  62 WS_DLL_PUBLIC
  63 const gchar         *get_column_width_string(const gint, const gint);
  64 WS_DLL_PUBLIC
  65 gint                 get_column_char_width(const gint format);
  66 WS_DLL_PUBLIC
  67 gchar               *get_column_tooltip(const gint col);
  68
  69 WS_DLL_PUBLIC
  70 void
  71 col_finalize(column_info *cinfo);
  72
  73 WS_DLL_PUBLIC
  74 void
  75 build_column_format_array(column_info *cinfo, const gint num_cols, const gboolean reset_fences);
  76
  77 WS_DLL_PUBLIC
  78 void                 column_dump_column_formats(void);
  79
  80 #ifdef __cplusplus
  81 }
  82 #endif /* __cplusplus */
  83
  84 #endif /* column.h */