GUIControlFactory.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 "GUIControl.h"
#include "utils/ColorUtils.h"
#include "utils/MovingSpeed.h"

#include <string>
#include <vector>

class CTextureInfo; // forward
class CAspectRatio;
class TiXmlNode;
class CGUIAction;

namespace KODI
{
namespace GUILIB
{
namespace GUIINFO
{
class CGUIInfoLabel;
}
} // namespace GUILIB
} // namespace KODI

class CGUIControlFactory
{
public:
  CGUIControlFactory(void);
  virtual ~CGUIControlFactory(void);
  CGUIControl* Create(int parentID,
                      const CRect& rect,
                      TiXmlElement* pControlNode,
                      bool insideContainer = false);

  static CGUIControl::GUICONTROLTYPES TranslateControlType(const std::string& type);

  static std::string TranslateControlType(CGUIControl::GUICONTROLTYPES type);

  static bool GetAspectRatio(const TiXmlNode* pRootNode,
                             const char* strTag,
                             CAspectRatio& aspectRatio);
  static bool GetInfoTexture(const TiXmlNode* pRootNode,
                             const char* strTag,
                             CTextureInfo& image,
                             KODI::GUILIB::GUIINFO::CGUIInfoLabel& info,
                             int parentID);
  static bool GetTexture(const TiXmlNode* pRootNode, const char* strTag, CTextureInfo& image);
  static bool GetAlignment(const TiXmlNode* pRootNode, const char* strTag, uint32_t& dwAlignment);
  static bool GetAlignmentY(const TiXmlNode* pRootNode, const char* strTag, uint32_t& dwAlignment);
  static bool GetAnimations(TiXmlNode* control,
                            const CRect& rect,
                            int context,
                            std::vector<CAnimation>& animation);

  static float ParsePosition(const char* pos, const float parentSize);

  static bool GetInfoLabelFromElement(const TiXmlElement* element,
                                      KODI::GUILIB::GUIINFO::CGUIInfoLabel& infoLabel,
                                      int parentID);
  static void GetInfoLabel(const TiXmlNode* pControlNode,
                           const std::string& labelTag,
                           KODI::GUILIB::GUIINFO::CGUIInfoLabel& infoLabel,
                           int parentID);
  static void GetInfoLabels(const TiXmlNode* pControlNode,
                            const std::string& labelTag,
                            std::vector<KODI::GUILIB::GUIINFO::CGUIInfoLabel>& infoLabels,
                            int parentID);
  static bool GetColor(const TiXmlNode* pRootNode, const char* strTag, UTILS::COLOR::Color& value);
  static bool GetInfoColor(const TiXmlNode* pRootNode,
                           const char* strTag,
                           KODI::GUILIB::GUIINFO::CGUIInfoColor& value,
                           int parentID);
  static std::string FilterLabel(const std::string& label);
  static bool GetConditionalVisibility(const TiXmlNode* control, std::string& condition);
  static bool GetActions(const TiXmlNode* pRootNode, const char* strTag, CGUIAction& actions);
  static void GetRectFromString(const std::string& string, CRect& rect);
  static bool GetHitRect(const TiXmlNode* pRootNode, CRect& rect, const CRect& parentRect);
  static bool GetScroller(const TiXmlNode* pControlNode,
                          const std::string& scrollerTag,
                          CScroller& scroller);

private:
  static std::string GetType(const TiXmlElement* pControlNode);
  static bool GetMovingSpeedConfig(const TiXmlNode* pRootNode,
                                   const char* strTag,
                                   UTILS::MOVING_SPEED::MapEventConfig& movingSpeedCfg);
  static bool GetConditionalVisibility(const TiXmlNode* control,
                                       std::string& condition,
                                       std::string& allowHiddenFocus);
  bool GetString(const TiXmlNode* pRootNode, const char* strTag, std::string& strString);
  static bool GetFloatRange(const TiXmlNode* pRootNode,
                            const char* strTag,
                            float& iMinValue,
                            float& iMaxValue,
                            float& iIntervalValue);
  static bool GetIntRange(const TiXmlNode* pRootNode,
                          const char* strTag,
                          int& iMinValue,
                          int& iMaxValue,
                          int& iIntervalValue);

  static bool GetPosition(const TiXmlNode* node,
                          const char* tag,
                          const float parentSize,
                          float& value);

  static bool GetDimension(
      const TiXmlNode* node, const char* strTag, const float parentSize, float& value, float& min);

  static bool GetDimensions(const TiXmlNode* node,
                            const char* leftTag,
                            const char* rightTag,
                            const char* centerLeftTag,
                            const char* centerRightTag,
                            const char* widthTag,
                            const float parentSize,
                            float& left,
                            float& width,
                            float& min_width);
};