#pragma once
#pragma region CPL License
/*
Nuclex Unreal Module
Copyright (C) 2014-2021 Nuclex Development Labs

This library is free software; you can redistribute it and/or
modify it under the terms of the IBM Common Public License as
published by the IBM Corporation; either version 1.0 of the
License, or (at your option) any later version.

This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
IBM Common Public License for more details.

You should have received a copy of the IBM Common Public
License along with this library
*/
#pragma endregion // CPL License

#include <CoreMinimal.h>
#include <UObject/Interface.h>

#include "ButtonControllableDialog.generated.h"

// --------------------------------------------------------------------------------------------- //

// This class does not need to be modified.
UINTERFACE(MinimalAPI, BlueprintType)
class UButtonControllableDialog : public UInterface {
  GENERATED_BODY()
};

// --------------------------------------------------------------------------------------------- //

/// Implemented by dialogs and menus that can be controlled with keyboard and gamepad
class NUCLEX_API IButtonControllableDialog {

  GENERATED_BODY()

  /// Accepts the currently selected dialog option
  public: UFUNCTION(BlueprintCallable, BlueprintNativeEvent, Category="UI")
  void Accept();

  /// Cancels the currently selected dialog
  public: UFUNCTION(BlueprintCallable, BlueprintNativeEvent, Category="UI")
  void Cancel();

  /// Selects the element above the currently selected one
  public: UFUNCTION(BlueprintCallable, BlueprintNativeEvent, Category="UI")
  void SelectUp();

  /// Selects the element below the currently selected one
  public: UFUNCTION(BlueprintCallable, BlueprintNativeEvent, Category="UI")
  void SelectDown();

  /// Selects the element left of the currently selected one
  public: UFUNCTION(BlueprintCallable, BlueprintNativeEvent, Category="UI")
  void SelectLeft();

  /// Selects the element right of the currently selected one
  public: UFUNCTION(BlueprintCallable, BlueprintNativeEvent, Category="UI")
  void SelectRight();

};

// --------------------------------------------------------------------------------------------- //