xbmc/dialogs/GUIDialogSelect.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 "GUIDialogSelect.h"
  10
  11 #include "FileItem.h"
  12 #include "FileItemList.h"
  13 #include "guilib/GUIMessage.h"
  14 #include "guilib/LocalizeStrings.h"
  15 #include "input/actions/ActionIDs.h"
  16 #include "utils/StringUtils.h"
  17
  18 #include <memory>
  19
  20 #define CONTROL_HEADING         1
  21 #define CONTROL_NUMBER_OF_ITEMS 2
  22 #define CONTROL_SIMPLE_LIST     3
  23 #define CONTROL_DETAILED_LIST   6
  24 #define CONTROL_EXTRA_BUTTON    5
  25 #define CONTROL_EXTRA_BUTTON2 8
  26 #define CONTROL_CANCEL_BUTTON   7
  27
  28 CGUIDialogSelect::CGUIDialogSelect() : CGUIDialogSelect(WINDOW_DIALOG_SELECT) {}
  29
  30 CGUIDialogSelect::CGUIDialogSelect(int windowId)
  31   : CGUIDialogBoxBase(windowId, "DialogSelect.xml"),
  32     m_vecList(std::make_unique<CFileItemList>()),
  33     m_bButtonEnabled(false),
  34     m_bButton2Enabled(false),
  35     m_bButtonPressed(false),
  36     m_bButton2Pressed(false),
  37     m_useDetails(false),
  38     m_multiSelection(false)
  39 {
  40   m_bConfirmed = false;
  41   m_loadType = KEEP_IN_MEMORY;
  42 }
  43
  44 CGUIDialogSelect::~CGUIDialogSelect(void) = default;
  45
  46 bool CGUIDialogSelect::OnMessage(CGUIMessage& message)
  47 {
  48   switch (message.GetMessage())
  49   {
  50   case GUI_MSG_WINDOW_DEINIT:
  51     {
  52       CGUIDialogBoxBase::OnMessage(message);
  53
  54       m_bButtonEnabled = false;
  55       m_bButton2Enabled = false;
  56       m_useDetails = false;
  57       m_multiSelection = false;
  58
  59       // construct selected items list
  60       m_selectedItems.clear();
  61       m_selectedItem = nullptr;
  62       for (int i = 0 ; i < m_vecList->Size() ; i++)
  63       {
  64         CFileItemPtr item = m_vecList->Get(i);
  65         if (item->IsSelected())
  66         {
  67           m_selectedItems.push_back(i);
  68           if (!m_selectedItem)
  69             m_selectedItem = item;
  70         }
  71       }
  72       m_vecList->Clear();
  73       return true;
  74     }
  75     break;
  76
  77   case GUI_MSG_WINDOW_INIT:
  78     {
  79       m_bButtonPressed = false;
  80       m_bButton2Pressed = false;
  81       m_bConfirmed = false;
  82       CGUIDialogBoxBase::OnMessage(message);
  83       return true;
  84     }
  85     break;
  86
  87
  88   case GUI_MSG_CLICKED:
  89     {
  90       int iControl = message.GetSenderId();
  91       if (m_viewControl.HasControl(CONTROL_SIMPLE_LIST))
  92       {
  93         int iAction = message.GetParam1();
  94         if (ACTION_SELECT_ITEM == iAction || ACTION_MOUSE_LEFT_CLICK == iAction)
  95         {
  96           int iSelected = m_viewControl.GetSelectedItem();
  97           if (iSelected >= 0 && iSelected < m_vecList->Size())
  98           {
  99             CFileItemPtr item(m_vecList->Get(iSelected));
 100             if (m_multiSelection)
 101               item->Select(!item->IsSelected());
 102             else
 103             {
 104               for (int i = 0 ; i < m_vecList->Size() ; i++)
 105                 m_vecList->Get(i)->Select(false);
 106               item->Select(true);
 107               OnSelect(iSelected);
 108             }
 109           }
 110         }
 111       }
 112       if (iControl == CONTROL_EXTRA_BUTTON2)
 113       {
 114         m_bButton2Pressed = true;
 115         if (m_multiSelection)
 116           m_bConfirmed = true;
 117         Close();
 118       }
 119       if (iControl == CONTROL_EXTRA_BUTTON)
 120       {
 121         m_selectedItem = nullptr;
 122         m_bButtonPressed = true;
 123         if (m_multiSelection)
 124           m_bConfirmed = true;
 125         Close();
 126       }
 127       else if (iControl == CONTROL_CANCEL_BUTTON)
 128       {
 129         m_selectedItem = nullptr;
 130         m_vecList->Clear();
 131         m_selectedItems.clear();
 132         m_bConfirmed = false;
 133         Close();
 134       }
 135     }
 136     break;
 137   case GUI_MSG_SETFOCUS:
 138     {
 139       if (m_viewControl.HasControl(message.GetControlId()))
 140       {
 141         if (m_vecList->IsEmpty())
 142         {
 143           if (m_bButtonEnabled)
 144             SET_CONTROL_FOCUS(CONTROL_EXTRA_BUTTON, 0);
 145           else
 146             SET_CONTROL_FOCUS(CONTROL_CANCEL_BUTTON, 0);
 147           return true;
 148         }
 149         if (m_viewControl.GetCurrentControl() != message.GetControlId())
 150         {
 151           m_viewControl.SetFocused();
 152           return true;
 153         }
 154       }
 155     }
 156     break;
 157   }
 158
 159   return CGUIDialogBoxBase::OnMessage(message);
 160 }
 161
 162 void CGUIDialogSelect::OnSelect(int idx)
 163 {
 164   m_bConfirmed = true;
 165   Close();
 166 }
 167
 168 bool CGUIDialogSelect::OnBack(int actionID)
 169 {
 170   m_selectedItem = nullptr;
 171   m_vecList->Clear();
 172   m_selectedItems.clear();
 173   m_bConfirmed = false;
 174   return CGUIDialogBoxBase::OnBack(actionID);
 175 }
 176
 177 void CGUIDialogSelect::Reset()
 178 {
 179   m_bButtonEnabled = false;
 180   m_bButtonPressed = false;
 181   m_bButton2Enabled = false;
 182   m_bButton2Pressed = false;
 183
 184   m_useDetails = false;
 185   m_multiSelection = false;
 186   m_focusToButton = false;
 187   m_selectedItem = nullptr;
 188   m_vecList->Clear();
 189   m_selectedItems.clear();
 190 }
 191
 192 int CGUIDialogSelect::Add(const std::string& strLabel)
 193 {
 194   CFileItemPtr pItem(new CFileItem(strLabel));
 195   m_vecList->Add(pItem);
 196   return m_vecList->Size() - 1;
 197 }
 198
 199 int CGUIDialogSelect::Add(const CFileItem& item)
 200 {
 201   m_vecList->Add(std::make_shared<CFileItem>(item));
 202   return m_vecList->Size() - 1;
 203 }
 204
 205 void CGUIDialogSelect::SetItems(const CFileItemList& pList)
 206 {
 207   m_vecList->Clear();
 208   m_vecList->Append(pList);
 209
 210   m_viewControl.SetItems(*m_vecList);
 211 }
 212
 213 int CGUIDialogSelect::GetSelectedItem() const
 214 {
 215   return m_selectedItems.size() > 0 ? m_selectedItems[0] : -1;
 216 }
 217
 218 const CFileItemPtr CGUIDialogSelect::GetSelectedFileItem() const
 219 {
 220   if (m_selectedItem)
 221     return m_selectedItem;
 222   return std::make_shared<CFileItem>();
 223 }
 224
 225 const std::vector<int>& CGUIDialogSelect::GetSelectedItems() const
 226 {
 227   return m_selectedItems;
 228 }
 229
 230 void CGUIDialogSelect::EnableButton(bool enable, int label)
 231 {
 232   m_bButtonEnabled = enable;
 233   m_buttonLabel = g_localizeStrings.Get(label);
 234 }
 235
 236 void CGUIDialogSelect::EnableButton(bool enable, const std::string& label)
 237 {
 238   m_bButtonEnabled = enable;
 239   m_buttonLabel = label;
 240 }
 241
 242 void CGUIDialogSelect::EnableButton2(bool enable, int label)
 243 {
 244   m_bButton2Enabled = enable;
 245   m_button2Label = g_localizeStrings.Get(label);
 246 }
 247
 248 void CGUIDialogSelect::EnableButton2(bool enable, const std::string& label)
 249 {
 250   m_bButton2Enabled = enable;
 251   m_button2Label = label;
 252 }
 253
 254 bool CGUIDialogSelect::IsButtonPressed()
 255 {
 256   return m_bButtonPressed;
 257 }
 258
 259 bool CGUIDialogSelect::IsButton2Pressed()
 260 {
 261   return m_bButton2Pressed;
 262 }
 263
 264 void CGUIDialogSelect::Sort(bool bSortOrder /*=true*/)
 265 {
 266   m_vecList->Sort(SortByLabel, bSortOrder ? SortOrderAscending : SortOrderDescending);
 267 }
 268
 269 void CGUIDialogSelect::SetSelected(int iSelected)
 270 {
 271   if (iSelected < 0 || iSelected >= m_vecList->Size() ||
 272       m_vecList->Get(iSelected).get() == NULL)
 273     return;
 274
 275   // only set m_iSelected if there is no multi-select
 276   // or if it doesn't have a valid value yet
 277   // or if the current value is bigger than the new one
 278   // so that we always focus the item nearest to the beginning of the list
 279   if (!m_multiSelection || !m_selectedItem ||
 280       (!m_selectedItems.empty() && m_selectedItems.back() > iSelected))
 281     m_selectedItem = m_vecList->Get(iSelected);
 282   m_vecList->Get(iSelected)->Select(true);
 283   m_selectedItems.push_back(iSelected);
 284 }
 285
 286 void CGUIDialogSelect::SetSelected(const std::string &strSelectedLabel)
 287 {
 288   for (int index = 0; index < m_vecList->Size(); index++)
 289   {
 290     if (strSelectedLabel == m_vecList->Get(index)->GetLabel())
 291     {
 292       SetSelected(index);
 293       return;
 294     }
 295   }
 296 }
 297
 298 void CGUIDialogSelect::SetSelected(const std::vector<int>& selectedIndexes)
 299 {
 300   for (auto i : selectedIndexes)
 301     SetSelected(i);
 302 }
 303
 304 void CGUIDialogSelect::SetSelected(const std::vector<std::string> &selectedLabels)
 305 {
 306   for (const auto& label : selectedLabels)
 307     SetSelected(label);
 308 }
 309
 310 void CGUIDialogSelect::SetUseDetails(bool useDetails)
 311 {
 312   m_useDetails = useDetails;
 313 }
 314
 315 void CGUIDialogSelect::SetMultiSelection(bool multiSelection)
 316 {
 317   m_multiSelection = multiSelection;
 318 }
 319
 320 void CGUIDialogSelect::SetButtonFocus(bool buttonFocus)
 321 {
 322   m_focusToButton = buttonFocus;
 323 }
 324
 325 CGUIControl *CGUIDialogSelect::GetFirstFocusableControl(int id)
 326 {
 327   if (m_viewControl.HasControl(id))
 328     id = m_viewControl.GetCurrentControl();
 329   return CGUIDialogBoxBase::GetFirstFocusableControl(id);
 330 }
 331
 332 void CGUIDialogSelect::OnWindowLoaded()
 333 {
 334   CGUIDialogBoxBase::OnWindowLoaded();
 335   m_viewControl.Reset();
 336   m_viewControl.SetParentWindow(GetID());
 337   m_viewControl.AddView(GetControl(CONTROL_SIMPLE_LIST));
 338   m_viewControl.AddView(GetControl(CONTROL_DETAILED_LIST));
 339 }
 340
 341 void CGUIDialogSelect::OnInitWindow()
 342 {
 343   m_viewControl.SetItems(*m_vecList);
 344   m_selectedItems.clear();
 345   for(int i = 0 ; i < m_vecList->Size(); i++)
 346   {
 347     auto item = m_vecList->Get(i);
 348     if (item->IsSelected())
 349     {
 350       m_selectedItems.push_back(i);
 351       if (m_selectedItem == nullptr)
 352         m_selectedItem = item;
 353     }
 354   }
 355   m_viewControl.SetCurrentView(m_useDetails ? CONTROL_DETAILED_LIST : CONTROL_SIMPLE_LIST);
 356
 357   SET_CONTROL_LABEL(CONTROL_NUMBER_OF_ITEMS,
 358                     StringUtils::Format("{} {}", m_vecList->Size(), g_localizeStrings.Get(127)));
 359
 360   if (m_multiSelection)
 361     EnableButton(true, 186);
 362
 363   if (m_bButtonEnabled)
 364   {
 365     SET_CONTROL_LABEL(CONTROL_EXTRA_BUTTON, m_buttonLabel);
 366     SET_CONTROL_VISIBLE(CONTROL_EXTRA_BUTTON);
 367   }
 368   else
 369     SET_CONTROL_HIDDEN(CONTROL_EXTRA_BUTTON);
 370
 371   if (m_bButton2Enabled)
 372   {
 373     SET_CONTROL_LABEL(CONTROL_EXTRA_BUTTON2, m_button2Label);
 374     SET_CONTROL_VISIBLE(CONTROL_EXTRA_BUTTON2);
 375   }
 376   else
 377     SET_CONTROL_HIDDEN(CONTROL_EXTRA_BUTTON2);
 378
 379   SET_CONTROL_LABEL(CONTROL_CANCEL_BUTTON, g_localizeStrings.Get(222));
 380
 381   CGUIDialogBoxBase::OnInitWindow();
 382
 383   // focus one of the buttons if explicitly requested
 384   // ATTENTION: this must be done after calling CGUIDialogBoxBase::OnInitWindow()
 385   if (m_focusToButton)
 386   {
 387     if (m_bButtonEnabled)
 388       SET_CONTROL_FOCUS(CONTROL_EXTRA_BUTTON, 0);
 389     else
 390       SET_CONTROL_FOCUS(CONTROL_CANCEL_BUTTON, 0);
 391   }
 392
 393   // if nothing is selected, select first item
 394   m_viewControl.SetSelectedItem(std::max(GetSelectedItem(), 0));
 395 }
 396
 397 void CGUIDialogSelect::OnDeinitWindow(int nextWindowID)
 398 {
 399   m_viewControl.Clear();
 400   CGUIDialogBoxBase::OnDeinitWindow(nextWindowID);
 401 }
 402
 403 void CGUIDialogSelect::OnWindowUnload()
 404 {
 405   CGUIDialogBoxBase::OnWindowUnload();
 406   m_viewControl.Reset();
 407 }