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
|
/**
* @file llnotify.h
* @brief Non-blocking notification that doesn't take keyboard focus.
*
* $LicenseInfo:firstyear=2003&license=viewergpl$
*
* Copyright (c) 2003-2008, Linden Research, Inc.
*
* Second Life Viewer Source Code
* The source code in this file ("Source Code") is provided by Linden Lab
* to you under the terms of the GNU General Public License, version 2.0
* ("GPL"), unless you have obtained a separate licensing agreement
* ("Other License"), formally executed by you and Linden Lab. Terms of
* the GPL can be found in doc/GPL-license.txt in this distribution, or
* online at http://secondlifegrid.net/programs/open_source/licensing/gplv2
*
* There are special exceptions to the terms and conditions of the GPL as
* it is applied to this Source Code. View the full text of the exception
* in the file doc/FLOSS-exception.txt in this software distribution, or
* online at http://secondlifegrid.net/programs/open_source/licensing/flossexception
*
* By copying, modifying or distributing this software, you acknowledge
* that you have read and understood your obligations described above,
* and agree to abide by those obligations.
*
* ALL LINDEN LAB SOURCE CODE IS PROVIDED "AS IS." LINDEN LAB MAKES NO
* WARRANTIES, EXPRESS, IMPLIED OR OTHERWISE, REGARDING ITS ACCURACY,
* COMPLETENESS OR PERFORMANCE.
* $/LicenseInfo$
*/
#ifndef LL_LLNOTIFY_H
#define LL_LLNOTIFY_H
#include "llfontgl.h"
#include "llpanel.h"
#include "lltimer.h"
#include <vector>
class LLButton;
class LLNotifyBoxTemplate;
// NotifyBox - for notifications that require a response from the user.
class LLNotifyBox : public LLPanel, public LLEventTimer
{
public:
typedef void (*notify_callback_t)(S32 option, void* data);
typedef std::vector<std::string> option_list_t;
static LLNotifyBox* showXml( const std::string& xml_desc,
notify_callback_t callback = NULL, void *user_data = NULL);
static LLNotifyBox* showXml( const std::string& xml_desc, const LLStringUtil::format_map_t& args, BOOL is_caution,
notify_callback_t callback = NULL, void *user_data = NULL);
static LLNotifyBox* showXml( const std::string& xml_desc, const LLStringUtil::format_map_t& args,
notify_callback_t callback = NULL, void *user_data = NULL);
// For script notifications:
static LLNotifyBox* showXml( const std::string& xml_desc, const LLStringUtil::format_map_t& args,
notify_callback_t callback, void *user_data,
const option_list_t& options,
BOOL layout_script_dialog = FALSE);
static bool parseNotify(const std::string& xml_filename);
static const std::string getTemplateMessage(const std::string& xml_desc, const LLStringUtil::format_map_t& args);
static const std::string getTemplateMessage(const std::string& xml_desc);
static BOOL getTemplateIsCaution(const std::string& xml_desc);
BOOL isTip() const { return mIsTip; }
BOOL isCaution() const { return mIsCaution; }
/*virtual*/ void setVisible(BOOL visible);
void stopAnimation() { mAnimating = FALSE; }
notify_callback_t getNotifyCallback() { return mBehavior->mCallback; }
void* getUserData() { return mBehavior->mData; }
void close();
static void cleanup();
static void format(std::string& msg, const LLStringUtil::format_map_t& args);
protected:
LLNotifyBox(LLPointer<LLNotifyBoxTemplate> notify_template, const LLStringUtil::format_map_t& args,
notify_callback_t callback, void* user_data,
BOOL is_caution = FALSE,
const option_list_t& extra_options = option_list_t(),
BOOL layout_script_dialog = FALSE);
/*virtual*/ ~LLNotifyBox();
/*virtual*/ BOOL handleMouseUp(S32 x, S32 y, MASK mask);
/*virtual*/ BOOL handleRightMouseDown(S32 x, S32 y, MASK mask);
// Animate as sliding onto the screen.
/*virtual*/ void draw();
/*virtual*/ BOOL tick();
void moveToBack(bool getfocus = false);
// Returns the rect, relative to gNotifyView, where this
// notify box should be placed.
static LLRect getNotifyRect(S32 num_options, BOOL layout_script_dialog, BOOL is_caution);
static LLRect getNotifyTipRect(const std::string &message);
// internal handler for button being clicked
static void onClickButton(void* data);
// for "next" button
static void onClickNext(void* data);
static LLPointer<LLNotifyBoxTemplate> getTemplate(const std::string& xml_desc);
static LLNotifyBox* findExistingNotify(LLPointer<LLNotifyBoxTemplate> notify_template, const LLStringUtil::format_map_t& args);
private:
void drawBackground() const;
static LLPointer<LLNotifyBoxTemplate> sDefaultTemplate;
protected:
std::string mMessage;
BOOL mIsTip;
BOOL mIsCaution; // is this a caution notification?
BOOL mAnimating; // Are we sliding onscreen?
BOOL mUnique;
// Time since this notification was displayed.
// This is an LLTimer not a frame timer because I am concerned
// that I could be out-of-sync by one frame in the animation.
LLTimer mAnimateTimer;
LLButton* mNextBtn;
// keep response behavior isolated here
struct LLNotifyBehavior
{
LLNotifyBehavior(notify_callback_t callback, void* data);
notify_callback_t mCallback;
void* mData;
};
LLNotifyBehavior* mBehavior;
S32 mNumOptions;
S32 mDefaultOption;
// Used for callbacks
struct InstanceAndS32
{
LLNotifyBox* mSelf;
S32 mButton;
};
std::vector<InstanceAndS32*> mBtnCallbackData;
typedef std::map<std::string, LLPointer<LLNotifyBoxTemplate> > template_map_t;
static template_map_t sNotifyTemplates; // by mLabel
static S32 sNotifyBoxCount;
static const LLFontGL* sFont;
static const LLFontGL* sFontSmall;
typedef std::map<std::string, LLNotifyBox*> unique_map_t;
static unique_map_t sOpenUniqueNotifyBoxes;
};
class LLNotifyBoxView : public LLUICtrl
{
public:
LLNotifyBoxView(const std::string& name, const LLRect& rect, BOOL mouse_opaque, U32 follows=FOLLOWS_NONE);
void showOnly(LLView * ctrl);
LLNotifyBox * getFirstNontipBox() const;
class Matcher
{
public:
Matcher(){}
virtual ~Matcher() {}
virtual BOOL matches(LLNotifyBox::notify_callback_t callback, void* cb_data) const = 0;
};
// Walks the list and removes any stacked messages for which the given matcher returns TRUE.
// Useful when muting people and things in order to clear out any similar previously queued messages.
void purgeMessagesMatching(const Matcher& matcher);
};
// This view contains the stack of notification windows.
extern LLNotifyBoxView* gNotifyBoxView;
class LLNotifyBoxTemplate : public LLRefCount
{
public:
LLNotifyBoxTemplate(BOOL unique, F32 duration) :
mIsTip(FALSE),
mIsCaution(FALSE),
mUnique(unique),
mDuration(duration),
mDefaultOption(0)
{}
void setMessage(const std::string& message)
{
mMessage = message;
}
void addOption(const std::string& label, BOOL is_default = FALSE)
{
if (is_default)
{
mDefaultOption = mOptions.size();
}
mOptions.push_back(label);
}
public:
std::string mLabel; // Handle for access from code, etc
std::string mMessage; // Message to display
BOOL mIsTip;
BOOL mIsCaution;
BOOL mUnique;
F32 mDuration;
LLNotifyBox::option_list_t mOptions;
S32 mDefaultOption;
};
#endif
|
