source/gui/CList.cpp

   1 /* Copyright (C) 2017 Wildfire Games.
   2  * This file is part of 0 A.D.
   3  *
   4  * 0 A.D. is free software: you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation, either version 2 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * 0 A.D. is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
  16  */
  17
  18 #include "precompiled.h"
  19
  20 #include "CList.h"
  21
  22 #include "CGUIScrollBarVertical.h"
  23
  24 #include "lib/external_libraries/libsdl.h"
  25 #include "ps/CLogger.h"
  26 #include "ps/Profile.h"
  27 #include "soundmanager/ISoundManager.h"
  28
  29
  30 CList::CList()
  31         : m_Modified(false), m_PrevSelectedItem(-1), m_LastItemClickTime(0)
  32 {
  33         // Add sprite_disabled! TODO
  34
  35         AddSetting(GUIST_float,                                 "buffer_zone");
  36         AddSetting(GUIST_CStrW,                                 "font");
  37         AddSetting(GUIST_bool,                                  "scrollbar");
  38         AddSetting(GUIST_CStr,                                  "scrollbar_style");
  39         AddSetting(GUIST_CStrW,                                 "sound_disabled");
  40         AddSetting(GUIST_CStrW,                                 "sound_selected");
  41         AddSetting(GUIST_CGUISpriteInstance,    "sprite");
  42         AddSetting(GUIST_CGUISpriteInstance,    "sprite_selectarea");
  43         AddSetting(GUIST_int,                                   "cell_id");
  44         AddSetting(GUIST_EAlign,                                "text_align");
  45         AddSetting(GUIST_CColor,                                "textcolor");
  46         AddSetting(GUIST_CColor,                                "textcolor_selected");
  47         AddSetting(GUIST_int,                                   "selected");    // Index selected. -1 is none.
  48         AddSetting(GUIST_int,                                   "hovered");
  49         AddSetting(GUIST_CStrW,                                 "tooltip");
  50         AddSetting(GUIST_CStr,                                  "tooltip_style");
  51
  52         // Each list item has both a name (in 'list') and an associated data string (in 'list_data')
  53         AddSetting(GUIST_CGUIList,                              "list");
  54         AddSetting(GUIST_CGUIList,                              "list_data"); // TODO: this should be a list of raw strings, not of CGUIStrings
  55
  56         GUI<bool>::SetSetting(this, "scrollbar", false);
  57         GUI<int>::SetSetting(this, "selected", -1);
  58         GUI<int>::SetSetting(this, "hovered", -1);
  59
  60         // Add scroll-bar
  61         CGUIScrollBarVertical* bar = new CGUIScrollBarVertical();
  62         bar->SetRightAligned(true);
  63         AddScrollBar(bar);
  64 }
  65
  66 CList::~CList()
  67 {
  68 }
  69
  70 void CList::SetupText()
  71 {
  72         if (!GetGUI())
  73                 return;
  74
  75         m_Modified = true;
  76         CGUIList* pList;
  77         GUI<CGUIList>::GetSettingPointer(this, "list", pList);
  78
  79         //ENSURE(m_GeneratedTexts.size()>=1);
  80
  81         m_ItemsYPositions.resize(pList->m_Items.size()+1);
  82
  83         // Delete all generated texts. Some could probably be saved,
  84         //  but this is easier, and this function will never be called
  85         //  continuously, or even often, so it'll probably be okay.
  86         for (SGUIText* const& t : m_GeneratedTexts)
  87                 delete t;
  88         m_GeneratedTexts.clear();
  89
  90         CStrW font;
  91         if (GUI<CStrW>::GetSetting(this, "font", font) != PSRETURN_OK || font.empty())
  92                 // Use the default if none is specified
  93                 // TODO Gee: (2004-08-14) Don't define standard like this. Do it with the default style.
  94                 font = L"default";
  95
  96         bool scrollbar;
  97         GUI<bool>::GetSetting(this, "scrollbar", scrollbar);
  98
  99         float width = GetListRect().GetWidth();
 100         // remove scrollbar if applicable
 101         if (scrollbar && GetScrollBar(0).GetStyle())
 102                 width -= GetScrollBar(0).GetStyle()->m_Width;
 103
 104         float buffer_zone = 0.f;
 105         GUI<float>::GetSetting(this, "buffer_zone", buffer_zone);
 106
 107         // Generate texts
 108         float buffered_y = 0.f;
 109
 110         for (size_t i = 0; i < pList->m_Items.size(); ++i)
 111         {
 112                 // Create a new SGUIText. Later on, input it using AddText()
 113                 SGUIText* text = new SGUIText();
 114
 115                 if (!pList->m_Items[i].GetOriginalString().empty())
 116                         *text = GetGUI()->GenerateText(pList->m_Items[i], font, width, buffer_zone, this);
 117                 else
 118                 {
 119                         // Minimum height of a space character of the current font size
 120                         CGUIString align_string;
 121                         align_string.SetValue(L" ");
 122                         *text = GetGUI()->GenerateText(align_string, font, width, buffer_zone, this);
 123                 }
 124
 125                 m_ItemsYPositions[i] = buffered_y;
 126                 buffered_y += text->m_Size.cy;
 127
 128                 AddText(text);
 129         }
 130
 131         m_ItemsYPositions[pList->m_Items.size()] = buffered_y;
 132
 133         // Setup scrollbar
 134         if (scrollbar)
 135         {
 136                 GetScrollBar(0).SetScrollRange(m_ItemsYPositions.back());
 137                 GetScrollBar(0).SetScrollSpace(GetListRect().GetHeight());
 138
 139                 CRect rect = GetListRect();
 140                 GetScrollBar(0).SetX(rect.right);
 141                 GetScrollBar(0).SetY(rect.top);
 142                 GetScrollBar(0).SetZ(GetBufferedZ());
 143                 GetScrollBar(0).SetLength(rect.bottom - rect.top);
 144         }
 145 }
 146
 147 void CList::HandleMessage(SGUIMessage& Message)
 148 {
 149         IGUIScrollBarOwner::HandleMessage(Message);
 150         //IGUITextOwner::HandleMessage(Message); <== placed it after the switch instead!
 151
 152         m_Modified = false;
 153         switch (Message.type)
 154         {
 155         case GUIM_SETTINGS_UPDATED:
 156                 if (Message.value == "list")
 157                         SetupText();
 158
 159                 // If selected is changed, call "SelectionChange"
 160                 if (Message.value == "selected")
 161                 {
 162                         // TODO: Check range
 163
 164                         UpdateAutoScroll();
 165
 166                         // TODO only works if lower-case, shouldn't it be made case sensitive instead?
 167                         ScriptEvent("selectionchange");
 168                 }
 169
 170                 if (Message.value == "scrollbar")
 171                         SetupText();
 172
 173                 // Update scrollbar
 174                 if (Message.value == "scrollbar_style")
 175                 {
 176                         CStr scrollbar_style;
 177                         GUI<CStr>::GetSetting(this, Message.value, scrollbar_style);
 178
 179                         GetScrollBar(0).SetScrollBarStyle(scrollbar_style);
 180
 181                         SetupText();
 182                 }
 183
 184                 break;
 185
 186         case GUIM_MOUSE_PRESS_LEFT:
 187         {
 188                 bool enabled;
 189                 GUI<bool>::GetSetting(this, "enabled", enabled);
 190                 if (!enabled)
 191                 {
 192                         CStrW soundPath;
 193                         if (g_SoundManager && GUI<CStrW>::GetSetting(this, "sound_disabled", soundPath) == PSRETURN_OK && !soundPath.empty())
 194                                 g_SoundManager->PlayAsUI(soundPath.c_str(), false);
 195                         break;
 196                 }
 197
 198                 int hovered = GetHoveredItem();
 199                 if (hovered == -1)
 200                         break;
 201                 GUI<int>::SetSetting(this, "selected", hovered);
 202                 UpdateAutoScroll();
 203
 204                 CStrW soundPath;
 205                 if (g_SoundManager && GUI<CStrW>::GetSetting(this, "sound_selected", soundPath) == PSRETURN_OK && !soundPath.empty())
 206                         g_SoundManager->PlayAsUI(soundPath.c_str(), false);
 207
 208                 if (timer_Time() - m_LastItemClickTime < SELECT_DBLCLICK_RATE && hovered == m_PrevSelectedItem)
 209                         this->SendEvent(GUIM_MOUSE_DBLCLICK_LEFT_ITEM, "mouseleftdoubleclickitem");
 210                 else
 211                         this->SendEvent(GUIM_MOUSE_PRESS_LEFT_ITEM, "mouseleftclickitem");
 212
 213                 m_LastItemClickTime = timer_Time();
 214                 m_PrevSelectedItem = hovered;
 215                 break;
 216         }
 217
 218         case GUIM_MOUSE_LEAVE:
 219         {
 220                 int hoveredSetting = -1;
 221                 GUI<int>::GetSetting(this, "hovered", hoveredSetting);
 222                 if (hoveredSetting == -1)
 223                         break;
 224
 225                 GUI<int>::SetSetting(this, "hovered", -1);
 226                 ScriptEvent("hoverchange");
 227                 break;
 228         }
 229
 230         case GUIM_MOUSE_OVER:
 231         {
 232                 int hoveredSetting = -1;
 233                 GUI<int>::GetSetting(this, "hovered", hoveredSetting);
 234
 235                 int hovered = GetHoveredItem();
 236                 if (hovered == hoveredSetting)
 237                         break;
 238
 239                 GUI<int>::SetSetting(this, "hovered", hovered);
 240                 ScriptEvent("hoverchange");
 241                 break;
 242         }
 243
 244         case GUIM_LOAD:
 245         {
 246                 CStr scrollbar_style;
 247                 GUI<CStr>::GetSetting(this, "scrollbar_style", scrollbar_style);
 248                 GetScrollBar(0).SetScrollBarStyle(scrollbar_style);
 249                 break;
 250         }
 251
 252         default:
 253                 break;
 254         }
 255
 256         IGUITextOwner::HandleMessage(Message);
 257 }
 258
 259 InReaction CList::ManuallyHandleEvent(const SDL_Event_* ev)
 260 {
 261         InReaction result = IN_PASS;
 262
 263         if (ev->ev.type == SDL_KEYDOWN)
 264         {
 265                 int szChar = ev->ev.key.keysym.sym;
 266
 267                 switch (szChar)
 268                 {
 269                 case SDLK_HOME:
 270                         SelectFirstElement();
 271                         UpdateAutoScroll();
 272                         result = IN_HANDLED;
 273                         break;
 274
 275                 case SDLK_END:
 276                         SelectLastElement();
 277                         UpdateAutoScroll();
 278                         result = IN_HANDLED;
 279                         break;
 280
 281                 case SDLK_UP:
 282                         SelectPrevElement();
 283                         UpdateAutoScroll();
 284                         result = IN_HANDLED;
 285                         break;
 286
 287                 case SDLK_DOWN:
 288                         SelectNextElement();
 289                         UpdateAutoScroll();
 290                         result = IN_HANDLED;
 291                         break;
 292
 293                 case SDLK_PAGEUP:
 294                         GetScrollBar(0).ScrollMinusPlenty();
 295                         result = IN_HANDLED;
 296                         break;
 297
 298                 case SDLK_PAGEDOWN:
 299                         GetScrollBar(0).ScrollPlusPlenty();
 300                         result = IN_HANDLED;
 301                         break;
 302
 303                 default: // Do nothing
 304                         result = IN_PASS;
 305                 }
 306         }
 307
 308         return result;
 309 }
 310
 311 void CList::Draw()
 312 {
 313         int selected;
 314         GUI<int>::GetSetting(this, "selected", selected);
 315
 316         DrawList(selected, "sprite", "sprite_selectarea", "textcolor");
 317 }
 318
 319 void CList::DrawList(const int& selected, const CStr& _sprite, const CStr& _sprite_selected, const CStr& _textcolor)
 320 {
 321         float bz = GetBufferedZ();
 322
 323         // First call draw on ScrollBarOwner
 324         bool scrollbar;
 325         GUI<bool>::GetSetting(this, "scrollbar", scrollbar);
 326
 327         if (scrollbar)
 328                 IGUIScrollBarOwner::Draw();
 329
 330         if (GetGUI())
 331         {
 332                 CRect rect = GetListRect();
 333
 334                 CGUISpriteInstance* sprite = NULL;
 335                 CGUISpriteInstance* sprite_selectarea = NULL;
 336                 int cell_id;
 337                 GUI<CGUISpriteInstance>::GetSettingPointer(this, _sprite, sprite);
 338                 GUI<CGUISpriteInstance>::GetSettingPointer(this, _sprite_selected, sprite_selectarea);
 339                 GUI<int>::GetSetting(this, "cell_id", cell_id);
 340
 341                 CGUIList* pList;
 342                 GUI<CGUIList>::GetSettingPointer(this, "list", pList);
 343
 344                 GetGUI()->DrawSprite(*sprite, cell_id, bz, rect);
 345
 346                 float scroll = 0.f;
 347                 if (scrollbar)
 348                         scroll = GetScrollBar(0).GetPos();
 349
 350                 if (selected >= 0 && selected+1 < (int)m_ItemsYPositions.size())
 351                 {
 352                         // Get rectangle of selection:
 353                         CRect rect_sel(rect.left, rect.top + m_ItemsYPositions[selected] - scroll,
 354                                                rect.right, rect.top + m_ItemsYPositions[selected+1] - scroll);
 355
 356                         if (rect_sel.top <= rect.bottom &&
 357                                 rect_sel.bottom >= rect.top)
 358                         {
 359                                 if (rect_sel.bottom > rect.bottom)
 360                                         rect_sel.bottom = rect.bottom;
 361                                 if (rect_sel.top < rect.top)
 362                                         rect_sel.top = rect.top;
 363
 364                                 if (scrollbar)
 365                                 {
 366                                         // Remove any overlapping area of the scrollbar.
 367                                         if (rect_sel.right > GetScrollBar(0).GetOuterRect().left &&
 368                                                 rect_sel.right <= GetScrollBar(0).GetOuterRect().right)
 369                                                 rect_sel.right = GetScrollBar(0).GetOuterRect().left;
 370
 371                                         if (rect_sel.left >= GetScrollBar(0).GetOuterRect().left &&
 372                                                 rect_sel.left < GetScrollBar(0).GetOuterRect().right)
 373                                                 rect_sel.left = GetScrollBar(0).GetOuterRect().right;
 374                                 }
 375
 376                                 GetGUI()->DrawSprite(*sprite_selectarea, cell_id, bz+0.05f, rect_sel);
 377                         }
 378                 }
 379
 380                 CColor color;
 381                 GUI<CColor>::GetSetting(this, _textcolor, color);
 382
 383                 for (size_t i = 0; i < pList->m_Items.size(); ++i)
 384                 {
 385                         if (m_ItemsYPositions[i+1] - scroll < 0 ||
 386                                 m_ItemsYPositions[i] - scroll > rect.GetHeight())
 387                                 continue;
 388
 389                         // Clipping area (we'll have to substract the scrollbar)
 390                         CRect cliparea = GetListRect();
 391
 392                         if (scrollbar)
 393                         {
 394                                 if (cliparea.right > GetScrollBar(0).GetOuterRect().left &&
 395                                         cliparea.right <= GetScrollBar(0).GetOuterRect().right)
 396                                         cliparea.right = GetScrollBar(0).GetOuterRect().left;
 397
 398                                 if (cliparea.left >= GetScrollBar(0).GetOuterRect().left &&
 399                                         cliparea.left < GetScrollBar(0).GetOuterRect().right)
 400                                         cliparea.left = GetScrollBar(0).GetOuterRect().right;
 401                         }
 402
 403                         DrawText(i, color, rect.TopLeft() - CPos(0.f, scroll - m_ItemsYPositions[i]), bz+0.1f, cliparea);
 404                 }
 405         }
 406 }
 407
 408 void CList::AddItem(const CStrW& str, const CStrW& data)
 409 {
 410         CGUIList* pList;
 411         CGUIList* pListData;
 412         GUI<CGUIList>::GetSettingPointer(this, "list", pList);
 413         GUI<CGUIList>::GetSettingPointer(this, "list_data", pListData);
 414
 415         CGUIString gui_string;
 416         gui_string.SetValue(str);
 417         pList->m_Items.push_back(gui_string);
 418
 419         CGUIString data_string;
 420         data_string.SetValue(data);
 421         pListData->m_Items.push_back(data_string);
 422
 423         // TODO Temp
 424         SetupText();
 425 }
 426
 427 bool CList::HandleAdditionalChildren(const XMBElement& child, CXeromyces* pFile)
 428 {
 429         int elmt_item = pFile->GetElementID("item");
 430
 431         if (child.GetNodeName() == elmt_item)
 432         {
 433                 AddItem(child.GetText().FromUTF8(), child.GetText().FromUTF8());
 434                 return true;
 435         }
 436
 437         return false;
 438 }
 439
 440 void CList::SelectNextElement()
 441 {
 442         int selected;
 443         GUI<int>::GetSetting(this, "selected", selected);
 444
 445         CGUIList* pList;
 446         GUI<CGUIList>::GetSettingPointer(this, "list", pList);
 447
 448         if (selected != (int)pList->m_Items.size()-1)
 449         {
 450                 ++selected;
 451                 GUI<int>::SetSetting(this, "selected", selected);
 452
 453                 CStrW soundPath;
 454                 if (g_SoundManager && GUI<CStrW>::GetSetting(this, "sound_selected", soundPath) == PSRETURN_OK && !soundPath.empty())
 455                         g_SoundManager->PlayAsUI(soundPath.c_str(), false);
 456         }
 457 }
 458
 459 void CList::SelectPrevElement()
 460 {
 461         int selected;
 462         GUI<int>::GetSetting(this, "selected", selected);
 463
 464         if (selected > 0)
 465         {
 466                 --selected;
 467                 GUI<int>::SetSetting(this, "selected", selected);
 468
 469                 CStrW soundPath;
 470                 if (g_SoundManager && GUI<CStrW>::GetSetting(this, "sound_selected", soundPath) == PSRETURN_OK && !soundPath.empty())
 471                         g_SoundManager->PlayAsUI(soundPath.c_str(), false);
 472         }
 473 }
 474
 475 void CList::SelectFirstElement()
 476 {
 477         int selected;
 478         GUI<int>::GetSetting(this, "selected", selected);
 479
 480         if (selected >= 0)
 481                 GUI<int>::SetSetting(this, "selected", 0);
 482 }
 483
 484 void CList::SelectLastElement()
 485 {
 486         int selected;
 487         GUI<int>::GetSetting(this, "selected", selected);
 488
 489         CGUIList* pList;
 490         GUI<CGUIList>::GetSettingPointer(this, "list", pList);
 491
 492         if (selected != (int)pList->m_Items.size()-1)
 493                 GUI<int>::SetSetting(this, "selected", (int)pList->m_Items.size()-1);
 494 }
 495
 496 void CList::UpdateAutoScroll()
 497 {
 498         int selected;
 499         bool scrollbar;
 500         float scroll;
 501         GUI<int>::GetSetting(this, "selected", selected);
 502         GUI<bool>::GetSetting(this, "scrollbar", scrollbar);
 503
 504         // No scrollbar, no scrolling (at least it's not made to work properly).
 505         if (!scrollbar || selected < 0 || (std::size_t) selected >= m_ItemsYPositions.size())
 506                 return;
 507
 508         scroll = GetScrollBar(0).GetPos();
 509
 510         // Check upper boundary
 511         if (m_ItemsYPositions[selected] < scroll)
 512         {
 513                 GetScrollBar(0).SetPos(m_ItemsYPositions[selected]);
 514                 return; // this means, if it wants to align both up and down at the same time
 515                                 //  this will have precedence.
 516         }
 517
 518         // Check lower boundary
 519         CRect rect = GetListRect();
 520         if (m_ItemsYPositions[selected+1]-rect.GetHeight() > scroll)
 521                 GetScrollBar(0).SetPos(m_ItemsYPositions[selected+1]-rect.GetHeight());
 522 }
 523
 524 int CList::GetHoveredItem()
 525 {
 526         bool scrollbar;
 527         CGUIList* pList;
 528         GUI<bool>::GetSetting(this, "scrollbar", scrollbar);
 529         GUI<CGUIList>::GetSettingPointer(this, "list", pList);
 530         float scroll = 0.f;
 531         if (scrollbar)
 532                 scroll = GetScrollBar(0).GetPos();
 533
 534         CRect rect = GetListRect();
 535         CPos mouse = GetMousePos();
 536         mouse.y += scroll;
 537
 538         // Mouse is over scrollbar
 539         if (scrollbar && GetScrollBar(0).IsVisible() &&
 540             mouse.x >= GetScrollBar(0).GetOuterRect().left &&
 541             mouse.x <= GetScrollBar(0).GetOuterRect().right)
 542                 return -1;
 543
 544         for (size_t i = 0; i < pList->m_Items.size(); ++i)
 545                 if (mouse.y >= rect.top + m_ItemsYPositions[i] &&
 546                     mouse.y < rect.top + m_ItemsYPositions[i + 1])
 547                         return i;
 548
 549         return -1;
 550 }