//////////////////////////////////////////////////////////////////////////////
//
// Copyright (c) 2004-2021 musikcube team
//
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
//    * Redistributions of source code must retain the above copyright notice,
//      this list of conditions and the following disclaimer.
//
//    * Redistributions in binary form must reproduce the above copyright
//      notice, this list of conditions and the following disclaimer in the
//      documentation and/or other materials provided with the distribution.
//
//    * Neither the name of the author nor the names of other contributors may
//      be used to endorse or promote products derived from this software
//      without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
// POSSIBILITY OF SUCH DAMAGE.
//
//////////////////////////////////////////////////////////////////////////////

#pragma once

#include <cursespp/IWindowGroup.h>
#include <cursespp/IDisplayable.h>
#include <cursespp/IKeyHandler.h>
#include <cursespp/IMouseHandler.h>
#include <memory>

namespace cursespp {
    class ILayout:
        public IWindowGroup,
        public IKeyHandler,
        public IMouseHandler,
        public IOrderable,
        public IDisplayable
    {
        public:
            enum FocusMode {
                FocusModeCircular = 0,
                FocusModeTerminating = 1
            };

            virtual ~ILayout() { }
            virtual IWindowPtr FocusFirst() = 0;
            virtual IWindowPtr FocusLast() = 0;
            virtual IWindowPtr FocusNext() = 0;
            virtual IWindowPtr FocusPrev() = 0;

            virtual IWindowPtr GetFocus() = 0;
            virtual int GetFocusIndex() = 0;

            virtual bool SetFocus(IWindowPtr window) = 0;
            virtual void SetFocusIndex(int index, bool applyFocus = true) = 0;

            virtual int GetFocusableCount() = 0;
            virtual IWindowPtr GetFocusableAt(int index) = 0;

            virtual FocusMode GetFocusMode() const = 0;
            virtual void SetFocusMode(FocusMode mode) = 0;

            virtual void Layout() = 0;
    };

    typedef std::shared_ptr<ILayout> ILayoutPtr;
}
