remmina_ftp_client.h 5.34 KB
Newer Older
Antenore Gatta's avatar
Antenore Gatta committed
1 2
/*
 * Remmina - The GTK+ Remote Desktop Client
Antenore Gatta's avatar
Antenore Gatta committed
3
 * Copyright (C) 2009-2010 Vic Lee
Antenore Gatta's avatar
Antenore Gatta committed
4
 * Copyright (C) 2014-2015 Antenore Gatta, Fabio Castelli, Giovanni Panozzo
5
 * Copyright (C) 2016-2018 Antenore Gatta, Giovanni Panozzo
Antenore Gatta's avatar
Antenore Gatta committed
6 7 8 9 10 11 12 13 14 15 16 17 18
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
Antenore Gatta's avatar
Antenore Gatta committed
19
 * Foundation, Inc., 51 Franklin Street, Fifth Floor,
Antenore Gatta's avatar
Antenore Gatta committed
20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35
 * Boston, MA  02110-1301, USA.
 *
 *  In addition, as a special exception, the copyright holders give
 *  permission to link the code of portions of this program with the
 *  OpenSSL library under certain conditions as described in each
 *  individual source file, and distribute linked combinations
 *  including the two.
 *  You must obey the GNU General Public License in all respects
 *  for all of the code used other than OpenSSL. *  If you modify
 *  file(s) with this exception, you may extend this exception to your
 *  version of the file(s), but you are not obligated to do so. *  If you
 *  do not wish to do so, delete this exception statement from your
 *  version. *  If you delete this exception statement from all source
 *  files in the program, then also delete it here.
 *
 */
36

37
#pragma once
38 39 40

G_BEGIN_DECLS

Antenore Gatta's avatar
Antenore Gatta committed
41 42 43 44 45 46
#define REMMINA_TYPE_FTP_CLIENT               (remmina_ftp_client_get_type())
#define REMMINA_FTP_CLIENT(obj)               (G_TYPE_CHECK_INSTANCE_CAST((obj), REMMINA_TYPE_FTP_CLIENT, RemminaFTPClient))
#define REMMINA_FTP_CLIENT_CLASS(klass)       (G_TYPE_CHECK_CLASS_CAST((klass), REMMINA_TYPE_FTP_CLIENT, RemminaFTPClientClass))
#define REMMINA_IS_FTP_CLIENT(obj)            (G_TYPE_CHECK_INSTANCE_TYPE((obj), REMMINA_TYPE_FTP_CLIENT))
#define REMMINA_IS_FTP_CLIENT_CLASS(klass)    (G_TYPE_CHECK_CLASS_TYPE((klass), REMMINA_TYPE_FTP_CLIENT))
#define REMMINA_FTP_CLIENT_GET_CLASS(obj)     (G_TYPE_INSTANCE_GET_CLASS((obj), REMMINA_TYPE_FTP_CLIENT, RemminaFTPClientClass))
47

48
typedef struct _RemminaFTPClientPriv RemminaFTPClientPriv;
49

Antenore Gatta's avatar
Antenore Gatta committed
50
typedef struct _RemminaFTPClient {
51
	GtkVBox vbox;
52

53
	RemminaFTPClientPriv *priv;
54
} RemminaFTPClient;
55

Antenore Gatta's avatar
Antenore Gatta committed
56
typedef struct _RemminaFTPClientClass {
57
	GtkVBoxClass parent_class;
58

59 60 61 62
	void (*open_dir)(RemminaFTPClient *client);
	void (*new_task)(RemminaFTPClient *client);
	void (*cancel_task)(RemminaFTPClient *client);
	void (*delete_file)(RemminaFTPClient *client);
63
} RemminaFTPClientClass;
64

65 66
GType remmina_ftp_client_get_type(void)
G_GNUC_CONST;
67

Antenore Gatta's avatar
Antenore Gatta committed
68
enum {
69
	REMMINA_FTP_FILE_TYPE_DIR, REMMINA_FTP_FILE_TYPE_FILE, REMMINA_FTP_FILE_N_TYPES,
70 71
};

Antenore Gatta's avatar
Antenore Gatta committed
72
enum {
73 74 75 76 77 78 79 80
	REMMINA_FTP_FILE_COLUMN_TYPE,
	REMMINA_FTP_FILE_COLUMN_NAME,
	REMMINA_FTP_FILE_COLUMN_SIZE,
	REMMINA_FTP_FILE_COLUMN_USER,
	REMMINA_FTP_FILE_COLUMN_GROUP,
	REMMINA_FTP_FILE_COLUMN_PERMISSION,
	REMMINA_FTP_FILE_COLUMN_NAME_SORT, /* Auto populate */
	REMMINA_FTP_FILE_N_COLUMNS
81 82
};

Antenore Gatta's avatar
Antenore Gatta committed
83
enum {
84
	REMMINA_FTP_TASK_TYPE_DOWNLOAD, REMMINA_FTP_TASK_TYPE_UPLOAD, REMMINA_FTP_TASK_N_TYPES
85 86
};

Antenore Gatta's avatar
Antenore Gatta committed
87
enum {
88 89 90 91 92
	REMMINA_FTP_TASK_STATUS_WAIT,
	REMMINA_FTP_TASK_STATUS_RUN,
	REMMINA_FTP_TASK_STATUS_FINISH,
	REMMINA_FTP_TASK_STATUS_ERROR,
	REMMINA_FTP_TASK_N_STATUSES
93 94
};

Antenore Gatta's avatar
Antenore Gatta committed
95
enum {
96 97 98 99 100 101 102 103 104 105 106
	REMMINA_FTP_TASK_COLUMN_TYPE,
	REMMINA_FTP_TASK_COLUMN_NAME,
	REMMINA_FTP_TASK_COLUMN_SIZE,
	REMMINA_FTP_TASK_COLUMN_TASKID,
	REMMINA_FTP_TASK_COLUMN_TASKTYPE,
	REMMINA_FTP_TASK_COLUMN_REMOTEDIR,
	REMMINA_FTP_TASK_COLUMN_LOCALDIR,
	REMMINA_FTP_TASK_COLUMN_STATUS,
	REMMINA_FTP_TASK_COLUMN_DONESIZE,
	REMMINA_FTP_TASK_COLUMN_TOOLTIP,
	REMMINA_FTP_TASK_N_COLUMNS
107 108
};

Antenore Gatta's avatar
Antenore Gatta committed
109
typedef struct _RemminaFTPTask {
110 111 112 113 114 115 116 117 118 119 120 121 122
	/* Read-only */
	gint type;
	gchar *name;
	gint taskid;
	gint tasktype;
	gchar *remotedir;
	gchar *localdir;
	GtkTreeRowReference *rowref;
	/* Updatable */
	gfloat size;
	gint status;
	gfloat donesize;
	gchar *tooltip;
123 124
} RemminaFTPTask;

125
GtkWidget* remmina_ftp_client_new(void);
126

127 128
void remmina_ftp_client_save_state(RemminaFTPClient *client, RemminaFile *remminafile);
void remmina_ftp_client_load_state(RemminaFTPClient *client, RemminaFile *remminafile);
129

130 131
void remmina_ftp_client_set_show_hidden(RemminaFTPClient *client, gboolean show_hidden);
void remmina_ftp_client_clear_file_list(RemminaFTPClient *client);
132
/* column, value, ..., -1 */
133
void remmina_ftp_client_add_file(RemminaFTPClient *client, ...);
134
/* Set the current directory. Should be called by opendir signal handler */
135
void remmina_ftp_client_set_dir(RemminaFTPClient *client, const gchar *dir);
136
/* Get the current directory as newly allocated string */
137
gchar* remmina_ftp_client_get_dir(RemminaFTPClient *client);
138
/* Get the next waiting task */
139
RemminaFTPTask* remmina_ftp_client_get_waiting_task(RemminaFTPClient *client);
140
/* Update the task */
141
void remmina_ftp_client_update_task(RemminaFTPClient *client, RemminaFTPTask* task);
142
/* Free the RemminaFTPTask object */
143
void remmina_ftp_task_free(RemminaFTPTask *task);
144 145 146
/* Get/Set Set overwrite_all status */
void remmina_ftp_client_set_overwrite_status(RemminaFTPClient *client, gboolean status);
gboolean remmina_ftp_client_get_overwrite_status(RemminaFTPClient *client);
147 148 149 150

G_END_DECLS