1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
|
/**
* @file lluilistener.cpp
* @author Nat Goodspeed
* @date 2009-08-18
* @brief Implementation for lluilistener.
*
* $LicenseInfo:firstyear=2009&license=viewerlgpl$
* Second Life Viewer Source Code
* Copyright (C) 2010, Linden Research, Inc.
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation;
* version 2.1 of the License only.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*
* Linden Research, Inc., 945 Battery Street, San Francisco, CA 94111 USA
* $/LicenseInfo$
*/
// Precompiled header
#include "llviewerprecompiledheaders.h"
// associated header
#include "lluilistener.h"
// STL headers
// std headers
// external library headers
// other Linden headers
#include "llmenugl.h"
#include "llui.h" // getRootView(), resolvePath()
#include "lluictrl.h"
#include "llerror.h"
extern LLMenuBarGL* gMenuBarView;
#define THROTTLE_PERIOD 1.5 // required seconds between throttled functions
#define MIN_THROTTLE 0.5
LLUIListener::LLUIListener():
LLEventAPI("UI",
"LLUICtrl::CommitCallbackRegistry listener.\n"
"Capable of invoking any function (with parameter) you can specify in XUI.")
{
add("call",
"Invoke the operation named by [\"function\"], passing [\"parameter\"],\n"
"as if from a user gesture on a menu -- or a button click.",
&LLUIListener::call,
llsd::map("function", LLSD(), "reply", LLSD()));
add("getValue",
"For the UI control identified by the path in [\"path\"], return the control's\n"
"current value as [\"value\"] reply.",
&LLUIListener::getValue,
llsd::map("path", LLSD(), "reply", LLSD()));
LLSD required_args = llsd::map("name", LLSD(), "label", LLSD(), "reply", LLSD());
add("addMenu",
"Add new drop-down menu [\"name\"] with displayed [\"label\"] to the Top menu.",
&LLUIListener::addMenu,
required_args);
required_args.insert("parent_menu", LLSD());
add("addMenuBranch",
"Add new menu branch [\"name\"] with displayed [\"label\"]\n"
"to the [\"parent_menu\"] within the Top menu.",
&LLUIListener::addMenuBranch,
required_args);
add("addMenuItem",
"Add new menu item [\"name\"] with displayed [\"label\"]\n"
"and call-on-click UI function [\"func\"] with optional [\"param\"]\n"
"to the [\"parent_menu\"] within the Top menu.",
&LLUIListener::addMenuItem,
required_args.with("func", LLSD()));
add("addMenuSeparator",
"Add menu separator to the [\"parent_menu\"] within the Top menu.",
&LLUIListener::addMenuSeparator,
llsd::map("parent_menu", LLSD(), "reply", LLSD()));
}
typedef LLUICtrl::CommitCallbackInfo cb_info;
void LLUIListener::call(const LLSD& event)
{
Response response(LLSD(), event);
LLUICtrl::CommitCallbackInfo *info = LLUICtrl::CommitCallbackRegistry::getValue(event["function"]);
if (!info || !info->callback_func)
{
return response.error(stringize("Function ", std::quoted(event["function"].asString()), " was not found"));
}
if (info->handle_untrusted == cb_info::UNTRUSTED_BLOCK)
{
return response.error(stringize("Function ", std::quoted(event["function"].asString()), " may not be called from the script"));
}
//Separate UNTRUSTED_THROTTLE and UNTRUSTED_ALLOW functions to have different timeout
F64 *throttlep, period;
if (info->handle_untrusted == cb_info::UNTRUSTED_THROTTLE)
{
throttlep = &mLastUntrustedThrottle;
period = THROTTLE_PERIOD;
}
else
{
throttlep = &mLastMinThrottle;
period = MIN_THROTTLE;
}
F64 cur_time = LLTimer::getElapsedSeconds();
F64 time_delta = *throttlep + period;
if (cur_time < time_delta)
{
LL_WARNS("LLUIListener") << "Throttled function " << std::quoted(event["function"].asString()) << LL_ENDL;
return;
}
*throttlep = cur_time;
// Interestingly, view_listener_t::addMenu() (addCommit(),
// addEnable()) constructs a commit_callback_t callable that accepts
// two parameters but discards the first. Only the second is passed to
// handleEvent(). Therefore we feel completely safe passing NULL for
// the first parameter.
(info->callback_func)(NULL, event["parameter"]);
}
void LLUIListener::getValue(const LLSD&event) const
{
Response response(LLSD(), event);
const LLView* root = LLUI::getInstance()->getRootView();
const LLView* view = LLUI::getInstance()->resolvePath(root, event["path"].asString());
const LLUICtrl* ctrl(dynamic_cast<const LLUICtrl*>(view));
if (ctrl)
{
response["value"] = ctrl->getValue();
}
else
{
response.error(stringize("UI control ", std::quoted(event["path"].asString()), " was not found"));
}
}
LLMenuGL::Params get_params(const LLSD&event)
{
LLMenuGL::Params item_params;
item_params.name = event["name"];
item_params.label = event["label"];
item_params.can_tear_off = true;
return item_params;
}
LLMenuGL* get_parent_menu(LLEventAPI::Response& response, const LLSD&event)
{
LLMenuGL* parent_menu = gMenuBarView->findChildMenuByName(event["parent_menu"], true);
if(!parent_menu)
{
response.error(stringize("Parent menu ", std::quoted(event["parent_menu"].asString()), " was not found"));
}
return parent_menu;
}
void LLUIListener::addMenu(const LLSD&event) const
{
Response response(LLSD(), event);
LLMenuGL::Params item_params = get_params(event);
if(!gMenuBarView->appendMenu(LLUICtrlFactory::create<LLMenuGL>(item_params)))
{
response.error(stringize("Menu ", std::quoted(event["name"].asString()), " was not added"));
}
}
void LLUIListener::addMenuBranch(const LLSD&event) const
{
Response response(LLSD(), event);
if(LLMenuGL* parent_menu = get_parent_menu(response, event))
{
LLMenuGL::Params item_params = get_params(event);
if(!parent_menu->appendMenu(LLUICtrlFactory::create<LLMenuGL>(item_params)))
{
response.error(stringize("Menu branch ", std::quoted(event["name"].asString()), " was not added"));
}
}
}
void LLUIListener::addMenuItem(const LLSD&event) const
{
Response response(LLSD(), event);
LLMenuItemCallGL::Params item_params;
item_params.name = event["name"];
item_params.label = event["label"];
LLUICtrl::CommitCallbackParam item_func;
item_func.function_name = event["func"];
if (event.has("param"))
{
item_func.parameter = event["param"];
}
item_params.on_click = item_func;
if(LLMenuGL* parent_menu = get_parent_menu(response, event))
{
if(!parent_menu->append(LLUICtrlFactory::create<LLMenuItemCallGL>(item_params)))
{
response.error(stringize("Menu item ", std::quoted(event["name"].asString()), " was not added"));
}
}
}
void LLUIListener::addMenuSeparator(const LLSD&event) const
{
Response response(LLSD(), event);
if(LLMenuGL* parent_menu = get_parent_menu(response, event))
{
if(!parent_menu->addSeparator())
{
response.error("Separator was not added");
}
}
}
|
