gntfilesel.h
Go to the documentation of this file.
/*
* 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
GType gnt_file_sel_get_gtype(void);
GntWidget * gnt_file_sel_new(void);
gboolean gnt_file_sel_set_current_location(GntFileSel *sel, const char *path);
void gnt_file_sel_set_dirs_only(GntFileSel *sel, gboolean dirs);
gboolean gnt_file_sel_get_dirs_only(GntFileSel *sel);
void gnt_file_sel_set_must_exist(GntFileSel *sel, gboolean must);
gboolean gnt_file_sel_get_must_exist(GntFileSel *sel);
char * gnt_file_sel_get_selected_file(GntFileSel *sel);
GList * gnt_file_sel_get_selected_multi_files(GntFileSel *sel);
void gnt_file_sel_set_multi_select(GntFileSel *sel, gboolean set);
void gnt_file_sel_set_suggested_filename(GntFileSel *sel, const char *suggest);
void gnt_file_sel_set_read_fn(GntFileSel *sel, gboolean (*read_fn)(const char *path, GList **files, GError **error));
GntFile* gnt_file_new(const char *name, unsigned long size);
GntFile* gnt_file_new_dir(const char *name);
G_END_DECLS
#endif /* GNT_FILE_SEL_H */
gnt_file_sel_get_selected_file
char * gnt_file_sel_get_selected_file(GntFileSel *sel)
Get the selected file in the selector.
gnt_file_sel_get_must_exist
gboolean gnt_file_sel_get_must_exist(GntFileSel *sel)
Check whether the selector allows selecting non-existent files.
_GntWidget
Definition: gntwidget.h:98
gnt.h
gntkeys.h
gnt_file_sel_new
GntWidget * gnt_file_sel_new(void)
Create a new file selector.
gnt_file_sel_set_multi_select
void gnt_file_sel_set_multi_select(GntFileSel *sel, gboolean set)
Allow selecting multiple files.
gnt_file_new
GntFile * gnt_file_new(const char *name, unsigned long size)
Create a new GntFile.
gntcolors.h
gnt_file_sel_get_dirs_only
gboolean gnt_file_sel_get_dirs_only(GntFileSel *sel)
Check whether the file selector allows only selecting directories.
gnt_file_sel_get_selected_multi_files
GList * gnt_file_sel_get_selected_multi_files(GntFileSel *sel)
Get the list of selected files in the selector.
gnt_file_sel_get_gtype
G_BEGIN_DECLS GType gnt_file_sel_get_gtype(void)
_GntWindow
Definition: gntwindow.h:57
_GntFile
Definition: gntfilesel.h:90
gnt_file_new_dir
GntFile * gnt_file_new_dir(const char *name)
Create a new GntFile for a directory.
_GntFileSelClass
Definition: gntfilesel.h:73
gnt_file_sel_set_read_fn
void gnt_file_sel_set_read_fn(GntFileSel *sel, gboolean(*read_fn)(const char *path, GList **files, GError **error))
Set custom functions to read the names of files.
_GntWindowClass
Definition: gntwindow.h:64
gnt_file_sel_set_current_location
gboolean gnt_file_sel_set_current_location(GntFileSel *sel, const char *path)
Set the current location of the file selector.
gnt_file_sel_set_dirs_only
void gnt_file_sel_set_dirs_only(GntFileSel *sel, gboolean dirs)
Set wheter to only allow selecting directories.
gnt_file_sel_set_suggested_filename
void gnt_file_sel_set_suggested_filename(GntFileSel *sel, const char *suggest)
Set the suggested file to have selected at startup.
_GntFileSel
Definition: gntfilesel.h:51
gntwindow.h
gnt_file_sel_set_must_exist
void gnt_file_sel_set_must_exist(GntFileSel *sel, gboolean must)
Set whether a selected file must exist.