Download

Support

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_File
 The data structure for Ewl_Filelist_File. 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_FILE(fl)   ((Ewl_Filelist_File *)fl)
#define EWL_FILELIST_FILE_TYPE   "filelist_file"
#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 struct Ewl_Filelist Ewl_Filelist
typedef struct
Ewl_Filelist_Directory 
Ewl_Filelist_Directory
typedef struct Ewl_Filelist_File Ewl_Filelist_File
typedef struct 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_Filterewl_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.
char * ewl_filelist_groupname_get (gid_t st_gid)
 Converts the given group id into a group name.
Ewl_Scrollpane_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_Scrollpane_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.
char * ewl_filelist_modtime_get (time_t modtime)
 Converts the given modtime to a human readable string.
Ewl_Widgetewl_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_Widgetewl_filelist_new (void)
 Creates a new Ewl_Filelist widget.
char * ewl_filelist_perms_get (mode_t st_mode)
 Converts the given mode settings into a human readable string.
char * ewl_filelist_selected_file_get (Ewl_Filelist *fl)
 Returns the currently selected file from the filelist.
Ewl_Widgetewl_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.
char * ewl_filelist_size_get (off_t st_size)
 Converts the given size into a human readable format.
const char * ewl_filelist_stock_icon_get (const char *path)
 Retrieves the stock icon for the given file.
char * ewl_filelist_username_get (uid_t st_uid)
 Convertes the given user id into the approriate user name.
Ewl_Filelist_Viewewl_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_Scrollpane_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_Scrollpane_Flags v)
 Sets the value to use for flags on the vertical scrollbar.

Define Documentation

#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_FILE ( fl   )     ((Ewl_Filelist_File *)fl)

Typecasts a pointer to an Ewl_Filelist_File pointer

#define EWL_FILELIST_FILE_TYPE   "filelist_file"

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 (  )     (ewl_widget_type_is(EWL_WIDGET(w), EWL_FILELIST_TYPE))

Returns TRUE if the widget is an Ewl_Filelist, FALSE otherwise


Typedef Documentation

typedef struct Ewl_Filelist Ewl_Filelist

The Ewl_Filelist provides a base class for the file lists


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

References DCHECK_PARAM_PTR_RET, DCHECK_TYPE_RET, DENTER_FUNCTION, directory, DLEVEL_STABLE, DRETURN_PTR, and EWL_FILELIST_TYPE.

Referenced by ewl_filelist_expand_path(), ewl_filelist_selected_file_preview_get(), ewl_filepicker_directory_get(), and ewl_filepicker_selected_file_get().

void ewl_filelist_directory_set ( Ewl_Filelist fl,
const char *  dir 
)

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

References DCHECK_PARAM_PTR_RET, DCHECK_TYPE_RET, DENTER_FUNCTION, DLEVEL_STABLE, DRETURN_PTR, EWL_FILELIST, ewl_filelist_directory_get(), EWL_FILELIST_TYPE, and PATH_MAX.

Referenced by ewl_filelist_selected_file_set().

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!

References DCHECK_PARAM_PTR_RET, DCHECK_TYPE_RET, DENTER_FUNCTION, DLEVEL_STABLE, DRETURN_PTR, EWL_FILELIST_TYPE, and filter.

Referenced by ewl_filepicker_filter_get().

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.

References controller, DCHECK_PARAM_PTR, DCHECK_TYPE, DENTER_FUNCTION, DLEAVE_FUNCTION, DLEVEL_STABLE, ewl_filelist_model_filter_set(), EWL_FILELIST_TYPE, EWL_MVC, ewl_mvc_data_get(), ewl_mvc_dirty_set(), and filter.

char* ewl_filelist_groupname_get ( gid_t  st_gid  ) 

Converts the given group id into a group name.

Parameters:
st_gid,: The group id to convert
Returns:
Returns the group name for the given id

References DENTER_FUNCTION, DLEVEL_STABLE, DRETURN_PTR, and PATH_MAX.

Referenced by ewl_filelist_model_data_fetch(), and ewl_filelist_selected_file_preview_get().

Ewl_Scrollpane_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

References DCHECK_PARAM_PTR_RET, DCHECK_TYPE_RET, DENTER_FUNCTION, DLEVEL_STABLE, DRETURN_INT, EWL_FILELIST_TYPE, EWL_SCROLLPANE_FLAG_NONE, h, and scroll_flags.

void ewl_filelist_hscroll_flag_set ( Ewl_Filelist fl,
Ewl_Scrollpane_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

References DCHECK_PARAM_PTR, DCHECK_TYPE, DENTER_FUNCTION, DLEAVE_FUNCTION, DLEVEL_STABLE, EWL_FILELIST_TYPE, h, and scroll_flags.

char* ewl_filelist_modtime_get ( time_t  st_modtime  ) 

Converts the given modtime to a human readable string.

Parameters:
st_modtime,: The modification time to convert
Returns:
Returns the string version of the modtime

References DENTER_FUNCTION, DLEVEL_STABLE, and DRETURN_PTR.

Referenced by ewl_filelist_model_data_fetch(), and ewl_filelist_selected_file_preview_get().

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

References DCHECK_PARAM_PTR_RET, DCHECK_TYPE_RET, DENTER_FUNCTION, DLEVEL_STABLE, DRETURN_PTR, EWL_BOX, ewl_box_orientation_set(), EWL_CONTAINER, ewl_container_child_append(), EWL_FILELIST_TYPE, EWL_ICON, ewl_icon_label_set(), ewl_icon_simple_new(), EWL_ORIENTATION_VERTICAL, ewl_vbox_new(), and ewl_widget_show().

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

References DCHECK_PARAM_PTR_RET, DCHECK_TYPE_RET, DENTER_FUNCTION, DLEVEL_STABLE, DRETURN_INT, EWL_FILELIST_TYPE, and multiselect.

Referenced by ewl_filepicker_multiselect_get().

void ewl_filelist_multiselect_set ( Ewl_Filelist fl,
unsigned int  ms 
)

Ewl_Widget* ewl_filelist_new ( void   ) 

Creates a new Ewl_Filelist widget.

Returns:
Returns a new Ewl_Filelist widget or NULL on failure

References DENTER_FUNCTION, DLEVEL_STABLE, DRETURN_PTR, EWL_FILELIST, ewl_filelist_init(), ewl_widget_destroy(), and NEW.

Referenced by ewl_filepicker_init().

char* ewl_filelist_perms_get ( mode_t  st_mode  ) 

Converts the given mode settings into a human readable string.

Parameters:
st_mode,: The mode setting to convert
Returns:
Returns the string of the given mode setting

References DENTER_FUNCTION, DLEVEL_STABLE, and DRETURN_PTR.

Referenced by ewl_filelist_model_data_fetch(), and ewl_filelist_selected_file_preview_get().

char* ewl_filelist_selected_file_get ( Ewl_Filelist fl  ) 

void ewl_filelist_selected_file_set ( Ewl_Filelist fl,
const char *  file 
)

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.

References DCHECK_PARAM_PTR, DCHECK_TYPE, DENTER_FUNCTION, DLEAVE_FUNCTION, DLEVEL_STABLE, ewl_callback_call_with_event_data(), EWL_CALLBACK_VALUE_CHANGED, EWL_FILELIST_EVENT_SELECTION_CHANGE, EWL_FILELIST_TYPE, EWL_WIDGET, and Ewl_Event_Action_Response::response.

Referenced by ewl_filelist_selected_file_set(), and ewl_filelist_selected_files_set().

void ewl_filelist_selected_files_set ( Ewl_Filelist fl,
Ecore_List *  files 
)

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

References DCHECK_PARAM_PTR_RET, DCHECK_TYPE_RET, DENTER_FUNCTION, DLEVEL_STABLE, DRETURN_INT, EWL_FILELIST_TYPE, and show_dot.

Referenced by ewl_filepicker_show_dot_files_get().

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.

References controller, DCHECK_PARAM_PTR, DCHECK_TYPE, DENTER_FUNCTION, DLEAVE_FUNCTION, DLEVEL_STABLE, DRETURN, ewl_filelist_model_show_dot_files_set(), EWL_FILELIST_TYPE, EWL_MVC, ewl_mvc_data_get(), ewl_mvc_dirty_set(), and show_dot.

Referenced by ewl_filepicker_show_dot_files_set().

char* ewl_filelist_size_get ( off_t  st_size  ) 

Converts the given size into a human readable format.

Parameters:
st_size,: The size to convert
Returns:
Returns a string representation of the given size

References DENTER_FUNCTION, DLEVEL_STABLE, and DRETURN_PTR.

Referenced by ewl_filelist_model_data_fetch(), and ewl_filelist_selected_file_preview_get().

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

References DCHECK_PARAM_PTR_RET, DENTER_FUNCTION, DLEVEL_STABLE, DRETURN_PTR, EWL_ICON_APPLICATION_X_EXECUTABLE, EWL_ICON_FOLDER, EWL_ICON_TEXT_X_GENERIC, and ewl_io_manager_extension_icon_name_get().

Referenced by ewl_filelist_view_widget_fetch().

char* ewl_filelist_username_get ( uid_t  st_uid  ) 

Convertes the given user id into the approriate user name.

Parameters:
st_uid,: The userid to lookup. On Windows, this parameter should be unused.
Returns:
Returns the user name for the given user id

References DENTER_FUNCTION, DLEVEL_STABLE, DRETURN_PTR, and PATH_MAX.

Referenced by ewl_filelist_model_data_fetch(), and ewl_filelist_selected_file_preview_get().

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

References DCHECK_PARAM_PTR_RET, DENTER_FUNCTION, DLEVEL_STABLE, DRETURN_PTR, and view_flag.

Referenced by ewl_filepicker_list_view_get().

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

References DCHECK_PARAM_PTR, DCHECK_TYPE, DENTER_FUNCTION, DLEAVE_FUNCTION, DLEVEL_STABLE, DRETURN, EWL_FILELIST_TYPE, and view_flag.

Referenced by ewl_filepicker_list_view_set().

Ewl_Scrollpane_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

References DCHECK_PARAM_PTR_RET, DCHECK_TYPE_RET, DENTER_FUNCTION, DLEVEL_STABLE, DRETURN_INT, EWL_FILELIST_TYPE, EWL_SCROLLPANE_FLAG_NONE, scroll_flags, and v.

void ewl_filelist_vscroll_flag_set ( Ewl_Filelist fl,
Ewl_Scrollpane_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

References DCHECK_PARAM_PTR, DCHECK_TYPE, DENTER_FUNCTION, DLEAVE_FUNCTION, DLEVEL_STABLE, EWL_FILELIST_TYPE, scroll_flags, and v.


Copyright © Enlightenment.org

Enlightened Widget Library Documentation Generated: Sat May 17 16:51:09 2008