Function

PurpleTrieReplaceCb

Declaration

gboolean
(* PurpleTrieReplaceCb) (
  GString* out,
  const gchar* word,
  gpointer word_data,
  gpointer user_data
)

Description [src]

A function called on every matching substring to be replaced.

If you decide to replace the word, append your text to out and return TRUE. Otherwise, you must not touch out. In both cases, you must not do any operations on out other than appending text to it.

Parameters

`out`	`GString`
	Currently built output string, append replacement to it.
	The data is owned by the caller of the function.
`word`	`const gchar*`
	Found word.
	The data is owned by the caller of the function.
	The value is a NUL terminated UTF-8 string.
`word_data`	`gpointer`
	The user data bound with this word, when added with #purple_trie_add.
	The argument can be `NULL`.
	The data is owned by the caller of the function.
`user_data`	`gpointer`
	The user supplied data passed when calling #purple_trie_replace.
	The argument can be `NULL`.
	The data is owned by the caller of the function.

Return value

Returns:	`gboolean`
	`TRUE` if the word was replaced, `FALSE` otherwise.