clang-tidy: readability-non-const-parameter
[geeqie.git] / src / ui-utildlg.h
1 /*
2  * Copyright (C) 2004 John Ellis
3  * Copyright (C) 2008 - 2016 The Geeqie Team
4  *
5  * Author: John Ellis
6  *
7  * This program is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 2 of the License, or
10  * (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License along
18  * with this program; if not, write to the Free Software Foundation, Inc.,
19  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
20  */
21
22 #ifndef UI_UTILDLG_H
23 #define UI_UTILDLG_H
24
25 struct FileData;
26
27 #define GENERIC_DIALOG(gd) ((GenericDialog *)gd)
28
29 struct GenericDialog
30 {
31         GtkWidget *dialog;      /**< window */
32         GtkWidget *vbox;        /**< place to add widgets */
33
34         GtkWidget *hbox;        /**< button hbox */
35
36         gboolean auto_close;
37
38         void (*default_cb)(GenericDialog *, gpointer);
39         void (*cancel_cb)(GenericDialog *, gpointer);
40         gpointer data;
41
42         GtkWidget *cancel_button; /**< private */
43
44 };
45
46 struct FileDialog
47 {
48         GenericDialog gd;
49
50         GtkWidget *entry;
51
52         gint type;
53
54         FileData *source_fd;
55         GList *source_list;
56
57         gchar *dest_path;
58 };
59
60
61 /**
62  * @headerfile generic_dialog_new
63  * When parent is not NULL, the dialog is set as a transient of the window containing parent
64  */
65 GenericDialog *generic_dialog_new(const gchar *title,
66                                   const gchar *role,
67                                   GtkWidget *parent, gboolean auto_close,
68                                   void (*cancel_cb)(GenericDialog *, gpointer), gpointer data);
69 void generic_dialog_close(GenericDialog *gd);
70
71 GtkWidget *generic_dialog_add_button(GenericDialog *gd, const gchar *icon_name, const gchar *text,
72                                      void (*func_cb)(GenericDialog *, gpointer), gboolean is_default);
73 void generic_dialog_attach_default(GenericDialog *gd, GtkWidget *widget);
74
75 GtkWidget *generic_dialog_add_message(GenericDialog *gd, const gchar *icon_name,
76                                       const gchar *heading, const gchar *text, gboolean expand);
77
78 gboolean generic_dialog_get_alternative_button_order(GtkWidget *widget);
79
80 GenericDialog *warning_dialog(const gchar *heading, const gchar *text,
81                               const gchar *icon_name, GtkWidget *parent);
82
83 FileDialog *file_dialog_new(const gchar *title,
84                             const gchar *role,
85                             GtkWidget *parent,
86                             void (*cancel_cb)(FileDialog *, gpointer), gpointer data);
87 void file_dialog_close(FileDialog *fd);
88
89 GtkWidget *file_dialog_add_button(FileDialog *fd, const gchar *stock_id, const gchar *text,
90                                   void (*func_cb)(FileDialog *, gpointer), gboolean is_default);
91
92 /**
93  * @headerfile file_dialog_add_path_widgets
94  * default_path is default base directory, and is only used if no history
95  * exists for history_key (HOME is used if default_path is NULL).
96  * path can be a full path or only a file name. If name only, appended to
97  * the default_path or the last history (see default_path)
98  */
99 void file_dialog_add_path_widgets(FileDialog *fd, const gchar *default_path, const gchar *path,
100                                   const gchar *history_key, const gchar *filter, const gchar *filter_desc);
101
102 void file_dialog_clear_filter(FileDialog *fd);
103 void file_dialog_sync_history(FileDialog *fd, gboolean dir_only);
104
105 void generic_dialog_windows_load_config(const gchar **attribute_names, const gchar **attribute_values);
106 void generic_dialog_windows_write_config(GString *outstr, gint indent);
107
108 void appimage_notification();
109 #endif
110 /* vim: set shiftwidth=8 softtabstop=0 cindent cinoptions={1s: */