summaryrefslogtreecommitdiff
path: root/indra/newview/llscreenchannel.h
blob: f05c205e2ab4c8f7976b973c90055df8d1aa5177 (plain)
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
/** 
 * @file llscreenchannel.h
 * @brief Class implements a channel on a screen in which appropriate toasts may appear.
 *
 * $LicenseInfo:firstyear=2003&license=viewergpl$
 * 
 * Copyright (c) 2003-2009, 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_LLSCREENCHANNEL_H
#define LL_LLSCREENCHANNEL_H

#include "lltoast.h"

#include <map>
#include <boost/shared_ptr.hpp>

namespace LLNotificationsUI
{

typedef enum e_notification_toast_alignment
{
	NA_TOP, 
	NA_CENTRE,
	NA_BOTTOM,
} EToastAlignment;


/**
 * Screen channel manages toasts visibility and positioning on the screen.
 */
class LLScreenChannel : public LLUICtrl
{
	friend class LLChannelManager;
public:
	LLScreenChannel();
	virtual ~LLScreenChannel();

	void		reshape(S32 width, S32 height, BOOL called_from_parent = TRUE);

	LLToast*	addToast(LLUUID id, LLPanel* panel, bool is_not_tip = true);
	void		init(S32 channel_left, S32 channel_right);
	
	void		killToastByNotificationID(LLUUID id);
	void		modifyToastByNotificationID(LLUUID id, LLPanel* panel);
	
	void		setToastAlignment(e_notification_toast_alignment align) {mToastAlignment = align;}

	void		setControlHovering(bool control) { mControlHovering = control; }
	void		setHovering(bool hovering) { mIsHovering = hovering; }

	void		removeToastsFromChannel();
	void		hideToastsFromScreen();

	void		setStoreToasts(bool store) { mStoreToasts = store; }
	void		loadStoredToastsToChannel();
	
	void		showToasts();

	S32			getNumberOfHiddenToasts() { return mHiddenToastsNum;}
	void		setNumberOfHiddenToasts(S32 num) { mHiddenToastsNum = num;}

	static void	setStartUpToastShown() { mWasStartUpToastShown = true; }

	e_notification_toast_alignment getToastAlignment() {return mToastAlignment;}

	void		setOverflowFormatString ( std::string str)  { mOverflowFormatString = str; }

private:
	struct ToastElem
	{
		LLUUID		id;
		LLToast*	toast;
		ToastElem(LLUUID lluuid, LLPanel* panel) : id(lluuid)
		{
			toast = new LLToast(panel);
		}

		ToastElem(const ToastElem& toast_elem)
		{
			id = toast_elem.id;
			toast = toast_elem.toast;
		}

		bool operator == (const LLUUID &id_op) const
		{
			return (id == id_op);
		}

		bool operator == (LLPanel* panel_op) const
		{
			return (toast == panel_op);
		}
	};

	void	onToastHover(LLToast* toast, bool mouse_enter);

	void	onToastFade(LLToast* toast);
	void	storeToast(ToastElem& toast_elem);
	
	void	showToastsBottom();
	void	showToastsCentre();
	void	showToastsTop();
	
	void	createOverflowToast(S32 bottom, F32 timer = 0);
	void	onOverflowToastHide();

	static bool	mWasStartUpToastShown;
	bool		mControlHovering;
	bool		mIsHovering;
	bool		mStoreToasts;
	bool		mOverflowToastHidden;
	S32			mHiddenToastsNum;
	LLToast*	mUnreadToastsPanel;
	std::vector<ToastElem>	mToastList;
	std::vector<ToastElem>	mStoredToastList;
	e_notification_toast_alignment	mToastAlignment;
	std::map<LLToast*, bool>	mToastEventStack;

	std::string mOverflowFormatString;
};

}
#endif