NCBI C++ ToolKit
Public Types | Public Member Functions | List of all members
IDMSearchForm Class Referenceabstract

Search Toolkit Book for IDMSearchForm

IDMSearchForm - interface for abstract Search From. More...

#include <gui/core/dm_search_tool.hpp>

+ Inheritance diagram for IDMSearchForm:
+ Collaboration diagram for IDMSearchForm:

Public Types

enum  ECommands { eCmdDMSearch = 11000 }
 
enum  TDialogType { FEATURE_SEL_DIALOG }
 

Public Member Functions

virtual ~IDMSearchForm ()
 
virtual void SetController (IDMSearchFormController *)
 
virtual void Create ()
 
virtual void Init ()
 
virtual void Update ()=0
 
virtual wxSizer * GetWidget (wxWindow *)
 return a widget associated with the form; the form controls the lifetime of the widget (do not delete the widget) More...
 
virtual void UpdateContexts ()=0
 called by Data Mining View to update the list of search contexts More...
 
virtual void PopupADialog (TDialogType dt)=0
 ask something in dialog More...
 
virtual bool IsRunning () const
 the tool associated with the form is running More...
 
virtual string GetCurrentModeKey ()
 return a section name for the current mode or "" More...
 
virtual string GetMainValue ()
 get/set main search value, this is separate from settings More...
 
virtual void SetMainValue (string)
 
virtual void Push ()=0
 
virtual void SetDictionary (list< string > *)=0
 
virtual void SetRangeLimit (bool bLimit)=0
 
virtual CIRef< IDMSearchQueryConstructQuery ()=0
 
IRegSettings interface
virtual void SetRegistryPath (const string &reg_path)=0
 
virtual void LoadSettings ()=0
 
virtual void SaveSettings () const =0
 
- Public Member Functions inherited from IRegSettings
virtual ~IRegSettings ()
 

Detailed Description

IDMSearchForm - interface for abstract Search From.

Definition at line 206 of file dm_search_tool.hpp.

Member Enumeration Documentation

◆ ECommands

Enumerator
eCmdDMSearch 

Definition at line 209 of file dm_search_tool.hpp.

◆ TDialogType

Enumerator
FEATURE_SEL_DIALOG 

Definition at line 214 of file dm_search_tool.hpp.

Constructor & Destructor Documentation

◆ ~IDMSearchForm()

virtual IDMSearchForm::~IDMSearchForm ( )
inlinevirtual

Definition at line 218 of file dm_search_tool.hpp.

Member Function Documentation

◆ ConstructQuery()

virtual CIRef<IDMSearchQuery> IDMSearchForm::ConstructQuery ( )
pure virtual

◆ Create()

virtual void IDMSearchForm::Create ( void  )
inlinevirtual

◆ GetCurrentModeKey()

virtual string IDMSearchForm::GetCurrentModeKey ( )
inlinevirtual

return a section name for the current mode or ""

Definition at line 242 of file dm_search_tool.hpp.

◆ GetMainValue()

virtual string IDMSearchForm::GetMainValue ( )
inlinevirtual

get/set main search value, this is separate from settings

Reimplemented in CSearchFormBase.

Definition at line 245 of file dm_search_tool.hpp.

◆ GetWidget()

virtual wxSizer* IDMSearchForm::GetWidget ( wxWindow *  )
inlinevirtual

return a widget associated with the form; the form controls the lifetime of the widget (do not delete the widget)

Reimplemented in CVcfSearchForm, CSequenceSearchForm, COrfSearchForm, CFeatureSearchForm, CEntrezSearchForm, CCpgSearchForm, CComponentSearchForm, CSNPSearchForm, CNetBLAST_DMSearchForm, and CSearchFormBase.

Definition at line 228 of file dm_search_tool.hpp.

References NULL.

◆ Init()

virtual void IDMSearchForm::Init ( void  )
inlinevirtual

◆ IsRunning()

virtual bool IDMSearchForm::IsRunning ( void  ) const
inlinevirtual

the tool associated with the form is running

Definition at line 239 of file dm_search_tool.hpp.

◆ LoadSettings()

virtual void IDMSearchForm::LoadSettings ( )
pure virtual

Implements IRegSettings.

Implemented in CSeqLocFormBase, and CSearchFormBase.

◆ PopupADialog()

virtual void IDMSearchForm::PopupADialog ( TDialogType  dt)
pure virtual

ask something in dialog

Implemented in CSearchFormBase.

◆ Push()

virtual void IDMSearchForm::Push ( )
pure virtual

Implemented in CSearchFormBase.

◆ SaveSettings()

virtual void IDMSearchForm::SaveSettings ( ) const
pure virtual

Implements IRegSettings.

Implemented in CSeqLocFormBase, and CSearchFormBase.

◆ SetController()

virtual void IDMSearchForm::SetController ( IDMSearchFormController )
inlinevirtual

Reimplemented in CSearchFormBase.

Definition at line 220 of file dm_search_tool.hpp.

◆ SetDictionary()

virtual void IDMSearchForm::SetDictionary ( list< string > *  )
pure virtual

Implemented in CSearchFormBase, and CEntrezSearchForm.

◆ SetMainValue()

virtual void IDMSearchForm::SetMainValue ( string  )
inlinevirtual

Reimplemented in CEntrezSearchForm, and CSearchFormBase.

Definition at line 246 of file dm_search_tool.hpp.

◆ SetRangeLimit()

virtual void IDMSearchForm::SetRangeLimit ( bool  bLimit)
pure virtual

Implemented in CSearchFormBase.

◆ SetRegistryPath()

virtual void IDMSearchForm::SetRegistryPath ( const string reg_path)
pure virtual

Implements IRegSettings.

Implemented in CSearchFormBase.

◆ Update()

virtual void IDMSearchForm::Update ( )
pure virtual

◆ UpdateContexts()

virtual void IDMSearchForm::UpdateContexts ( )
pure virtual

called by Data Mining View to update the list of search contexts

Implemented in CVcfSearchForm, CSequenceSearchForm, CFeatureSearchForm, CEntrezSearchForm, CCpgSearchForm, CComponentSearchForm, CSNPSearchForm, CNetBLAST_DMSearchForm, and CSearchFormBase.


The documentation for this class was generated from the following file:
Modified on Tue May 28 05:49:54 2024 by modify_doxy.py rev. 669887