IBusObservedPath

IBusObservedPath — Path object of IBus.

Stability Level

Stable, unless otherwise indicated

Functions

Types and Values

Object Hierarchy

    GObject
    ╰── GInitiallyUnowned
        ╰── IBusObject
            ╰── IBusSerializable
                ╰── IBusObservedPath

Description

IBusObservedPath provides methods for file path manipulation, such as monitor modification, directory tree traversal.

Functions

ibus_observed_path_new_from_xml_node ()

IBusObservedPath *
ibus_observed_path_new_from_xml_node (XMLNode *node,
                                      gboolean fill_stat);

New an IBusObservedPath from an XML node.

Parameters

node

An XML node that contain path.

 

fill_stat

Auto-fill the path status.

 

Returns

A newly allocated IBusObservedPath.


ibus_observed_path_new ()

IBusObservedPath *
ibus_observed_path_new (const gchar *path,
                        gboolean fill_stat);

New an IBusObservedPath from an XML node.

Parameters

path

The path string.

 

fill_stat

Auto-fill the path status.

 

Returns

A newly allocated IBusObservedPath.


ibus_observed_path_traverse ()

GList *
ibus_observed_path_traverse (IBusObservedPath *path);

Recursively traverse the path and put the files and subdirectory in to a newly allocated GLists, if the path is a directory. Otherwise returns NULL.

Parameters

path

An IBusObservedPath.

 

Returns

A newly allocate GList which holds content in path; NULL if path is not directory.

[element-type IBusObservedPath]


ibus_observed_path_check_modification ()

gboolean
ibus_observed_path_check_modification (IBusObservedPath *path);

Checks whether the path is modified by comparing the mtime in object and mtime in file system. Returns TRUE if imtime is changed, otherwise FALSE.

Parameters

path

An IBusObservedPath.

 

Returns

TRUE if mtime is changed; FALSE otherwise.


ibus_observed_path_output ()

void
ibus_observed_path_output (IBusObservedPath *path,
                           GString *output,
                           gint indent);

Append the observed path to a string with following format: <path mtime="<i>modified time</i>" ><i>path</i></path>

Parameters

path

An IBusObservedPath.

 

output

Path is appended to.

 

indent

number of indent.

 

Types and Values

struct IBusObservedPath

struct IBusObservedPath;

Data structure of IBusObservedPath.

Members