Top | ![]() |
![]() |
![]() |
![]() |
FolksSimpleQuery * | folks_simple_query_new () |
const gchar * | folks_simple_query_get_query_string () |
void | folks_simple_query_set_query_string () |
const gchar * | folks_simple_query_get_query_locale () |
void | folks_simple_query_set_query_locale () |
#define | FOLKS_TYPE_SIMPLE_QUERY |
struct | FolksSimpleQuery |
struct | FolksSimpleQueryClass |
This is a generic implementation of the FolksQuery interface which supports general UI-style search use cases. It implements case-insensitive prefix matching, with transliteration of accents and other non-ASCII characters to improve matching against accented characters. It also normalises phone numbers to make matches invariant to hyphenation and spacing in phone numbers.
See also: FolksSearchView
FolksSimpleQuery * folks_simple_query_new (const gchar *query_string
,gchar **match_fields
,gint match_fields_length1
);
Create a simple text query.
query_string |
. text to match contacts against. Results will match all tokens within the whitespace-delimited string (logical-ANDing the tokens). A value of "" will match all contacts. However, it is recommended to not use a query at all if filtering is not required. . |
[in] |
match_fields |
. the field names to apply this query to. See "match-fields" for more details. An empty array will match all contacts. However, it is recommended to use the FolksIndividualAggregator directly if filtering is not required. FolksPersonaDetail and . |
[in][array length=match_fields_length1] |
match_fields_length1 |
length of the |
Since: 0.11.0
const gchar *
folks_simple_query_get_query_string (FolksSimpleQuery *self
);
Get and return the current value of the "query-string" property.
The text query string.
This re-evaluates the query immediately, so most clients should implement de-bouncing to ensure re-evaluation only happens when (for example) the user has stopped typing a new query.
Since: 0.11.0
void folks_simple_query_set_query_string (FolksSimpleQuery *self
,const gchar *value
);
Set the value of the "query-string" property to value
.
The text query string.
This re-evaluates the query immediately, so most clients should implement de-bouncing to ensure re-evaluation only happens when (for example) the user has stopped typing a new query.
self |
the FolksSimpleQuery instance to modify |
|
value |
the new value of the "query-string" property |
Since: 0.11.0
const gchar *
folks_simple_query_get_query_locale (FolksSimpleQuery *self
);
Get and return the current value of the "query-locale" property.
Locale to interpret the query_string
in.
If possible, locale-specific query string transliteration is done to increase the number of matches. Set this property to a POSIX locale name (e.g. ‘en’, ‘de_DE’, ‘de_DEeuro
’ or ‘C’) to potentially improve the transliteration performed.
This may be `null` if the locale is unknown, in which case the current locale will be used. To perform transliteration for no specific locale, use `C`.
Since: 0.11.0
void folks_simple_query_set_query_locale (FolksSimpleQuery *self
,const gchar *value
);
Set the value of the "query-locale" property to value
.
Locale to interpret the query_string
in.
If possible, locale-specific query string transliteration is done to increase the number of matches. Set this property to a POSIX locale name (e.g. ‘en’, ‘de_DE’, ‘de_DEeuro
’ or ‘C’) to potentially improve the transliteration performed.
This may be `null` if the locale is unknown, in which case the current locale will be used. To perform transliteration for no specific locale, use `C`.
self |
the FolksSimpleQuery instance to modify |
|
value |
the new value of the "query-locale" property |
Since: 0.11.0
#define FOLKS_TYPE_SIMPLE_QUERY (folks_simple_query_get_type ())
The type for FolksSimpleQuery.
struct FolksSimpleQuery { FolksQuery parent_instance; FolksSimpleQueryPrivate * priv; };
A simple text-based contact query.
This is a generic implementation of the FolksQuery interface which supports general UI-style search use cases. It implements case-insensitive prefix matching, with transliteration of accents and other non-ASCII characters to improve matching against accented characters. It also normalises phone numbers to make matches invariant to hyphenation and spacing in phone numbers.
See also: FolksSearchView
Since: 0.11.0
struct FolksSimpleQueryClass { FolksQueryClass parent_class; };
The class structure for FOLKS_TYPE_SIMPLE_QUERY
. All the fields in this structure are private and should never be accessed directly.