Top | ![]() |
![]() |
![]() |
![]() |
include
: libfm/fm.h
The FmDirListJob can be used to gather list of FmFileInfo that some directory contains.
FmDirListJob * fm_dir_list_job_new (FmPath *path
,gboolean dir_only
);
fm_dir_list_job_new
has been deprecated since version 1.2.0 and should not be used in newly-written code.
Use fm_dir_list_job_new2()
instead.
Creates a new FmDirListJob for directory listing. If dir_only
is
TRUE
then objects other than directories will be omitted from the
listing.
path |
path to directory to get listing |
|
dir_only |
|
Since: 0.1.0
FmDirListJob * fm_dir_list_job_new2 (FmPath *path
,FmDirListJobFlags flags
);
Creates a new FmDirListJob for directory listing.
Since: 1.2.0
FmDirListJob *
fm_dir_list_job_new_for_gfile (GFile *gf
);
Creates a new FmDirListJob for listing of directory gf
.
Since: 0.1.0
FmFileInfoList *
fm_dir_list_job_get_files (FmDirListJob *job
);
Retrieves gathered listing from the job
. This function may be called
only from “finished” signal handler. Returned data is owned by
the job
and should be not freed by caller.
Before 1.0.1 this call had name fm_dir_dist_job_get_files due to typo.
Since: 0.1.0
void fm_dir_list_job_set_incremental (FmDirListJob *job
,gboolean set
);
Sets whether job
should send the “files-found” signal
on found files before the job
is finished or not.
This should only be called before the job
is launched.
Since: 1.0.2
void fm_dir_list_job_add_found_file (FmDirListJob *job
,FmFileInfo *file
);
This API may be called by the classes derived of FmDirListJob only. Application developers should not use this API. When a new file is found in the dir being listed, implementations of FmDirListJob should call this API with the info of the newly found file. The FmFileInfo will be added to the found file list.
If emission of the “files-found” signal is turned on by
fm_dir_list_job_set_incremental()
, the signal will be emitted
for the newly found files after several new files are added.
See the document for the signal for more detail.
Since: 1.0.2
“files-found”
signalvoid user_function (FmDirListJob *job, gpointer files, gpointer user_data)
The “files-found” signal is emitted for every file
found during directory listing. By default the signal is not
emitted for performance reason. This can be turned on by calling
fm_dir_list_job_set_incremental()
.
job |
a job that emitted the signal |
|
files |
GSList of found files. |
[element-type FmFileInfo] |
user_data |
user data set when the signal handler was connected. |
Flags: Run Last
Since: 1.0.2