label.hpp

Go to the documentation of this file.

// label.hpp
/*
  neogfx C++ App/Game Engine
  Copyright (c) 2015, 2020 Leigh Johnston.  All Rights Reserved.
  
  This program is free software: you can redistribute it and / or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation, either version 3 of the License, or
  (at your option) any later version.
  
  This program is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.
  
  You should have received a copy of the GNU General Public License
  along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/
 
#pragma once
 
#include <neogfx/neogfx.hpp>
#include <neolib/core/i_enum.hpp>
#include <neogfx/gui/layout/grid_layout.hpp>
#include <neogfx/gui/widget/text_widget.hpp>
#include <neogfx/gui/widget/image_widget.hpp>
 
namespace neogfx
{
    class i_spacer;
 
    enum class label_placement : uint32_t
    {
        Text                        = 0x00000001,
        Image                       = 0x00000002,
        Spacer                      = 0x00000004,
        Horizontal                  = 0x00000010,
        Vertical                    = 0x00000020,
        TextBeforeImage             = Text | Image | 0x00000100,
        ImageBeforeText             = Text | Image | 0x00000200,
        TextHorizontal              = Text | Horizontal,
        TextVertical                = Text | Vertical,
        ImageHorizontal             = Image | Horizontal,
        ImageVertical               = Image | Vertical,
        TextImageHorizontal         = TextBeforeImage | Horizontal,
        TextImageVertical           = TextBeforeImage | Vertical,
        ImageTextHorizontal         = ImageBeforeText | Horizontal,
        ImageTextVertical           = ImageBeforeText | Vertical,
        TextSpacerImageHorizontal   = TextBeforeImage | Spacer | Horizontal,
        TextSpacerImageVertical     = TextBeforeImage | Spacer | Vertical,
        ImageSpacerTextHorizontal   = ImageBeforeText | Spacer | Horizontal,
        ImageSpacerTextVertical     = ImageBeforeText | Spacer | Vertical
    };
 
    inline constexpr label_placement operator|(label_placement aLhs, label_placement aRhs)
    {
        return static_cast<label_placement>(static_cast<uint32_t>(aLhs) | static_cast<uint32_t>(aRhs));
    }
 
    inline constexpr label_placement operator&(label_placement aLhs, label_placement aRhs)
    {
        return static_cast<label_placement>(static_cast<uint32_t>(aLhs) & static_cast<uint32_t>(aRhs));
    }
}
 
begin_declare_enum(neogfx::label_placement)
declare_enum_string(neogfx::label_placement, TextHorizontal)
declare_enum_string(neogfx::label_placement, TextVertical)
declare_enum_string(neogfx::label_placement, ImageHorizontal)
declare_enum_string(neogfx::label_placement, ImageVertical)
declare_enum_string(neogfx::label_placement, TextImageHorizontal)
declare_enum_string(neogfx::label_placement, TextImageVertical)
declare_enum_string(neogfx::label_placement, ImageTextHorizontal)
declare_enum_string(neogfx::label_placement, ImageTextVertical)
declare_enum_string(neogfx::label_placement, TextSpacerImageHorizontal)
declare_enum_string(neogfx::label_placement, TextSpacerImageVertical)
declare_enum_string(neogfx::label_placement, ImageSpacerTextHorizontal)
declare_enum_string(neogfx::label_placement, ImageSpacerTextVertical)
end_declare_enum(neogfx::label_placement)
 
namespace neogfx
{
    typedef text_widget_type label_type;
 
    class label : public widget<>
    {
        meta_object(widget<>)
    public:
        struct no_center_spacer : std::logic_error { no_center_spacer() : std::logic_error("neogfx::label::no_center_spacer") {} };
        struct no_buddy : std::logic_error { no_buddy() : std::logic_error("neogfx::label::no_buddy") {} };
    public:
        label(label_type aType = label_type::MultiLine, neogfx::alignment aAlignment = neogfx::alignment::Left | neogfx::alignment::VCenter, label_placement aPlacement = label_placement::ImageTextHorizontal);
        label(std::string const& aText, label_type aType = label_type::MultiLine, neogfx::alignment aAlignment = neogfx::alignment::Left | neogfx::alignment::VCenter, label_placement aPlacement = label_placement::ImageTextHorizontal);
        label(const i_texture& aTexture, label_type aType = label_type::MultiLine, neogfx::alignment aAlignment = neogfx::alignment::Left | neogfx::alignment::VCenter, label_placement aPlacement = label_placement::ImageTextHorizontal);
        label(const i_image& aImage, label_type aType = label_type::MultiLine, neogfx::alignment aAlignment = neogfx::alignment::Left | neogfx::alignment::VCenter, label_placement aPlacement = label_placement::ImageTextHorizontal);
        label(std::string const& aText, const i_texture& aTexture, label_type aType = label_type::MultiLine, neogfx::alignment aAlignment = neogfx::alignment::Left | neogfx::alignment::VCenter, label_placement aPlacement = label_placement::ImageTextHorizontal);
        label(std::string const& aText, const i_image& aImage, label_type aType = label_type::MultiLine, neogfx::alignment aAlignment = neogfx::alignment::Left | neogfx::alignment::VCenter, label_placement aPlacement = label_placement::ImageTextHorizontal);
        label(i_widget& aParent, label_type aType = label_type::MultiLine, neogfx::alignment aAlignment = neogfx::alignment::Left | neogfx::alignment::VCenter, label_placement aPlacement = label_placement::ImageTextHorizontal);
        label(i_widget& aParent, std::string const& aText, label_type aType = label_type::MultiLine, neogfx::alignment aAlignment = neogfx::alignment::Left | neogfx::alignment::VCenter, label_placement aPlacement = label_placement::ImageTextHorizontal);
        label(i_widget& aParent, const i_texture& aTexture, label_type aType = label_type::MultiLine, neogfx::alignment aAlignment = neogfx::alignment::Left | neogfx::alignment::VCenter, label_placement aPlacement = label_placement::ImageTextHorizontal);
        label(i_widget& aParent, const i_image& aImage, label_type aType = label_type::MultiLine, neogfx::alignment aAlignment = neogfx::alignment::Left | neogfx::alignment::VCenter, label_placement aPlacement = label_placement::ImageTextHorizontal);
        label(i_widget& aParent, std::string const& aText, const i_texture& aTexture, label_type aType = label_type::MultiLine, neogfx::alignment aAlignment = neogfx::alignment::Left | neogfx::alignment::VCenter, label_placement aPlacement = label_placement::ImageTextHorizontal);
        label(i_widget& aParent, std::string const& aText, const i_image& aImage, label_type aType = label_type::MultiLine, neogfx::alignment aAlignment = neogfx::alignment::Left | neogfx::alignment::VCenter, label_placement aPlacement = label_placement::ImageTextHorizontal);
        label(i_layout& aLayout, label_type aType = label_type::MultiLine, neogfx::alignment aAlignment = neogfx::alignment::Left | neogfx::alignment::VCenter, label_placement aPlacement = label_placement::ImageTextHorizontal);
        label(i_layout& aLayout, std::string const& aText, label_type aType = label_type::MultiLine, neogfx::alignment aAlignment = neogfx::alignment::Left | neogfx::alignment::VCenter, label_placement aPlacement = label_placement::ImageTextHorizontal);
        label(i_layout& aLayout, const i_texture& aTexture, label_type aType = label_type::MultiLine, neogfx::alignment aAlignment = neogfx::alignment::Left | neogfx::alignment::VCenter, label_placement aPlacement = label_placement::ImageTextHorizontal);
        label(i_layout& aLayout, const i_image& aImage, label_type aType = label_type::MultiLine, neogfx::alignment aAlignment = neogfx::alignment::Left | neogfx::alignment::VCenter, label_placement aPlacement = label_placement::ImageTextHorizontal);
        label(i_layout& aLayout, std::string const& aText, const i_texture& aTexture, label_type aType = label_type::MultiLine, neogfx::alignment aAlignment = neogfx::alignment::Left | neogfx::alignment::VCenter, label_placement aPlacement = label_placement::ImageTextHorizontal);
        label(i_layout& aLayout, std::string const& aText, const i_image& aImage, label_type aType = label_type::MultiLine, neogfx::alignment aAlignment = neogfx::alignment::Left | neogfx::alignment::VCenter, label_placement aPlacement = label_placement::ImageTextHorizontal);
        ~label();
    public:
        const grid_layout& layout() const override;
        grid_layout& layout() override;
    public:
        neogfx::size_policy size_policy() const override;
    public:
        void set_font_role(const optional_font_role& aFontRole) override;
        void set_font(optional_font const& aFont) override;
    public:
        neogfx::alignment alignment() const;
        void set_alignment(neogfx::alignment aAlignment);
    public:
        i_string const& text() const;
        void set_text(i_string const& aText);
        const texture& image() const;
        void set_image(i_string const& aImageUri);
        void set_image(const neogfx::image& aImage);
        void set_image(const texture& aImage);
        label_placement placement() const;
        void set_placement(label_placement aPlacement);
        label_placement effective_placement() const;
        const neogfx::text_widget& text_widget() const;
        neogfx::text_widget& text_widget();
        const neogfx::image_widget& image_widget() const;
        neogfx::image_widget& image_widget();
        const i_spacer& center_spacer() const;
        i_spacer& center_spacer();
        bool has_buddy() const;
        i_widget& buddy() const;
        void set_buddy(i_widget& aBuddy);
        void set_buddy(std::shared_ptr<i_widget> aBuddy);
        void unset_buddy();
    private:
        void init();
        void handle_placement_change();
    private:
        sink iSink;
        neogfx::alignment iAlignment;
        label_placement iPlacement;
        grid_layout iLayout;
        size_policy_of_parent<neogfx::text_widget, layout_item_category::Widget> iText;
        size_policy_of_parent<neogfx::image_widget, layout_item_category::Widget> iImage;
        i_spacer* iCenterSpacer;
        std::shared_ptr<i_widget> iBuddy;
    };
}