Have sidebar folder selection return false if invalid folder position

Blake-Madden · Dec 19, 2023 · c586d6b · c586d6b
1 parent a4379cf
commit c586d6b
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 6 deletions.
diff --git a/src/ui/controls/sidebar.cpp b/src/ui/controls/sidebar.cpp
@@ -926,12 +926,12 @@ void SideBar::EnsureFolderVisible(const size_t index)
     }
 
 //-------------------------------------------
-void SideBar::SelectFolder(const size_t item, const bool setFocus /*= true*/,
+bool SideBar::SelectFolder(const size_t item, const bool setFocus /*= true*/,
                            const bool sendEvent /*= true*/,
                            const bool collapseIfExpanded /*= false*/)
     {
     if (item >= GetFolderCount())
-        { return; }
+        { return false; }
 
     EnsureFolderVisible(item);
 
@@ -951,7 +951,7 @@ void SideBar::SelectFolder(const size_t item, const bool setFocus /*= true*/,
         RecalcSizes();
         Refresh(true, &refreshRect);
         Update();
-        return;
+        return true;
         }
     // See if we should fire a subitem selection event instead
     // (in case this parent has subitems)
@@ -960,7 +960,7 @@ void SideBar::SelectFolder(const size_t item, const bool setFocus /*= true*/,
         if (!m_folders[item].IsSubItemSelected())
             { m_folders[item].m_selectedItem = 0; }
         SelectSubItem(item, m_folders[item].m_selectedItem.value(), setFocus, sendEvent);
-        return;
+        return true;
         }
 
     m_selectedFolder = item;
@@ -979,6 +979,8 @@ void SideBar::SelectFolder(const size_t item, const bool setFocus /*= true*/,
         cevent.SetEventObject(this);
         GetEventHandler()->ProcessEvent(cevent);
         }
+
+    return true;
     }
 
 //-------------------------------------------

diff --git a/src/ui/controls/sidebar.h b/src/ui/controls/sidebar.h
@@ -247,8 +247,9 @@ namespace Wisteria::UI
             @param sendEvent Whether to send a @c EVT_SIDEBAR_CLICK event.
             @param collapseIfExpanded @c true to collapse the folder if already expanded.\n
                 If collapsing the folder, then @c sendEvent will be overridden
-                (i.e., the selection event will not be fired).*/
-        void SelectFolder(const size_t item, const bool setFocus = true,
+                (i.e., the selection event will not be fired).
+            @returns @c true if the folder was selected.*/
+        bool SelectFolder(const size_t item, const bool setFocus = true,
                           const bool sendEvent = true,
                           const bool collapseIfExpanded = false);
         /** @brief Selects a subitem.