Engine/Source/Developer/FriendsAndChat/Private/Models/ChatViewModel.h

// Copyright 1998-2015 Epic Games, Inc. All Rights Reserved.

#pragma once

#include "FriendViewModel.h"

class FChatItemViewModel;
namespace EChatMessageType
{
	enum Type : uint8;
}

struct FSelectedFriend
{
	TSharedPtr<FUniqueNetId> UserID;
	FText DisplayName;
	EChatMessageType::Type MessageType;
	TSharedPtr<FFriendViewModel> ViewModel;
	TSharedPtr<FChatItemViewModel> SelectedMessage;
};

class FChatViewModel
	: public TSharedFromThis<FChatViewModel>
{
public:
	virtual TArray<TSharedRef<FChatItemViewModel > >& GetMessages() = 0;
	virtual FReply HandleSelectionChanged(TSharedRef<FChatItemViewModel> ItemSelected) = 0;
	virtual FText GetViewGroupText() const = 0;
	virtual FText GetChatGroupText() const = 0;
	virtual EVisibility GetFriendRequestVisibility() const = 0;
	virtual EVisibility GetInviteToGameVisibility() const = 0;
	virtual EVisibility GetOpenWhisperVisibility() const = 0;
	virtual EVisibility GetAcceptFriendRequestVisibility() const = 0;
	virtual EVisibility GetIgnoreFriendRequestVisibility() const = 0;
	virtual EVisibility GetCancelFriendRequestVisibility() const = 0;
	virtual void EnumerateFriendOptions(TArray<EFriendActionType::Type>& OUTActionList) = 0;
	virtual void PerformFriendAction(EFriendActionType::Type ActionType) = 0;
	virtual void CancelAction() = 0;
	virtual void SetChatChannel(const EChatMessageType::Type NewOption) = 0;
	virtual void SetWhisperChannel(const TSharedPtr<FSelectedFriend> InFriend) = 0;
	virtual void SetViewChannel(const EChatMessageType::Type NewOption) = 0;
	virtual const EChatMessageType::Type GetChatChannel() const = 0;
	virtual bool IsChatChannelValid() const = 0;
	virtual bool IsChatConnected() const = 0;
	virtual FText GetChatDisconnectText() const = 0;
	virtual void SetChannelUserClicked(const TSharedRef<FChatItemViewModel> ChatItemSelected) = 0;
	virtual bool SendMessage(const FText NewMessage) = 0;
	virtual EChatMessageType::Type GetChatChannelType() const = 0;
	virtual const TArray<TSharedPtr<FSelectedFriend> >& GetRecentOptions() const = 0;
	virtual void SetDisplayGlobalChat(bool bAllow) = 0;
	virtual bool IsDisplayingGlobalChat() const = 0;
	virtual bool IsGlobalChatEnabled() const = 0;
	virtual bool HasValidSelectedFriend() const = 0;
	virtual bool HasFriendChatAction() const = 0;
	virtual bool HasActionPending() const = 0;
	virtual void SetInGame(bool bInGameSetting) = 0;
	virtual void LockChatChannel(bool bLocked) = 0;
	virtual bool IsChatChannelLocked() const = 0;	
	virtual void EnableGlobalChat(bool bEnable) = 0;
	DECLARE_EVENT(FChatViewModel, FChatListUpdated)
	virtual FChatListUpdated& OnChatListUpdated() = 0;

	virtual ~FChatViewModel() {}
};

/**
 * Creates the implementation for an ChatViewModel.
 *
 * @return the newly created ChatViewModel implementation.
 */
FACTORY(TSharedRef< FChatViewModel >, FChatViewModel,
	const TSharedRef<class FFriendsMessageManager>& MessageManager);
Update copyright notices to 2015. [CL 2379638 by Ben Marsh in Main branch] 2014-12-07 19:09:38 -05:00			`// Copyright 1998-2015 Epic Games, Inc. All Rights Reserved.`
Merging Dev -> Main using UE4-Fortnite-To-UE4 from CL 2340802 Includes following engine changes: Getting display metrics only once at construct time when using SSafeZone. GetDisplayMetrics is expensive in Windows so it is impractical to call it every frame. - Some AI API improvements, mostly switchig pointer function parameters to references. - minor refactor of UCrowdFollowingComponent's queryinf functions: - IsCrowdEnabled functions refactored to IsCrowdActive - implemented IsCrowd*Enabled that return acrual values of relevant properties - Added a function to CrowdManager to query for location of agents neighbouring given agent Added support for PS4 touchpad-based cursor You can now choose to skip synchronously scanning for asset data in object libraries and just use the data that is currently in the asset registry. The data will be refereshed automatically later once the global scan completes. The only applies to non-commandlet editor instances. Crash fixes for trying to access NULL Metal surfaces on IOS Slate: Cleaned up some atlas code related to padding and corrected some comments [CL 2347323 by Ben Zeigler in Main branch] 2014-11-03 15:47:28 -05:00
			`#pragma once`

Merging from Fortnite to Main [CL 2364721 by Nicholas Davies in Main branch] 2014-11-19 05:28:05 -05:00			`#include "FriendViewModel.h"`

Merging Dev -> Main using UE4-Fortnite-To-UE4 from CL 2340802 Includes following engine changes: Getting display metrics only once at construct time when using SSafeZone. GetDisplayMetrics is expensive in Windows so it is impractical to call it every frame. - Some AI API improvements, mostly switchig pointer function parameters to references. - minor refactor of UCrowdFollowingComponent's queryinf functions: - IsCrowdEnabled functions refactored to IsCrowdActive - implemented IsCrowd*Enabled that return acrual values of relevant properties - Added a function to CrowdManager to query for location of agents neighbouring given agent Added support for PS4 touchpad-based cursor You can now choose to skip synchronously scanning for asset data in object libraries and just use the data that is currently in the asset registry. The data will be refereshed automatically later once the global scan completes. The only applies to non-commandlet editor instances. Crash fixes for trying to access NULL Metal surfaces on IOS Slate: Cleaned up some atlas code related to padding and corrected some comments [CL 2347323 by Ben Zeigler in Main branch] 2014-11-03 15:47:28 -05:00			`class FChatItemViewModel;`
			`namespace EChatMessageType`
			`{`
			`enum Type : uint8;`
			`}`

Merging from Fortnite [CL 2359911 by Nicholas Davies in Main branch] 2014-11-14 08:05:34 -05:00			`struct FSelectedFriend`
			`{`
			`TSharedPtr<FUniqueNetId> UserID;`
[INTEGRATE] UE4-LauncherDev->UE4 integrate all up to cl 2475889 [CL 2478426 by Carlos Cuello in Main branch] 2015-03-13 08:26:18 -04:00			`FText DisplayName;`
Merging from Fortnite to Main [CL 2364721 by Nicholas Davies in Main branch] 2014-11-19 05:28:05 -05:00			`EChatMessageType::Type MessageType;`
			`TSharedPtr<FFriendViewModel> ViewModel;`
Fix up message caps for different message types. Fixed a party chat message display issue. Changed the list view to use chat item view models provided from the manager. Fixed an issue with non-friends selected action changes when a friend status changes #jira n/a [CL 2374802 by Nicholas Davies in Main branch] 2014-12-03 10:21:53 -05:00			`TSharedPtr<FChatItemViewModel> SelectedMessage;`
Merging from Fortnite [CL 2359911 by Nicholas Davies in Main branch] 2014-11-14 08:05:34 -05:00			`};`

Merging Dev -> Main using UE4-Fortnite-To-UE4 from CL 2340802 Includes following engine changes: Getting display metrics only once at construct time when using SSafeZone. GetDisplayMetrics is expensive in Windows so it is impractical to call it every frame. - Some AI API improvements, mostly switchig pointer function parameters to references. - minor refactor of UCrowdFollowingComponent's queryinf functions: - IsCrowdEnabled functions refactored to IsCrowdActive - implemented IsCrowd*Enabled that return acrual values of relevant properties - Added a function to CrowdManager to query for location of agents neighbouring given agent Added support for PS4 touchpad-based cursor You can now choose to skip synchronously scanning for asset data in object libraries and just use the data that is currently in the asset registry. The data will be refereshed automatically later once the global scan completes. The only applies to non-commandlet editor instances. Crash fixes for trying to access NULL Metal surfaces on IOS Slate: Cleaned up some atlas code related to padding and corrected some comments [CL 2347323 by Ben Zeigler in Main branch] 2014-11-03 15:47:28 -05:00			`class FChatViewModel`
			`: public TSharedFromThis<FChatViewModel>`
			`{`
			`public:`
[INTEGRATE] UE4-LauncherDev->UE4 integrate all up to cl 2475889 [CL 2478426 by Carlos Cuello in Main branch] 2015-03-13 08:26:18 -04:00			`virtual TArray<TSharedRef<FChatItemViewModel > >& GetMessages() = 0;`
Merging from UE4-Fortnite - update to Friends and Chat system CL 2340958 to 2350247 [CL 2351555 by Nicholas Davies in Main branch] 2014-11-06 15:17:11 -05:00			`virtual FReply HandleSelectionChanged(TSharedRef<FChatItemViewModel> ItemSelected) = 0;`
Merging Dev -> Main using UE4-Fortnite-To-UE4 from CL 2340802 Includes following engine changes: Getting display metrics only once at construct time when using SSafeZone. GetDisplayMetrics is expensive in Windows so it is impractical to call it every frame. - Some AI API improvements, mostly switchig pointer function parameters to references. - minor refactor of UCrowdFollowingComponent's queryinf functions: - IsCrowdEnabled functions refactored to IsCrowdActive - implemented IsCrowd*Enabled that return acrual values of relevant properties - Added a function to CrowdManager to query for location of agents neighbouring given agent Added support for PS4 touchpad-based cursor You can now choose to skip synchronously scanning for asset data in object libraries and just use the data that is currently in the asset registry. The data will be refereshed automatically later once the global scan completes. The only applies to non-commandlet editor instances. Crash fixes for trying to access NULL Metal surfaces on IOS Slate: Cleaned up some atlas code related to padding and corrected some comments [CL 2347323 by Ben Zeigler in Main branch] 2014-11-03 15:47:28 -05:00			`virtual FText GetViewGroupText() const = 0;`
			`virtual FText GetChatGroupText() const = 0;`
Merge FriendsAndChat UE4-LauncherDev => UE4 (main) upto CL 2436945 [CL 2439641 by Chris Wood in Main branch] 2015-02-10 06:44:35 -05:00			`virtual EVisibility GetFriendRequestVisibility() const = 0;`
#Friends UI - Merging updates from Fortnite branch. #codereview: Sam.Zamani [CL 2366147 by Nicholas Davies in Main branch] 2014-11-20 04:05:40 -05:00			`virtual EVisibility GetInviteToGameVisibility() const = 0;`
Merge FriendsAndChat UE4-LauncherDev => UE4 (main) upto CL 2436945 [CL 2439641 by Chris Wood in Main branch] 2015-02-10 06:44:35 -05:00			`virtual EVisibility GetOpenWhisperVisibility() const = 0;`
[INTEGRATE] UE4-LauncherDev->UE4 integrate all up to cl 2475889 [CL 2478426 by Carlos Cuello in Main branch] 2015-03-13 08:26:18 -04:00			`virtual EVisibility GetAcceptFriendRequestVisibility() const = 0;`
			`virtual EVisibility GetIgnoreFriendRequestVisibility() const = 0;`
			`virtual EVisibility GetCancelFriendRequestVisibility() const = 0;`
Merging from Fortnite to Main [CL 2364721 by Nicholas Davies in Main branch] 2014-11-19 05:28:05 -05:00			`virtual void EnumerateFriendOptions(TArray<EFriendActionType::Type>& OUTActionList) = 0;`
			`virtual void PerformFriendAction(EFriendActionType::Type ActionType) = 0;`
#Friends UI - Merging updates from Fortnite branch. #codereview: Sam.Zamani [CL 2366147 by Nicholas Davies in Main branch] 2014-11-20 04:05:40 -05:00			`virtual void CancelAction() = 0;`
Merging from Fortnite [CL 2359911 by Nicholas Davies in Main branch] 2014-11-14 08:05:34 -05:00			`virtual void SetChatChannel(const EChatMessageType::Type NewOption) = 0;`
			`virtual void SetWhisperChannel(const TSharedPtr<FSelectedFriend> InFriend) = 0;`
Merging Dev -> Main using UE4-Fortnite-To-UE4 from CL 2340802 Includes following engine changes: Getting display metrics only once at construct time when using SSafeZone. GetDisplayMetrics is expensive in Windows so it is impractical to call it every frame. - Some AI API improvements, mostly switchig pointer function parameters to references. - minor refactor of UCrowdFollowingComponent's queryinf functions: - IsCrowdEnabled functions refactored to IsCrowdActive - implemented IsCrowd*Enabled that return acrual values of relevant properties - Added a function to CrowdManager to query for location of agents neighbouring given agent Added support for PS4 touchpad-based cursor You can now choose to skip synchronously scanning for asset data in object libraries and just use the data that is currently in the asset registry. The data will be refereshed automatically later once the global scan completes. The only applies to non-commandlet editor instances. Crash fixes for trying to access NULL Metal surfaces on IOS Slate: Cleaned up some atlas code related to padding and corrected some comments [CL 2347323 by Ben Zeigler in Main branch] 2014-11-03 15:47:28 -05:00			`virtual void SetViewChannel(const EChatMessageType::Type NewOption) = 0;`
#FriendsAndChat - Merge from Fortnite Dev [CL 2408759 by Nicholas Davies in Main branch] 2015-01-16 09:08:08 -05:00			`virtual const EChatMessageType::Type GetChatChannel() const = 0;`
Merge FriendsAndChat UE4-LauncherDev => UE4 (main) upto CL 2436945 [CL 2439641 by Chris Wood in Main branch] 2015-02-10 06:44:35 -05:00			`virtual bool IsChatChannelValid() const = 0;`
[INTEGRATE] UE4-LauncherDev->UE4 integrate all up to cl 2475889 [CL 2478426 by Carlos Cuello in Main branch] 2015-03-13 08:26:18 -04:00			`virtual bool IsChatConnected() const = 0;`
			`virtual FText GetChatDisconnectText() const = 0;`
Fix up message caps for different message types. Fixed a party chat message display issue. Changed the list view to use chat item view models provided from the manager. Fixed an issue with non-friends selected action changes when a friend status changes #jira n/a [CL 2374802 by Nicholas Davies in Main branch] 2014-12-03 10:21:53 -05:00			`virtual void SetChannelUserClicked(const TSharedRef<FChatItemViewModel> ChatItemSelected) = 0;`
Merging from Fortnite to Main [CL 2364721 by Nicholas Davies in Main branch] 2014-11-19 05:28:05 -05:00			`virtual bool SendMessage(const FText NewMessage) = 0;`
Merging from UE4-Fortnite - update to Friends and Chat system CL 2340958 to 2350247 [CL 2351555 by Nicholas Davies in Main branch] 2014-11-06 15:17:11 -05:00			`virtual EChatMessageType::Type GetChatChannelType() const = 0;`
Merging from Fortnite [CL 2359911 by Nicholas Davies in Main branch] 2014-11-14 08:05:34 -05:00			`virtual const TArray<TSharedPtr<FSelectedFriend> >& GetRecentOptions() const = 0;`
Merge FriendsAndChat UE4-LauncherDev => UE4 (main) upto CL 2436945 [CL 2439641 by Chris Wood in Main branch] 2015-02-10 06:44:35 -05:00			`virtual void SetDisplayGlobalChat(bool bAllow) = 0;`
			`virtual bool IsDisplayingGlobalChat() const = 0;`
Chat updates merging from Fortnite [CL 2358966 by Nicholas Davies in Main branch] 2014-11-13 16:15:33 -05:00			`virtual bool IsGlobalChatEnabled() const = 0;`
Merging from Fortnite to Main [CL 2364721 by Nicholas Davies in Main branch] 2014-11-19 05:28:05 -05:00			`virtual bool HasValidSelectedFriend() const = 0;`
			`virtual bool HasFriendChatAction() const = 0;`
#FriendsAndChat - Merge from Fortnite Dev [CL 2408759 by Nicholas Davies in Main branch] 2015-01-16 09:08:08 -05:00			`virtual bool HasActionPending() const = 0;`
			`virtual void SetInGame(bool bInGameSetting) = 0;`
Merge FriendsAndChat UE4-LauncherDev => UE4 (main) upto CL 2436945 [CL 2439641 by Chris Wood in Main branch] 2015-02-10 06:44:35 -05:00			`virtual void LockChatChannel(bool bLocked) = 0;`
[INTEGRATE] UE4-LauncherDev->UE4 integrate all up to cl 2475889 [CL 2478426 by Carlos Cuello in Main branch] 2015-03-13 08:26:18 -04:00			`virtual bool IsChatChannelLocked() const = 0;`
Merge FriendsAndChat UE4-LauncherDev => UE4 (main) upto CL 2436945 [CL 2439641 by Chris Wood in Main branch] 2015-02-10 06:44:35 -05:00			`virtual void EnableGlobalChat(bool bEnable) = 0;`
#FriendsAndChat - Merge from Fortnite Dev [CL 2408759 by Nicholas Davies in Main branch] 2015-01-16 09:08:08 -05:00			`DECLARE_EVENT(FChatViewModel, FChatListUpdated)`
			`virtual FChatListUpdated& OnChatListUpdated() = 0;`
Merging Dev -> Main using UE4-Fortnite-To-UE4 from CL 2340802 Includes following engine changes: Getting display metrics only once at construct time when using SSafeZone. GetDisplayMetrics is expensive in Windows so it is impractical to call it every frame. - Some AI API improvements, mostly switchig pointer function parameters to references. - minor refactor of UCrowdFollowingComponent's queryinf functions: - IsCrowdEnabled functions refactored to IsCrowdActive - implemented IsCrowd*Enabled that return acrual values of relevant properties - Added a function to CrowdManager to query for location of agents neighbouring given agent Added support for PS4 touchpad-based cursor You can now choose to skip synchronously scanning for asset data in object libraries and just use the data that is currently in the asset registry. The data will be refereshed automatically later once the global scan completes. The only applies to non-commandlet editor instances. Crash fixes for trying to access NULL Metal surfaces on IOS Slate: Cleaned up some atlas code related to padding and corrected some comments [CL 2347323 by Ben Zeigler in Main branch] 2014-11-03 15:47:28 -05:00
			`virtual ~FChatViewModel() {}`
			`};`

			`/**`
			`* Creates the implementation for an ChatViewModel.`
			`*`
			`* @return the newly created ChatViewModel implementation.`
			`*/`
Merging from UE4-Fortnite - update to Friends and Chat system CL 2340958 to 2350247 [CL 2351555 by Nicholas Davies in Main branch] 2014-11-06 15:17:11 -05:00			`FACTORY(TSharedRef< FChatViewModel >, FChatViewModel,`
			`const TSharedRef<class FFriendsMessageManager>& MessageManager);`