![]() |
LeechCraft
%{LEECHCRAFT_VERSION}
Modular cross-platform feature rich live environment.
|
A horizontal bar with typical widgets for text search. More...
#include "findnotification.h"
Public Types | |
enum | FindFlag { FindNoFlags = 0x0, FindCaseSensitively = 0x1, FindBackwards = 0x2, FindWrapsAround = 0x4 } |
Public Slots | |
void | findNext () |
Search for the next occurrence of the current search. More... | |
void | findPrevious () |
Search for the previous occurrence of the current search. More... | |
void | clear () |
Clears the text in the find field. More... | |
Public Member Functions | |
FindNotification (ICoreProxy_ptr proxy, QWidget *near) | |
Creates the search widget in parent layout of near. More... | |
~FindNotification () | |
void | SetEscCloses (bool close) |
Sets whether Esc closes the widget. More... | |
void | SetText (const QString &text) |
Sets the text in the find field. More... | |
QString | GetText () const |
Returns the currently entered text in the find field. More... | |
void | SetSuccessful (bool successful) |
Updates the widget to show whether the search has been successful. More... | |
FindFlags | GetFlags () const |
Returns the current find flags except the direction. More... | |
![]() | |
PageNotification (QWidget *parent) | |
Creates the widget embedding into the parent layout of the parent widget. More... | |
Protected Member Functions | |
virtual void | handleNext (const QString &text, FindFlags flags)=0 |
Called each time the user requests a search. More... | |
A horizontal bar with typical widgets for text search.
This widget provides typical features for text searching: a text input field, checkboxes for selecting find mode and buttons for searching and closing the notification, as well as convenience slots findNext() and findPrevious().
The widget will automatically be embedded into the layout of the parent widget of near after the near widget (which is passed to the constructor).
This class is typically used as following:
QWebPage::findText()
. The implementation may also call SetSuccessful() to indicate whether anything has been found.triggered()
signal is connected to this class' show() and setFocus() slots (latter is needed so that user can start typing his search query immediately).The FindNotificationWk class provides some utilities to aid integrating this class with a QWebPage.
Definition at line 83 of file findnotification.h.
LeechCraft::Util::FindNotification::FindNotification | ( | ICoreProxy_ptr | proxy, |
QWidget * | near | ||
) |
Creates the search widget in parent layout of near.
Embedding is done only if possible — that is, if parent's layout is QVBoxLayout. Otherwise one should place this widget where needed himself.
[in] | proxy | The core proxy to be used by this find notification. |
[in] | near | The widget near which to embed. |
Definition at line 39 of file findnotification.cpp.
LeechCraft::Util::FindNotification::~FindNotification | ( | ) |
Definition at line 53 of file findnotification.cpp.
|
slot |
Clears the text in the find field.
This is equivalent to SetText ({})
.
Definition at line 125 of file findnotification.cpp.
References SetText().
|
slot |
Search for the next occurrence of the current search.
Definition at line 107 of file findnotification.cpp.
References GetFlags(), GetText(), and handleNext().
|
slot |
Search for the previous occurrence of the current search.
Definition at line 116 of file findnotification.cpp.
References FindBackwards, GetFlags(), GetText(), and handleNext().
auto LeechCraft::Util::FindNotification::GetFlags | ( | ) | const |
Returns the current find flags except the direction.
Please note that the direction flag (FindBackwards) never appears in the return result.
Definition at line 97 of file findnotification.cpp.
References FindCaseSensitively, and FindWrapsAround.
Referenced by findNext(), and findPrevious().
QString LeechCraft::Util::FindNotification::GetText | ( | ) | const |
Returns the currently entered text in the find field.
Definition at line 68 of file findnotification.cpp.
Referenced by findNext(), and findPrevious().
|
protectedpure virtual |
Called each time the user requests a search.
Reimplement this function to perform the actual search.
[in] | text | The text to search for. |
[in] | flags | The flags to search with. |
Implemented in LeechCraft::Util::FindNotificationWk.
Referenced by findNext(), and findPrevious().
void LeechCraft::Util::FindNotification::SetEscCloses | ( | bool | close | ) |
Sets whether Esc closes the widget.
[in] | close | Whether pressing Esc button closes the widget. |
Definition at line 58 of file findnotification.cpp.
void LeechCraft::Util::FindNotification::SetSuccessful | ( | bool | successful | ) |
Updates the widget to show whether the search has been successful.
[in] | successful | Whether the search has been successful. |
Definition at line 73 of file findnotification.cpp.
Referenced by LeechCraft::Util::FindNotificationWk::handleNext().
void LeechCraft::Util::FindNotification::SetText | ( | const QString & | text | ) |
Sets the text in the find field.
[in] | text | The text to set in find field. |
Definition at line 63 of file findnotification.cpp.
Referenced by clear().