/ gwuserquicksearch.h / Functions / Description

Functions



user_quick_search_new

Creates a new user quick search
struct user_quick_search *user_quick_search_new ( void);
This function creates a new user quick search. It's an allocation function.
All data are agregated.

Result: a pointer to the user quick search structure. Returns NULL when an error occured..


user_quick_search_set_pattern

Sets the search pattern string
gint user_quick_search_set_pattern ( struct user_quick_search *p, gchar *pattern);
This function sets the pattern for quick search. This patern is a regular expression

Parameters
p the user quick search to set patern
pattern the search pattern string

Result: an error code. Returns 0 when it's done. Returns -1 when an error occured..


user_quick_search_set_case_sensitive

Sets if the quick search is case sensitive
gint user_quick_search_set_case_sensitive ( struct user_quick_search *p, gboolean case_sensitive);
This function sets if the quick search is case sensitive.

Parameters
p the user quick search to set case sensitive mode
case_sensitive TRUE if quick search is case sensitive or FALSE if is uncase sensitive

Result: an error code. Returns 0 when it's done. Returns -1 when an error occured..


user_quick_search_set_type

Sets the quick search type
gint user_quick_search_set_type ( struct user_quick_search *p, gint type);
This function sets the quick search type.

Parameters
p the user quick search to set if uses regular expression
type SEARCH_TYPE_KEY_WORDS,SEARCH_TYPE_WILDCARDS or SEARCH_TYPE_REGEX

Result: an error code. Returns 0 when it's done. Returns -1 when an error occured..


user_quick_search_set_match_file

Sets if the quick search matches with files
gint user_quick_search_set_match_file ( struct user_quick_search *p, gboolean match_file);
This function sets if the quick search matches with files

Parameters
p the user quick search to set if matches with files
match_file TRUE if quick search matches with files or FALSE if doesn't match

Result: an error code. Returns 0 when it's done. Returns -1 when an error occured..


user_quick_search_set_match_folder

Sets if the quick search matches with folders
gint user_quick_search_set_match_folder ( struct user_quick_search *p, gboolean match_folder);
This function sets if the quick search matches with folders

Parameters
p the user quick search to set if matches with folders
match_folder TRUE if quick search matches with folders or FALSE if doesn't match

Result: an error code. Returns 0 when it's done. Returns -1 when an error occured..


user_quick_search_set_match_disk

Sets if the quick search matches with disks
gint user_quick_search_set_match_disk ( struct user_quick_search *p, gboolean match_disk);
This function sets if the quick search matches with disks

Parameters
p the user quick search to set if matches with disks
match_disk TRUE if quick search matches with disks or FALSE if doesn't match

Result: an error code. Returns 0 when it's done. Returns -1 when an error occured..


user_quick_search_set_match_category

Sets if the quick search matches with categories
gint user_quick_search_set_match_category ( struct user_quick_search *p, gboolean match_category);
This function sets if the quick search matches with categories

Parameters
p the user quick search to set if matches with cateogies
match_category TRUE if quick search matches with categories or FALSE if doesn't match

Result: an error code. Returns 0 when it's done. Returns -1 when an error occured..


user_quick_search_set_match_description

Sets if the quick search matches with descriptions
gint user_quick_search_set_match_description ( struct user_quick_search *p, gboolean match_description);
This function sets if the quick search matches with descriptions

Parameters
p the user quick search to set if matches with descriptions
match_description TRUE if quick search matches with descriptions or FALSE if doesn't match

Result: an error code. Returns 0 when it's done. Returns -1 when an error occured..


user_quick_search_get_pattern

Gets the search pattern string
gchar * user_quick_search_get_pattern ( struct user_quick_search *p);
This function gets the pattern for quick search.

Parameters
p the user quick search to get pattern

Result: the pattern Returns NULL when an error occured..


user_quick_search_get_case_sensitive

Gets if the quick search is case sensitive
gboolean user_quick_search_get_case_sensitive ( struct user_quick_search *p);
This function gets if the quick search is case sensitive.

Parameters
p the user quick search to get if is case sensitive

Result: TRUE if the quick search is case sensitive or FALSE if is uncase sensitive Returns NULL when an error occured..


user_quick_search_get_type

Gets if the quick search uses regural expressions
gint user_quick_search_get_type ( struct user_quick_search *p);
This function gets if the quick search uses regular expressions.

Parameters
p the user quick search to get if uses regular expressions

Result: SEARCH_TYPE_KEY_WORDS,SEARCH_TYPE_WILDCARDS or SEARCH_TYPE_REGEX Returns SEARCH_TYPE_NONE when an error occured..


user_quick_search_get_match_file

Gets if the quick search matches with files
gboolean user_quick_search_get_match_file ( struct user_quick_search *p);
This function gets if the quick search matches with files.

Parameters
p the user quick search to get if matches with files

Result: TRUE if the quick search matches with files or FALSE if doesn't match Returns NULL when an error occured..


user_quick_search_get_match_folder

Gets if the quick search matches with folders
gboolean user_quick_search_get_match_folder ( struct user_quick_search *p);
This function gets if the quick search matches with folders.

Parameters
p the user quick search to get if matches with folders

Result: TRUE if the quick search matches with folders or FALSE if doesn't match Returns NULL when an error occured..


user_quick_search_get_match_disk

Gets if the quick search matches with disks
gboolean user_quick_search_get_match_disk ( struct user_quick_search *p);
This function gets if the quick search matches with disks.

Parameters
p the user quick search to get if matches with disks

Result: TRUE if the quick search matches with disks or FALSE if doesn't match Returns NULL when an error occured..


user_quick_search_get_match_category

Gets if the quick search matches with categories
gboolean user_quick_search_get_match_category ( struct user_quick_search *p);
This function gets if the quick search matches with categories.

Parameters
p the user quick search to get if matches with categories

Result: TRUE if the quick search matches with categories or FALSE if doesn't match Returns NULL when an error occured..


user_quick_search_get_match_description

Gets if the quick search matches with descriptions
gboolean user_quick_search_get_match_description ( struct user_quick_search *p);
This function gets if the quick search matches with descriptions.

Parameters
p the user quick search to get if matches with descriptions

Result: TRUE if the quick search matches with descriptions or FALSE if doesn't match Returns NULL when an error occured..


user_quick_search_free

Frees data structure
gint user_quick_search_free ( struct user_quick_search *p);
This function frees the user quick search data structure.

Parameters
p the user quick search to free

Result: an error code. Returns 0 when it's done. Returns -1 when an error occured..


user_quick_search_to_engine_quick_search

Transforms a user quick search to engine quick search
struct engine_quick_search *user_quick_search_to_engine_quick_search ( struct user_quick_search *p);
This function tranforms user quick search to engine quick search. It's creates a regular expression from the search patern.

Parameters
p the user quick search to transform

Result: the engine quick search structure. Returns NULL when an error occured..