otclient/src/framework/ui/uicontainer.cpp

/* The MIT License
 *
 * Copyright (c) 2010 OTClient, https://github.com/edubart/otclient
 *
 * 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.
 */


#include <prerequisites.h>
#include <core/resources.h>
#include <ui/uicontainer.h>
#include <core/dispatcher.h>

UIContainerPtr rootContainer(new UIContainer);

UIContainerPtr& UIContainer::getRootContainer()
{
    return rootContainer;
}

void UIContainer::addChild(UIElementPtr child)
{
    m_children.push_back(child);
    child->setParent(asUIContainer());
}

void UIContainer::removeChild(UIElementPtr child)
{
    // first check if its really a child
    bool removed = false;
    for(auto it = m_children.begin(); it != m_children.end(); ++it) {
        if((*it) == child) {
            removed = true;
            m_children.erase(it);
            break;
        }
    }
    assert(removed);

    if(m_focusedElement == child)
        setFocusedElement(UIElementPtr());

    // child must have this container as parent
    assert(child->getParent() == asUIContainer());
    child->setParent(UIContainerPtr());
}

UIElementPtr UIContainer::getChildById(const std::string& id)
{
    if(getId() == id)
        return asUIElement();
    for(auto it = m_children.begin(); it != m_children.end(); ++it) {
        if((*it)->getId() == id)
            return (*it);
    }
    return UIElementPtr();
}

UIElementPtr UIContainer::getChildByPos(const Point& pos)
{
    for(auto it = m_children.rbegin(); it != m_children.rend(); ++it) {
        if((*it)->getRect().contains(pos))
            return (*it);
    }
    return UIElementPtr();
}

UIElementPtr UIContainer::recursiveGetChildById(const std::string& id)
{
    if(getId() == id)
        return asUIElement();

    UIElementPtr element;
    for(auto it = m_children.begin(); it != m_children.end(); ++it) {
        element = (*it);
        if(element->getId() == id) {
            return element;
        } else {
            UIContainerPtr container = element->asUIContainer();
            if(container) {
                element = container->recursiveGetChildById(id);
                if(element)
                    return element;
            }
        }
    }
    return UIElementPtr();
}

void UIContainer::pushChildToTop(const UIElementPtr& child)
{
    bool removed = false;
    for(auto it = m_children.begin(); it != m_children.end(); ++it) {
        if((*it) == child) {
            removed = true;
            m_children.erase(it);
            break;
        }
    }
    if(removed) {
        m_children.push_back(child);
    }
}

void UIContainer::render()
{
    UIElement::render();
    for(auto it = m_children.begin(); it != m_children.end(); ++it) {
        const UIElementPtr& child = (*it);
        if(child->isVisible())
            child->render();
    }
}

void UIContainer::onInputEvent(const InputEvent& event)
{
    UIElementPtr focusedElement = m_focusedElement;
    for(auto it = m_children.begin(); it != m_children.end(); ++it) {
        const UIElementPtr& child = (*it);
        bool shouldFire = false;

        // events should pass only when element is visible and enabled
        if(child->isEnabled() && child->isVisible()) {
            if(event.type & EV_KEYBOARD) {
                // keyboard events only go to focused elements or containers
                if(child->asUIContainer() || child == focusedElement) {
                    shouldFire = true;
                }
            // mouse events
            } else if(event.type & EV_MOUSE) {
                // mouse down and wheel events only go to elements that contains the mouse position
                if(event.type & EV_DOWN || event.type & EV_MOUSE_WHEEL) {
                    // the child must contains the mouse position and be on top
                    if(child->getRect().contains(event.mousePos) && child == getChildByPos(event.mousePos)) {
                        // focus it
                        if(event.type == EV_MOUSE_LDOWN && child->isFocusable())
                            setFocusedElement(child);
                        shouldFire = true;
                    }
                } else {
                    shouldFire = true;
                }
            }
        }

        if(shouldFire)
            child->onInputEvent(event);
    }
}

void UIContainer::focusNextElement()
{
    UIElementPtr element;
    auto focusedIt = std::find(m_children.begin(), m_children.end(), m_focusedElement);
    if(focusedIt != m_children.end()) {
        for(auto it = ++focusedIt; it != m_children.end(); ++it) {
            const UIElementPtr& child = (*it);
            if(child->isFocusable()) {
                element = child;
                break;
            }
        }
    }
    if(!element) {
        for(auto it = m_children.begin(); it != m_children.end(); ++it) {
            const UIElementPtr& child = (*it);
            if(child->isFocusable()) {
                element = child;
                break;
            }
        }
    }
    if(element)
        setFocusedElement(element);
}

void UIContainer::setFocusedElement(UIElementPtr focusedElement)
{
    if(focusedElement != m_focusedElement) {
        if(m_focusedElement) {
            m_focusedElement->setFocused(false);
            m_focusedElement->onFocusChange();
        }

        m_focusedElement = focusedElement;
        if(m_focusedElement) {
            m_focusedElement->setFocused(true);
            m_focusedElement->onFocusChange();
        }
    }

    // when containers are focused they go to the top
    if(focusedElement && focusedElement->asUIContainer()) {
        g_dispatcher.addTask(boost::bind(&UIContainer::pushChildToTop, asUIContainer(), m_focusedElement));
    }
}

bool UIContainer::lockElement(UIElementPtr element)
{
    bool found = false;
    for(auto it = m_children.begin(); it != m_children.end(); ++it) {
        if((*it) == element) {
            (*it)->setEnabled(true);
            found = true;
            break;
        }
    }

    if(found) {
        for(auto it = m_children.begin(); it != m_children.end(); ++it) {
            if((*it) != element)
                (*it)->setEnabled(false);
        }
        return true;
    }
    return false;
}

void UIContainer::unlockElement()
{
    for(auto it = m_children.begin(); it != m_children.end(); ++it) {
        (*it)->setEnabled(true);
    }
}