examples/common/screen-framework/include/Screen.h

/*
 *
 *    Copyright (c) 2020 Project CHIP Authors
 *    All rights reserved.
 *
 *    Licensed under the Apache License, Version 2.0 (the "License");
 *    you may not use this file except in compliance with the License.
 *    You may obtain a copy of the License at
 *
 *        http://www.apache.org/licenses/LICENSE-2.0
 *
 *    Unless required by applicable law or agreed to in writing, software
 *    distributed under the License is distributed on an "AS IS" BASIS,
 *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *    See the License for the specific language governing permissions and
 *    limitations under the License.
 */

/**
 * @file Screen.h
 *
 * Simple screen.
 *
 */

#pragma once

#include "Display.h"

#if CONFIG_HAVE_DISPLAY

#include "ScreenManager.h"

#include <string>

class Screen
{
public:
    enum FocusType
    {
        NONE,
        BLUR,
        UNBLUR,
        NEXT,
        PREVIOUS
    };

    virtual ~Screen() = default;

    virtual std::string GetTitle() { return "Untitled"; }

    virtual std::string GetButtonText(int id);

    virtual void Display() {}

    virtual void Enter(bool pushed) {}

    virtual void Exit(bool popped) {}

    virtual bool IsFocusable() { return false; }

    virtual void Focus(FocusType focus) {}

    virtual void Action() {}
};

#endif // CONFIG_HAVE_DISPLAY