CSearchFormBase Class Reference

Search Toolkit Book for CSearchFormBase

#include <search_form_base.hpp>

Inheritance diagram for CSearchFormBase:

[legend]Collaboration diagram for CSearchFormBase:

[legend]List of all members.

---

Detailed Description

CSearchFormBase.

Definition at line 63 of file search_form_base.hpp.

Public Types
typedef vector< IDataMiningContext * >	TContexts
typedef CMRUList< string >	TMRUInputs
typedef objects::CFeatListItem	TFeatTypeItem
typedef set< TFeatTypeItem >	TFeatTypeItemSet
typedef CSearchToolBase::EPatternType	TPatternType
typedef map< string, TPatternType >	TNameToType
Public Member Functions
	CSearchFormBase ()
	CSearchFormBase.
virtual	~CSearchFormBase ()
virtual void	SetController (IDMSearchFormController *controller)
virtual IDMSearchTool *	x_GetTool ()=0
virtual wxSizer *	GetWidget (wxWindow *parent)
	return a widget associated with the form; the form controls the lifetime of the widget (do not delete the widget)
virtual CIRef< IDMSearchQuery >	ConstructQuery ()
virtual void	UpdateContexts ()
	updates m_ContextCombo
void	UpdateContextCombo (wxChoice *combo)
virtual void	PopupADialog (TDialogType dt)
	popup a dialog for additional info
virtual void	SetDictionary (list< string > *ddd)
virtual void	Push ()
virtual void	SetRangeLimit (bool bLimit)
virtual string	GetMainValue ()
	get/set main search value, this is separate from settings
virtual void	SetMainValue (string val)
virtual void	SetRegistryPath (const string &reg_path)
virtual void	LoadSettings ()
virtual void	SaveSettings () const
Protected Member Functions
virtual void	x_LoadSettings (CGuiRegistry::TReadView &view)
virtual void	x_SaveSettings (CGuiRegistry::TReadWriteView &view) const
Protected Attributes
TContexts	m_Contexts
IDataMiningContext *	m_ActiveContext
TFeatTypeItemSet	m_FeatTypesSet
IDMSearchFormController *	m_Controller
wxSizer *	m_Sizer
CSearchControl *	m_Text
string	m_RegPath
string	m_Input
bool	m_bRange
Private Member Functions
	CSearchFormBase (const CSearchFormBase &)
CSearchFormBase &	operator= (const CSearchFormBase &)

---

Member Typedef Documentation

typedef vector<IDataMiningContext*> CSearchFormBase::TContexts

Definition at line 68 of file search_form_base.hpp.

typedef objects::CFeatListItem CSearchFormBase::TFeatTypeItem

Reimplemented in CFeatureSearchForm. Definition at line 71 of file search_form_base.hpp.

typedef set<TFeatTypeItem> CSearchFormBase::TFeatTypeItemSet

Reimplemented in CFeatureSearchForm. Definition at line 72 of file search_form_base.hpp.

typedef CMRUList<string> CSearchFormBase::TMRUInputs

Definition at line 69 of file search_form_base.hpp.

typedef map<string, TPatternType> CSearchFormBase::TNameToType

Reimplemented in CSeqLocFormBase. Definition at line 75 of file search_form_base.hpp.

typedef CSearchToolBase::EPatternType CSearchFormBase::TPatternType

Reimplemented in CSeqLocFormBase, CFeatureSearchForm, and CSequenceSearchForm. Definition at line 74 of file search_form_base.hpp.

---

Constructor & Destructor Documentation

CSearchFormBase::CSearchFormBase (   )

CSearchFormBase. Definition at line 327 of file search_form_base.cpp. References CSeqFeatData_Base::e_Cdregion, CSeqFeatData_Base::e_Gene, CSeqFeatData_Base::e_Rna, CFeatListItem::GetDescription(), CSeqFeatData::GetFeatList(), CFeatListItem::GetType(), set< Key, Compare >::insert(), ITERATE, and m_FeatTypesSet.

CSearchFormBase::~CSearchFormBase (   )  [virtual]

Definition at line 350 of file search_form_base.cpp.

CSearchFormBase::CSearchFormBase (  const CSearchFormBase &   )  [private]

---

Member Function Documentation

CIRef< IDMSearchQuery > CSearchFormBase::ConstructQuery (   )  [virtual]

Implements IDMSearchForm. Reimplemented in CNetBLAST_DMSearchForm, CComponentSearchForm, CCpgSearchForm, CEntrezSearchForm, CFeatureSearchForm, COrfSearchForm, and CSequenceSearchForm. Definition at line 379 of file search_form_base.cpp.

string CSearchFormBase::GetMainValue (   )  [virtual]

get/set main search value, this is separate from settings Reimplemented from IDMSearchForm. Definition at line 520 of file search_form_base.cpp. References m_Text, and ToStdString().

wxSizer * CSearchFormBase::GetWidget (  wxWindow *  parent  )  [virtual]

return a widget associated with the form; the form controls the lifetime of the widget (do not delete the widget) Reimplemented from IDMSearchForm. Reimplemented in CNetBLAST_DMSearchForm, CComponentSearchForm, CCpgSearchForm, CEntrezSearchForm, CFeatureSearchForm, COrfSearchForm, and CSequenceSearchForm. Definition at line 373 of file search_form_base.cpp.

void CSearchFormBase::LoadSettings (   )  [virtual]

Implements IDMSearchForm. Reimplemented in CSeqLocFormBase. Definition at line 498 of file search_form_base.cpp. References CGuiRegistry::GetInstance(), CGuiRegistry::GetReadView(), m_RegPath, and x_LoadSettings().

CSearchFormBase& CSearchFormBase::operator= (  const CSearchFormBase &   )  [private]

void CSearchFormBase::PopupADialog (  TDialogType  dt  )  [virtual]

popup a dialog for additional info Definition at line 470 of file search_form_base.cpp. References IDMSearchForm::FEATURE_SEL_DIALOG, CFeatureCheckDialog::GetSelected(), m_FeatTypesSet, m_RegPath, CFeatureCheckDialog::SetRegistryPath(), CFeatureCheckDialog::SetSelected(), and CFeatureCheckDialog::ShowModal().

void CSearchFormBase::Push (   )  [virtual]

Implements IDMSearchForm. Definition at line 360 of file search_form_base.cpp. References m_Text, and CSearchControl::Push().

void CSearchFormBase::SaveSettings (   )  const [virtual]

Implements IDMSearchForm. Reimplemented in CSeqLocFormBase. Definition at line 509 of file search_form_base.cpp. References CGuiRegistry::GetInstance(), CGuiRegistry::GetReadWriteView(), m_RegPath, and x_SaveSettings().

void CSearchFormBase::SetController (  IDMSearchFormController *  controller  )  [virtual]

Reimplemented from IDMSearchForm. Definition at line 355 of file search_form_base.cpp. References m_Controller.

void CSearchFormBase::SetDictionary (  list< string > *  ddd  )  [virtual]

Implements IDMSearchForm. Definition at line 484 of file search_form_base.cpp. References m_Text, and CSearchControl::SetDictionary().

void CSearchFormBase::SetMainValue (  string  val  )  [virtual]

Reimplemented from IDMSearchForm. Definition at line 525 of file search_form_base.cpp. References m_Text, and ToWxString().

void CSearchFormBase::SetRangeLimit (  bool  bLimit  )  [virtual]

Implements IDMSearchForm. Definition at line 367 of file search_form_base.cpp. References m_bRange.

void CSearchFormBase::SetRegistryPath (  const string &  reg_path  )  [virtual]

Implements IDMSearchForm. Definition at line 492 of file search_form_base.cpp. References m_RegPath.

void CSearchFormBase::UpdateContextCombo (  wxChoice *  combo  )

Definition at line 442 of file search_form_base.cpp. References _T, IDataMiningContext::GetDMContextName(), NStr::IntToString(), m_ActiveContext, m_Contexts, and ToWxString(). Referenced by CSequenceSearchForm::Update(), COrfSearchForm::Update(), CFeatureSearchForm::Update(), CCpgSearchForm::Update(), and CComponentSearchForm::Update().

void CSearchFormBase::UpdateContexts (   )  [virtual]

updates m_ContextCombo create a list of compatible contexts Add "Active" Context now add all the compatible contexts initilize the ComboBox with the list of context names Implements IDMSearchForm. Reimplemented in CNetBLAST_DMSearchForm, CComponentSearchForm, CCpgSearchForm, CEntrezSearchForm, CFeatureSearchForm, and CSequenceSearchForm. Definition at line 387 of file search_form_base.cpp. References CDataMiningService::GetContexts(), IDMSearchFormController::GetDataMiningService(), CDataMiningService::GetLastActiveContext(), IDMSearchTool::IsCompatible(), m_ActiveContext, m_Contexts, m_Controller, and x_GetTool(). Referenced by CSequenceSearchForm::UpdateContexts(), CFeatureSearchForm::UpdateContexts(), CEntrezSearchForm::UpdateContexts(), CCpgSearchForm::UpdateContexts(), CComponentSearchForm::UpdateContexts(), and CNetBLAST_DMSearchForm::UpdateContexts().

virtual IDMSearchTool* CSearchFormBase::x_GetTool (   )  [pure virtual]

Implemented in CNetBLAST_DMSearchForm, CComponentSearchForm, CCpgSearchForm, CEntrezSearchForm, CFeatureSearchForm, COrfSearchForm, and CSequenceSearchForm. Referenced by UpdateContexts().

virtual void CSearchFormBase::x_LoadSettings (  CGuiRegistry::TReadView &  view  )  [inline, protected, virtual]

Reimplemented in CNetBLAST_DMSearchForm, CCpgSearchForm, CEntrezSearchForm, CFeatureSearchForm, COrfSearchForm, and CSequenceSearchForm. Definition at line 105 of file search_form_base.hpp. Referenced by LoadSettings(), CSequenceSearchForm::x_LoadSettings(), COrfSearchForm::x_LoadSettings(), CFeatureSearchForm::x_LoadSettings(), CEntrezSearchForm::x_LoadSettings(), CCpgSearchForm::x_LoadSettings(), and CNetBLAST_DMSearchForm::x_LoadSettings().

virtual void CSearchFormBase::x_SaveSettings (  CGuiRegistry::TReadWriteView &  view  )  const [inline, protected, virtual]

Reimplemented in CNetBLAST_DMSearchForm, CCpgSearchForm, CEntrezSearchForm, CFeatureSearchForm, COrfSearchForm, and CSequenceSearchForm. Definition at line 106 of file search_form_base.hpp. Referenced by SaveSettings(), CSequenceSearchForm::x_SaveSettings(), COrfSearchForm::x_SaveSettings(), CFeatureSearchForm::x_SaveSettings(), CEntrezSearchForm::x_SaveSettings(), CCpgSearchForm::x_SaveSettings(), and CNetBLAST_DMSearchForm::x_SaveSettings().

---

Member Data Documentation

IDataMiningContext* CSearchFormBase::m_ActiveContext [protected]

Definition at line 110 of file search_form_base.hpp. Referenced by UpdateContextCombo(), and UpdateContexts().

bool CSearchFormBase::m_bRange [protected]

Definition at line 118 of file search_form_base.hpp. Referenced by SetRangeLimit().

TContexts CSearchFormBase::m_Contexts [protected]

Definition at line 109 of file search_form_base.hpp. Referenced by CSequenceSearchForm::ConstructQuery(), COrfSearchForm::ConstructQuery(), CFeatureSearchForm::ConstructQuery(), CCpgSearchForm::ConstructQuery(), CComponentSearchForm::ConstructQuery(), UpdateContextCombo(), and UpdateContexts().

IDMSearchFormController* CSearchFormBase::m_Controller [protected]

Definition at line 112 of file search_form_base.hpp. Referenced by SetController(), CEntrezSearchForm::UpdateContexts(), CNetBLAST_DMSearchForm::UpdateContexts(), and UpdateContexts().

TFeatTypeItemSet CSearchFormBase::m_FeatTypesSet [protected]

Definition at line 111 of file search_form_base.hpp. Referenced by CSearchFormBase(), PopupADialog(), CFeatureSearchForm::Update(), CFeatureSearchForm::x_LoadSettings(), and CFeatureSearchForm::x_SaveSettings().

string CSearchFormBase::m_Input [protected]

Definition at line 117 of file search_form_base.hpp.

string CSearchFormBase::m_RegPath [protected]

Definition at line 115 of file search_form_base.hpp. Referenced by LoadSettings(), PopupADialog(), SaveSettings(), and SetRegistryPath().

wxSizer* CSearchFormBase::m_Sizer [protected]

Definition at line 113 of file search_form_base.hpp. Referenced by CSequenceSearchForm::GetWidget(), COrfSearchForm::GetWidget(), CFeatureSearchForm::GetWidget(), CEntrezSearchForm::GetWidget(), CCpgSearchForm::GetWidget(), CComponentSearchForm::GetWidget(), CNetBLAST_DMSearchForm::GetWidget(), and CSequenceSearchForm::Update().

CSearchControl* CSearchFormBase::m_Text [protected]

Definition at line 114 of file search_form_base.hpp. Referenced by CEntrezSearchForm::ConstructQuery(), GetMainValue(), CSequenceSearchForm::GetWidget(), CFeatureSearchForm::GetWidget(), CEntrezSearchForm::GetWidget(), CComponentSearchForm::GetWidget(), Push(), SetDictionary(), and SetMainValue().

---

The documentation for this class was generated from the following files:

• include/gui/core/search_form_base.hpp
• src/gui/core/search_form_base.cpp

---