src/view-file.h

   1 /*
   2  * Copyright (C) 2008 - 2016 The Geeqie Team
   3  *
   4  * Author: Laurent Monin
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License along
  17  * with this program; if not, write to the Free Software Foundation, Inc.,
  18  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  19  */
  20
  21 #ifndef VIEW_FILE_H
  22 #define VIEW_FILE_H
  23
  24 #include <ctime>
  25 #include <functional>
  26
  27 #include <glib.h>
  28 #include <gtk/gtk.h>
  29
  30 #include "typedefs.h"
  31
  32 struct FileData;
  33 struct LayoutWindow;
  34 struct ThumbLoader;
  35
  36 struct ViewFile
  37 {
  38         FileViewType type;      /**< @todo (xsdg): Turn this into a union (see VFLIST and VFICON). */
  39
  40         gpointer info;
  41
  42         GtkWidget *widget;
  43         GtkWidget *listview;
  44         GtkWidget *scrolled;
  45         GtkWidget *filter;
  46         GtkWidget *filter_check[FILEDATA_MARKS_SIZE];
  47
  48         struct {
  49                 GtkWidget *combo;
  50                 GtkWidget *frame;
  51                 gint count;
  52                 gint last_selected;
  53                 gboolean case_sensitive;
  54         } file_filter;
  55
  56         FileData *dir_fd;
  57         GList *list;
  58
  59         FileData *click_fd;
  60
  61         SortType sort_method;
  62         gboolean sort_ascend;
  63         gboolean sort_case;
  64
  65         /* func list */
  66         void (*func_thumb_status)(ViewFile *vf, gdouble val, const gchar *text, gpointer data);
  67         gpointer data_thumb_status;
  68
  69         void (*func_status)(ViewFile *vf, gpointer data);
  70         gpointer data_status;
  71
  72         LayoutWindow *layout;
  73
  74         GtkWidget *popup;
  75
  76         /* thumbs updates*/
  77         gboolean thumbs_running;
  78         ThumbLoader *thumbs_loader;
  79         FileData *thumbs_filedata;
  80
  81         /* marks */
  82         gboolean marks_enabled;
  83         gint active_mark;
  84         gint clicked_mark;
  85
  86         /* stars */
  87         FileData *stars_filedata;
  88         guint stars_id;
  89
  90         /* refresh */
  91         guint refresh_idle_id; /**< event source id */
  92         time_t time_refresh_set; /**< time when refresh_idle_id was set */
  93
  94         GList *editmenu_fd_list; /**< file list for edit menu */
  95
  96         guint read_metadata_in_idle_id;
  97 };
  98
  99 struct ViewFileInfoList
 100 {
 101         FileData *select_fd;
 102
 103         gboolean thumbs_enabled;
 104
 105         guint select_idle_id; /**< event source id */
 106 };
 107
 108 struct ViewFileInfoIcon
 109 {
 110         /* table stuff */
 111         gint columns;
 112         gint rows;
 113
 114         GList *selection;
 115         FileData *prev_selection;
 116
 117         GtkWidget *tip_window;
 118         guint tip_delay_id; /**< event source id */
 119         FileData *tip_fd;
 120
 121         FileData *focus_fd;
 122         gint focus_row;
 123         gint focus_column;
 124
 125         gboolean show_text;
 126 };
 127
 128 #define VFLIST(_vf_) ((ViewFileInfoList *)(_vf_->info))
 129 #define VFICON(_vf_) ((ViewFileInfoIcon *)(_vf_->info))
 130
 131 const gint VIEW_FILE_COLUMN_POINTER = 0; // @todo Use inline constexpr in C++17
 132
 133 void vf_send_update(ViewFile *vf);
 134
 135 ViewFile *vf_new(FileViewType type, FileData *dir_fd);
 136
 137 void vf_set_status_func(ViewFile *vf, void (*func)(ViewFile *vf, gpointer data), gpointer data);
 138 void vf_set_thumb_status_func(ViewFile *vf, void (*func)(ViewFile *vf, gdouble val, const gchar *text, gpointer data), gpointer data);
 139
 140 void vf_set_layout(ViewFile *vf, LayoutWindow *layout);
 141
 142 gboolean vf_set_fd(ViewFile *vf, FileData *fd);
 143 gboolean vf_refresh(ViewFile *vf);
 144 void vf_refresh_idle(ViewFile *vf);
 145
 146 void vf_thumb_set(ViewFile *vf, gboolean enable);
 147 void vf_marks_set(ViewFile *vf, gboolean enable);
 148 void vf_star_rating_set(ViewFile *vf, gboolean enable);
 149 void vf_sort_set(ViewFile *vf, SortType type, gboolean ascend, gboolean case_sensitive);
 150
 151 guint vf_marks_get_filter(ViewFile *vf);
 152 void vf_mark_filter_toggle(ViewFile *vf, gint mark);
 153
 154 guint vf_class_get_filter(ViewFile *vf);
 155
 156 GList *vf_selection_get_one(ViewFile *vf, FileData *fd);
 157 GList *vf_pop_menu_file_list(ViewFile *vf);
 158 GtkWidget *vf_pop_menu(ViewFile *vf);
 159
 160 FileData *vf_index_get_data(ViewFile *vf, gint row);
 161 gint vf_index_by_fd(ViewFile *vf, FileData *in_fd);
 162 guint vf_count(ViewFile *vf, gint64 *bytes);
 163 GList *vf_get_list(ViewFile *vf);
 164
 165 guint vf_selection_count(ViewFile *vf, gint64 *bytes);
 166 GList *vf_selection_get_list(ViewFile *vf);
 167 GList *vf_selection_get_list_by_index(ViewFile *vf);
 168 using ViewFileSelectionCallback = std::function<void(FileData *)>;
 169 void vf_selection_foreach(ViewFile *vf, const ViewFileSelectionCallback &func);
 170
 171 void vf_select_all(ViewFile *vf);
 172 void vf_select_none(ViewFile *vf);
 173 void vf_select_invert(ViewFile *vf);
 174 void vf_select_by_fd(ViewFile *vf, FileData *fd);
 175 void vf_select_list(ViewFile *vf, GList *list);
 176
 177 void vf_mark_to_selection(ViewFile *vf, gint mark, MarkToSelectionMode mode);
 178 void vf_selection_to_mark(ViewFile *vf, gint mark, SelectionToMarkMode mode);
 179
 180 void vf_refresh_idle_cancel(ViewFile *vf);
 181 void vf_notify_cb(FileData *fd, NotifyType type, gpointer data);
 182
 183 void vf_thumb_update(ViewFile *vf);
 184 void vf_thumb_cleanup(ViewFile *vf);
 185 void vf_thumb_stop(ViewFile *vf);
 186 void vf_read_metadata_in_idle(ViewFile *vf);
 187 void vf_file_filter_set(ViewFile *vf, gboolean enable);
 188 GRegex *vf_file_filter_get_filter(ViewFile *vf);
 189
 190 void vf_star_update(ViewFile *vf);
 191 gboolean vf_stars_cb(gpointer data);
 192 void vf_star_stop(ViewFile *vf);
 193 void vf_star_cleanup(ViewFile *vf);
 194
 195 #endif /* VIEW_FILE_H */
 196 /* vim: set shiftwidth=8 softtabstop=0 cindent cinoptions={1s: */