Widget.h

/*
 * Gamedev Framework (gf)
 * Copyright (C) 2016-2021 Julien Bernard
 * Copyright (C) 2018 Lilian Franchi
 *
 * This software is provided 'as-is', without any express or implied
 * warranty.  In no event will the authors be held liable for any damages
 * arising from the use of this software.
 *
 * Permission is granted to anyone to use this software for any purpose,
 * including commercial applications, and to alter it and redistribute it
 * freely, subject to the following restrictions:
 *
 * 1. The origin of this software must not be misrepresented; you must not
 *    claim that you wrote the original software. If you use this software
 *    in a product, an acknowledgment in the product documentation would be
 *    appreciated but is not required.
 * 2. Altered source versions must be plainly marked as such, and must not be
 *    misrepresented as being the original software.
 * 3. This notice may not be removed or altered from any source distribution.
 */
#ifndef GF_WIDGET_H
#define GF_WIDGET_H

#include <functional>

#include "GraphicsApi.h"
#include "Transformable.h"
#include "Vector.h"

namespace gf {
#ifndef DOXYGEN_SHOULD_SKIP_THIS
inline namespace v1 {
#endif

  struct RenderStates;
  class RenderTarget;

  enum class WidgetState {
    Disabled, 
    Default,  
    Selected, 
  };

  class GF_GRAPHICS_API Widget : public Transformable {
  public:
    Widget();

    virtual bool contains(Vector2f coords) = 0;

    void setDisabled();

    bool isDisabled() const noexcept {
      return m_state == WidgetState::Disabled;
    }

    void setDefault();

    bool isDefault() const noexcept {
      return m_state == WidgetState::Default;
    }

    void setSelected();

    bool isSelected() const {
      return m_state == WidgetState::Selected;
    }

    void setState(WidgetState state);

    WidgetState getState() const noexcept {
      return m_state;
    }

    void setCallback(std::function<void()> callback);

    void triggerCallback();

  protected:
    virtual void onStateChanged();

    virtual void triggered();

  private:
    WidgetState m_state;
    std::function<void()> m_callback;
  };

#ifndef DOXYGEN_SHOULD_SKIP_THIS
}
#endif
}

#endif // GF_WIDGET_H