Git-Mirrors/keepassxc
1
0
Fork 0
mirror of https://github.com/keepassxreboot/keepassxc.git synced 2025-08-06 05:24:13 -04:00
Code Issues Projects Releases Packages Wiki Activity

Add doc strings to EntrySearcher functions

Browse source
This commit is contained in:
Jonathan White 2019-02-24 18:52:25 -05:00
parent bbf678975f
commit ff87207cf4
1 changed files with 35 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

35
src/core/EntrySearcher.cpp
View file

@ -28,6 +28,15 @@ EntrySearcher::EntrySearcher(bool caseSensitive)
{ {
} }
/**
* Search group, and its children, by parsing the provided search
* string for search terms.
*
* @param searchString search terms
* @param baseGroup group to start search from, cannot be null
* @param forceSearch ignore group search settings
* @return list of entries that match the search terms
*/
QList<Entry*> EntrySearcher::search(const QString& searchString, const Group* baseGroup, bool forceSearch) QList<Entry*> EntrySearcher::search(const QString& searchString, const Group* baseGroup, bool forceSearch)
{ {
Q_ASSERT(baseGroup); Q_ASSERT(baseGroup);
@ -36,6 +45,13 @@ QList<Entry*> EntrySearcher::search(const QString& searchString, const Group* ba
return repeat(baseGroup, forceSearch); return repeat(baseGroup, forceSearch);
} }
/**
* Repeat the last search starting from the given group
*
* @param baseGroup group to start search from, cannot be null
* @param forceSearch ignore group search settings
* @return list of entries that match the search terms
*/
QList<Entry*> EntrySearcher::repeat(const Group* baseGroup, bool forceSearch) QList<Entry*> EntrySearcher::repeat(const Group* baseGroup, bool forceSearch)
{ {
Q_ASSERT(baseGroup); Q_ASSERT(baseGroup);
@ -53,12 +69,26 @@ QList<Entry*> EntrySearcher::repeat(const Group* baseGroup, bool forceSearch)
return results; return results;
} }
/**
* Search provided entries by parsing the search string
* for search terms.
*
* @param searchString search terms
* @param entries list of entries to include in the search
* @return list of entries that match the search terms
*/
QList<Entry*> EntrySearcher::searchEntries(const QString& searchString, const QList<Entry*>& entries) QList<Entry*> EntrySearcher::searchEntries(const QString& searchString, const QList<Entry*>& entries)
{ {
parseSearchTerms(searchString); parseSearchTerms(searchString);
return repeatEntries(entries); return repeatEntries(entries);
} }
/**
* Repeat the last search on the given entries
*
* @param entries list of entries to include in the search
* @return list of entries that match the search terms
*/
QList<Entry*> EntrySearcher::repeatEntries(const QList<Entry*>& entries) QList<Entry*> EntrySearcher::repeatEntries(const QList<Entry*>& entries)
{ {
QList<Entry*> results; QList<Entry*> results;
@ -70,6 +100,11 @@ QList<Entry*> EntrySearcher::repeatEntries(const QList<Entry*>& entries)
return results; return results;
} }
/**
* Set the next search to be case sensitive or not
*
* @param state
*/
void EntrySearcher::setCaseSensitive(bool state) void EntrySearcher::setCaseSensitive(bool state)
{ {
m_caseSensitive = state; m_caseSensitive = state;