Added a documentation panel with primitive word-wrap functionality. It can be display...
[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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, 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 #ifdef __cplusplus
33 extern "C" {
34 #endif
35
36 /* ****************************************************************************
37 Suggestions must be added in sorted order (no attempt is made to sort the list)
38 The list is then divided up based on the prefix provided by update_suggestions:
39 Example:
40   Prefix: ab
41   aaa <-- first
42   aab
43   aba <-- firstmatch
44   abb <-- lastmatch
45   baa
46   bab <-- last
47 **************************************************************************** */
48
49 struct Text;
50
51 typedef struct SuggItem {
52         struct SuggItem *prev, *next;
53         char *name;
54         char type;
55 } SuggItem;
56
57 typedef struct SuggList {
58         SuggItem *first, *last;
59         SuggItem *firstmatch, *lastmatch;
60         SuggItem *selected;
61 } SuggList;
62
63 /* Free all suggestion related memory */
64 void free_suggestions();
65
66 /* Used to identify which Text object the current tools should appear against */
67 void suggest_set_active(Text *text);
68 void suggest_clear_active();
69 short suggest_is_active(Text *text);
70
71 void suggest_add(const char *name, char type);
72 void suggest_prefix(const char *prefix);
73 SuggItem *suggest_first();
74 SuggItem *suggest_last();
75
76 void suggest_set_selected(SuggItem *sel);
77 SuggItem *suggest_get_selected();
78
79 void suggest_documentation(const char *docs);
80 char *suggest_get_docs();
81 void suggest_clear_docs();
82
83 #ifdef __cplusplus
84 }
85 #endif
86
87 #endif