xbmc/guilib/GUIListGroup.cpp

   1 /*
   2  *  Copyright (C) 2005-2018 Team Kodi
   3  *  This file is part of Kodi - https://kodi.tv
   4  *
   5  *  SPDX-License-Identifier: GPL-2.0-or-later
   6  *  See LICENSES/README.md for more information.
   7  */
   8
   9 #include "GUIListGroup.h"
  10
  11 #include "GUIListLabel.h"
  12 #include "utils/log.h"
  13
  14 #include <set>
  15
  16 namespace
  17 {
  18 // Supported control types. Keep sorted.
  19 const std::set<CGUIControl::GUICONTROLTYPES> supportedTypes = {
  20     // clang-format off
  21     CGUIControl::GUICONTROL_BORDEREDIMAGE,
  22     CGUIControl::GUICONTROL_GAME,
  23     CGUIControl::GUICONTROL_GAMECONTROLLER,
  24     CGUIControl::GUICONTROL_GAMECONTROLLERLIST,
  25     CGUIControl::GUICONTROL_IMAGE,
  26     CGUIControl::GUICONTROL_LISTGROUP,
  27     CGUIControl::GUICONTROL_LISTLABEL,
  28     CGUIControl::GUICONTROL_MULTI_IMAGE,
  29     CGUIControl::GUICONTROL_PROGRESS,
  30     CGUIControl::GUICONTROL_TEXTBOX,
  31     // clang-format on
  32 };
  33 } // namespace
  34
  35 CGUIListGroup::CGUIListGroup(int parentID, int controlID, float posX, float posY, float width, float height)
  36 : CGUIControlGroup(parentID, controlID, posX, posY, width, height)
  37 {
  38   m_item = NULL;
  39   ControlType = GUICONTROL_LISTGROUP;
  40 }
  41
  42 CGUIListGroup::CGUIListGroup(const CGUIListGroup &right)
  43 : CGUIControlGroup(right)
  44 {
  45   m_item = NULL;
  46   ControlType = GUICONTROL_LISTGROUP;
  47 }
  48
  49 CGUIListGroup::~CGUIListGroup(void)
  50 {
  51   FreeResources();
  52 }
  53
  54 void CGUIListGroup::AddControl(CGUIControl *control, int position /*= -1*/)
  55 {
  56   if (control)
  57   {
  58     if (supportedTypes.find(control->GetControlType()) == supportedTypes.end())
  59       CLog::Log(LOGWARNING, "Trying to add unsupported control type {}", control->GetControlType());
  60   }
  61   CGUIControlGroup::AddControl(control, position);
  62 }
  63
  64 void CGUIListGroup::Process(unsigned int currentTime, CDirtyRegionList &dirtyregions)
  65 {
  66   CServiceBroker::GetWinSystem()->GetGfxContext().SetOrigin(m_posX, m_posY);
  67
  68   CRect rect;
  69   for (iControls it = m_children.begin(); it != m_children.end(); ++it)
  70   {
  71     CGUIControl *control = *it;
  72     control->UpdateVisibility(m_item);
  73     unsigned int oldDirty = dirtyregions.size();
  74     control->DoProcess(currentTime, dirtyregions);
  75     if (control->IsVisible() || (oldDirty != dirtyregions.size())) // visible or dirty (was visible?)
  76       rect.Union(control->GetRenderRegion());
  77   }
  78
  79   CServiceBroker::GetWinSystem()->GetGfxContext().RestoreOrigin();
  80   CGUIControl::Process(currentTime, dirtyregions);
  81   m_renderRegion = rect;
  82   m_item = NULL;
  83 }
  84
  85 void CGUIListGroup::ResetAnimation(ANIMATION_TYPE type)
  86 {
  87   CGUIControl::ResetAnimation(type);
  88   for (iControls it = m_children.begin(); it != m_children.end(); ++it)
  89     (*it)->ResetAnimation(type);
  90 }
  91
  92 void CGUIListGroup::UpdateVisibility(const CGUIListItem *item)
  93 {
  94   CGUIControlGroup::UpdateVisibility(item);
  95   m_item = item;
  96 }
  97
  98 void CGUIListGroup::UpdateInfo(const CGUIListItem *item)
  99 {
 100   for (iControls it = m_children.begin(); it != m_children.end(); it++)
 101   {
 102     (*it)->UpdateInfo(item);
 103     (*it)->UpdateVisibility(item);
 104   }
 105   // now we have to check our overlapping label pairs
 106   for (unsigned int i = 0; i < m_children.size(); i++)
 107   {
 108     if (m_children[i]->GetControlType() == CGUIControl::GUICONTROL_LISTLABEL && m_children[i]->IsVisible())
 109     {
 110       for (unsigned int j = i + 1; j < m_children.size(); j++)
 111       {
 112         if (m_children[j]->GetControlType() == CGUIControl::GUICONTROL_LISTLABEL && m_children[j]->IsVisible())
 113           CGUIListLabel::CheckAndCorrectOverlap(*static_cast<CGUIListLabel*>(m_children[i]), *static_cast<CGUIListLabel*>(m_children[j]));
 114       }
 115     }
 116   }
 117 }
 118
 119 void CGUIListGroup::EnlargeWidth(float difference)
 120 {
 121   // Alters the width of the controls that have an ID of 1 to 14
 122   for (iControls it = m_children.begin(); it != m_children.end(); it++)
 123   {
 124     CGUIControl *child = *it;
 125     if (child->GetID() >= 1 && child->GetID() <= 14)
 126     {
 127       if (child->GetID() == 1)
 128       {
 129         child->SetWidth(child->GetWidth() + difference);
 130         child->SetVisible(child->GetWidth() > 10);
 131       }
 132       else
 133       {
 134         child->SetWidth(child->GetWidth() + difference);
 135       }
 136     }
 137   }
 138   SetInvalid();
 139 }
 140
 141 void CGUIListGroup::EnlargeHeight(float difference)
 142 {
 143   // Alters the height of the controls that have an ID of 1 to 14
 144   for (iControls it = m_children.begin(); it != m_children.end(); it++)
 145   {
 146     CGUIControl *child = *it;
 147     if (child->GetID() >= 1 && child->GetID() <= 14)
 148     {
 149       if (child->GetID() == 1)
 150       {
 151         child->SetHeight(child->GetHeight() + difference);
 152         child->SetVisible(child->GetHeight() > 10);
 153       }
 154       else
 155       {
 156         child->SetHeight(child->GetHeight() + difference);
 157       }
 158     }
 159   }
 160   SetInvalid();
 161 }
 162
 163 void CGUIListGroup::SetInvalid()
 164 {
 165   if (!m_bInvalidated)
 166   { // this can be triggered by an item change, so all children need invalidating rather than just the group
 167     for (iControls it = m_children.begin(); it != m_children.end(); ++it)
 168       (*it)->SetInvalid();
 169     CGUIControlGroup::SetInvalid();
 170   }
 171 }
 172
 173 void CGUIListGroup::SetFocusedItem(unsigned int focus)
 174 {
 175   for (iControls it = m_children.begin(); it != m_children.end(); it++)
 176   {
 177     if ((*it)->GetControlType() == CGUIControl::GUICONTROL_LISTGROUP)
 178       ((CGUIListGroup *)(*it))->SetFocusedItem(focus);
 179     else
 180       (*it)->SetFocus(focus > 0);
 181   }
 182   SetFocus(focus > 0);
 183 }
 184
 185 unsigned int CGUIListGroup::GetFocusedItem() const
 186 {
 187   for (ciControls it = m_children.begin(); it != m_children.end(); it++)
 188   {
 189     if ((*it)->GetControlType() == CGUIControl::GUICONTROL_LISTGROUP && ((CGUIListGroup *)(*it))->GetFocusedItem())
 190       return ((CGUIListGroup *)(*it))->GetFocusedItem();
 191   }
 192   return m_bHasFocus ? 1 : 0;
 193 }
 194
 195 bool CGUIListGroup::MoveLeft()
 196 {
 197   for (iControls it = m_children.begin(); it != m_children.end(); it++)
 198   {
 199     if ((*it)->GetControlType() == CGUIControl::GUICONTROL_LISTGROUP && ((CGUIListGroup *)(*it))->MoveLeft())
 200       return true;
 201   }
 202   return false;
 203 }
 204
 205 bool CGUIListGroup::MoveRight()
 206 {
 207   for (iControls it = m_children.begin(); it != m_children.end(); it++)
 208   {
 209     if ((*it)->GetControlType() == CGUIControl::GUICONTROL_LISTGROUP && ((CGUIListGroup *)(*it))->MoveRight())
 210       return true;
 211   }
 212   return false;
 213 }
 214
 215 void CGUIListGroup::SetState(bool selected, bool focused)
 216 {
 217   for (iControls it = m_children.begin(); it != m_children.end(); it++)
 218   {
 219     if ((*it)->GetControlType() == CGUIControl::GUICONTROL_LISTLABEL)
 220     {
 221       CGUIListLabel *label = (CGUIListLabel *)(*it);
 222       label->SetSelected(selected);
 223     }
 224     else if ((*it)->GetControlType() == CGUIControl::GUICONTROL_LISTGROUP)
 225       ((CGUIListGroup *)(*it))->SetState(selected, focused);
 226   }
 227 }
 228
 229 void CGUIListGroup::SelectItemFromPoint(const CPoint &point)
 230 {
 231   CPoint controlCoords(point);
 232   m_transform.InverseTransformPosition(controlCoords.x, controlCoords.y);
 233   for (iControls it = m_children.begin(); it != m_children.end(); ++it)
 234   {
 235     CGUIControl *child = *it;
 236     if (child->GetControlType() == CGUIControl::GUICONTROL_LISTGROUP)
 237       static_cast<CGUIListGroup*>(child)->SelectItemFromPoint(point);
 238   }
 239 }