GameMenuPage.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "Delegates/Delegate.h"
#include "Internationalization/Text.h"
#include "GameFramework/PlayerController.h"
#include "GameMenuItem.h"
 
class FString;
class SGameMenuItemWidget;
class SGameMenuPageWidget;
class UGameViewportClient;
 
class GAMEMENUBUILDER_API FGameMenuPage : public TSharedFromThis<FGameMenuPage>
{
public:
    FGameMenuPage();
    
    DECLARE_DELEGATE(FOnMenuGoBack);
 
    DECLARE_DELEGATE(FOnMenuHidden);
    
    DECLARE_DELEGATE(FOnMenuOpening);
 
    bool InitialiseRootMenu(APlayerController* InPCOwner, const FString& InStyleName, UGameViewportClient* InGameViewport);
 
    void DestroyRootMenu();
 
    /* Return the number of items in menu item list. */
    int32 NumItems() const;
 
    /* Get the specified item in the menu item list. Will assert if the value is out of range. */
    TSharedPtr<FGameMenuItem> GetItem(int32 Index) const;
    
    /* Is the supplied index with the valid range of menu items. Returns false if it is not. */
    bool IsValidMenuEntryIndex(int32 Index) const;
                
    TWeakObjectPtr<APlayerController> PCOwner;
 
    void ShowRootMenu();
 
    int32 SelectedIndex;
 
    FText MenuTitle;
 
    TSharedRef<FGameMenuItem> AddMenuItem(const FText& Text, TSharedPtr<FGameMenuPage> InSubMenu = nullptr);
 
    /*
    *
    * Add a menu item.
    *
    * @param    Text        Label of the menu item
    * @param    InObj       Menu page object
    * @param    InMethod    Method to call when selection changes.
    * @returns  SharedRef to the MenuItem that was created.
    */
    template< class UserClass >
    inline TSharedRef<FGameMenuItem> AddMenuItem(const FText& InText, UserClass* InObj, typename FGameMenuItem::FOnConfirmMenuItem::TMethodPtr< UserClass > InMethod)
    {
        TSharedPtr<FGameMenuItem> Item = MakeShareable(new FGameMenuItem(InText));
        Item->OnConfirmMenuItem.BindSP(InObj, InMethod);
        MenuItems.Add(Item);
        return Item.ToSharedRef();
    }
 
    template< class UserClass >
    inline TSharedRef<FGameMenuItem> AddMenuItemWithOptions(const FText& Text, const TArray<FText>& OptionsList, UserClass* InObj, typename FGameMenuItem::FOnOptionChanged::TMethodPtr< UserClass > InMethod)
    {
        TSharedPtr<FGameMenuItem> Item = MakeShareable(new FGameMenuItem(Text, OptionsList));
        Item->OnOptionChanged.BindSP(InObj, InMethod);
        MenuItems.Add(Item);
        return Item.ToSharedRef();
    }
 
    template< class UserClass >
    inline TSharedRef<FGameMenuItem> AddCustomMenuItem(const FText& Text, TSharedPtr<SGameMenuItemWidget> CustomWidget, UserClass* InObj, typename FGameMenuItem::FOnOptionChanged::TMethodPtr< UserClass > InMethod)
    {
        TSharedPtr<FGameMenuItem> Item = MakeShareable(new FGameMenuItem(CustomWidget));
        Item->OnOptionChanged.BindSP(InObj, InMethod);
        MenuItems.Add(Item);
        return Item.ToSharedRef();
    }
 
    template< class UserClass >
    inline void SetCancelHandler(UserClass* InObj, typename FGameMenuPage::FOnMenuGoBack::TMethodPtr< UserClass > InMethod)
    {
        OnGoBackCancel.BindSP(InObj, InMethod);
    }
    
    template< class UserClass >
    inline void SetOnHiddenHandler(UserClass* InObj, typename FGameMenuPage::FOnMenuHidden::TMethodPtr< UserClass > InMethod)
    {
        OnMenuHidden.BindSP(InObj, InMethod);
    }
 
    template< class UserClass >
    inline void SetAcceptHandler(UserClass* InObj, typename FGameMenuPage::FOnMenuGoBack::TMethodPtr< UserClass > InMethod)
    {
        OnGoBack.BindSP(InObj, InMethod);
    }
 
    template< class UserClass >
    inline void SetOnOpenHandler(UserClass* InObj, typename FGameMenuPage::FOnMenuHidden::TMethodPtr< UserClass > InMethod)
    {
        OnMenuOpening.BindSP(InObj, InMethod);
    }
 
    void LockControls(bool bLockState);
        
    TSharedPtr<SGameMenuPageWidget> RootMenuPageWidget;
 
    void MenuGoBack()
    {
        OnGoBack.ExecuteIfBound();
    }
 
    void MenuGoBackCancel()
    {
        OnGoBackCancel.ExecuteIfBound();
    }
 
    /* Called when the menu has finished hiding. */
    void MenuHidden()
    {
        OnMenuHidden.ExecuteIfBound();
    }
 
    /* Called when the menu is about to be opened. */
    void MenuOpening()
    {
        OnMenuOpening.ExecuteIfBound();
    }
 
    /* Hide the menu. */
    void HideMenu();
 
    /* Remove all the items from the item array. */
    void RemoveAllItems();
 
protected:  
    
    FOnMenuGoBack OnGoBack;
 
    FOnMenuGoBack OnGoBackCancel;
 
    FOnMenuHidden OnMenuHidden;
 
    FOnMenuOpening OnMenuOpening;
 
    /* Array of menu items that represents the menu. */
    typedef TArray< TSharedPtr<FGameMenuItem> > MenuItemList;
    MenuItemList    MenuItems;
};