Ticket #3391: t3391_fix_sortable_list_column_header_v2.patch

source/gui/COList.cpp

@@ -133 +133 @@
 CRect COList::GetListRect() const
 {
     return m_CachedActualSize + CRect(0, m_HeadingHeight, 0, 0);
 }
 
 void COList::HandleMessage(SGUIMessage& Message)
 {
     CList::HandleMessage(Message);
 
     switch (Message.type)
     {
     // If somebody clicks on the column heading
     case GUIM_MOUSE_PRESS_LEFT:
     {
         bool sortable;
         GUI<bool>::GetSetting(this, "sortable", sortable);
         if (!sortable)
             return;
 
         CPos mouse = GetMousePos();
         if (!m_CachedActualSize.PointInside(mouse))
             return;
 
         float xpos = 0;
         for (size_t def = 0; def < m_ObjectsDefs.size(); ++def)
         {
             float width = m_ObjectsDefs[def].m_Width;
             // Check if it's a decimal value, and if so, assume relative positioning.
             if (m_ObjectsDefs[def].m_Width < 1 && m_ObjectsDefs[def].m_Width > 0)
                 width *= m_TotalAvalibleColumnWidth;
-            CPos leftTopCorner = m_CachedActualSize.TopLeft() + CPos(xpos, 4);
+            CPos leftTopCorner = m_CachedActualSize.TopLeft() + CPos(xpos, 0);
             if (mouse.x >= leftTopCorner.x &&
                 mouse.x < leftTopCorner.x + width &&
                 mouse.y < leftTopCorner.y + m_HeadingHeight)
             {
                 if (def != m_SelectedDef)
                 {
                     m_SelectedColumnOrder = 1;
                     m_SelectedDef = def;
                 }
                 else
                     m_SelectedColumnOrder = -m_SelectedColumnOrder;
                 GUI<CStr>::SetSetting(this, "selected_column", m_ObjectsDefs[def].m_Id.substr(5));
                 GUI<int>::SetSetting(this, "selected_column_order", m_SelectedColumnOrder);
                 GUI<int>::SetSetting(this, "selected_def", def);
                 ScriptEvent("selectioncolumnchange");
 
                 CStrW soundPath;
                 if (g_SoundManager && GUI<CStrW>::GetSetting(this, "sound_selected", soundPath) == PSRETURN_OK && !soundPath.empty())
                     g_SoundManager->PlayAsUI(soundPath.c_str(), false);
 
                 return;
             }
             xpos += width;
         }
         return;
     }
     default:
         return;
     }
 }
@@ -294 +294 @@
     float bz = GetBufferedZ();
 
     // First call draw on ScrollBarOwner
     bool scrollbar;
     GUI<bool>::GetSetting(this, "scrollbar", scrollbar);
 
     if (scrollbar)
         IGUIScrollBarOwner::Draw();
 
     if (!GetGUI())
         return;
 
     CRect rect = GetListRect();
 
     CGUISpriteInstance* sprite = NULL;
     CGUISpriteInstance* sprite_selectarea = NULL;
     int cell_id;
     GUI<CGUISpriteInstance>::GetSettingPointer(this, _sprite, sprite);
     GUI<CGUISpriteInstance>::GetSettingPointer(this, _sprite_selected, sprite_selectarea);
     GUI<int>::GetSetting(this, "cell_id", cell_id);
 
     CGUIList* pList;
     GUI<CGUIList>::GetSettingPointer(this, "list_name", pList);
 
     GetGUI()->DrawSprite(*sprite, cell_id, bz, rect);
 
     float scroll = 0.f;
     if (scrollbar)
         scroll = GetScrollBar(0).GetPos();
 
+    // Draw item selection
     if (selected != -1)
     {
         ENSURE(selected >= 0 && selected+1 < (int)m_ItemsYPositions.size());
 
         // Get rectangle of selection:
         CRect rect_sel(rect.left, rect.top + m_ItemsYPositions[selected] - scroll,
                        rect.right, rect.top + m_ItemsYPositions[selected+1] - scroll);
 
         if (rect_sel.top <= rect.bottom &&
             rect_sel.bottom >= rect.top)
         {
             if (rect_sel.bottom > rect.bottom)
                 rect_sel.bottom = rect.bottom;
             if (rect_sel.top < rect.top)
                 rect_sel.top = rect.top;
 
             if (scrollbar)
             {
                 // Remove any overlapping area of the scrollbar.
                 if (rect_sel.right > GetScrollBar(0).GetOuterRect().left &&
                     rect_sel.right <= GetScrollBar(0).GetOuterRect().right)
                     rect_sel.right = GetScrollBar(0).GetOuterRect().left;
 
                 if (rect_sel.left >= GetScrollBar(0).GetOuterRect().left &&
                     rect_sel.left < GetScrollBar(0).GetOuterRect().right)
                     rect_sel.left = GetScrollBar(0).GetOuterRect().right;
             }
 
+            // Draw item selection
             GetGUI()->DrawSprite(*sprite_selectarea, cell_id, bz+0.05f, rect_sel);
         }
     }
 
     CColor color;
     GUI<CColor>::GetSetting(this, _textcolor, color);
 
+    // Draw line above column header
     CGUISpriteInstance* sprite_heading = NULL;
     GUI<CGUISpriteInstance>::GetSettingPointer(this, "sprite_heading", sprite_heading);
     CRect rect_head(m_CachedActualSize.left, m_CachedActualSize.top, m_CachedActualSize.right,
                                     m_CachedActualSize.top + m_HeadingHeight);
     GetGUI()->DrawSprite(*sprite_heading, cell_id, bz, rect_head);
 
     CGUISpriteInstance* sprite_order;
     CGUISpriteInstance* sprite_not_sorted;
     if (m_SelectedColumnOrder != -1)
         GUI<CGUISpriteInstance>::GetSettingPointer(this, "sprite_asc", sprite_order);
     else
         GUI<CGUISpriteInstance>::GetSettingPointer(this, "sprite_desc", sprite_order);
     GUI<CGUISpriteInstance>::GetSettingPointer(this, "sprite_not_sorted", sprite_not_sorted);
 
+    // Draw column headers
     float xpos = 0;
     for (size_t def = 0; def < m_ObjectsDefs.size(); ++def)
     {
         // Check if it's a decimal value, and if so, assume relative positioning.
         float width = m_ObjectsDefs[def].m_Width;
         if (m_ObjectsDefs[def].m_Width < 1 && m_ObjectsDefs[def].m_Width > 0)
             width *= m_TotalAvalibleColumnWidth;
 
         CPos leftTopCorner = m_CachedActualSize.TopLeft() + CPos(xpos, 0);
+
         CGUISpriteInstance* sprite;
         // If the list sorted by current column
         if (m_SelectedDef == def)
             sprite = sprite_order;
         else
             sprite = sprite_not_sorted;
+
+        // Draw sort arrows in colum header
         GetGUI()->DrawSprite(*sprite, cell_id, bz + 0.1f, CRect(leftTopCorner + CPos(width - 16, 0), leftTopCorner + CPos(width, 16)));
 
+        // Draw column header text
         DrawText(def, color, leftTopCorner + CPos(0, 4), bz + 0.1f, rect_head);
         xpos += width;
     }
 
+    // Draw list items for each column
     const size_t objectsCount = m_ObjectsDefs.size();
     for (size_t i = 0; i < pList->m_Items.size(); ++i)
     {
         if (m_ItemsYPositions[i+1] - scroll < 0 ||
             m_ItemsYPositions[i] - scroll > rect.GetHeight())
             continue;
 
         const float rowHeight = m_ItemsYPositions[i+1] - m_ItemsYPositions[i];
 
         // Clipping area (we'll have to substract the scrollbar)
         CRect cliparea = GetListRect();
 
         if (scrollbar)
         {
             if (cliparea.right > GetScrollBar(0).GetOuterRect().left &&
                 cliparea.right <= GetScrollBar(0).GetOuterRect().right)
                 cliparea.right = GetScrollBar(0).GetOuterRect().left;
 
             if (cliparea.left >= GetScrollBar(0).GetOuterRect().left &&
                 cliparea.left < GetScrollBar(0).GetOuterRect().right)
                 cliparea.left = GetScrollBar(0).GetOuterRect().right;
         }
 
+        // Draw all items for that column
         xpos = 0;
         for (size_t def = 0; def < objectsCount; ++def)
         {
             // Determine text position and width
             const CPos textPos = rect.TopLeft() + CPos(xpos, -scroll + m_ItemsYPositions[i]);
 
             float width = m_ObjectsDefs[def].m_Width;;
             // Check if it's a decimal value, and if so, assume relative positioning.
             if (m_ObjectsDefs[def].m_Width < 1 && m_ObjectsDefs[def].m_Width > 0)
                 width *= m_TotalAvalibleColumnWidth;
 
             // Clip text to the column (to prevent drawing text into the neighboring column)
             CRect cliparea2 = cliparea;
             cliparea2.right = std::min(cliparea2.right, textPos.x + width);
             cliparea2.bottom = std::min(cliparea2.bottom, textPos.y + rowHeight);
 
+            // Draw list item
             DrawText(objectsCount * (i+/*Heading*/1) + def, m_ObjectsDefs[def].m_TextColor, textPos, bz+0.1f, cliparea2);
             xpos += width;
         }
     }
 }