Font.h

Go to the documentation of this file.

/*--------------------------------------------------------------------------------------------
Copyright (c) 2019, NDEVR LLC
tyler.parke@ndevr.org
  __    __   ____     _____ __     __  _______
 |  \  |  | |  __ \  |  ___|\ \   / / |   __  \
 |   \ |  | | |  \ \ | |___  \ \ / /  |  |__)  |
 |  . \|  | | |__/ / | |___   \ V /   |   _   /
 |  |\    |_|_____/__|_____|___\_/____|  | \  \
 |__| \__________________________________|  \__\
 
Subject to the terms of the Enterprise+ Agreement, NDEVR hereby grants 
Licensee a limited, non-exclusive, non-transferable, royalty-free license 
(without the right to sublicense) to use the API solely for the purpose of 
Licensee's internal development efforts to develop applications for which 
the API was provided.
 
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.
 
Library: Base
File: Font
Included in API: True
Author(s): Tyler Parke
 *-----------------------------------------------------------------------------------------**/
#pragma once
#include "DLLInfo.h"
#include <NDEVR/File.h>
#include <NDEVR/RGBColor.h>
#include <NDEVR/Dictionary.h>
namespace NDEVR
{
    class UUID;
 
    /**--------------------------------------------------------------------------------------------------
    \brief Information for how to display text data.
 
    **/
    struct Font
    {
        String name;
        String app_font_name;
        fltp08 point_size = 0.0;
        fltp08 pixel_size = Constant<fltp08>::Invalid;
        fltp08 fixed_width = Constant<fltp08>::Invalid;
        fltp08 tab_advance = 0.0;
        uint04 index = 0;
        RGBColor color = Constant<RGBColor>::Invalid;
        uint01 alignment = 0;
        bool is_bold = false;
        bool is_italic = false;
        bool is_underline = false;
        bool is_overstrike = false;
        bool is_strikethrough = false;
        NDEVR_BASE_API bool operator==(const Font& font) const;
        NDEVR_BASE_API bool operator!=(const Font& font) const;
        NDEVR_BASE_API File getFile() const;
        void setFile(const File& file) { m_file = file; }
    protected:
        mutable File m_file;
    };
 
    /**--------------------------------------------------------------------------------------------------
    \brief Stores many different types of font
 
    **/
    class FontEngine
    {
    public:
        static constexpr char DefaultFont[8] = "Default";
        NDEVR_BASE_API static void SetApplicationFont(const String& app_font, const Font& font);
        NDEVR_BASE_API static const Font& ApplicationFont(const String& app_font);
        NDEVR_BASE_API static bool HasApplicationFont(const String& app_font);
        NDEVR_BASE_API static File FindBestFitFontFile(const Font& font);
        NDEVR_BASE_API static void PullFontFromFolder(const File& folder);
        NDEVR_BASE_API static bool HasFontFile(const String& font_name);
        NDEVR_BASE_API static void SetFontFile(const String& font_name, const File& file, uint04 index = 0); 
        NDEVR_BASE_API static void SetSettingsFile(const File& file);
        NDEVR_BASE_API static void SaveFontSettings();
        NDEVR_BASE_API static void ReadFontSettings();
        NDEVR_BASE_API static void AddFontListener(const String& app_font, UUID id, std::function<void(const String&)> callback);
        NDEVR_BASE_API static void RemoveFontListener(const String& app_font, UUID id);
    protected:
        NDEVR_BASE_API static File TryFontName(const String& family);
    protected:
        NDEVR_BASE_API static Dictionary<String, Font> s_system_fonts;
        NDEVR_BASE_API static Dictionary<String, Font> s_application_fonts;
        NDEVR_BASE_API static Dictionary<String, String> s_font_files;
        NDEVR_BASE_API static Dictionary<String, uint04> s_font_indices;
        NDEVR_BASE_API static Dictionary<String, Dictionary<UUID, std::function<void(const String&)>>> s_app_font_listener;
        NDEVR_BASE_API static File s_settings_file;
    };
    /**--------------------------------------------------------------------------------------------------
    \brief text that is formatted the same way, typically part of a bigger group of text
 
    **/
    struct TextBlock
    {
        String text;
        Font font;
        bool operator==(const TextBlock& block) const
        {
            return text == block.text && font == block.font;
        }
        bool operator!=(const TextBlock& block) const
        {
            return text != block.text || font != block.font;
        }
    };
 
    /**--------------------------------------------------------------------------------------------------
    \brief How to align text into a given container
 
    **/
    enum class TextAlignment
    {
          e_left = 0x01
        , e_right = 0x02
        , e_top = 0x04
        , e_bottom = 0x08
        , e_bottom_base = 0x10
        , e_h_center = e_left | e_right
        , e_v_center = e_top | e_bottom
        , e_v_baseline_center = e_top | e_bottom_base
        , e_center = e_v_center | e_h_center
    };
    inline uint01 operator|(const TextAlignment& a, const TextAlignment& b)
    {
        return cast<uint01>(a) | cast<uint01>(b);
    }
}