xbmc/guilib/GUIButtonControl.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 "GUIButtonControl.h"
  10
  11 #include "GUIFontManager.h"
  12 #include "input/actions/Action.h"
  13 #include "input/actions/ActionIDs.h"
  14 #include "input/mouse/MouseEvent.h"
  15
  16 using namespace KODI;
  17
  18 CGUIButtonControl::CGUIButtonControl(int parentID,
  19                                      int controlID,
  20                                      float posX,
  21                                      float posY,
  22                                      float width,
  23                                      float height,
  24                                      const CTextureInfo& textureFocus,
  25                                      const CTextureInfo& textureNoFocus,
  26                                      const CLabelInfo& labelInfo,
  27                                      bool wrapMultiline)
  28   : CGUIControl(parentID, controlID, posX, posY, width, height),
  29     m_imgFocus(CGUITexture::CreateTexture(posX, posY, width, height, textureFocus)),
  30     m_imgNoFocus(CGUITexture::CreateTexture(posX, posY, width, height, textureNoFocus)),
  31     m_label(posX,
  32             posY,
  33             width,
  34             height,
  35             labelInfo,
  36             wrapMultiline ? CGUILabel::OVER_FLOW_WRAP : CGUILabel::OVER_FLOW_TRUNCATE),
  37     m_label2(posX, posY, width, height, labelInfo)
  38 {
  39   m_bSelected = false;
  40   m_alpha = 255;
  41   m_focusCounter = 0;
  42   m_minWidth = 0;
  43   m_maxWidth = width;
  44   ControlType = GUICONTROL_BUTTON;
  45 }
  46
  47 CGUIButtonControl::CGUIButtonControl(const CGUIButtonControl& control)
  48   : CGUIControl(control),
  49     m_imgFocus(control.m_imgFocus->Clone()),
  50     m_imgNoFocus(control.m_imgNoFocus->Clone()),
  51     m_focusCounter(control.m_focusCounter),
  52     m_alpha(control.m_alpha),
  53     m_minWidth(control.m_minWidth),
  54     m_maxWidth(control.m_maxWidth),
  55     m_info(control.m_info),
  56     m_info2(control.m_info2),
  57     m_label(control.m_label),
  58     m_label2(control.m_label2),
  59     m_clickActions(control.m_clickActions),
  60     m_focusActions(control.m_focusActions),
  61     m_unfocusActions(control.m_unfocusActions),
  62     m_bSelected(control.m_bSelected)
  63 {
  64 }
  65
  66 void CGUIButtonControl::Process(unsigned int currentTime, CDirtyRegionList &dirtyregions)
  67 {
  68   ProcessText(currentTime);
  69   if (m_bInvalidated)
  70   {
  71     m_imgFocus->SetWidth(GetWidth());
  72     m_imgFocus->SetHeight(m_height);
  73
  74     m_imgNoFocus->SetWidth(GetWidth());
  75     m_imgNoFocus->SetHeight(m_height);
  76   }
  77
  78   if (HasFocus())
  79   {
  80     unsigned int alphaChannel = m_alpha;
  81     if (m_pulseOnSelect)
  82     {
  83       unsigned int alphaCounter = m_focusCounter + 2;
  84       if ((alphaCounter % 128) >= 64)
  85         alphaChannel = alphaCounter % 64;
  86       else
  87         alphaChannel = 63 - (alphaCounter % 64);
  88
  89       alphaChannel += 192;
  90       alphaChannel = (unsigned int)((float)m_alpha * (float)alphaChannel / 255.0f);
  91     }
  92     if (m_imgFocus->SetAlpha((unsigned char)alphaChannel))
  93       MarkDirtyRegion();
  94
  95     m_imgFocus->SetVisible(true);
  96     m_imgNoFocus->SetVisible(false);
  97     m_focusCounter++;
  98   }
  99   else
 100   {
 101     m_imgFocus->SetVisible(false);
 102     m_imgNoFocus->SetVisible(true);
 103   }
 104
 105   m_imgFocus->Process(currentTime);
 106   m_imgNoFocus->Process(currentTime);
 107
 108   CGUIControl::Process(currentTime, dirtyregions);
 109 }
 110
 111 void CGUIButtonControl::Render()
 112 {
 113   if (CServiceBroker::GetWinSystem()->GetGfxContext().GetRenderOrder() ==
 114       RENDER_ORDER_FRONT_TO_BACK)
 115   {
 116     m_imgNoFocus->Render();
 117     m_imgFocus->Render(-1);
 118   }
 119   else
 120   {
 121     m_imgFocus->Render(-1);
 122     m_imgNoFocus->Render();
 123     RenderText();
 124   }
 125
 126   CGUIControl::Render();
 127 }
 128
 129 void CGUIButtonControl::RenderText()
 130 {
 131   if (CServiceBroker::GetWinSystem()->GetGfxContext().GetRenderOrder() ==
 132       RENDER_ORDER_FRONT_TO_BACK)
 133     return;
 134   m_label.Render();
 135   m_label2.Render();
 136 }
 137
 138 CGUILabel::COLOR CGUIButtonControl::GetTextColor() const
 139 {
 140   if (IsDisabled())
 141     return CGUILabel::COLOR_DISABLED;
 142   if (HasFocus())
 143     return CGUILabel::COLOR_FOCUSED;
 144   return CGUILabel::COLOR_TEXT;
 145 }
 146
 147 #define CLAMP(x, low, high)  (((x) > (high)) ? (high) : (((x) < (low)) ? (low) : (x)))
 148 float CGUIButtonControl::GetWidth() const
 149 {
 150   if (m_minWidth && m_minWidth != m_width)
 151   {
 152     float txtWidth = m_label.GetTextWidth() + 2 * m_label.GetLabelInfo().offsetX;
 153     if (m_label2.GetTextWidth())
 154     {
 155       static const float min_space = 10;
 156       txtWidth += m_label2.GetTextWidth() + 2 * m_label2.GetLabelInfo().offsetX + min_space;
 157     }
 158     float maxWidth = m_maxWidth ? m_maxWidth : txtWidth;
 159     return CLAMP(txtWidth, m_minWidth, maxWidth);
 160   }
 161   return m_width;
 162 }
 163
 164 void CGUIButtonControl::SetMinWidth(float minWidth)
 165 {
 166   if (m_minWidth != minWidth)
 167     MarkDirtyRegion();
 168
 169   m_minWidth = minWidth;
 170 }
 171
 172 void CGUIButtonControl::ProcessText(unsigned int currentTime)
 173 {
 174   CRect labelRenderRect = m_label.GetRenderRect();
 175   CRect label2RenderRect = m_label2.GetRenderRect();
 176
 177   float renderWidth = GetWidth();
 178   float renderTextWidth = renderWidth;
 179   if (m_labelMaxWidth > 0 && m_labelMaxWidth < renderWidth)
 180     renderTextWidth = m_labelMaxWidth;
 181
 182   bool changed = m_label.SetMaxRect(m_posX, m_posY, renderTextWidth, m_height);
 183   changed |= m_label.SetText(m_info.GetLabel(m_parentID));
 184   changed |= m_label.SetScrolling(HasFocus());
 185   changed |= m_label2.SetMaxRect(m_posX, m_posY, renderTextWidth, m_height);
 186   changed |= m_label2.SetText(m_info2.GetLabel(m_parentID));
 187
 188   // text changed - images need resizing
 189   if (m_minWidth && (m_label.GetRenderRect() != labelRenderRect))
 190     SetInvalid();
 191
 192   // auto-width - adjust hitrect
 193   if (m_minWidth && m_width != renderWidth)
 194   {
 195     CRect rect{m_posX, m_posY, m_posX + renderWidth, m_posY + m_height};
 196     SetHitRect(rect, m_hitColor);
 197   }
 198
 199   // render the second label if it exists
 200   if (!m_info2.GetLabel(m_parentID).empty())
 201   {
 202     changed |= m_label2.SetAlign(XBFONT_RIGHT | (m_label.GetLabelInfo().align & XBFONT_CENTER_Y) | XBFONT_TRUNCATED);
 203     changed |= m_label2.SetScrolling(HasFocus());
 204
 205     // If overlapping was corrected - compare render rects to determine
 206     // if they changed since last frame.
 207     if (CGUILabel::CheckAndCorrectOverlap(m_label, m_label2))
 208       changed |= (m_label.GetRenderRect()  != labelRenderRect ||
 209                   m_label2.GetRenderRect() != label2RenderRect);
 210
 211     changed |= m_label2.SetColor(GetTextColor());
 212     changed |= m_label2.Process(currentTime);
 213   }
 214   changed |= m_label.SetColor(GetTextColor());
 215   changed |= m_label.Process(currentTime);
 216   if (changed)
 217     MarkDirtyRegion();
 218 }
 219
 220 bool CGUIButtonControl::OnAction(const CAction &action)
 221 {
 222   if (action.GetID() == ACTION_SELECT_ITEM)
 223   {
 224     OnClick();
 225     return true;
 226   }
 227   return CGUIControl::OnAction(action);
 228 }
 229
 230 bool CGUIButtonControl::OnMessage(CGUIMessage& message)
 231 {
 232   if (message.GetControlId() == GetID())
 233   {
 234     if (message.GetMessage() == GUI_MSG_LABEL_SET)
 235     {
 236       SetLabel(message.GetLabel());
 237       return true;
 238     }
 239     if (message.GetMessage() == GUI_MSG_LABEL2_SET)
 240     {
 241       SetLabel2(message.GetLabel());
 242       return true;
 243     }
 244     if (message.GetMessage() == GUI_MSG_IS_SELECTED)
 245     {
 246       message.SetParam1(m_bSelected ? 1 : 0);
 247       return true;
 248     }
 249     if (message.GetMessage() == GUI_MSG_SET_SELECTED)
 250     {
 251       if (!m_bSelected)
 252         SetInvalid();
 253       m_bSelected = true;
 254       return true;
 255     }
 256     if (message.GetMessage() == GUI_MSG_SET_DESELECTED)
 257     {
 258       if (m_bSelected)
 259         SetInvalid();
 260       m_bSelected = false;
 261       return true;
 262     }
 263   }
 264
 265   return CGUIControl::OnMessage(message);
 266 }
 267
 268 void CGUIButtonControl::AllocResources()
 269 {
 270   CGUIControl::AllocResources();
 271   m_focusCounter = 0;
 272   m_imgFocus->AllocResources();
 273   m_imgNoFocus->AllocResources();
 274   if (!m_width)
 275     m_width = m_imgFocus->GetWidth();
 276   if (!m_height)
 277     m_height = m_imgFocus->GetHeight();
 278 }
 279
 280 void CGUIButtonControl::FreeResources(bool immediately)
 281 {
 282   CGUIControl::FreeResources(immediately);
 283   m_imgFocus->FreeResources(immediately);
 284   m_imgNoFocus->FreeResources(immediately);
 285 }
 286
 287 void CGUIButtonControl::DynamicResourceAlloc(bool bOnOff)
 288 {
 289   CGUIControl::DynamicResourceAlloc(bOnOff);
 290   m_imgFocus->DynamicResourceAlloc(bOnOff);
 291   m_imgNoFocus->DynamicResourceAlloc(bOnOff);
 292 }
 293
 294 void CGUIButtonControl::SetInvalid()
 295 {
 296   CGUIControl::SetInvalid();
 297   m_label.SetInvalid();
 298   m_label2.SetInvalid();
 299   m_imgFocus->SetInvalid();
 300   m_imgNoFocus->SetInvalid();
 301 }
 302
 303 void CGUIButtonControl::SetLabel(const std::string &label)
 304 { // NOTE: No fallback for buttons at this point
 305   if (m_info.GetLabel(GetParentID(), false) != label)
 306   {
 307     m_info.SetLabel(label, "", GetParentID());
 308     SetInvalid();
 309   }
 310 }
 311
 312 void CGUIButtonControl::SetLabel2(const std::string &label2)
 313 { // NOTE: No fallback for buttons at this point
 314   if (m_info2.GetLabel(GetParentID(), false) != label2)
 315   {
 316     m_info2.SetLabel(label2, "", GetParentID());
 317     SetInvalid();
 318   }
 319 }
 320
 321 void CGUIButtonControl::SetPosition(float posX, float posY)
 322 {
 323   CGUIControl::SetPosition(posX, posY);
 324   m_imgFocus->SetPosition(posX, posY);
 325   m_imgNoFocus->SetPosition(posX, posY);
 326 }
 327
 328 void CGUIButtonControl::SetAlpha(unsigned char alpha)
 329 {
 330   if (m_alpha != alpha)
 331     MarkDirtyRegion();
 332   m_alpha = alpha;
 333 }
 334
 335 bool CGUIButtonControl::UpdateColors(const CGUIListItem* item)
 336 {
 337   bool changed = CGUIControl::UpdateColors(nullptr);
 338   changed |= m_label.UpdateColors();
 339   changed |= m_label2.UpdateColors();
 340   changed |= m_imgFocus->SetDiffuseColor(m_diffuseColor);
 341   changed |= m_imgNoFocus->SetDiffuseColor(m_diffuseColor);
 342
 343   return changed;
 344 }
 345
 346 CRect CGUIButtonControl::CalcRenderRegion() const
 347 {
 348   CRect buttonRect = CGUIControl::CalcRenderRegion();
 349   CRect textRect = m_label.GetRenderRect();
 350   buttonRect.Union(textRect);
 351   return buttonRect;
 352 }
 353
 354 EVENT_RESULT CGUIButtonControl::OnMouseEvent(const CPoint& point, const MOUSE::CMouseEvent& event)
 355 {
 356   if (event.m_id == ACTION_MOUSE_LEFT_CLICK)
 357   {
 358     OnAction(CAction(ACTION_SELECT_ITEM));
 359     return EVENT_RESULT_HANDLED;
 360   }
 361   return EVENT_RESULT_UNHANDLED;
 362 }
 363
 364 std::string CGUIButtonControl::GetDescription() const
 365 {
 366   std::string strLabel(m_info.GetLabel(m_parentID));
 367   return strLabel;
 368 }
 369
 370 std::string CGUIButtonControl::GetLabel2() const
 371 {
 372   std::string strLabel(m_info2.GetLabel(m_parentID));
 373   return strLabel;
 374 }
 375
 376 void CGUIButtonControl::PythonSetLabel(const std::string& strFont,
 377                                        const std::string& strText,
 378                                        KODI::UTILS::COLOR::Color textColor,
 379                                        KODI::UTILS::COLOR::Color shadowColor,
 380                                        KODI::UTILS::COLOR::Color focusedColor)
 381 {
 382   m_label.GetLabelInfo().font = g_fontManager.GetFont(strFont);
 383   m_label.GetLabelInfo().textColor = textColor;
 384   m_label.GetLabelInfo().focusedColor = focusedColor;
 385   m_label.GetLabelInfo().shadowColor = shadowColor;
 386   SetLabel(strText);
 387 }
 388
 389 void CGUIButtonControl::PythonSetDisabledColor(KODI::UTILS::COLOR::Color disabledColor)
 390 {
 391   m_label.GetLabelInfo().disabledColor = disabledColor;
 392 }
 393
 394 void CGUIButtonControl::OnClick()
 395 {
 396   // Save values, as the click message may deactivate the window
 397   int controlID = GetID();
 398   int parentID = GetParentID();
 399   CGUIAction clickActions = m_clickActions;
 400
 401   // button selected, send a message
 402   CGUIMessage msg(GUI_MSG_CLICKED, controlID, parentID, 0);
 403   SendWindowMessage(msg);
 404
 405   clickActions.ExecuteActions(controlID, parentID);
 406 }
 407
 408 void CGUIButtonControl::OnFocus()
 409 {
 410   m_focusActions.ExecuteActions(GetID(), GetParentID());
 411 }
 412
 413 void CGUIButtonControl::OnUnFocus()
 414 {
 415   m_unfocusActions.ExecuteActions(GetID(), GetParentID());
 416 }
 417
 418 void CGUIButtonControl::SetSelected(bool bSelected)
 419 {
 420   if (m_bSelected != bSelected)
 421   {
 422     m_bSelected = bSelected;
 423     SetInvalid();
 424   }
 425 }