NCBI C++ ToolKit
Public Member Functions | List of all members
IQueryWidget Class Reference

Search Toolkit Book for IQueryWidget

IQueryWidget. More...

#include <gui/objutils/query_widget.hpp>

+ Inheritance diagram for IQueryWidget:

Public Member Functions

 IQueryWidget ()
 
virtual ~IQueryWidget ()
 
virtual string GetSearchHelpAddr () const
 Return web-address for the help page that disusses help for the specific widget. More...
 
virtual void QueryStart ()
 Disable any widgets and/or set cursor/scroll as needed when query starts. More...
 
virtual void QueryEnd (CMacroQueryExec *exec)
 Re-enable widgets and/or set cursor/scroll as needed when query ends. More...
 
virtual void IterateSelection (int)
 go to next(1), previous(-1) or first(0) element from most recent query More...
 
virtual void SetSelectAll (bool)
 set to yes to show all queried elements as selected More...
 
virtual void SetHideUnselected (bool)
 set to true to hide/obscure elements not selected by most recent query More...
 
virtual void DlgOverlayFix (wxWindow *win)
 let widget send fake resize to fix windows opengl bug. More...
 

Detailed Description

IQueryWidget.

This are the interface requirements for a widget that wants to support the query interface currently defined by CQueryParsePanel. Interface allows query toolbar to tell widget to show/hide/iterate from the query selection set, and also to adjust the UI for the period while the query is running.

Definition at line 52 of file query_widget.hpp.

Constructor & Destructor Documentation

◆ IQueryWidget()

IQueryWidget::IQueryWidget ( )
inline

Definition at line 54 of file query_widget.hpp.

◆ ~IQueryWidget()

virtual IQueryWidget::~IQueryWidget ( )
inlinevirtual

Definition at line 55 of file query_widget.hpp.

Member Function Documentation

◆ DlgOverlayFix()

virtual void IQueryWidget::DlgOverlayFix ( wxWindow *  win)
inlinevirtual

◆ GetSearchHelpAddr()

virtual string IQueryWidget::GetSearchHelpAddr ( ) const
inlinevirtual

Return web-address for the help page that disusses help for the specific widget.

The default ("") will hide the help icon.

Reimplemented in CPhyloTreeWidget, and CGridWidget.

Definition at line 59 of file query_widget.hpp.

References string.

Referenced by CQueryParsePanel::CreateControls(), and CQueryParsePanel::OnSearchHelp().

◆ IterateSelection()

virtual void IQueryWidget::IterateSelection ( int  )
inlinevirtual

go to next(1), previous(-1) or first(0) element from most recent query

Reimplemented in CPhyloTreeWidget, and CGridWidget.

Definition at line 68 of file query_widget.hpp.

Referenced by CQueryParsePanel::OnButtonNext(), and CQueryParsePanel::OnButtonPrevious().

◆ QueryEnd()

virtual void IQueryWidget::QueryEnd ( CMacroQueryExec exec)
inlinevirtual

Re-enable widgets and/or set cursor/scroll as needed when query ends.

Reimplemented in CPhyloTreeWidget, and CGridWidget.

Definition at line 65 of file query_widget.hpp.

Referenced by CQueryParsePanel::CompleteQuery().

◆ QueryStart()

virtual void IQueryWidget::QueryStart ( )
inlinevirtual

Disable any widgets and/or set cursor/scroll as needed when query starts.

Reimplemented in CPhyloTreeWidget, and CGridWidget.

Definition at line 63 of file query_widget.hpp.

Referenced by CQueryParsePanel::x_ExecuteQuery().

◆ SetHideUnselected()

virtual void IQueryWidget::SetHideUnselected ( bool  )
inlinevirtual

set to true to hide/obscure elements not selected by most recent query

Reimplemented in CPhyloTreeWidget, and CGridWidget.

Definition at line 72 of file query_widget.hpp.

Referenced by CQueryParsePanel::OnToggleHideUnselected().

◆ SetSelectAll()

virtual void IQueryWidget::SetSelectAll ( bool  )
inlinevirtual

set to yes to show all queried elements as selected

Reimplemented in CPhyloTreeWidget, and CGridWidget.

Definition at line 70 of file query_widget.hpp.

Referenced by CQueryParsePanel::OnToggleSelectAll(), and CQueryParsePanel::SetDataSource().


The documentation for this class was generated from the following file:
Modified on Sun May 19 04:43:44 2024 by modify_doxy.py rev. 669887