summaryrefslogtreecommitdiff
path: root/indra/newview/llchannelmanager.h
blob: 2d6aa181c5414aca410562a52e1d227aa72d1ee9 (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
/** 
 * @file llchannelmanager.h
 * @brief This class rules screen notification channels.
 *
 * $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_LLCHANNELMANAGER_H
#define LL_LLCHANNELMANAGER_H


#include "llscreenchannel.h"

#include "lluuid.h"

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

namespace LLNotificationsUI
{
/**
 * Manager for screen channels.
 * Responsible for instantiating and retrieving screen channels.
 */
class LLChannelManager : public LLSingleton<LLChannelManager>
{
public:	
	struct Params
	{
		LLUUID				id;
		bool				display_toasts_always;
		EToastAlignment		toast_align;
		EChannelAlignment	channel_align;

		Params():	id(LLUUID("")), display_toasts_always(false), toast_align(NA_BOTTOM), channel_align(CA_LEFT)
		{}
	};

	struct ChannelElem
	{
		LLUUID				id;
		LLScreenChannelBase*	channel;

		ChannelElem() : id(LLUUID("")), channel(NULL) { }

		ChannelElem(const ChannelElem &elem)
		{
			id = elem.id;
			channel = elem.channel;
		}

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

	LLChannelManager();	
	virtual ~LLChannelManager();

	// On LoginCompleted - show StartUp toast
	void onLoginCompleted();
	// removes a channel intended for the startup toast and allows other channels to show their toasts
	void onStartUpToastClose();

	// creates a new ScreenChannel according to the given parameters or returns existing if present
	LLScreenChannelBase*	getChannel(LLChannelManager::Params& p);

	LLScreenChannelBase*	addChannel(LLScreenChannelBase* channel);

	// returns a channel by its ID
	LLScreenChannelBase*	findChannelByID(const LLUUID id);

	// creator of the Notification channel, that is used in more than one handler
	LLScreenChannel*		createNotificationChannel();

	// remove channel methods
	void	removeChannelByID(const LLUUID id);

	/**
	 * Manages toasts showing for all channels.
	 *
	 * @param mute Flag to disable/enable toasts showing.
	 */
	void muteAllChannels(bool mute);

	/**
	 * Kills matched toasts from specified  toast screen channel.
	 */
	void killToastsFromChannel(const LLUUID& channel_id, const LLScreenChannel::Matcher& matcher);

	/**
	 * Returns notification screen channel.
	 */
	static LLNotificationsUI::LLScreenChannel* getNotificationScreenChannel();

	std::vector<ChannelElem>& getChannelList() { return mChannelList;}
private:

	LLScreenChannel* createChannel(LLChannelManager::Params& p);

	LLScreenChannel*			mStartUpChannel;
	std::vector<ChannelElem>	mChannelList;
};

}
#endif