merge with/from trunk at r35190
[blender.git] / source / blender / blenkernel / BKE_suggestions.h
1 /*      
2  * $Id$ 
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19  *
20  * The Original Code is Copyright (C) 2008, Blender Foundation
21  * All rights reserved.
22  *
23  * The Original Code is: all of this file.
24  *
25  * Contributor(s): none yet.
26  *
27  * ***** END GPL LICENSE BLOCK *****
28  */
29 #ifndef BKE_SUGGESTIONS_H
30 #define BKE_SUGGESTIONS_H
31
32 /** \file BKE_suggestions.h
33  *  \ingroup bke
34  */
35
36 #ifdef __cplusplus
37 extern "C" {
38 #endif
39
40 /* ****************************************************************************
41 Suggestions should be added in sorted order although a linear sorting method is
42 implemented. The list is then divided up based on the prefix provided by
43 update_suggestions:
44
45 Example:
46   Prefix: ab
47   aaa <-- first
48   aab
49   aba <-- firstmatch
50   abb <-- lastmatch
51   baa
52   bab <-- last
53 **************************************************************************** */
54
55 struct Text;
56
57 typedef struct SuggItem {
58         struct SuggItem *prev, *next;
59         char *name;
60         char type;
61 } SuggItem;
62
63 typedef struct SuggList {
64         SuggItem *first, *last;
65         SuggItem *firstmatch, *lastmatch;
66         SuggItem *selected;
67         int top;
68 } SuggList;
69
70 /* Free all text tool memory */
71 void free_texttools(void);
72
73 /* Used to identify which Text object the current tools should appear against */
74 void texttool_text_set_active(Text *text);
75 void texttool_text_clear(void);
76 short texttool_text_is_active(Text *text);
77
78 /* Suggestions */
79 void texttool_suggest_add(const char *name, char type);
80 void texttool_suggest_prefix(const char *prefix);
81 void texttool_suggest_clear(void);
82 SuggItem *texttool_suggest_first(void);
83 SuggItem *texttool_suggest_last(void);
84 void texttool_suggest_select(SuggItem *sel);
85 SuggItem *texttool_suggest_selected(void);
86 int *texttool_suggest_top(void);
87
88 /* Documentation */
89 void texttool_docs_show(const char *docs);
90 char *texttool_docs_get(void);
91 void texttool_docs_clear(void);
92
93 #ifdef __cplusplus
94 }
95 #endif
96
97 #endif