header cleanup (no functional changes)
[blender.git] / source / blender / blenkernel / BKE_suggestions.h
index d0f982263c001892c6e8f4f1de8cb38462d489d9..c684271cbbfb2fc299c4d3036fa9dcc5b6f7bd64 100644 (file)
@@ -1,5 +1,5 @@
-/**    
- * $Id
+/*
+ * $Id$ 
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
  *
@@ -15,7 +15,7 @@
  *
  * You should have received a copy of the GNU General Public License
  * along with this program; if not, write to the Free Software Foundation,
- * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  *
  * The Original Code is Copyright (C) 2008, Blender Foundation
  * All rights reserved.
 #ifndef BKE_SUGGESTIONS_H
 #define BKE_SUGGESTIONS_H
 
+/** \file BKE_suggestions.h
+ *  \ingroup bke
+ */
+
 #ifdef __cplusplus
 extern "C" {
 #endif
 
 /* ****************************************************************************
-Suggestions must be added in sorted order (no attempt is made to sort the list)
-The list is then divided up based on the prefix provided by update_suggestions:
+Suggestions should be added in sorted order although a linear sorting method is
+implemented. The list is then divided up based on the prefix provided by
+update_suggestions:
+
 Example:
   Prefix: ab
   aaa <-- first
@@ -58,21 +64,31 @@ typedef struct SuggList {
        SuggItem *first, *last;
        SuggItem *firstmatch, *lastmatch;
        SuggItem *selected;
+       int top;
 } SuggList;
 
-void free_suggestions();
+/* Free all text tool memory */
+void free_texttools(void);
 
-void suggest_add(const char *name, char type);
-void suggest_prefix(const char *prefix);
-SuggItem *suggest_first();
-SuggItem *suggest_last();
+/* Used to identify which Text object the current tools should appear against */
+void texttool_text_set_active(Text *text);
+void texttool_text_clear(void);
+short texttool_text_is_active(Text *text);
 
-void suggest_set_text(Text *text);
-void suggest_clear_text();
-short suggest_is_active(Text *text);
+/* Suggestions */
+void texttool_suggest_add(const char *name, char type);
+void texttool_suggest_prefix(const char *prefix);
+void texttool_suggest_clear(void);
+SuggItem *texttool_suggest_first(void);
+SuggItem *texttool_suggest_last(void);
+void texttool_suggest_select(SuggItem *sel);
+SuggItem *texttool_suggest_selected(void);
+int *texttool_suggest_top(void);
 
-void suggest_set_selected(SuggItem *sel);
-SuggItem *suggest_get_selected();
+/* Documentation */
+void texttool_docs_show(const char *docs);
+char *texttool_docs_get(void);
+void texttool_docs_clear(void);
 
 #ifdef __cplusplus
 }