UnrealEngineUWP/Engine/Source/Runtime/Slate/Public/Framework/MultiBox/MultiBoxDefs.h

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

#pragma once

#include "CoreMinimal.h"
#include "Misc/Attribute.h"
#include "Styling/ISlateStyle.h"
#include "Framework/Commands/UICommandInfo.h"

class SToolTip;
class SWidget;

/**
 * Types of MultiBoxes
 */
namespace EMultiBoxType
{
	enum Type
	{
		/** Horizontal menu bar */
		MenuBar,

		/** Horizontal tool bar */
		ToolBar,

		/** Vertical tool bar */
		VerticalToolBar,

		/** Vertical menu (pull-down menu, or context menu) */
		Menu,

		/** Buttons arranged in rows, with a maximum number of buttons per row, like a toolbar but can have multiple rows*/
		ButtonRow
	};
}

/**
 * Types of MultiBlocks
 */
namespace EMultiBlockType
{
	enum Type
	{
		None = 0,
		ButtonRow,
		EditableText,
		Heading,
		MenuEntry,
		MenuSeparator,
		ToolBarButton,
		ToolBarComboButton,
		ToolBarSeparator,
		Widget,
	};
}

class SLATE_API FMultiBoxSettings
{
public:

	DECLARE_DELEGATE_RetVal_ThreeParams( TSharedRef< SToolTip >, FConstructToolTip, const TAttribute<FText>& /*ToolTipText*/, const TSharedPtr<SWidget>& /*OverrideContent*/, const TSharedPtr<const FUICommandInfo>& /*Action*/ );

	/** Access to whether multiboxes use small icons or default sized icons */
	static TAttribute<bool> UseSmallToolBarIcons;
	static TAttribute<bool> DisplayMultiboxHooks;
	static FConstructToolTip ToolTipConstructor;

	FMultiBoxSettings();

	/** Enables or disables toolbar editing */
	static void ToggleToolbarEditing();

	/** @return True if in toolbar edit mode */
	static bool IsInToolbarEditMode() { return bInToolbarEditMode; }

	static TSharedRef< SToolTip > ConstructDefaultToolTip( const TAttribute<FText>& ToolTipText, const TSharedPtr<SWidget>& OverrideContent, const TSharedPtr<const FUICommandInfo>& Action );

	static void ResetToolTipConstructor();

private:
	static bool bInToolbarEditMode;
};

struct SLATE_API FMultiBoxCustomization
{
	static const FMultiBoxCustomization None;

	static FMultiBoxCustomization AllowCustomization( FName InCustomizationName )
	{
		ensure( InCustomizationName != NAME_None );
		return FMultiBoxCustomization( InCustomizationName );
	}

	FName GetCustomizationName() const { return CustomizationName; }

	FMultiBoxCustomization( FName InCustomizationName )
		: CustomizationName( InCustomizationName )
	{}

private:
	/** The Name of the customization that uniquely identifies the multibox for saving and loading users data*/
	FName CustomizationName;
};

/** 
 * Block location information
 */
namespace EMultiBlockLocation
{
	enum Type
	{
		/** Default, either no other blocks in group or grouping style is disabled */
		None = -1,
		
		/** Denotes the beginning of a group, currently left most first */
		Start,

		/** Denotes a middle block(s) of a group */
		Middle,

		/** Denotes the end of a group, currently the right most */
		End,
	};

	/** returns the passed in style with the addition of the location information */
	static FName ToName(FName StyleName, Type InLocation)
	{
		switch(InLocation)
		{
		case Start:
			return ISlateStyle::Join(StyleName, ".Start");
		case Middle:
			return ISlateStyle::Join(StyleName, ".Middle");
		case End:
			return ISlateStyle::Join(StyleName, ".End");
		}
		return StyleName;
	}
}