diff --git a/src/gnome-utils/QuickFill.h b/src/gnome-utils/QuickFill.h index 61c3a2e6bc..709e4a4a3e 100644 --- a/src/gnome-utils/QuickFill.h +++ b/src/gnome-utils/QuickFill.h @@ -24,24 +24,24 @@ */ /** @addtogroup QuickFill - QuickFill is meant to be used by the GUI to auto-complete - (e.g. tab-complete) typed user input. - Quickfill is implemented as a heirarchical tree - of partial matching strings. The root of the tree contains - all of the strings that user input should be matched to. - Then, given a short string segment, quickfill will return + QuickFill is meant to be used by the GUI to auto-complete + (e.g. tab-complete) typed user input. + QuickFill is implemented as a hierarchical tree + of partial matching strings. The root of the tree contains + all of the strings that user input should be matched to. + Then, given a short string segment, QuickFill will return a subtree containing only those strings that start with desired substring. As additional letters are added to the substring, - Quickfill will thus narrow down to the unique matching string + QuickFill will thus narrow down to the unique matching string (or to nothing if no match). - QuickFill works with national-language i18n'ed/l10n'ed multi-byte + QuickFill works with national-language i18n'ed/l10n'ed multi-byte and wide-char strings, as well as plain-old C-locale strings. @{ */ /** @file QuickFill.h - @brief Quickfill is used to auto-complete typed user entries. + @brief QuickFill is used to auto-complete typed user entries. @author Copyright (C) 1997 Robin D. Clark @author Copyright (C) 1998,2004 Linas Vepstas @author Copyright (C) 2000 Dave Peticolas @@ -73,23 +73,23 @@ void gnc_quickfill_purge (QuickFill *qf); const char * gnc_quickfill_string (QuickFill *qf); /** Return the subnode of the tree whose strings all hold 'wc' as - * the next letter. That is, if 'qf' holds all strings starting + * the next letter. That is, if 'qf' holds all strings starting * with the letter 'a', and we ask for the letter 'b', then this * routine will return the node holding all strings that start * with "ab". * - * The best-guess matching string can be retreived with + * The best-guess matching string can be retrieved with * gnc_quickfill_string(). */ QuickFill * gnc_quickfill_get_char_match (QuickFill *qf, gunichar c); -/** Return a subnode in the tree whose strings all match the +/** Return a subnode in the tree whose strings all match the * string 'str' as the next substring. Thus, for example, if - * the argument 'qf' holds strings that start with "abc", and + * the argument 'qf' holds strings that start with "abc", and * this routine is called with "def", then the returned node - * will hold strings that start with "abcdef". + * will hold strings that start with "abcdef". * - * The best-guess matching string can be retreived with + * The best-guess matching string can be retrieved with * gnc_quickfill_string(). * * To convert a plain C-locale char * string to GdkWChar *, @@ -99,22 +99,22 @@ QuickFill * gnc_quickfill_get_string_match (QuickFill *qf, const char *str); /** Same as gnc_quickfill_get_string_match(), except that the - * string length is explicilty specified. + * string length is explicitly specified. */ QuickFill * gnc_quickfill_get_string_len_match (QuickFill *qf, const char *str, int len); -/** Walk a 'unique' part of the quickfill tree. This routine is - * typically used to assist in the tab-completion of strings. - * If the inital portion of the string is unique, but some later +/** Walk a 'unique' part of the QuickFill tree. This routine is + * typically used to assist in the tab-completion of strings. + * If the initial portion of the string is unique, but some later * portion is not, this routine will advance to the first non-unique * part of the string. If len is non-NULL, then *len will be set * to the length of the unique portion of the string. - * - * Thus, for example, if the root node contains the strings + * + * Thus, for example, if the root node contains the strings * "The Book" and "The Movie", then the returned len will be 4, - * and the returned node will distinguish "Book" and "Movie". - * Thus, for example, gnc_quickfill_get_char_match(.., 'B') on + * and the returned node will distinguish "Book" and "Movie". + * Thus, for example, gnc_quickfill_get_char_match(.., 'B') on * the result will identify "The Book". */ QuickFill * gnc_quickfill_get_unique_len_match (QuickFill *qf, int *len);