DI-Guy C++ SDK Reference  13.0
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
diguyInfoPopup.h
Go to the documentation of this file.
1 
2 /*********************************************************************
3  ** Copyright (c) 1992-2014 VT MAK
4  ** All rights reserved.
5  *********************************************************************/
6 
7 /*********************************************************************
8  **
9  *t diguyInfoPopup
10  **
11  *b Link against: libdiguy
12  */
13 
14 #ifndef __diguyInfoPopup_H
15 #define __diguyInfoPopup_H
16 
17 #ifdef SWIG
18 %module diguyInfoPopup
19 #else
20 #define CPLUSPLUS_ONLY
21 #endif
22 
23 #ifdef CPLUSPLUS_ONLY
24 
25 class bdiScenarioInfoPopup;
26 class diguyInfoPopup;
27 
28 #endif /* CPLUSPLUS_ONLY */
29 
30 
31 #include <declspec_diguy.h>
32 
33 /****************************************************************************/
34 class BDI_DECLSPEC_diguy diguyInfoPopup
35 {
36 
37 public:
38 
39  /*l
40  *b Description:
41  **
42  ** Returns the name of the info popup. This pointer will
43  ** never be NULL.
44  **
45  *b Returns:
46  **
47  ** name of the info popup
48  **
49  *b Callable From:
50  **
51  *- - C++
52  *- - Script
53  */
54  const char* get_name();
55 
56  /*l
57  *b Description:
58  **
59  ** This function sets the name of this object.
60  **
61  *b Returns:
62  **
63  ** 0 on success, -1 on failure
64  **
65  *b Callable From:
66  **
67  *- - C++
68  *- - Script
69  */
70  int set_name(const char* name);
71 
72  /*l
73  *b Description:
74  **
75  ** This function shows the info popup.
76  **
77  *b Arguments:
78  **
79  *a duration - length of time in seconds to show to the info popup;
80  *a the default argument of -1 will show the info popup
81  *a indefinitely, until the hide() function is called
82  **
83  *b Returns:
84  **
85  ** 0 on success, -1 on failure
86  **
87  *b Callable From:
88  **
89  *- - C++
90  *- - Script
91  *- - Decision Bead
92  */
93  int show(float show_duration = -1.0f);
94 
95  /*l
96  *b Description:
97  **
98  ** This function hides the info popup, if it is currently shown.
99  **
100  *b Returns:
101  **
102  ** 0 on success, -1 on failure
103  **
104  *b Callable From:
105  **
106  *- - C++
107  *- - Script
108  *- - Decision Bead
109  */
110  int hide();
111 
112  /*l
113  *b Returns:
114  **
115  ** Returns 1 if the info popup is showing, 0 if not.
116  **
117  *b Callable From:
118  **
119  *- - C++
120  *- - Script
121  *- - Decision Bead
122  */
123  int is_showing();
124 
125  /*l
126  *b Description:
127  **
128  ** This function clears the contents of the info popup.
129  **
130  *b Returns:
131  **
132  ** 0 on success, -1 on failure
133  **
134  *b Callable From:
135  **
136  *- - C++
137  *- - Script
138  */
139  int clear();
140 
141  /*l
142  *b Description:
143  **
144  ** This function appends the contents of the file identified
145  ** by filename to the info popup.
146  **
147  *b Arguments:
148  **
149  *a filename - name of the file
150  **
151  *b Returns:
152  **
153  ** 0 on success, -1 on failure
154  **
155  *b Callable From:
156  **
157  *- - C++
158  *- - Script
159  */
160  int append_file(const char* filename);
161 
162  /*l
163  *b Description:
164  **
165  ** This function appends a string to the info popup.
166  **
167  *b Arguments:
168  **
169  *a string - string to append
170  **
171  *b Returns:
172  **
173  ** 0 on success, -1 on failure
174  **
175  *b Callable From:
176  **
177  *- - C++
178  *- - Script
179  */
180  int append_string(const char* string);
181 
182 
187 #ifdef CPLUSPLUS_ONLY
188 
189 private:
190 
191  /*l
192  ** A private constructor.
193  */
194  diguyInfoPopup(bdiScenarioInfoPopup* info_popup);
195 
196  /*l
197  ** A pointer to internal data.
198  */
199  bdiScenarioInfoPopup* m_scripted_object;
200 
201  friend class bdiScenarioInfoPopup;
202 
203 #endif /* CPLUSPLUS_ONLY */
204 
205 };
206 
207 #endif /* __diguyInfoPopup_H */