cheats-updater/lib/borealis/library/include/borealis/box_layout.hpp

/*
    Borealis, a Nintendo Switch UI Library
    Copyright (C) 2019  natinusala
    Copyright (C) 2019  WerWolv
    Copyright (C) 2019  p-sam

    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    This program 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
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program.  If not, see <https://www.gnu.org/licenses/>.
*/

#pragma once

#include <borealis/view.hpp>
#include <vector>

namespace brls
{

enum class BoxLayoutOrientation
{
    VERTICAL,
    HORIZONTAL
};

// TODO: Implement all gravity options for both orientations
enum class BoxLayoutGravity
{
    DEFAULT, // left for horizontal, top for vertical
    LEFT,
    RIGHT,
    TOP,
    BOTTOM,
    CENTER
};

class BoxLayoutChild
{
  public:
    View* view;
    bool fill; // should the child fill the remaining space?
};

// A basic horizontal or vertical box layout :
// - Children can currently only be stretched to full width (vertical) or height (horizontal)
// - Only works with children with fixed width (horizontal) or height (vertical)

// TODO: More complex alignment and/or stretching parameters to children
class BoxLayout : public View
{
  private:
    BoxLayoutOrientation orientation;

    unsigned spacing = 0;

    bool resize = false; // should the view be resized according to children size after a layout?

    BoxLayoutGravity gravity = BoxLayoutGravity::DEFAULT;

  protected:
    std::vector<BoxLayoutChild*> children;

    size_t originalDefaultFocus = 0;
    size_t defaultFocusedIndex  = 0;
    bool childFocused           = false;

    bool rememberFocus = false;

    unsigned marginTop    = 0;
    unsigned marginRight  = 0;
    unsigned marginBottom = 0;
    unsigned marginLeft   = 0;

    /**
      * Should the BoxLayout apply spacing after
      * this view?
      */
    virtual void customSpacing(View* current, View* next, int* spacing) { }

  public:
    BoxLayout(BoxLayoutOrientation orientation, size_t defaultFocus = 0);
    ~BoxLayout();

    void layout(NVGcontext* vg, Style* style, FontStash* stash) override;
    void draw(NVGcontext* vg, int x, int y, unsigned width, unsigned height, Style* style, FrameContext* ctx) override;
    View* getNextFocus(FocusDirection direction, View* currentView) override;
    View* getDefaultFocus() override;
    void onChildFocusGained(View* child) override;
    void onChildFocusLost(View* child) override;
    void willAppear(bool resetState = false) override;
    void willDisappear(bool resetState = false) override;
    void onWindowSizeChanged() override;

    /**
     * Sets gravity
     */
    void setGravity(BoxLayoutGravity gravity);

    /**
      * Sets spacing between views
      */
    void setSpacing(unsigned spacing);
    unsigned getSpacing();

    /**
      * Sets margins around views
      * Bottom (vertical) or right (horizontal) are
      * only effective if the last child is set to fill
      */
    void setMargins(unsigned top, unsigned right, unsigned bottom, unsigned left);
    void setMarginBottom(unsigned bottom);

    /**
      * Adds a view to this box layout
      * If fill is set to true, the child will
      * fill the remaining space
      */
    void addView(View* view, bool fill = false, bool resetState = false);

    /**
      * Removes the view at specified
      * The view will be freed if free
      * is set to true (defaults to true)
      *
      * Warning: this method isn't correctly
      * implemented - currently removing a view will
      * most likely result in memory corruption
      */
    void removeView(int index, bool free = true);

    /**
     * Removes all views
     * from this layout
     */
    void clear(bool free = true);

    /**
      * Returns true if this layout
      * doesn't contain any views
      */
    bool isEmpty();

    bool isChildFocused();

    void setFocusedIndex(unsigned index);
    size_t getViewsCount();

    View* getChild(size_t i);

    /**
     * If enabled, will force the layout to resize itself
     * to match the children size
     * Mandatory for using in a ScrollView
     */
    void setResize(bool resize);

    /**
     * Should the default focus be set to the originally focused
     * view (until the layout disappears)?
     */
    void setRememberFocus(bool rememberFocus);
};

} // namespace brls