Panel.hpp

Go to the documentation of this file.

/*
 * This file is part of the DUDS project. It is subject to the BSD-style
 * license terms in the LICENSE file found in the top-level directory of this
 * distribution and at https://github.com/jjackowski/duds/blob/master/LICENSE.
 * No part of DUDS, including this file, may be copied, modified, propagated,
 * or distributed except according to the terms contained in the LICENSE file.
 *
 * Copyright (C) 2020  Jeff Jackowski
 */
#ifndef PANEL_HPP
#define PANEL_HPP

#include <duds/ui/graphics/BppImage.hpp>

namespace duds { namespace ui { namespace graphics {

class PriorityGridLayout;

struct PanelMargins {
    std::uint16_t l;
    std::uint16_t r;
    std::uint16_t t;
    std::uint16_t b;
};

class Panel {
public:
    virtual void added(PriorityGridLayout *pgl, unsigned int pri);
    virtual void removing(PriorityGridLayout *pgl, unsigned int pri);
    virtual const BppImage *render(
        ImageLocation &offset,
        ImageDimensions &dim,
        PanelMargins &margin,
        int sizeStep
    ) = 0;
};

typedef std::shared_ptr<Panel>  PanelSptr;

class EmptyPanel : public Panel {
    struct Token { };
public:
    EmptyPanel(Token) { }
    static std::shared_ptr<EmptyPanel> make() {
        return std::make_shared<EmptyPanel>(Token());
    }
    virtual const BppImage *render(
        ImageLocation &,
        ImageDimensions &,
        PanelMargins &,
        int
    );
};



/*
 * A Panel that provides an image based on the size-step selected by the
 * layout.
 * @todo  Implement.
 * /
class SteppedImagePanel : public Panel {
protected:
    std::vector<ConstBppImageSptr> images;
public:
    virtual const BppImage *render(
        ImageLocation &,
        ImageDimensions &,
        PanelMargins &,
        int sizeStep
    ) {
        return images[sizeStep];
    }
};
*/

} } }

#endif        //  #ifndef PANEL_HPP