GUILabel.h

Go to the documentation of this file.

/*
 *  Copyright (C) 2005-2018 Team Kodi
 *  This file is part of Kodi - https://kodi.tv
 *
 *  SPDX-License-Identifier: GPL-2.0-or-later
 *  See LICENSES/README.md for more information.
 */

#pragma once

#include "GUIFont.h"
#include "GUITextLayout.h"
#include "guiinfo/GUIInfoColor.h"
#include "utils/ColorUtils.h"
#include "utils/Geometry.h"

class CLabelInfo
{
public:
  CLabelInfo():
    scrollSuffix(" | ")
  {
    font = NULL;
    align = XBFONT_LEFT;
    offsetX = offsetY = 0;
    width = 0;
    angle = 0;
    scrollSpeed = CScrollInfo::defaultSpeed;
  };
  bool UpdateColors()
  {
    bool changed = false;

    changed |= textColor.Update();
    changed |= shadowColor.Update();
    changed |= selectedColor.Update();
    changed |= disabledColor.Update();
    changed |= focusedColor.Update();
    changed |= invalidColor.Update();

    return changed;
  };

  KODI::GUILIB::GUIINFO::CGUIInfoColor textColor;
  KODI::GUILIB::GUIINFO::CGUIInfoColor shadowColor;
  KODI::GUILIB::GUIINFO::CGUIInfoColor selectedColor;
  KODI::GUILIB::GUIINFO::CGUIInfoColor disabledColor;
  KODI::GUILIB::GUIINFO::CGUIInfoColor focusedColor;
  KODI::GUILIB::GUIINFO::CGUIInfoColor invalidColor;
  uint32_t align;
  float offsetX;
  float offsetY;
  float width;
  float angle;
  CGUIFont *font;
  int scrollSpeed;
  std::string scrollSuffix;
};

class CGUILabel
{
public:
  enum COLOR { COLOR_TEXT = 0,
               COLOR_SELECTED,
               COLOR_FOCUSED,
               COLOR_DISABLED,
               COLOR_INVALID };

  enum OVER_FLOW
  {
    OVER_FLOW_TRUNCATE = 0, // Truncated text from right (text end with ellipses)
    OVER_FLOW_SCROLL,
    OVER_FLOW_WRAP,
    OVER_FLOW_CLIP,
    OVER_FLOW_TRUNCATE_LEFT // Truncated text from left (text start with ellipses)
  };

  CGUILabel(float posX, float posY, float width, float height, const CLabelInfo& labelInfo, OVER_FLOW overflow = OVER_FLOW_TRUNCATE);
  CGUILabel(const CGUILabel& label);

  virtual ~CGUILabel() = default;

  bool Process(unsigned int currentTime);

  void Render();

  bool SetMaxRect(float x, float y, float w, float h);

  bool SetAlign(uint32_t align);

  bool SetText(const std::string &label);

  bool SetTextW(const std::wstring &label);

  bool SetStyledText(const vecText& text, const std::vector<UTILS::COLOR::Color>& colors);

  bool SetColor(COLOR color);

  void SetRenderRect(const CRect& rect) { m_renderRect = rect; }

  bool SetScrolling(bool scrolling);

  void SetScrollLoopCount(unsigned int loopCount) { m_maxScrollLoops = loopCount; }

  bool SetOverflow(OVER_FLOW overflow);

  void SetInvalid();

  bool UpdateColors();

  const CRect& GetRenderRect() const { return m_renderRect; }

  float GetTextWidth() const { return m_textLayout.GetTextWidth(); }

  float GetMaxWidth() const;

  float CalcTextWidth(const std::wstring& text) const { return m_textLayout.GetTextWidth(text); }

  const CLabelInfo& GetLabelInfo() const { return m_label; }
  CLabelInfo& GetLabelInfo() { return m_label; }

  static bool CheckAndCorrectOverlap(CGUILabel &label1, CGUILabel &label2);

protected:
  UTILS::COLOR::Color GetColor() const;

  void UpdateRenderRect();

private:
  CLabelInfo     m_label;
  CGUITextLayout m_textLayout;

  bool           m_scrolling;
  OVER_FLOW m_overflowType;
  CScrollInfo    m_scrollInfo;
  CRect          m_renderRect;   
  CRect          m_maxRect;      
  bool m_invalid = true; 
  COLOR m_color = COLOR_TEXT; 
  unsigned int   m_maxScrollLoops = ~0U;
};