![]() |
![]() |
![]() |
Libfm Reference Manual | ![]() |
---|---|---|---|---|
Top | Description | Object Hierarchy | Implemented Interfaces | Signals |
#define FM_FOLDER_MODEL_COL_DEFAULT #define FM_FOLDER_MODEL_COL_UNSORTED FmFolderModel; struct FmFolderModelClass; enum FmFolderModelCol; gboolean (*FmFolderModelFilterFunc) (FmFileInfo *file
,gpointer user_data
); void fm_folder_model_add_filter (FmFolderModel *model
,FmFolderModelFilterFunc func
,gpointer user_data
); void fm_folder_model_apply_filters (FmFolderModel *model
); const char * fm_folder_model_col_get_name (FmFolderModelCol col_id
); const char * fm_folder_model_col_get_title (FmFolderModel *model
,FmFolderModelCol col_id
); gboolean fm_folder_model_col_is_sortable (FmFolderModel *model
,FmFolderModelCol col_id
); void fm_folder_model_file_changed (FmFolderModel *model
,FmFileInfo *file
); void fm_folder_model_file_created (FmFolderModel *model
,FmFileInfo *file
); void fm_folder_model_file_deleted (FmFolderModel *model
,FmFileInfo *file
); gboolean fm_folder_model_find_iter_by_filename (FmFolderModel *model
,GtkTreeIter *it
,const char *name
); FmFolderModelCol fm_folder_model_get_col_by_name (const char *str
); FmFolder * fm_folder_model_get_folder (FmFolderModel *model
); FmPath * fm_folder_model_get_folder_path (FmFolderModel *model
); guint fm_folder_model_get_icon_size (FmFolderModel *model
); gpointer fm_folder_model_get_item_userdata (FmFolderModel *model
,GtkTreeIter *it
); gboolean fm_folder_model_get_show_hidden (FmFolderModel *model
); gboolean fm_folder_model_get_sort (FmFolderModel *model
,FmFolderModelCol *col
,FmSortMode *mode
); FmFolderModel * fm_folder_model_new (FmFolder *dir
,gboolean show_hidden
); void fm_folder_model_remove_filter (FmFolderModel *model
,FmFolderModelFilterFunc func
,gpointer user_data
); void fm_folder_model_set_folder (FmFolderModel *model
,FmFolder *dir
); void fm_folder_model_set_icon_size (FmFolderModel *model
,guint icon_size
); void fm_folder_model_set_item_userdata (FmFolderModel *model
,GtkTreeIter *it
,gpointer user_data
); void fm_folder_model_set_show_hidden (FmFolderModel *model
,gboolean show_hidden
); void fm_folder_model_set_sort (FmFolderModel *model
,FmFolderModelCol col
,FmSortMode mode
);
FmFolderModel implements GtkTreeModel, GtkTreeSortable, GtkTreeDragSource and GtkTreeDragDest.
include
: libfm/fm-folder-model.h
The FmFolderModel is used by widgets such as FmFolderView to arrange items of folder.
#define FM_FOLDER_MODEL_COL_DEFAULT ((FmFolderModelCol)-1)
value which means do not change sorting column.
#define FM_FOLDER_MODEL_COL_UNSORTED FM_FOLDER_MODEL_COL_INFO
for 'Unsorted' folder view use 'FileInfo' column which is ambiguous for sorting
struct FmFolderModelClass { GObjectClass parent; void (*row_deleting)(FmFolderModel* model, GtkTreePath* tp, GtkTreeIter* iter, gpointer data); void (*filter_changed)(FmFolderModel* model); };
the parent class | |
the class closure for the "row-deleting" signal | |
the class closure for the "filter-changed" signal |
typedef enum { FM_FOLDER_MODEL_COL_GICON = 0, FM_FOLDER_MODEL_COL_ICON, FM_FOLDER_MODEL_COL_NAME, FM_FOLDER_MODEL_COL_SIZE, FM_FOLDER_MODEL_COL_DESC, FM_FOLDER_MODEL_COL_PERM, FM_FOLDER_MODEL_COL_OWNER, FM_FOLDER_MODEL_COL_MTIME, FM_FOLDER_MODEL_COL_INFO, FM_FOLDER_MODEL_COL_DIRNAME, } FmFolderModelCol;
Columns of folder view
(GIcon *) icon image | |
(FmIcon *) icon descriptor | |
(gchar *) file display name | |
(gchar *) file size text | |
(gchar *) file MIME description | |
(gchar *) reserved, not implemented | |
(gchar *) reserved, not implemented | |
(gchar *) modification time text | |
(FmFileInfo *) file info | |
(gchar *) path of dir containing the file |
gboolean (*FmFolderModelFilterFunc) (FmFileInfo *file
,gpointer user_data
);
void fm_folder_model_add_filter (FmFolderModel *model
,FmFolderModelFilterFunc func
,gpointer user_data
);
Install a filter function to filter out and hide some items.
This only install a filter function and does not update content of the model.
You need to call fm_folder_model_apply_filters()
to refilter the model.
|
the folder model instance |
|
a filter function |
|
user data passed to the filter function |
Since 1.0.2
void fm_folder_model_apply_filters (FmFolderModel *model
);
After changing the filters by fm_folder_model_add_filter()
or
fm_folder_model_remove_filter()
, you have to call this function
to really apply the filter to the model content.
This is for performance reason.
You can add many filter functions and also remove some, and then
call fm_folder_model_apply_filters()
to update the content of the model once.
If you forgot to call fm_folder_model_apply_filters()
, the content of the
model may be incorrect.
|
the folder model instance |
Since 1.0.2
const char * fm_folder_model_col_get_name (FmFolderModelCol col_id
);
Retrieves the name of the column specified, or NULL
if the specified
col_id
is invalid. The name of column may be used for config save or
another similar purpose. Returned data are owned by implementation and
should be not freed by caller.
|
column id |
Returns : |
the name associated with column. |
Since 1.0.2
const char * fm_folder_model_col_get_title (FmFolderModel *model
,FmFolderModelCol col_id
);
Retrieves the title of the column specified, or NULL
if the specified
col_id
is invalid. Returned data are owned by implementation and
should be not freed by caller.
|
the folder model |
|
column id |
Returns : |
title of column in current locale. |
Since 1.0.2
gboolean fm_folder_model_col_is_sortable (FmFolderModel *model
,FmFolderModelCol col_id
);
Checks if model can be sorted by col
.
|
model to check |
|
column id |
Returns : |
TRUE if model can be sorted by col . |
Since 1.0.2
void fm_folder_model_file_changed (FmFolderModel *model
,FmFileInfo *file
);
Updates info for the file
in the model
.
|
a folder model instance |
|
a file into |
Since 0.1.0
void fm_folder_model_file_created (FmFolderModel *model
,FmFileInfo *file
);
Adds new created file
into model
.
|
the folder model instance |
|
new file into |
Since 0.1.0
void fm_folder_model_file_deleted (FmFolderModel *model
,FmFileInfo *file
);
Removes a file
from model
.
|
the folder model instance |
|
removed file into |
Since 0.1.0
gboolean fm_folder_model_find_iter_by_filename (FmFolderModel *model
,GtkTreeIter *it
,const char *name
);
Searches model
for existance of some file in it. If file was found
then sets it
to match found file.
|
the folder model instance |
|
pointer to iterator to fill |
|
file name to search |
Returns : |
TRUE if file was found. |
Since 0.1.0
FmFolderModelCol fm_folder_model_get_col_by_name (const char *str
);
Finds a column which has associated name equal to str
.
|
a column name |
Returns : |
column id or (FmFolderModelCol)-1 if no such column exists. |
Since 1.0.2
FmFolder * fm_folder_model_get_folder (FmFolderModel *model
);
Retrieves a folder that model
is created for. Returned data are owned
by the model
and should not be freed by caller.
|
the folder model instance |
Returns : |
the folder descriptor. [transfer none] |
Since 1.0.0
FmPath * fm_folder_model_get_folder_path (FmFolderModel *model
);
Retrieves path of folder that model
is created for. Returned data
are owned by the model
and should not be freed by caller.
|
the folder model instance |
Returns : |
the path of the folder of the model. [transfer none] |
Since 1.0.0
guint fm_folder_model_get_icon_size (FmFolderModel *model
);
Retrieves the size of icons in model
data.
|
the folder model instance |
Returns : |
size of icons in pixels. |
Since 0.1.0
gpointer fm_folder_model_get_item_userdata (FmFolderModel *model
,GtkTreeIter *it
);
Returns the data that was set by last call of
fm_folder_model_set_item_userdata()
on that row.
|
the folder model instance |
|
iterator of row to retrieve data |
Returns : |
user data that was set on that row |
Since 1.0.0
gboolean fm_folder_model_get_show_hidden (FmFolderModel *model
);
Retrieves info whether folder model includes hidden files.
|
the folder model instance |
Returns : |
TRUE if hidden files are visible within model . |
Since 0.1.0
gboolean fm_folder_model_get_sort (FmFolderModel *model
,FmFolderModelCol *col
,FmSortMode *mode
);
Retrieves current sorting criteria for model
.
|
model to query |
|
location to store sorting column. [out][allow-none] |
|
location to store sorting mode. [out][allow-none] |
Returns : |
TRUE if model is valid. |
Since 1.0.2
FmFolderModel * fm_folder_model_new (FmFolder *dir
,gboolean show_hidden
);
Creates new folder model for the dir
.
|
the folder to create model |
|
whether show hidden files initially or not |
Returns : |
a new FmFolderModel object. [transfer full] |
Since 0.1.0
void fm_folder_model_remove_filter (FmFolderModel *model
,FmFolderModelFilterFunc func
,gpointer user_data
);
Remove a filter function previously installed by fm_folder_model_add_filter()
This only remove the filter function and does not update content of the model.
You need to call fm_folder_model_apply_filters()
to refilter the model.
|
the folder model instance |
|
a filter function |
|
user data passed to the filter function |
Since 1.0.2
void fm_folder_model_set_folder (FmFolderModel *model
,FmFolder *dir
);
Changes folder which model handles. This call allows reusing the model for different folder, in case, e.g. directory was changed.
|
a folder model instance |
|
a new folder for the model |
Since 0.1.0
void fm_folder_model_set_icon_size (FmFolderModel *model
,guint icon_size
);
Changes the size of icons in model
data.
|
the folder model instance |
|
new size for icons in pixels |
Since 0.1.0
void fm_folder_model_set_item_userdata (FmFolderModel *model
,GtkTreeIter *it
,gpointer user_data
);
Sets the data that can be retrieved by fm_folder_model_get_item_userdata()
.
|
the folder model instance |
|
iterator of row to set data |
|
user data that will be associated with the row |
Since 1.0.0
void fm_folder_model_set_show_hidden (FmFolderModel *model
,gboolean show_hidden
);
Changes visibility of hodden files within model
.
|
the folder model instance |
|
whether show hidden files or not |
Since 0.1.0
void fm_folder_model_set_sort (FmFolderModel *model
,FmFolderModelCol col
,FmSortMode mode
);
Changes sorting of model
items in accordance to new col
and mode
.
If new parameters are not different from previous then nothing will
be changed (nor any signal emitted).
|
model to apply |
|
new sorting column |
|
new sorting mode |
Since 1.0.2
"filter-changed"
signalvoid user_function (FmFolderModel *model,
gpointer user_data) : Run First
This signal is emitted when model data were changed due to filter changes.
|
folder model instance that received the signal |
|
user data set when the signal handler was connected. |
Since 1.0.2
"row-deleting"
signalvoid user_function (FmFolderModel *model,
GtkTreePath *row,
GtkTreeIter *iter,
gpointer data,
gpointer user_data) : Run First
This signal is emitted before row is deleted.
It can be used if view has some data associated with the row so those data can be freed safely.
|
folder model instance that received the signal |
|
path to row that is about to be deleted |
|
iterator of row that is about to be deleted |
|
user data associated with the row |
|
user data set when the signal handler was connected. |
Since 1.0.0