/ gwnotebooksearch.h / Functions / Description

Functions



gw_notebook_search_create

Creates a search engine notebook pane.
GtkWidget * gw_notebook_search_create ( GtkWindow *w);
This function creates a search engine notebook pane.

Parameters
w main window

Result: the search engine notebook pane.
Returns NULL when an error occured..


gw_notebook_search_create_and_add

Creates a search engine notebook pane and adds it to the notebook.
GtkWidget * gw_notebook_search_create_and_add ( GtkWindow *w, GtkNotebook * parent);
This function creates a search engine notebook pane and adds it to the notebook.

Parameters
w main window
parent the container

Result: the search engine notebook pane.
Returns NULL when an error occured..


gw_notebook_search_get_clist_search

Gets the list of the search engine.
GtkCList * gw_notebook_search_get_clist_search ( GtkWindow *w);
This function gets the list of search engine.

Parameters
w refence to the main window

Result: the list of search engine.
Returns NULL when an error occured..


gw_notebook_search_get_search_text

Gets the search string.
gchar * gw_notebook_search_get_search_text ( GtkWindow *w);
This function gets the search string. This string may be empty.

Parameters
w refence to the main window

Result: the search string of search engine. Must be freed with g_free().
Returns NULL when an error occured..


gw_notebook_search_set_option_case_sensitive

Sets the search to case sensitive.
gboolean gw_notebook_search_set_option_case_sensitive ( GtkWindow *w, gboolean case_sensitive);
This function sets the search to case sensitive.

Parameters
w refence to the main window
case_sensitive TRUE to activate case sensitive otherwise FALSE

Result: Returns TRUE when it is done. Returns FALSE when an error occured..


gw_notebook_search_set_option_key_words

Sets the search to use key words.
gboolean gw_notebook_search_set_option_key_words ( GtkWindow *w, gboolean key_words);
This function sets the search to use key words.

Parameters
w refence to the main window
key_words TRUE to activate key words search otherwise FALSE

Result: Returns TRUE when it is done. Returns FALSE when an error occured..


gw_notebook_search_set_option_wildcards

Sets the search to use wildcards.
gboolean gw_notebook_search_set_option_wildcards ( GtkWindow *w, gboolean wildcards);
This function sets the search to use wilcards.

Parameters
w refence to the main window
wildcards TRUE to activate wilcards search otherwise FALSE

Result: Returns TRUE when it is done. Returns FALSE when an error occured..


gw_notebook_search_set_option_regular_expression

Sets the search to use regular expression.
gboolean gw_notebook_search_set_option_regular_expression ( GtkWindow *w, gboolean regex);
This function sets the search to use regular expression.

Parameters
w refence to the main window
regex TRUE to activate regural expression search otherwise FALSE

Result: Returns TRUE when it is done. Returns FALSE when an error occured..


gw_notebook_search_set_option_search_type

Sets the search type.
gboolean gw_notebook_search_set_option_search_type ( GtkWindow *w, gint search_type);
This function sets the search type.

Parameters
w refence to the main window
search_type SEARCH_TYPE_KEY_WORDS,SEARCH_TYPE_WILDCARDS or SEARCH_TYPE_REGEX

Result: Returns TRUE when it is done. Returns FALSE when an error occured..


gw_notebook_search_set_option_match_file

Sets the search to matches with files
gboolean gw_notebook_search_set_option_match_file ( GtkWindow *w, gboolean match_file);
This function sets the search to matches with files name.

Parameters
w refence to the main window
match_file TRUE to match with files otherwise FALSE

Result: Returns TRUE when it is done. Returns FALSE when an error occured..


gw_notebook_search_set_option_match_folder

Sets the search to matches with folders
gboolean gw_notebook_search_set_option_match_folder ( GtkWindow *w, gboolean match_folder);
This function sets the search to matches with folders name.

Parameters
w refence to the main window
match_folder TRUE to match with folders otherwise FALSE

Result: Returns TRUE when it is done. Returns FALSE when an error occured..


gw_notebook_search_set_option_match_disk

Sets the search to matches with disks
gboolean gw_notebook_search_set_option_match_disk ( GtkWindow *w, gboolean match_disk);
This function sets the search to matches with disks name.

Parameters
w refence to the main window
match_disk TRUE to match with disks otherwise FALSE

Result: Returns TRUE when it is done. Returns FALSE when an error occured..


gw_notebook_search_set_option_match_category

Sets the search to matches with categories
gboolean gw_notebook_search_set_option_match_category ( GtkWindow *w, gboolean match_category);
This function sets the search to matches with categories.

Parameters
w refence to the main window
match_category TRUE to match with categories otherwise FALSE

Result: Returns TRUE when it is done. Returns FALSE when an error occured..


gw_notebook_search_set_option_match_description

Sets the search to matches with descriptions
gboolean gw_notebook_search_set_option_match_description ( GtkWindow *w, gboolean math_description);
This function sets the search to matches with descriptions.

Parameters
w refence to the main window
match_description TRUE to match with descriptions otherwise FALSE

Result: Returns TRUE when it is done. Returns FALSE when an error occured..


gw_notebook_search_clist_search_set_column_title

Sets the columns properties
gint gw_notebook_search_clist_search_set_column_title ( void);
This function sets the columns properties

Result: Returns 0 when it is done. Returns -1 when an error occured..


gw_notebook_search_get_option_case_sensitive

Gets if the search is case sensitive.
gboolean gw_notebook_search_get_option_case_sensitive ( GtkWindow *w);
This function gets if the search is case sensitive.

Parameters
w refence to the main window

Result: Returns TRUE if the search is case sensitive else returns FALSE.
Returns FALSE when an error occured..


gw_notebook_search_get_option_key_words

Gets if the search use key words.
gboolean gw_notebook_search_get_option_key_words ( GtkWindow *w);
This function gets if the search use key words.

Parameters
w refence to the main window

Result: Returns TRUE if the search use key words else returns FALSE.
Returns FALSE when an error occured.
.


gw_notebook_search_get_option_wildcards

Gets if the search use wildcards.
gboolean gw_notebook_search_get_option_wildcards ( GtkWindow *w);
This function gets if the search use wilcards.

Parameters
w refence to the main window

Result: Returns TRUE if the search use wildcards else returns FALSE.
Returns FALSE when an error occured.
.


gw_notebook_search_get_option_regular_expression

Gets if the search use regular expression.
gboolean gw_notebook_search_get_option_regular_expression ( GtkWindow *w);
This function gets if the search use regular expression.

Parameters
w refence to the main window

Result: Returns TRUE if the search use regular expression else returns FALSE.
Returns FALSE when an error occured.
.


gw_notebook_search_get_option_search_type

Gets the search type.
gint gw_notebook_search_get_option_search_type ( GtkWindow *w);
This function gets the search type.

Parameters
w refence to the main window

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


gw_notebook_search_get_option_match_file

Gets if the search matches with file
gboolean gw_notebook_search_get_option_match_file ( GtkWindow *w);
This function gets if the search matches with files name.

Parameters
w refence to the main window

Result: Returns TRUE if the search matches with files else returns FALSE.
Returns FALSE when an error occured..


gw_notebook_search_get_option_match_folder

Gets if the search matches with folder
gboolean gw_notebook_search_get_option_match_folder ( GtkWindow *w);
This function gets if the search matches with folders name.

Parameters
w refence to the main window

Result: Returns TRUE if the search matches with folders else returns FALSE.
Returns FALSE when an error occured..


gw_notebook_search_get_option_match_disk

Gets if the search matches with disk
gboolean gw_notebook_search_get_option_match_disk ( GtkWindow *w);
This function gets if the search matches with disks name.

Parameters
w refence to the main window

Result: Returns TRUE if the search matches with disks else returns FALSE.
Returns FALSE when an error occured..


gw_notebook_search_get_option_match_category

Gets if the search matches with categories
gboolean gw_notebook_search_get_option_match_category ( GtkWindow *w);
This function gets if the search matches with categories.

Parameters
w refence to the main window

Result: Returns TRUE if the search matches with categories else returns FALSE.
Returns FALSE when an error occured..


gw_notebook_search_get_option_match_description

Gets if the search matches with descriptions
gboolean gw_notebook_search_get_option_match_description ( GtkWindow *w);
This function gets if the search matches with descriptions.

Parameters
w refence to the main window

Result: Returns TRUE if the search matches with descriptions else returns FALSE.
Returns FALSE when an error occured..


gw_notebook_search_get_user_quick_search

Gets the user quick search informations
struct user_quick_search * gw_notebook_search_get_user_quick_search ( GtkWindow *w);
This function gets the user quick search informations. Warning : this function allocates a new struct user_quick_search must free this structure after.

Parameters
w refence to the main window

Result: the user quick search structure. Must be freed with user_quick_search_free().
Returns NULL when an error occured..