AtomicGameEngine/Source/Atomic/UI/UILayout.h

//
// Copyright (c) 2014-2015, THUNDERBEAST GAMES LLC All rights reserved
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
//

#pragma once

#include <ThirdParty/TurboBadger/tb_layout.h>

#include "UIWidget.h"

namespace Atomic
{

/// Specifies which height widgets in a AXIS_X layout should have,
///    or which width widgets in a AXIS_Y layout should have.
///    No matter what, it will still prioritize minimum and maximum for each widget.
enum UI_LAYOUT_SIZE
{
    /// Sizes depend on the gravity for each widget. (If the widget pulls
    /// towards both directions, it should grow to all available space)
    UI_LAYOUT_SIZE_GRAVITY = 0, // tb::LAYOUT_SIZE_GRAVITY,

    /// Size will be the preferred so each widget may be sized differently.
    UI_LAYOUT_SIZE_PREFERRED = 1, // tb::LAYOUT_SIZE_PREFERRED,

    /// Size should grow to all available space
    UI_LAYOUT_SIZE_AVAILABLE = 2 // tb::LAYOUT_SIZE_AVAILABLE
};

/// Specifies which width widgets in a AXIS_X layout should have,
///    or which height widgets in a AXIS_Y layout should have. */
///
enum UI_LAYOUT_DISTRIBUTION
{
    ///< Size will be the preferred so each widget may be sized differently.
    UI_LAYOUT_DISTRIBUTION_PREFERRED = 0, // tb::LAYOUT_DISTRIBUTION_PREFERRED,
    ///< Size should grow to all available space
    UI_LAYOUT_DISTRIBUTION_AVAILABLE = 1, // tb::LAYOUT_DISTRIBUTION_AVAILABLE,
    ///< Sizes depend on the gravity for each widget. (If the widget pulls
    /// ///< towards both directions, it should grow to all available space)
    UI_LAYOUT_DISTRIBUTION_GRAVITY = 2 // tb::LAYOUT_DISTRIBUTION_GRAVITY
};

/// Specifies which y position widgets in a AXIS_X layout should have,
///    or which x position widgets in a AXIS_Y layout should have. */
enum UI_LAYOUT_POSITION
{
    ///< Position is centered
    UI_LAYOUT_POSITION_CENTER = 0, // tb::LAYOUT_POSITION_CENTER,
    ///< Position is to the left for AXIS_Y layout and top for AXIS_X layout.
    UI_LAYOUT_POSITION_LEFT_TOP = 1, // tb::LAYOUT_POSITION_LEFT_TOP,
    ///< Position is to the right for AXIS_Y layout and bottom for AXIS_X layout.
    UI_LAYOUT_POSITION_RIGHT_BOTTOM = 2, // tb::LAYOUT_POSITION_RIGHT_BOTTOM,
    ///< Position depend on the gravity for each widget. (If the widget pulls
    /// ///< towards both directions, it will be centered)
    UI_LAYOUT_POSITION_GRAVITY = 3 // tb::LAYOUT_POSITION_GRAVITY
};

/** Specifies how widgets should be moved horizontally in a AXIS_X
    layout (or vertically in a AXIS_Y layout) if there is extra space
    available. */
enum UI_LAYOUT_DISTRIBUTION_POSITION
{
    UI_LAYOUT_DISTRIBUTION_POSITION_CENTER = 0, // tb::LAYOUT_DISTRIBUTION_POSITION_CENTER,
    UI_LAYOUT_DISTRIBUTION_POSITION_LEFT_TOP = 1, // tb::LAYOUT_DISTRIBUTION_POSITION_LEFT_TOP,
    UI_LAYOUT_DISTRIBUTION_POSITION_RIGHT_BOTTOM = 2 //tb::LAYOUT_DISTRIBUTION_POSITION_RIGHT_BOTTOM
};



class ATOMIC_API UILayoutParams : public Object
{
    ATOMIC_OBJECT(UILayoutParams, Object)

public:

    UILayoutParams(Context* context);
    virtual ~UILayoutParams();

    void SetWidth(int width) { params_.SetWidth(width); }
    void SetHeight(int height) { params_.SetHeight(height); }

    void SetMinWidth(int width) { params_.min_w = width; }
    void SetMinHeight(int height) { params_.min_h = height; }

    void SetMaxWidth(int width) { params_.max_w = width; }
    void SetMaxHeight(int height) { params_.max_h = height; }

    tb::LayoutParams* GetTBLayoutParams() { return &params_; }

private:

    tb::LayoutParams params_;

};


class ATOMIC_API UILayout : public UIWidget
{
    ATOMIC_OBJECT(UILayout, UIWidget)

public:

    UILayout(Context* context, UI_AXIS axis = UI_AXIS_X, bool createWidget = true);
    virtual ~UILayout();

    void SetSpacing(int spacing);

    void SetAxis(UI_AXIS axis);
    void SetLayoutSize(UI_LAYOUT_SIZE size);
    void SetLayoutPosition(UI_LAYOUT_POSITION position);
    void SetLayoutDistribution(UI_LAYOUT_DISTRIBUTION distribution);
    void SetLayoutDistributionPosition(UI_LAYOUT_DISTRIBUTION_POSITION distribution_pos);

    /// A different way of setting up a layout, using a series of characters to program the main 5 layout fields
    /// character [0] = 'X' or 'Y'  for UI_AXIS = X(D), Y
    /// character [1] = 'A'|'G'|'P' for UI_LAYOUT_SIZE = Available, Gravity(D), Perferred
    /// character [2] = 'C'|'G'|'L'|'R'  for UI_LAYOUT_POSITION = Center(D), Gravity, LeftTop, RightBottom
    /// character [3] = 'A'|'G'|'P'  for UI_LAYOUT_DISTRIBUTION = Available, Gravity, Perferred(D)
    /// character [4] = 'C'|'L'|'R'  for UI_LAYOUT_DISTRIBUTION_POSITION, Center(D), LeftTop, RightBottom
    /// A '-' character in any field will not program that entry.
    /// Any character used that is not an allowed characters or a '-' will result in the default setting to be used.
    /// Any text in the string above character 5 is ignored.
    /// If the input string is less than 5 characters it will not program any of the fields.
    void SetLayoutConfig ( const String &settings );

protected:

    virtual bool OnEvent(const tb::TBWidgetEvent &ev);

private:

};

}