GI.IBus.Objects.ObservedPath

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

Exported types

newtype ObservedPath

Memory-managed wrapper type.

Constructors

ObservedPath (ManagedPtr ObservedPath)

Instances

Eq ObservedPath

Defined in GI.IBus.Objects.ObservedPath

Methods

(==) :: ObservedPath -> ObservedPath -> Bool

(/=) :: ObservedPath -> ObservedPath -> Bool

GObject ObservedPath

Defined in GI.IBus.Objects.ObservedPath

ManagedPtrNewtype ObservedPath

Defined in GI.IBus.Objects.ObservedPath

Methods

toManagedPtr :: ObservedPath -> ManagedPtr ObservedPath

TypedObject ObservedPath

Defined in GI.IBus.Objects.ObservedPath

Methods

glibType :: IO GType

HasParentTypes ObservedPath

Defined in GI.IBus.Objects.ObservedPath

IsGValue (Maybe ObservedPath)

Convert ObservedPath to and from GValue. See toGValue and fromGValue.

Defined in GI.IBus.Objects.ObservedPath

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Maybe ObservedPath -> IO ()

gvalueGet_ :: Ptr GValue -> IO (Maybe ObservedPath)

type ParentTypes ObservedPath

Defined in GI.IBus.Objects.ObservedPath

type ParentTypes ObservedPath = '[Serializable, Object, Object]

class (GObject o, IsDescendantOf ObservedPath o) => IsObservedPath o

Type class for types which can be safely cast to ObservedPath, for instance with toObservedPath.

Instances

(GObject o, IsDescendantOf ObservedPath o) => IsObservedPath o

Defined in GI.IBus.Objects.ObservedPath

toObservedPath :: (MonadIO m, IsObservedPath o) => o -> m ObservedPath

Cast to ObservedPath, for types for which this is known to be safe. For general casts, use castTo.

Methods

Click to display all available methods, including inherited ones

Methods

bindProperty, bindPropertyFull, checkModification, copy, destroy, forceFloating, freezeNotify, getv, isFloating, notify, notifyByPspec, output, ref, refSink, removeQattachment, runDispose, serializeObject, stealData, stealQdata, thawNotify, traverse, unref, watchClosure.

Getters

getData, getProperty, getQattachment, getQdata.

Setters

setData, setDataFull, setProperty, setQattachment.

checkModification

observedPathCheckModification

Arguments

:: (HasCallStack, MonadIO m, IsObservedPath a)

=> a

path: An IBusObservedPath.

-> m Bool

Returns: True if imtime is changed, otherwise False.

Checks whether the path is modified by comparing the mtime in object and mtime in file system.

new

observedPathNew

Arguments

:: (HasCallStack, MonadIO m)

=> Text

path: The path string.

-> Bool

fillStat: Auto-fill the path status.

-> m ObservedPath

Returns: A newly allocated ObservedPath.

Creates a new ObservedPath from an XML node.

newFromXmlNode

observedPathNewFromXmlNode

Arguments

:: (HasCallStack, MonadIO m)

=> XML

node: An XML node that contain path.

-> Bool

fillStat: Auto-fill the path status.

-> m ObservedPath

Returns: A newly allocated ObservedPath.

Creates an new ObservedPath from an XML node.

output

observedPathOutput

Arguments

:: (HasCallStack, MonadIO m, IsObservedPath a)

=> a

path: An IBusObservedPath.

-> String

output: Path is appended to.

-> Int32

indent: number of indent.

-> m ()

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

traverse

observedPathTraverse

Arguments

:: (HasCallStack, MonadIO m, IsObservedPath a)

=> a

path: An IBusObservedPath.

-> Bool

dirOnly: Only looks for subdirs, not files

-> m [ObservedPath]

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

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.