GI.IBus.Objects.Registry

An Registry loads IBus component files and generates the cache files.

see_also: Component

Exported types

newtype Registry

Memory-managed wrapper type.

Constructors

Registry (ManagedPtr Registry)

Instances

Eq Registry

Defined in GI.IBus.Objects.Registry

Methods

(==) :: Registry -> Registry -> Bool

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

GObject Registry

Defined in GI.IBus.Objects.Registry

ManagedPtrNewtype Registry

Defined in GI.IBus.Objects.Registry

Methods

toManagedPtr :: Registry -> ManagedPtr Registry

TypedObject Registry

Defined in GI.IBus.Objects.Registry

Methods

glibType :: IO GType

HasParentTypes Registry

Defined in GI.IBus.Objects.Registry

IsGValue (Maybe Registry)

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

Defined in GI.IBus.Objects.Registry

Methods

gvalueGType_ :: IO GType

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

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

type ParentTypes Registry

Defined in GI.IBus.Objects.Registry

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

class (GObject o, IsDescendantOf Registry o) => IsRegistry o

Type class for types which can be safely cast to Registry, for instance with toRegistry.

Instances

(GObject o, IsDescendantOf Registry o) => IsRegistry o

Defined in GI.IBus.Objects.Registry

toRegistry :: (MonadIO m, IsRegistry o) => o -> m Registry

Cast to Registry, 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, load, loadCache, loadCacheFile, loadInDir, notify, notifyByPspec, output, ref, refSink, removeQattachment, runDispose, saveCache, saveCacheFile, serializeObject, startMonitorChanges, stealData, stealQdata, thawNotify, unref, watchClosure.

Getters

getComponents, getData, getObservedPaths, getProperty, getQattachment, getQdata.

Setters

setData, setDataFull, setProperty, setQattachment.

checkModification

registryCheckModification

Arguments

:: (HasCallStack, MonadIO m, IsRegistry a)

=> a

registry: An Registry.

-> m Bool

Returns: True if mtime is changed; False otherwise.

Check if the registry is updated.

getComponents

registryGetComponents

Arguments

:: (HasCallStack, MonadIO m, IsRegistry a)

=> a

registry: An Registry.

-> m [Component]

Returns: a list of Component objects. The caller has to call g_list_free() for the returned list.

List components.

getObservedPaths

registryGetObservedPaths

Arguments

:: (HasCallStack, MonadIO m, IsRegistry a)

=> a

registry: An Registry.

-> m [ObservedPath]

Returns: a list of ObservedPath objects. The caller has to call g_list_free() for the returned list.

List observed paths.

load

registryLoad

Arguments

:: (HasCallStack, MonadIO m, IsRegistry a)

=> a

registry: An Registry.

-> m ()

Read all XML files in a IBus component directory (typically /usr/share/ibus/component/ *.xml) and update the registry object. IBUS_COMPONENT_PATH environment valuable is also available for the custom component directories, whose delimiter is ':'.

loadCache

registryLoadCache

Arguments

:: (HasCallStack, MonadIO m, IsRegistry a)

=> a

registry: An Registry.

-> Bool

isUser: True if the registry cache is loaded in the user directory.

-> m Bool

Returns: True if the cache exists and is loaded successfully, False otherwise.

Load the user or system registry cache.

loadCacheFile

registryLoadCacheFile

Arguments

:: (HasCallStack, MonadIO m, IsRegistry a)

=> a

registry: An Registry.

-> Text

filename: The file path of the registry cache

-> m Bool

Returns: True if the cache exists and is loaded successfully, False otherwise.

Load the registry cache filename.

loadInDir

registryLoadInDir

Arguments

:: (HasCallStack, MonadIO m, IsRegistry a)

=> a

registry: An Registry.

-> Text

dirname: IBus component directory which includes XML files.

-> m ()

Read all XML files in dirname, create a Component object for each file, and add the component objects to the registry. If dirname is "/usr/share/ibus/component", this API and registryLoad are same.

new

registryNew

Arguments

:: (HasCallStack, MonadIO m)

=> m Registry

Returns: A newly allocated Registry.

Creates a new Registry

output

registryOutput

Arguments

:: (HasCallStack, MonadIO m, IsRegistry a)

=> a

registry: An Registry.

-> String

output: GString that holds the result.

-> Int32

indent: level of indent.

-> m ()

Output Registry as an XML-formatted string. The output string can be then shown on the screen or written to file.

saveCache

registrySaveCache

Arguments

:: (HasCallStack, MonadIO m, IsRegistry a)

=> a

registry: An Registry.

-> Bool

isUser: True if the registry cache is saved in the user directory.

-> m Bool

Returns: True if the cache is saved successfully, False otherwise.

Save the registry in a user directory or system directory.

saveCacheFile

registrySaveCacheFile

Arguments

:: (HasCallStack, MonadIO m, IsRegistry a)

=> a

registry: An Registry.

-> Text

filename: The file path of the registry cache

-> m Bool

Returns: True if the cache is saved successfully, False otherwise.

Save the registry cache filename.

startMonitorChanges

registryStartMonitorChanges

Arguments

:: (HasCallStack, MonadIO m, IsRegistry a)

=> a

registry: An Registry.

-> m ()

Start to monitor observed paths.

Signals

changed

type C_RegistryChangedCallback = Ptr () -> Ptr () -> IO ()

Type for the callback on the (unwrapped) C side.

type RegistryChangedCallback = IO ()

Emitted when any observed paths are changed. A method is not associated in this class. the "changed" signal would be handled in other classes.

See also: registryStartMonitorChanges.

afterRegistryChanged :: (IsRegistry a, MonadIO m) => a -> RegistryChangedCallback -> m SignalHandlerId

Connect a signal handler for the changed signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after registry #changed callback

genClosure_RegistryChanged :: MonadIO m => RegistryChangedCallback -> m (GClosure C_RegistryChangedCallback)

Wrap the callback into a GClosure.

mk_RegistryChangedCallback :: C_RegistryChangedCallback -> IO (FunPtr C_RegistryChangedCallback)

Generate a function pointer callable from C code, from a C_RegistryChangedCallback.

noRegistryChangedCallback :: Maybe RegistryChangedCallback

A convenience synonym for Nothing :: Maybe RegistryChangedCallback.

onRegistryChanged :: (IsRegistry a, MonadIO m) => a -> RegistryChangedCallback -> m SignalHandlerId

Connect a signal handler for the changed signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on registry #changed callback

wrap_RegistryChangedCallback :: RegistryChangedCallback -> C_RegistryChangedCallback

Wrap a RegistryChangedCallback into a C_RegistryChangedCallback.