Update FilterEdit and FilterTarget to preserve existing selections

bdash · bdash · commit ade58079a0a3 · 2025-11-04T16:04:04.000-08:00
The down and enter keys now preserve an existing selection in the
associated list or table views, rather than unconditionally selecting or
activating the first item.
diff --git a/examples/triage/entry.cpp b/examples/triage/entry.cpp
@@ -271,15 +271,18 @@ void EntryTreeView::scrollToCurrentItem()
 }
 
 
-void EntryTreeView::selectFirstItem()
+void EntryTreeView::ensureSelection()
 {
-	setCurrentIndex(m_model->index(0, 0, QModelIndex()));
+	if (auto current = currentIndex(); !current.isValid())
+		setCurrentIndex(m_model->index(0, 0, QModelIndex()));
 }
 
 
-void EntryTreeView::activateFirstItem()
+void EntryTreeView::activateSelection()
 {
-	entryDoubleClicked(m_model->index(0, 0, QModelIndex()));
+	ensureSelection();
+	if (auto current = currentIndex(); current.isValid())
+		entryDoubleClicked(current);
 }
 
 
diff --git a/examples/triage/entry.h b/examples/triage/entry.h
@@ -49,8 +49,8 @@ class EntryTreeView : public QTreeView, public FilterTarget
 	virtual void setFilter(const std::string& filterText) override;
 	virtual void scrollToFirstItem() override;
 	virtual void scrollToCurrentItem() override;
-	virtual void selectFirstItem() override;
-	virtual void activateFirstItem() override;
+	virtual void ensureSelection() override;
+	virtual void activateSelection() override;
 	virtual void closeFilter() override;
 
   protected:
diff --git a/examples/triage/exports.cpp b/examples/triage/exports.cpp
@@ -438,15 +438,18 @@ void ExportsTreeView::scrollToCurrentItem()
 }
 
 
-void ExportsTreeView::selectFirstItem()
+void ExportsTreeView::ensureSelection()
 {
-	setCurrentIndex(m_model->index(0, 0, QModelIndex()));
+	if (auto current = currentIndex(); !current.isValid())
+		setCurrentIndex(m_model->index(0, 0, QModelIndex()));
 }
 
 
-void ExportsTreeView::activateFirstItem()
+void ExportsTreeView::activateSelection()
 {
-	exportDoubleClicked(m_model->index(0, 0, QModelIndex()));
+	ensureSelection();
+	if (auto current = currentIndex(); current.isValid())
+		exportDoubleClicked(current);
 }
 
 
diff --git a/examples/triage/exports.h b/examples/triage/exports.h
@@ -80,8 +80,8 @@ class ExportsTreeView : public QTreeView, public FilterTarget
 	virtual void setFilter(const std::string& filterText) override;
 	virtual void scrollToFirstItem() override;
 	virtual void scrollToCurrentItem() override;
-	virtual void selectFirstItem() override;
-	virtual void activateFirstItem() override;
+	virtual void ensureSelection() override;
+	virtual void activateSelection() override;
 	virtual void closeFilter() override;
 
   protected:
diff --git a/examples/triage/imports.cpp b/examples/triage/imports.cpp
@@ -343,15 +343,18 @@ void ImportsTreeView::scrollToCurrentItem()
 }
 
 
-void ImportsTreeView::selectFirstItem()
+void ImportsTreeView::ensureSelection()
 {
-	setCurrentIndex(m_model->index(0, 0, QModelIndex()));
+	if (auto current = currentIndex(); !current.isValid())
+		setCurrentIndex(m_model->index(0, 0, QModelIndex()));
 }
 
 
-void ImportsTreeView::activateFirstItem()
+void ImportsTreeView::activateSelection()
 {
-	importDoubleClicked(m_model->index(0, 0, QModelIndex()));
+	ensureSelection();
+	if (auto current = currentIndex(); current.isValid())
+		importDoubleClicked(current);
 }
 
 
diff --git a/examples/triage/imports.h b/examples/triage/imports.h
@@ -58,8 +58,8 @@ class ImportsTreeView : public QTreeView, public FilterTarget
 	virtual void setFilter(const std::string& filterText) override;
 	virtual void scrollToFirstItem() override;
 	virtual void scrollToCurrentItem() override;
-	virtual void selectFirstItem() override;
-	virtual void activateFirstItem() override;
+	virtual void ensureSelection() override;
+	virtual void activateSelection() override;
 	virtual void closeFilter() override;
 
   protected:
diff --git a/examples/triage/strings.cpp b/examples/triage/strings.cpp
@@ -288,15 +288,18 @@ void StringsTreeView::scrollToCurrentItem()
 }
 
 
-void StringsTreeView::selectFirstItem()
+void StringsTreeView::ensureSelection()
 {
-	setCurrentIndex(m_model->index(0, 0, QModelIndex()));
+	if (auto current = currentIndex(); !current.isValid())
+		setCurrentIndex(m_model->index(0, 0, QModelIndex()));
 }
 
 
-void StringsTreeView::activateFirstItem()
+void StringsTreeView::activateSelection()
 {
-	stringDoubleClicked(m_model->index(0, 0, QModelIndex()));
+	ensureSelection();
+	if (auto current = currentIndex(); current.isValid())
+		stringDoubleClicked(current);
 }
 
 
diff --git a/examples/triage/strings.h b/examples/triage/strings.h
@@ -50,8 +50,8 @@ class StringsTreeView : public QTreeView, public FilterTarget
 	virtual void setFilter(const std::string& filterText) override;
 	virtual void scrollToFirstItem() override;
 	virtual void scrollToCurrentItem() override;
-	virtual void selectFirstItem() override;
-	virtual void activateFirstItem() override;
+	virtual void ensureSelection() override;
+	virtual void activateSelection() override;
 	virtual void closeFilter() override;
 
   protected:
diff --git a/plugins/warp/ui/shared/constraint.h b/plugins/warp/ui/shared/constraint.h
@@ -64,7 +64,7 @@ class WarpConstraintTableWidget : public QWidget, public FilterTarget
 
 	void scrollToCurrentItem() override {}
 
-	void selectFirstItem() override {}
+	void ensureSelection() override {}
 
-	void activateFirstItem() override {}
+	void activateSelection() override {}
 };
diff --git a/plugins/warp/ui/shared/function.h b/plugins/warp/ui/shared/function.h
@@ -129,9 +129,9 @@ class WarpFunctionTableWidget : public QWidget, public FilterTarget
 
 	void scrollToCurrentItem() override {}
 
-	void selectFirstItem() override {}
+	void ensureSelection() override {}
 
-	void activateFirstItem() override {}
+	void activateSelection() override {}
 };
 
 class WarpFunctionInfoWidget : public QWidget
diff --git a/python/examples/triage/exports.py b/python/examples/triage/exports.py
@@ -154,11 +154,14 @@ def scrollToFirstItem(self):
 	def scrollToCurrentItem(self):
 		self.scrollTo(self.currentIndex())
 
-	def selectFirstItem(self):
-		self.setCurrentIndex(self.model.index(0, 0, QModelIndex()))
-
-	def activateFirstItem(self):
-		self.exportDoubleClicked(self.model.index(0, 0, QModelIndex()))
+	def ensureSelection(self):
+		if not self.currentIndex().isValid():
+			self.setCurrentIndex(self.model.index(0, 0, QModelIndex()))
+
+	def activateSelection(self):
+		self.ensureSelection()
+		if self.currentIndex().isValid():
+			self.exportDoubleClicked(self.currentIndex())
 
 	def closeFilter(self):
 		self.setFocus(Qt.OtherFocusReason)
diff --git a/python/examples/triage/imports.py b/python/examples/triage/imports.py
@@ -336,11 +336,14 @@ def scrollToFirstItem(self):
 	def scrollToCurrentItem(self):
 		self.scrollTo(self.currentIndex())
 
-	def selectFirstItem(self):
-		self.setCurrentIndex(self.model.index(0, 0, QModelIndex()))
-
-	def activateFirstItem(self):
-		self.importDoubleClicked(self.model.index(0, 0, QModelIndex()))
+	def ensureSelection(self):
+		if not self.currentIndex().isValid():
+			self.setCurrentIndex(self.model.index(0, 0, QModelIndex()))
+
+	def activateSelection(self):
+		self.ensureSelection()
+		if self.currentIndex().isValid():
+			self.importDoubleClicked(self.currentIndex())
 
 	def closeFilter(self):
 		self.setFocus(Qt.OtherFocusReason)
diff --git a/python/examples/typelibexplorer.py b/python/examples/typelibexplorer.py
@@ -51,11 +51,12 @@ def scrollToFirstItem(self):
 	def scrollToCurrentItem(self):
 		self.scrollTo(self.currentIndex())
 
-	def selectFirstItem(self):
-		self.setCurrentIndex(self.model().index(0, 0, QModelIndex()))
+	def ensureSelection(self):
+		if not self.currentIndex().isValid():
+			self.setCurrentIndex(self.model().index(0, 0, QModelIndex()))
 
-	def activateFirstItem(self):
-		self.setCurrentIndex(self.model().index(0, 0, QModelIndex()))
+	def activateSelection(self):
+		self.ensureSelection()
 
 	def closeFilter(self):
 		self.setFocus(Qt.OtherFocusReason)
@@ -109,11 +110,12 @@ def scrollToFirstItem(self):
 	def scrollToCurrentItem(self):
 		self.scrollTo(self.currentIndex())
 
-	def selectFirstItem(self):
-		self.setCurrentIndex(self.model().index(0, 0, QModelIndex()))
+	def ensureSelection(self):
+		if not self.currentIndex().isValid():
+			self.setCurrentIndex(self.model().index(0, 0, QModelIndex()))
 
-	def activateFirstItem(self):
-		self.setCurrentIndex(self.model().index(0, 0, QModelIndex()))
+	def activateSelection(self):
+		self.ensureSelection()
 
 	def closeFilter(self):
 		self.setFocus(Qt.OtherFocusReason)
@@ -335,17 +337,17 @@ def scrollToCurrentItem(self):
 		else:
 			self.type_table.scrollToCurrentItem()
 
-	def selectFirstItem(self):
+	def ensureSelection(self):
 		if self.horizontal_tabs.currentIndex() == 0:
-			self.object_table.selectFirstItem()
+			self.object_table.ensureSelection()
 		else:
-			self.type_table.selectFirstItem()
+			self.type_table.ensureSelection()
 
-	def activateFirstItem(self):
+	def activateSelection(self):
 		if self.horizontal_tabs.currentIndex() == 0:
-			self.object_table.activateFirstItem()
+			self.object_table.activateSelection()
 		else:
-			self.type_table.activateFirstItem()
+			self.type_table.activateSelection()
 
 	def closeFilter(self):
 		if self.horizontal_tabs.currentIndex() == 0:
diff --git a/ui/bndbimportdialog.h b/ui/bndbimportdialog.h
@@ -120,7 +120,7 @@ protected Q_SLOTS:
 	void setFilter(const std::string& filter) override;
 	void scrollToFirstItem() override;
 	void scrollToCurrentItem() override;
-	void selectFirstItem() override;
-	void activateFirstItem() override;
+	void ensureSelection() override;
+	void activateSelection() override;
 	void closeFilter() override;
 };
diff --git a/ui/filter.h b/ui/filter.h
@@ -22,8 +22,16 @@ class BINARYNINJAUIAPI FilterTarget
 	virtual void setFilter(const std::string& filter) = 0;
 	virtual void scrollToFirstItem() = 0;
 	virtual void scrollToCurrentItem() = 0;
-	virtual void selectFirstItem() = 0;
-	virtual void activateFirstItem() = 0;
+
+	// Select an item, typically the first, if none is already selected.
+	virtual void ensureSelection() = 0;
+
+	// Activate the selected item, typically in response to the user
+	// pressing the return key.
+	virtual void activateSelection() = 0;
+
+	// Transfer focus away from the `FilterEdit`. By default, focus
+	// is transferred to `this` if it is an instance of `QWidget`.
 	virtual void closeFilter();
 };
 
diff --git a/ui/logview.h b/ui/logview.h
@@ -276,8 +276,8 @@ class BINARYNINJAUIAPI LogView : public SidebarWidget, public FilterTarget
 
 		void scrollToFirstItem() override;
 		void scrollToCurrentItem() override;
-		void selectFirstItem() override;
-		void activateFirstItem() override {}
+		void ensureSelection() override;
+		void activateSelection() override {}
 		void closeFilter() override;
 
 		// std::pair<size_t, size_t> GetSelectionIndexAndOffsetFromPosition(const QPoint& position) const;
diff --git a/ui/metadatachoicedialog.h b/ui/metadatachoicedialog.h
@@ -91,8 +91,8 @@ class BINARYNINJAUIAPI ManagedTableView : public QTableView, public FilterTarget
 	virtual void setFilter(const std::string& filter) override;
 	virtual void scrollToFirstItem() override;
 	virtual void scrollToCurrentItem() override;
-	virtual void selectFirstItem() override;
-	virtual void activateFirstItem() override;
+	virtual void ensureSelection() override;
+	virtual void activateSelection() override;
 
 	virtual void focusInEvent(QFocusEvent *event) override;
 	bool focusNextPrevChild(bool next) override;
diff --git a/ui/projectbrowser.h b/ui/projectbrowser.h
@@ -175,8 +175,8 @@ class BINARYNINJAUIAPI ProjectTree: public QTreeView, public FilterTarget
 
 	virtual void scrollToFirstItem() override;
 	virtual void scrollToCurrentItem() override;
-	virtual void selectFirstItem() override;
-	virtual void activateFirstItem() override;
+	virtual void ensureSelection() override;
+	virtual void activateSelection() override;
 	virtual void setFilter(const std::string& filter) override;
 
 protected:
@@ -198,8 +198,8 @@ class BINARYNINJAUIAPI RecentsList: public QListWidget, public FilterTarget
 
 	virtual void scrollToFirstItem() override;
 	virtual void scrollToCurrentItem() override;
-	virtual void selectFirstItem() override;
-	virtual void activateFirstItem() override;
+	virtual void ensureSelection() override;
+	virtual void activateSelection() override;
 	virtual void setFilter(const std::string& filter) override;
 
 public:
diff --git a/ui/searchresult.h b/ui/searchresult.h
@@ -325,8 +325,8 @@ class BINARYNINJAUIAPI SearchResultHeaderWidget : public QWidget, public FilterT
 	virtual void setFilter(const std::string&) override {}
 	virtual void scrollToFirstItem() override {}
 	virtual void scrollToCurrentItem() override {}
-	virtual void selectFirstItem() override {}
-	virtual void activateFirstItem() override;
+	virtual void ensureSelection() override {}
+	virtual void activateSelection() override;
 
 protected:
 	virtual void keyPressEvent(QKeyEvent* e) override;
diff --git a/ui/stringsview.h b/ui/stringsview.h
@@ -211,8 +211,8 @@ class BINARYNINJAUIAPI StringsView : public TableViewBase, public View, public F
 	virtual void setFilter(const std::string& filter) override;
 	virtual void scrollToFirstItem() override;
 	virtual void scrollToCurrentItem() override;
-	virtual void selectFirstItem() override;
-	virtual void activateFirstItem() override;
+	virtual void ensureSelection() override;
+	virtual void activateSelection() override;
 	virtual QFont getFont() override { return m_itemDelegate->getFont(); }
 
 	bool getIncludeStringsOverlappingCode() const { return m_list->getIncludeStringsOverlappingCode(); };
diff --git a/ui/symbollist.h b/ui/symbollist.h
@@ -359,8 +359,8 @@ class BINARYNINJAUIAPI SymbolList : public QListView, public FilterTarget
 
 	virtual void scrollToFirstItem() override;
 	virtual void scrollToCurrentItem() override;
-	virtual void selectFirstItem() override;
-	virtual void activateFirstItem() override;
+	virtual void ensureSelection() override;
+	virtual void activateSelection() override;
 	virtual void setFilter(const std::string& filter) override;
 
 	bool hasSymbols();
diff --git a/ui/taglist.h b/ui/taglist.h
@@ -193,10 +193,10 @@ class BINARYNINJAUIAPI TagList : public QTreeView, public FilterTarget
 	void navigateToNext();
 	void navigateToPrev();
 
-	void scrollToFirstItem() override;
-	void scrollToCurrentItem() override;
-	void selectFirstItem() override;
-	void activateFirstItem() override;
+	virtual void scrollToFirstItem() override;
+	virtual void scrollToCurrentItem() override;
+	virtual void ensureSelection() override;
+	virtual void activateSelection() override;
 };
 
 /*!
diff --git a/ui/typebrowser.h b/ui/typebrowser.h
@@ -438,8 +438,8 @@ class BINARYNINJAUIAPI TypeBrowserView : public QFrame, public View, public Filt
 	virtual void setFilter(const std::string& filter) override;
 	virtual void scrollToFirstItem() override;
 	virtual void scrollToCurrentItem() override;
-	virtual void selectFirstItem() override;
-	virtual void activateFirstItem() override;
+	virtual void ensureSelection() override;
+	virtual void activateSelection() override;
 
 	virtual void notifyRefresh() override;
 
diff --git a/ui/variablelist.h b/ui/variablelist.h
@@ -257,8 +257,8 @@ class BINARYNINJAUIAPI VariableList : public SidebarWidget, public FilterTarget
 	virtual void setFilter(const std::string& filter) override;
 	virtual void scrollToFirstItem() override;
 	virtual void scrollToCurrentItem() override;
-	virtual void selectFirstItem() override;
-	virtual void activateFirstItem() override;
+	virtual void ensureSelection() override;
+	virtual void activateSelection() override;
 };
 
 /*! The main variable list dock widget.
diff --git a/view/kernelcache/ui/kctriage.h b/view/kernelcache/ui/kctriage.h
diff --git a/view/kernelcache/ui/symboltable.h b/view/kernelcache/ui/symboltable.h
diff --git a/view/sharedcache/ui/dsctriage.h b/view/sharedcache/ui/dsctriage.h
diff --git a/view/sharedcache/ui/symboltable.h b/view/sharedcache/ui/symboltable.h

Original file line number	Diff line number	Diff line change
`@@ -271,15 +271,18 @@ void EntryTreeView::scrollToCurrentItem()`
`271`	`271`	`}`
`272`	`272`
`273`	`273`
`274`		`-void EntryTreeView::selectFirstItem()`
	`274`	`+void EntryTreeView::ensureSelection()`
`275`	`275`	`{`
`276`		`- setCurrentIndex(m_model->index(0, 0, QModelIndex()));`
	`276`	`+ if (auto current = currentIndex(); !current.isValid())`
	`277`	`+ setCurrentIndex(m_model->index(0, 0, QModelIndex()));`
`277`	`278`	`}`
`278`	`279`
`279`	`280`
`280`		`-void EntryTreeView::activateFirstItem()`
	`281`	`+void EntryTreeView::activateSelection()`
`281`	`282`	`{`
`282`		`- entryDoubleClicked(m_model->index(0, 0, QModelIndex()));`
	`283`	`+ ensureSelection();`
	`284`	`+ if (auto current = currentIndex(); current.isValid())`
	`285`	`+ entryDoubleClicked(current);`
`283`	`286`	`}`
`284`	`287`
`285`	`288`
Original file line number	Diff line number	Diff line change
`@@ -438,15 +438,18 @@ void ExportsTreeView::scrollToCurrentItem()`
`438`	`438`	`}`
`439`	`439`
`440`	`440`
`441`		`-void ExportsTreeView::selectFirstItem()`
	`441`	`+void ExportsTreeView::ensureSelection()`
`442`	`442`	`{`
`443`		`- setCurrentIndex(m_model->index(0, 0, QModelIndex()));`
	`443`	`+ if (auto current = currentIndex(); !current.isValid())`
	`444`	`+ setCurrentIndex(m_model->index(0, 0, QModelIndex()));`
`444`	`445`	`}`
`445`	`446`
`446`	`447`
`447`		`-void ExportsTreeView::activateFirstItem()`
	`448`	`+void ExportsTreeView::activateSelection()`
`448`	`449`	`{`
`449`		`- exportDoubleClicked(m_model->index(0, 0, QModelIndex()));`
	`450`	`+ ensureSelection();`
	`451`	`+ if (auto current = currentIndex(); current.isValid())`
	`452`	`+ exportDoubleClicked(current);`
`450`	`453`	`}`
`451`	`454`
`452`	`455`
Original file line number	Diff line number	Diff line change
`@@ -343,15 +343,18 @@ void ImportsTreeView::scrollToCurrentItem()`
`343`	`343`	`}`
`344`	`344`
`345`	`345`
`346`		`-void ImportsTreeView::selectFirstItem()`
	`346`	`+void ImportsTreeView::ensureSelection()`
`347`	`347`	`{`
`348`		`- setCurrentIndex(m_model->index(0, 0, QModelIndex()));`
	`348`	`+ if (auto current = currentIndex(); !current.isValid())`
	`349`	`+ setCurrentIndex(m_model->index(0, 0, QModelIndex()));`
`349`	`350`	`}`
`350`	`351`
`351`	`352`
`352`		`-void ImportsTreeView::activateFirstItem()`
	`353`	`+void ImportsTreeView::activateSelection()`
`353`	`354`	`{`
`354`		`- importDoubleClicked(m_model->index(0, 0, QModelIndex()));`
	`355`	`+ ensureSelection();`
	`356`	`+ if (auto current = currentIndex(); current.isValid())`
	`357`	`+ importDoubleClicked(current);`
`355`	`358`	`}`
`356`	`359`
`357`	`360`
Original file line number	Diff line number	Diff line change
`@@ -288,15 +288,18 @@ void StringsTreeView::scrollToCurrentItem()`
`288`	`288`	`}`
`289`	`289`
`290`	`290`
`291`		`-void StringsTreeView::selectFirstItem()`
	`291`	`+void StringsTreeView::ensureSelection()`
`292`	`292`	`{`
`293`		`- setCurrentIndex(m_model->index(0, 0, QModelIndex()));`
	`293`	`+ if (auto current = currentIndex(); !current.isValid())`
	`294`	`+ setCurrentIndex(m_model->index(0, 0, QModelIndex()));`
`294`	`295`	`}`
`295`	`296`
`296`	`297`
`297`		`-void StringsTreeView::activateFirstItem()`
	`298`	`+void StringsTreeView::activateSelection()`
`298`	`299`	`{`
`299`		`- stringDoubleClicked(m_model->index(0, 0, QModelIndex()));`
	`300`	`+ ensureSelection();`
	`301`	`+ if (auto current = currentIndex(); current.isValid())`
	`302`	`+ stringDoubleClicked(current);`
`300`	`303`	`}`
`301`	`304`
`302`	`305`