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
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
|
/**
* @file lltoast.h
* @brief This class implements a placeholder for any notification panel.
*
* $LicenseInfo:firstyear=2003&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$
*/
#ifndef LL_LLTOAST_H
#define LL_LLTOAST_H
#include "llinstancetracker.h"
#include "llpanel.h"
#include "llmodaldialog.h"
#include "lleventtimer.h"
#include "llnotificationptr.h"
#include "llviewercontrol.h"
#include "lltexteditor.h"
#define MOUSE_LEAVE false
#define MOUSE_ENTER true
namespace LLNotificationsUI
{
class LLToast;
/**
* Timer for toasts.
*/
class LLToastLifeTimer: public LLEventTimer
{
public:
LLToastLifeTimer(LLToast* toast, F32 period);
/*virtual*/
BOOL tick();
void stop();
void start();
void restart();
BOOL getStarted();
void setPeriod(F32 period);
F32 getRemainingTimeF32();
LLTimer& getEventTimer() { return mEventTimer;}
private :
LLToast* mToast;
};
/**
* Represents toast pop-up.
* This is a parent view for all toast panels.
*/
class LLToast : public LLModalDialog, public LLInstanceTracker<LLToast>
{
friend class LLToastLifeTimer;
public:
typedef boost::function<void (LLToast* toast)> toast_callback_t;
typedef boost::signals2::signal<void (LLToast* toast)> toast_signal_t;
typedef boost::signals2::signal<void (LLToast* toast, bool mouse_enter)> toast_hover_check_signal_t;
struct Params : public LLInitParam::Block<Params>
{
Mandatory<LLPanel*> panel;
Optional<LLUUID> notif_id, //notification ID
session_id; //im session ID
Optional<LLNotificationPtr> notification;
//NOTE: Life time of a toast (i.e. period of time from the moment toast was shown
//till the moment when toast was hidden) is the sum of lifetime_secs and fading_time_secs.
Optional<F32> lifetime_secs, // Number of seconds while a toast is non-transparent
fading_time_secs; // Number of seconds while a toast is transparent
Optional<toast_callback_t> on_delete_toast;
Optional<bool> can_fade,
can_be_stored,
enable_hide_btn,
is_modal,
is_tip,
force_show,
force_store;
Params();
};
static void updateClass();
LLToast(const LLToast::Params& p);
virtual ~LLToast();
BOOL postBuild();
/*virtual*/ void reshape(S32 width, S32 height, BOOL called_from_parent = TRUE);
// Toast handlers
virtual BOOL handleMouseDown(S32 x, S32 y, MASK mask);
//Fading
/** Stop lifetime/fading timer */
virtual void stopTimer();
/** Start lifetime/fading timer */
virtual void startTimer();
bool isHovered() { return mIsHovered; }
// Operating with toasts
// insert a panel to a toast
void insertPanel(LLPanel* panel);
void reshapeToPanel();
// get toast's panel
LLPanel* getPanel() const { return mPanel; }
// enable/disable Toast's Hide button
void setHideButtonEnabled(bool enabled);
//
F32 getTimeLeftToLive();
//
LLToastLifeTimer* getTimer() { return mTimer.get();}
//
virtual void draw();
//
virtual void setVisible(BOOL show);
/*virtual*/ void setBackgroundOpaque(BOOL b);
//
virtual void hide();
/*virtual*/ void onFocusLost();
/*virtual*/ void onFocusReceived();
void setLifetime(S32 seconds);
void setFadingTime(S32 seconds);
void closeToast();
/**
* Returns padding between floater top and wrapper_panel top.
* This padding should be taken into account when positioning or reshaping toasts
*/
S32 getTopPad();
S32 getRightPad();
// get/set Toast's flags or states
// get information whether the notification corresponding to the toast is valid or not
bool isNotificationValid();
// get toast's Notification ID
const LLUUID getNotificationID() const { return mNotificationID;}
// get toast's Session ID
const LLUUID getSessionID() const { return mSessionID;}
//
void setCanFade(bool can_fade);
//
void setCanBeStored(bool can_be_stored) { mCanBeStored = can_be_stored; }
//
bool getCanBeStored() { return mCanBeStored; }
// set whether this toast considered as hidden or not
void setIsHidden( bool is_toast_hidden ) { mIsHidden = is_toast_hidden; }
const LLNotificationPtr& getNotification() const { return mNotification;}
// Registers signals/callbacks for events
boost::signals2::connection setOnFadeCallback(const toast_signal_t::slot_type& cb) { return mOnFadeSignal.connect(cb); }
boost::signals2::connection setOnToastDestroyedCallback(const toast_signal_t::slot_type& cb) { return mOnToastDestroyedSignal.connect(cb); }
boost::signals2::connection setOnToastHoverCallback(const toast_hover_check_signal_t::slot_type& cb) { return mOnToastHoverSignal.connect(cb); }
boost::signals2::connection setMouseEnterCallback( const commit_signal_t::slot_type& cb ) { return mToastMouseEnterSignal.connect(cb); };
boost::signals2::connection setMouseLeaveCallback( const commit_signal_t::slot_type& cb ) { return mToastMouseLeaveSignal.connect(cb); };
virtual S32 notifyParent(const LLSD& info);
LLHandle<LLToast> getHandle() const { return getDerivedHandle<LLToast>(); }
protected:
void updateTransparency();
private:
void updateHoveredState();
void expire();
void setFading(bool fading);
LLUUID mNotificationID;
LLUUID mSessionID;
LLNotificationPtr mNotification;
//LLRootHandle<LLToast> mHandle;
LLPanel* mWrapperPanel;
// timer counts a lifetime of a toast
std::auto_ptr<LLToastLifeTimer> mTimer;
F32 mToastLifetime; // in seconds
F32 mToastFadingTime; // in seconds
LLPanel* mPanel;
LLButton* mHideBtn;
LLColor4 mBgColor;
bool mCanFade;
bool mCanBeStored;
bool mHideBtnEnabled;
bool mHideBtnPressed;
bool mIsHidden; // this flag is TRUE when a toast has faded or was hidden with (x) button (EXT-1849)
bool mIsTip;
bool mIsFading;
bool mIsHovered;
toast_signal_t mOnFadeSignal;
toast_signal_t mOnDeleteToastSignal;
toast_signal_t mOnToastDestroyedSignal;
toast_hover_check_signal_t mOnToastHoverSignal;
commit_signal_t mToastMouseEnterSignal;
commit_signal_t mToastMouseLeaveSignal;
};
}
#endif
|
