view finch/libgnt/gntfilesel.h @ 25904:64d255b0a5a7

Use "Add Buddy Pounce" and "Modify Buddy Pounce" as the buddy pounce dialog titles instead of "New Buddy Pounce" and "Edit Buddy Pounce" to match the "Add Account" and "Modify Account" dialogs. I went this way figuring more people are likely to have seen the account dialogs than the buddy pounce dialogs, but if we like New/Edit better than Add/Modify we can switch the other way.

/**
 * @file gntfilesel.h File selector API
 * @ingroup gnt
 */
/*
 * GNT - The GLib Ncurses Toolkit
 *
 * GNT is the legal property of its developers, whose names are too numerous
 * to list here.  Please refer to the COPYRIGHT file distributed with this
 * source distribution.
 *
 * This library 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
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02111-1301  USA
 */

#ifndef GNT_FILE_SEL_H
#define GNT_FILE_SEL_H

#include "gntwindow.h"
#include "gnt.h"
#include "gntcolors.h"
#include "gntkeys.h"

#define GNT_TYPE_FILE_SEL				(gnt_file_sel_get_gtype())
#define GNT_FILE_SEL(obj)				(G_TYPE_CHECK_INSTANCE_CAST((obj), GNT_TYPE_FILE_SEL, GntFileSel))
#define GNT_FILE_SEL_CLASS(klass)		(G_TYPE_CHECK_CLASS_CAST((klass), GNT_TYPE_FILE_SEL, GntFileSelClass))
#define GNT_IS_FILE_SEL(obj)			(G_TYPE_CHECK_INSTANCE_TYPE((obj), GNT_TYPE_FILE_SEL))
#define GNT_IS_FILE_SEL_CLASS(klass)	(G_TYPE_CHECK_CLASS_TYPE((klass), GNT_TYPE_FILE_SEL))
#define GNT_FILE_SEL_GET_CLASS(obj)	(G_TYPE_INSTANCE_GET_CLASS((obj), GNT_TYPE_FILE_SEL, GntFileSelClass))

#define GNT_FILE_SEL_FLAGS(obj)				(GNT_FILE_SEL(obj)->priv.flags)
#define GNT_FILE_SEL_SET_FLAGS(obj, flags)		(GNT_FILE_SEL_FLAGS(obj) |= flags)
#define GNT_FILE_SEL_UNSET_FLAGS(obj, flags)	(GNT_FILE_SEL_FLAGS(obj) &= ~(flags))

typedef struct _GntFileSel			GntFileSel;
typedef struct _GntFileSelPriv		GntFileSelPriv;
typedef struct _GntFileSelClass		GntFileSelClass;
typedef struct _GntFile             GntFile;

struct _GntFileSel
{
	GntWindow parent;

	GntWidget *dirs;     /* list of files */
	GntWidget *files;    /* list of directories */
	GntWidget *location; /* location entry */

	GntWidget *select;   /* select button */
	GntWidget *cancel;   /* cancel button */

	char *current; /* Full path of the current location */
	char *suggest; /* Suggested filename */
	/* XXX: someone should make these useful */
	gboolean must_exist; /* Make sure the selected file (the name entered in 'location') exists */
	gboolean dirsonly;   /* Show only directories */
    gboolean multiselect;
    GList *tags;         /* List of tagged files when multiselect is set */

	gboolean (*read_fn)(const char *path, GList **files, GError **error);
};

struct _GntFileSelClass
{
	GntWindowClass parent;

	void (*file_selected)(GntFileSel *sel, const char *path, const char *filename);
	void (*gnt_reserved1)(void);
	void (*gnt_reserved2)(void);
	void (*gnt_reserved3)(void);
	void (*gnt_reserved4)(void);
};

typedef enum _GntFileType
{
	GNT_FILE_REGULAR,
	GNT_FILE_DIR
} GntFileType;

struct _GntFile
{
	char *fullpath;
	char *basename;
	GntFileType type;
	unsigned long size;
};

G_BEGIN_DECLS

/**
 * @return GType for GntFileSel.
 */
GType gnt_file_sel_get_gtype(void);

/**
 * Create a new file selector.
 *
 * @return  The newly created file selector.
 */
GntWidget * gnt_file_sel_new(void);

/**
 * Set the current location of the file selector.
 *
 * @param sel   The file selector.
 * @param path  The current path of the selector.
 *
 * @return @c TRUE if the current location was successfully changed, @c FALSE otherwise.
 */
gboolean gnt_file_sel_set_current_location(GntFileSel *sel, const char *path);

/**
 * Set wheter to only allow selecting directories.
 *
 * @param sel    The file selector.
 * @param dirs   @c TRUE if only directories can be selected, @c FALSE if files
 *               can also be selected.
 */
void gnt_file_sel_set_dirs_only(GntFileSel *sel, gboolean dirs);

/**
 * Check whether the file selector allows only selecting directories.
 *
 * @param sel  The file selector.
 *
 * @return  @c TRUE if only directories can be selected.
 */
gboolean gnt_file_sel_get_dirs_only(GntFileSel *sel);

/**
 * Set whether a selected file must exist.
 *
 * @param sel   The file selector.
 * @param must  @c TRUE if the selected file must exist.
 */
void gnt_file_sel_set_must_exist(GntFileSel *sel, gboolean must);

/**
 * Check whether the selector allows selecting non-existent files.
 *
 * @param sel  The file selector.
 *
 * @return  @c TRUE if the selected file must exist, @c FALSE if a non-existent
 *          file can be selected.
 */
gboolean gnt_file_sel_get_must_exist(GntFileSel *sel);

/**
 * Get the selected file in the selector.
 *
 * @param sel  The file selector.
 *
 * @return The path of the selected file. The caller should g_free the returned
 *         string.
 */
char * gnt_file_sel_get_selected_file(GntFileSel *sel);

/**
 * Get the list of selected files in the selector.
 *
 * @param sel  The file selector.
 *
 * @return  A list of paths for the selected files. The caller must g_free the
 *          contents of the list, and g_list_free the list.
 */
GList * gnt_file_sel_get_selected_multi_files(GntFileSel *sel);

/**
 * Allow selecting multiple files.
 *
 * @param sel  The file selector.
 * @param set  @c TRUE if selecting multiple files should be allowed.
 */
void gnt_file_sel_set_multi_select(GntFileSel *sel, gboolean set);

/**
 * Set the suggested file to have selected at startup.
 *
 * @param sel      The file selector.
 * @param suggest  The suggested filename.
 */
void gnt_file_sel_set_suggested_filename(GntFileSel *sel, const char *suggest);

/**
 * Set custom functions to read the names of files.
 *
 * @param sel      The file selector.
 * @param read_fn  The custom read function.
 */
void gnt_file_sel_set_read_fn(GntFileSel *sel, gboolean (*read_fn)(const char *path, GList **files, GError **error));

/**
 * Create a new GntFile.
 *
 * @param name   The name of the file.
 * @param size   The size of the file.
 *
 * @return  The newly created GntFile.
 */
GntFile* gnt_file_new(const char *name, unsigned long size);

/**
 * Create a new GntFile for a directory.
 *
 * @param name  The name of the directory.
 *
 * @return  The newly created GntFile.
 */
GntFile* gnt_file_new_dir(const char *name);

G_END_DECLS

#endif /* GNT_FILE_SEL_H */