tracker_indexing_tree_new ()

TrackerIndexingTree *
tracker_indexing_tree_new (void);

Returns a newly created TrackerIndexingTree

Since: 0.14.0

tracker_indexing_tree_new_with_root ()

TrackerIndexingTree *
tracker_indexing_tree_new_with_root (GFile *root);

If root is NULL, the default value is 'file:///'. Using NULL here is the equivalent to calling tracker_indexing_tree_new() which takes no root argument.

Since: 1.2.2

tracker_indexing_tree_add ()

void
tracker_indexing_tree_add (TrackerIndexingTree *tree,
                           GFile *directory,
                           TrackerDirectoryFlags flags);

Adds a directory to the indexing tree with the given configuration flags.

tracker_indexing_tree_remove ()

void
tracker_indexing_tree_remove (TrackerIndexingTree *tree,
                              GFile *directory);

Removes directory from the indexing tree, note that only directories previously added with tracker_indexing_tree_add() can be effectively removed.

tracker_indexing_tree_add_filter ()

void
tracker_indexing_tree_add_filter (TrackerIndexingTree *tree,
                                  TrackerFilterType filter,
                                  const gchar *glob_string);

Adds a new filter for basenames.

tracker_indexing_tree_clear_filters ()

void
tracker_indexing_tree_clear_filters (TrackerIndexingTree *tree,
                                     TrackerFilterType type);

Clears all filters of a given type.

tracker_indexing_tree_file_matches_filter ()

gboolean
tracker_indexing_tree_file_matches_filter
                               (TrackerIndexingTree *tree,
                                TrackerFilterType type,
                                GFile *file);

Returns TRUE if file matches any filter of the given filter type.

tracker_indexing_tree_file_is_indexable ()

gboolean
tracker_indexing_tree_file_is_indexable
                               (TrackerIndexingTree *tree,
                                GFile *file,
                                GFileType file_type);

returns TRUE if file should be indexed according to the parameters given through tracker_indexing_tree_add() and tracker_indexing_tree_add_filter().

If file_type is G_FILE_TYPE_UNKNOWN, file type will be queried to the file system.

tracker_indexing_tree_parent_is_indexable ()

gboolean
tracker_indexing_tree_parent_is_indexable
                               (TrackerIndexingTree *tree,
                                GFile *parent,
                                GList *children);

returns TRUE if parent should be indexed based on its contents.

tracker_indexing_tree_get_filter_hidden ()

gboolean
tracker_indexing_tree_get_filter_hidden
                               (TrackerIndexingTree *tree);

Describes if the tree should index hidden content. To change this setting, see tracker_indexing_tree_set_filter_hidden().

Since: 0.18.

tracker_indexing_tree_set_filter_hidden ()

void
tracker_indexing_tree_set_filter_hidden
                               (TrackerIndexingTree *tree,
                                gboolean filter_hidden);

When indexing content, sometimes it is preferable to ignore hidden content, for example, files prefixed with ".". This is common for files in a home directory which are usually config files.

Sets the indexing policy for tree with hidden files and content. To ignore hidden files, filter_hidden should be TRUE, otherwise FALSE.

Since: 0.18.

tracker_indexing_tree_get_default_policy ()

TrackerFilterPolicy
tracker_indexing_tree_get_default_policy
                               (TrackerIndexingTree *tree,
                                TrackerFilterType filter);

Get the default filtering policies for tree when indexing content. Some content is black listed or white listed and the default policy for that is returned here. The filter allows specific type of policies to be returned, for example, the default policy for files (TRACKER_FILTER_FILE).

Since: 0.18.

tracker_indexing_tree_set_default_policy ()

void
tracker_indexing_tree_set_default_policy
                               (TrackerIndexingTree *tree,
                                TrackerFilterType filter,
                                TrackerFilterPolicy policy);

Set the default policy (to allow or deny) for content in tree based on the type - in this case filter . Here, filter is a file or directory and there are some other options too.

For example, you can (by default), disable indexing all directories using this function.

Since: 0.18.

tracker_indexing_tree_get_root ()

GFile *
tracker_indexing_tree_get_root (TrackerIndexingTree *tree,
                                GFile *file,
                                TrackerDirectoryFlags *directory_flags);

Returns the GFile that was previously added through tracker_indexing_tree_add() and would equal or contain file , or NULL if none applies.

If the return value is non-NULL, directory_flags would contain the TrackerDirectoryFlags applying to file .

tracker_indexing_tree_get_master_root ()

GFile *
tracker_indexing_tree_get_master_root (TrackerIndexingTree *tree);

Returns the GFile that represents the master root location for all indexing locations. For example, if file:///etc is an indexed path and so was file:///home/user, the master root is file:///. Only one scheme per tree can be used, so you can not mix http and file roots in tree .

The return value should NEVER be NULL. In cases where no root is given, we fallback to file:///.

Roots explained:

Since: 1.2.

tracker_indexing_tree_file_is_root ()

gboolean
tracker_indexing_tree_file_is_root (TrackerIndexingTree *tree,
                                    GFile *file);

Evaluates if the URL represented by file is the same of that for the root of the tree .

Since: 1.2.

tracker_indexing_tree_list_roots ()

GList *
tracker_indexing_tree_list_roots (TrackerIndexingTree *tree);

Returns the list of indexing roots in tree

struct TrackerIndexingTree

struct TrackerIndexingTree;

Base object used to configure indexing within TrackerMinerFS items.

TrackerIndexingTreeClass

typedef struct {
	GObjectClass parent_class;

	void (* directory_added)   (TrackerIndexingTree *indexing_tree,
	                            GFile               *directory);
	void (* directory_removed) (TrackerIndexingTree *indexing_tree,
	                            GFile               *directory);
	void (* directory_updated) (TrackerIndexingTree *indexing_tree,
	                            GFile               *directory);
	void (* child_updated)     (TrackerIndexingTree *indexing_tree,
	                            GFile               *root,
	                            GFile               *child);
	/* <Private> */
	gpointer padding[9];
} TrackerIndexingTreeClass;

Class for the TrackerIndexingTree.

The “filter-hidden” property

  “filter-hidden”            gboolean

Whether hidden resources are filtered.

Flags: Read / Write

Default value: FALSE

The “root” property

  “root”                     GFile *

The root GFile for the indexing tree.

Flags: Read / Write / Construct Only

The “child-updated” signal

void
user_function (TrackerIndexingTree *indexing_tree,
               GFile               *root,
               GFile               *child,
               gpointer             user_data)

The ::child-updated signal may be emitted to notify about possible changes on children of a root.

TrackerIndexingTree does not emit those by itself, those may be triggered through tracker_indexing_tree_notify_update().

Flags: Run Last

Since: 1.10

The “directory-added” signal

void
user_function (TrackerIndexingTree *indexing_tree,
               GFile               *directory,
               gpointer             user_data)

the ::directory-added signal is emitted when a new directory is added to the list of other directories which are to be considered for indexing. Typically this is signalled when the tracker_indexing_tree_add() API is called.

Flags: Run Last

Since: 0.14.0

The “directory-removed” signal

void
user_function (TrackerIndexingTree *indexing_tree,
               GFile               *directory,
               gpointer             user_data)

the ::directory-removed signal is emitted when a directory is removed from the list of other directories which are to be considered for indexing. Typically this is signalled when the tracker_indexing_tree_remove() API is called.

Flags: Run Last

Since: 0.14.0

The “directory-updated” signal

void
user_function (TrackerIndexingTree *indexing_tree,
               GFile               *directory,
               gpointer             user_data)

The ::directory-updated signal is emitted on a root when either its indexing flags change (e.g. due to consecutive calls to tracker_indexing_tree_add()), or anytime an update is requested through tracker_indexing_tree_notify_update().

Flags: Run Last

Since: 0.14.0