Ewl_Filelist: The base widget for the filelists

Detailed Description

A base class to be extended to provide different views on the file list

Remarks:: Inherits from Ewl_Box.


Data Structures
struct	Ewl_Filelist
	Inherits from Ewl_Box and extends to display a file list. More...
struct	Ewl_Filelist_Directory
	The data structure for Ewl_Filelist_Directory. More...
struct	Ewl_Filelist_Filter
	The data structure for Ewl_Filelist_Filter. More...
Defines
#define	EWL_FILELIST(fl) ((Ewl_Filelist *)fl)
#define	EWL_FILELIST_DIRECTORY(fl) ((Ewl_Filelist_Directory *)fl)
#define	EWL_FILELIST_DIRECTORY_TYPE "filelist_directory"
#define	EWL_FILELIST_FILTER(ff) , ((Ewl_Filelist_Filter *)ff)
#define	EWL_FILELIST_FILTER_TYPE "filelist_filter"
#define	EWL_FILELIST_IS(w) (ewl_widget_type_is(EWL_WIDGET(w), EWL_FILELIST_TYPE))
#define	EWL_FILELIST_TYPE "filelist"
Typedefs
typedef Ewl_Filelist	Ewl_Filelist
typedef Ewl_Filelist_Directory	Ewl_Filelist_Directory
typedef Ewl_Filelist_Filter	Ewl_Filelist_Filter
Functions
void	ewl_filelist_cb_destroy (Ewl_Widget w, void ev, void *data)
const char *	ewl_filelist_directory_get (Ewl_Filelist *fl)
	Retrieves the current directory set on the filelist.
void	ewl_filelist_directory_set (Ewl_Filelist fl, const char dir)
	Sets the given directory dir as the current directory in the filelist.
char *	ewl_filelist_expand_path (Ewl_Filelist fl, const char dir)
	This will attempt to return the full path to the given directory. It should handle things like .. as well.
Ewl_Filelist_Filter *	ewl_filelist_filter_get (Ewl_Filelist *fl)
	Retrieves the current filter set on the filelist.
void	ewl_filelist_filter_set (Ewl_Filelist fl, Ewl_Filelist_Filter filter)
	Sets the given filter into the filelist.
Ewl_Scrollport_Flags	ewl_filelist_hscroll_flag_get (Ewl_Filelist *fl)
	Retrieves the flags for the horizontal scrollbar.
void	ewl_filelist_hscroll_flag_set (Ewl_Filelist *fl, Ewl_Scrollport_Flags h)
	Sets the value to use for flags on the horizontal scrollbar.
int	ewl_filelist_init (Ewl_Filelist *fl)
	Initialzie a filelist to default values.
Ewl_Widget *	ewl_filelist_multi_select_preview_get (Ewl_Filelist *fl)
	Sets up a widget to display when multiple files selected.
unsigned int	ewl_filelist_multiselect_get (Ewl_Filelist *fl)
	Retrieves the current multiselect state of the filelist.
void	ewl_filelist_multiselect_set (Ewl_Filelist *fl, unsigned int ms)
	Sets the given multiselect value into the filelist.
Ewl_Widget *	ewl_filelist_new (void)
	Creates a new Ewl_Filelist widget.
void	ewl_filelist_refresh (Ewl_Filelist *fl)
	Refreshes the filelist when the directory shown is known to have changed.
char *	ewl_filelist_selected_file_get (Ewl_Filelist *fl)
	Returns the currently selected file from the filelist.
Ewl_Widget *	ewl_filelist_selected_file_preview_get (Ewl_Filelist fl, const char path)
	Creates and returns a preview widget for the given file.
void	ewl_filelist_selected_file_set (Ewl_Filelist fl, const char file)
	Sets the given file as selected in the filelist.
void	ewl_filelist_selected_files_change_notify (Ewl_Filelist *fl)
	Notifies interested consumers that the filelist has changed selected values.
Ecore_List *	ewl_filelist_selected_files_get (Ewl_Filelist *fl)
	Retrieves the list of selected files in the filelist.
void	ewl_filelist_selected_files_set (Ewl_Filelist fl, Ecore_List files)
	Sets the given files as selected in the filelist.
void	ewl_filelist_selected_signal_all (Ewl_Filelist fl, const char signal)
unsigned int	ewl_filelist_show_dot_files_get (Ewl_Filelist *fl)
	Retrieves the current show dot files setting for the filelist.
void	ewl_filelist_show_dot_files_set (Ewl_Filelist *fl, unsigned int dot)
	Sets the show dot files setting to the given value.
const char *	ewl_filelist_stock_icon_get (const char *path)
	Retrieves the stock icon for the given file.
Ewl_Filelist_View	ewl_filelist_view_get (Ewl_Filelist *fl)
	Gets the filelist view.
void	ewl_filelist_view_set (Ewl_Filelist *fl, Ewl_Filelist_View view)
	Sets the filelist view.
Ewl_Scrollport_Flags	ewl_filelist_vscroll_flag_get (Ewl_Filelist *fl)
	Retrieves the flags for the vertical scrollbar.
void	ewl_filelist_vscroll_flag_set (Ewl_Filelist *fl, Ewl_Scrollport_Flags v)
	Sets the value to use for flags on the vertical scrollbar.

Define Documentation

#define EWL_FILELIST ( fl ) ((Ewl_Filelist *)fl)

Typecasts a pointer to an Ewl_Filelist pointer.

#define EWL_FILELIST_DIRECTORY ( fl ) ((Ewl_Filelist_Directory *)fl)

Typecasts a pointer to an Ewl_Filelist_Directory pointer

#define EWL_FILELIST_DIRECTORY_TYPE "filelist_directory"

The type name

#define EWL_FILELIST_FILTER ( ff ) , ((Ewl_Filelist_Filter *)ff)

Typecasts a pointer to an Ewl_Filelist_Filter

#define EWL_FILELIST_FILTER_TYPE "filelist_filter"

The type name

#define EWL_FILELIST_IS ( w ) (ewl_widget_type_is(EWL_WIDGET(w), EWL_FILELIST_TYPE))

Returns TRUE if the widget is an Ewl_Filelist, FALSE otherwise

#define EWL_FILELIST_TYPE "filelist"

The type name for the Ewl_Filelist widget

Typedef Documentation

typedef struct Ewl_Filelist Ewl_Filelist

The Ewl_Filelist provides a base class for the file lists

typedef struct Ewl_Filelist_Directory Ewl_Filelist_Directory

typedef struct Ewl_Filelist_Filter Ewl_Filelist_Filter

Function Documentation

void ewl_filelist_cb_destroy	(	Ewl_Widget *	w,
		void *	ev,
		void *	data
	)

const char* ewl_filelist_directory_get ( Ewl_Filelist * fl )

Retrieves the current directory set on the filelist.

Parameters:

fl,:

The filelist to get the current directory from

Returns:: Returns the current directory

void ewl_filelist_directory_set	(	Ewl_Filelist *	fl,
		const char *	dir
	)

Sets the given directory dir as the current directory in the filelist.

Parameters:

	fl,:	The filelist to set the directory into
	dir,:	The directory to set

Returns:: Returns no value

char* ewl_filelist_expand_path	(	Ewl_Filelist *	fl,
		const char *	dir
	)

This will attempt to return the full path to the given directory. It should handle things like .. as well.

Parameters:

	fl,:	The filelist to get the path from
	dir,:	The dir name to append to the path

Returns:: Returns the full path to the given directory

Ewl_Filelist_Filter* ewl_filelist_filter_get ( Ewl_Filelist * fl )

Retrieves the current filter set on the filelist.

Parameters:

fl,:

The filelist to get the filter from

Returns:: Returns the current filter. Do not free returned filter!

void ewl_filelist_filter_set	(	Ewl_Filelist *	fl,
		Ewl_Filelist_Filter *	filter
	)

Sets the given filter into the filelist.

Parameters:

	fl,:	The filelist to set the filter into
	filter,:	The filter to set

Returns:: Returns no value.

Ewl_Scrollport_Flags ewl_filelist_hscroll_flag_get ( Ewl_Filelist * fl )

Retrieves the flags for the horizontal scrollbar.

Parameters:

fl,:

The filelist to work with

Returns:: Returns the flags for the horizontal scrollbar

void ewl_filelist_hscroll_flag_set	(	Ewl_Filelist *	fl,
		Ewl_Scrollport_Flags	h
	)

Sets the value to use for flags on the horizontal scrollbar.

Parameters:

	fl,:	The filelist to work with
	h,:	The value to set for the horizontal scrollbar

Returns:: Returns no value

int ewl_filelist_init ( Ewl_Filelist * fl )

Initialzie a filelist to default values.

Parameters:

fl,:

The filelist to initialize

Returns:: Returns TRUE on success or FALSE on failure

Ewl_Widget* ewl_filelist_multi_select_preview_get ( Ewl_Filelist * fl )

Sets up a widget to display when multiple files selected.

Parameters:

fl,:

The filelist to work with

Returns:: Return the widget to display

unsigned int ewl_filelist_multiselect_get ( Ewl_Filelist * fl )

Retrieves the current multiselect state of the filelist.

Parameters:

fl,:

The filelist to get the multiselect value from

Returns:: Returns the current multiselect state of the filelist

void ewl_filelist_multiselect_set	(	Ewl_Filelist *	fl,
		unsigned int	ms
	)

Sets the given multiselect value into the filelist.

Parameters:

	fl,:	The filelist to set the multiselect value into
	ms,:	The multiselect value to set

Returns:: Returns no value

Ewl_Widget* ewl_filelist_new ( void )

Creates a new Ewl_Filelist widget.

Returns:: Returns a new Ewl_Filelist widget or NULL on failure

void ewl_filelist_refresh ( Ewl_Filelist * fl )

Refreshes the filelist when the directory shown is known to have changed.

Parameters:

fl,:

The filelist to work with

Returns:: Returns no value

char* ewl_filelist_selected_file_get ( Ewl_Filelist * fl )

Returns the currently selected file from the filelist.

Parameters:

fl,:

The filelist to get the selected file from

Returns:: Returns the file currently selected in the filelist

Ewl_Widget* ewl_filelist_selected_file_preview_get	(	Ewl_Filelist *	fl,
		const char *	path
	)

Creates and returns a preview widget for the given file.

Parameters:

	fl,:	The Ewl_Filelist to work with
	path,:	The file to get the preview for

Returns:: Returns the preview widget for the given file

void ewl_filelist_selected_file_set	(	Ewl_Filelist *	fl,
		const char *	file
	)

Sets the given file as selected in the filelist.

Parameters:

	fl,:	The filelist to set the selected file into
	file,:	The file to set selected

Returns:: Returns no value

void ewl_filelist_selected_files_change_notify ( Ewl_Filelist * fl )

Notifies interested consumers that the filelist has changed selected values.

Parameters:

fl,:

The filelist to work with

Returns:: Returns no value.

Ecore_List* ewl_filelist_selected_files_get ( Ewl_Filelist * fl )

Retrieves the list of selected files in the filelist.

Parameters:

fl,:

The filelist to get the selected files from

Returns:: Returns the Ecore_List of selected files in the filelist

void ewl_filelist_selected_files_set	(	Ewl_Filelist *	fl,
		Ecore_List *	files
	)

Sets the given files as selected in the filelist.

Parameters:

	fl,:	The filelist to set the selected files into
	files,:	The Ecore_List of the files

Returns:: Returns no value.

void ewl_filelist_selected_signal_all	(	Ewl_Filelist *	fl,
		const char *	signal
	)

unsigned int ewl_filelist_show_dot_files_get ( Ewl_Filelist * fl )

Retrieves the current show dot files setting for the filelist.

Parameters:

fl,:

The filelist to get the value from

Returns:: Returns the current show dot files setting of the filelist

void ewl_filelist_show_dot_files_set	(	Ewl_Filelist *	fl,
		unsigned int	dot
	)

Sets the show dot files setting to the given value.

Parameters:

	fl,:	The filelist to set the show dot files setting into
	dot,:	The value to set into the show dot files field

Returns:: Returns no value.

const char* ewl_filelist_stock_icon_get ( const char * path )

Retrieves the stock icon for the given file.

Parameters:

path,:

The path to get the icon for

Returns:: Returns the stock icon for the given file

Ewl_Filelist_View ewl_filelist_view_get ( Ewl_Filelist * fl )

Gets the filelist view.

Parameters:

fl,:

The filelist to get the view from

Returns:: Returns the Ewl_Filelist_View used

void ewl_filelist_view_set	(	Ewl_Filelist *	fl,
		Ewl_Filelist_View	view
	)

Sets the filelist view.

Parameters:

	fl,:	The filelist to change the view for
	view,:	The view to set

Returns:: : Returns no value

Ewl_Scrollport_Flags ewl_filelist_vscroll_flag_get ( Ewl_Filelist * fl )

Retrieves the flags for the vertical scrollbar.

Parameters:

fl,:

The filelist to work with

Returns:: Returns the flags for the vertical scrollbar

void ewl_filelist_vscroll_flag_set	(	Ewl_Filelist *	fl,
		Ewl_Scrollport_Flags	v
	)

Sets the value to use for flags on the vertical scrollbar.

Parameters:

	fl,:	The filelist to work with
	v,:	The value to set for the vertical scrollbar

Returns:: Returns no value

Ewl_Filelist: The base widget for the filelists

Detailed Description

Data Structures

Defines

Typedefs

Functions

Define Documentation

Typedef Documentation

Function Documentation