CMacroStringConstraintPanel Class Reference

Search Toolkit Book for CMacroStringConstraintPanel

#include <gui/packages/pkg_sequence_edit/suspect_product_rule_editor.hpp>

Inheritance diagram for CMacroStringConstraintPanel:

Collaboration diagram for CMacroStringConstraintPanel:

Public Types
enum	EMatchType {   eMatchType_Contains = 0 , eMatchType_DoesNotContain , eMatchType_Equals , eMatchType_DoesNotEqual ,   eMatchType_StartsWith , eMatchType_EndsWith , eMatchType_IsOneOf , eMatchType_IsNotOneOf ,   eMatchType_DoesNotStartWith , eMatchType_DoesNotEndWith }

Public Member Functions
	CMacroStringConstraintPanel ()
	Constructors. More...
	CMacroStringConstraintPanel (wxWindow *parent, wxWindowID id=wxID_ANY, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxTAB_TRAVERSAL)
bool	Create (wxWindow *parent, wxWindowID id=wxID_ANY, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxTAB_TRAVERSAL)
	Creation. More...
	~CMacroStringConstraintPanel ()
	Destructor. More...
void	Init ()
	Initialises member variables. More...
void	CreateControls ()
	Creates the controls and sizers. More...
void	OnClear (wxCommandEvent &event)
void	OnMatchTypeSelected (wxCommandEvent &event)
void	OnWordSubstitution (wxCommandEvent &event)
void	ClearValues (void)
void	SetChoices (const vector< string > &choices)
void	ShowChoiceOrText (void)
wxBitmap	GetBitmapResource (const wxString &name)
	Retrieves bitmap resources. More...
wxIcon	GetIconResource (const wxString &name)
	Retrieves icon resources. More...
CRef< objects::CString_constraint >	GetStringConstraint ()
virtual void	AddWordSubstSet (CRef< objects::CWord_substitution_set > word_subst)
virtual CRef< CSearch_func >	GetSearchFunc ()
virtual void	SetSearchFunc (const CSearch_func &search_func)
Public Member Functions inherited from CWordSubstitutionSetConsumer
virtual	~CWordSubstitutionSetConsumer ()
Public Member Functions inherited from CSearch_func_provider
virtual	~CSearch_func_provider ()

Static Public Member Functions
static bool	ShowToolTips ()
	Should we show tooltips? More...

Private Attributes
wxChoice *	m_MatchType
wxTextCtrl *	m_MatchText
wxCheckBox *	m_IgnoreCase
wxCheckBox *	m_IgnoreSpace
wxCheckBox *	m_WholeWord
wxCheckBox *	m_IgnorePunct
wxCheckBox *	m_IgnoreSyn
wxRadioButton *	m_AnyLetters
wxRadioButton *	m_AllUpper
wxRadioButton *	m_AllLower
wxRadioButton *	m_AllPunct
wxComboBox *	m_MatchChoice
wxButton *	m_ClearButton
wxButton *	m_WordSubst
wxBoxSizer *	m_TextSizer
bool	m_is_choice
CRef< objects::CWord_substitution_set >	m_word_subst

Detailed Description

CMacroStringConstraintPanel class declaration

Definition at line 247 of file suspect_product_rule_editor.hpp.

Member Enumeration Documentation

EMatchType

enum CMacroStringConstraintPanel::EMatchType

Enumerator
eMatchType_Contains
eMatchType_DoesNotContain
eMatchType_Equals
eMatchType_DoesNotEqual
eMatchType_StartsWith
eMatchType_EndsWith
eMatchType_IsOneOf
eMatchType_IsNotOneOf
eMatchType_DoesNotStartWith
eMatchType_DoesNotEndWith

Definition at line 284 of file suspect_product_rule_editor.hpp.

Constructor & Destructor Documentation

CMacroStringConstraintPanel() [1/2]

CMacroStringConstraintPanel::CMacroStringConstraintPanel

(

)

Constructors.

CMacroStringConstraintPanel constructors

Definition at line 1357 of file suspect_product_rule_editor.cpp.

References Init().

CMacroStringConstraintPanel() [2/2]

CMacroStringConstraintPanel::CMacroStringConstraintPanel	(	wxWindow *	parent,
		wxWindowID	id = wxID_ANY,
		const wxPoint &	pos = wxDefaultPosition,
		const wxSize &	size = wxDefaultSize,
		long	style = wxTAB_TRAVERSAL
	)

Definition at line 1362 of file suspect_product_rule_editor.cpp.

References Create(), Init(), and ncbi::grid::netcache::search::fields::size.

~CMacroStringConstraintPanel()

CMacroStringConstraintPanel::~CMacroStringConstraintPanel

(

)

Destructor.

CMacroStringConstraintPanel destructor

Definition at line 1393 of file suspect_product_rule_editor.cpp.

Member Function Documentation

AddWordSubstSet()

void CMacroStringConstraintPanel::AddWordSubstSet ( CRef< objects::CWord_substitution_set >  word_subst )

virtual

Implements CWordSubstitutionSetConsumer.

Definition at line 1767 of file suspect_product_rule_editor.cpp.

References m_word_subst.

ClearValues()

void CMacroStringConstraintPanel::ClearValues

(

void

)

Definition at line 1532 of file suspect_product_rule_editor.cpp.

References _, m_AllLower, m_AllPunct, m_AllUpper, m_AnyLetters, m_IgnoreCase, m_IgnorePunct, m_IgnoreSpace, m_IgnoreSyn, m_is_choice, m_MatchChoice, m_MatchText, m_MatchType, m_TextSizer, m_WholeWord, m_word_subst, and CRef< C, Locker >::Reset().

Referenced by OnClear().

Create()

bool CMacroStringConstraintPanel::Create	(	wxWindow *	parent,
		wxWindowID	id = wxID_ANY,
		const wxPoint &	pos = wxDefaultPosition,
		const wxSize &	size = wxDefaultSize,
		long	style = wxTAB_TRAVERSAL
	)

Creation.

CMacroStringConstraintPanel creator

Definition at line 1372 of file suspect_product_rule_editor.cpp.

References CreateControls(), ShowChoiceOrText(), and ncbi::grid::netcache::search::fields::size.

Referenced by CMacroStringConstraintPanel().

CreateControls()

void CMacroStringConstraintPanel::CreateControls

(

)

Creates the controls and sizers.

Control creation for CMacroStringConstraintPanel

Definition at line 1429 of file suspect_product_rule_editor.cpp.

References _, m_AllLower, m_AllPunct, m_AllUpper, m_AnyLetters, m_ClearButton, m_IgnoreCase, m_IgnorePunct, m_IgnoreSpace, m_IgnoreSyn, m_MatchChoice, m_MatchText, m_MatchType, m_TextSizer, m_WholeWord, m_WordSubst, OnMatchTypeSelected(), SYMBOL_CMACROSTRINGCONSTRAINTPANEL_CLEAR_ID, SYMBOL_CMACROSTRINGCONSTRAINTPANEL_WORD_SUBST_ID, and wxID_ANY.

Referenced by Create().

GetBitmapResource()

wxBitmap CMacroStringConstraintPanel::GetBitmapResource

(

const wxString &

name

)

Retrieves bitmap resources.

Get bitmap resources

Definition at line 1612 of file suspect_product_rule_editor.cpp.

GetIconResource()

wxIcon CMacroStringConstraintPanel::GetIconResource

(

const wxString &

name

)

Retrieves icon resources.

Get icon resources

Definition at line 1624 of file suspect_product_rule_editor.cpp.

GetSearchFunc()

CRef< CSearch_func > CMacroStringConstraintPanel::GetSearchFunc ( )

virtual

Implements CSearch_func_provider.

Definition at line 1699 of file suspect_product_rule_editor.cpp.

References CString_constraint::Empty(), GetStringConstraint(), CRef< C, Locker >::Reset(), and CSearch_func_Base::SetString_constraint().

GetStringConstraint()

CRef< CString_constraint > CMacroStringConstraintPanel::GetStringConstraint

(

void

)

Definition at line 1633 of file suspect_product_rule_editor.cpp.

References eMatchType_Contains, eMatchType_DoesNotContain, eMatchType_DoesNotEndWith, eMatchType_DoesNotEqual, eMatchType_DoesNotStartWith, eMatchType_EndsWith, eMatchType_Equals, eMatchType_IsNotOneOf, eMatchType_IsOneOf, eMatchType_StartsWith, eString_location_contains, eString_location_ends, eString_location_equals, eString_location_inlist, eString_location_starts, m_AllLower, m_AllPunct, m_AllUpper, m_IgnoreCase, m_IgnorePunct, m_IgnoreSpace, m_IgnoreSyn, m_is_choice, m_MatchChoice, m_MatchText, m_MatchType, m_WholeWord, m_word_subst, NStr::Replace(), CRef< C, Locker >::Reset(), CString_constraint_Base::SetCase_sensitive(), CString_constraint_Base::SetIgnore_punct(), CString_constraint_Base::SetIgnore_space(), CString_constraint_Base::SetIgnore_weasel(), CString_constraint_Base::SetIgnore_words(), CString_constraint_Base::SetIs_all_caps(), CString_constraint_Base::SetIs_all_lower(), CString_constraint_Base::SetIs_all_punct(), CString_constraint_Base::SetMatch_location(), CString_constraint::SetMatch_text(), CString_constraint_Base::SetNot_present(), CString_constraint_Base::SetWhole_word(), ToStdString(), and NStr::TruncateSpaces().

Referenced by GetSearchFunc().

Init()

void CMacroStringConstraintPanel::Init

(

void

)

Initialises member variables.

Member initialisation

Definition at line 1403 of file suspect_product_rule_editor.cpp.

References m_AllLower, m_AllPunct, m_AllUpper, m_AnyLetters, m_ClearButton, m_IgnoreCase, m_IgnorePunct, m_IgnoreSpace, m_IgnoreSyn, m_is_choice, m_MatchChoice, m_MatchText, m_MatchType, m_TextSizer, m_WholeWord, m_WordSubst, and NULL.

Referenced by CMacroStringConstraintPanel().

OnClear()

void CMacroStringConstraintPanel::OnClear

(

wxCommandEvent &

event

)

Definition at line 1527 of file suspect_product_rule_editor.cpp.

References ClearValues().

OnMatchTypeSelected()

void CMacroStringConstraintPanel::OnMatchTypeSelected

(

wxCommandEvent &

event

)

Definition at line 1595 of file suspect_product_rule_editor.cpp.

References ShowChoiceOrText().

Referenced by CreateControls().

OnWordSubstitution()

void CMacroStringConstraintPanel::OnWordSubstitution

(

wxCommandEvent &

event

)

Definition at line 1761 of file suspect_product_rule_editor.cpp.

References m_word_subst.

SetChoices()

void CMacroStringConstraintPanel::SetChoices

(

const vector< string > &

choices

)

Definition at line 1557 of file suspect_product_rule_editor.cpp.

References ITERATE, m_MatchChoice, ShowChoiceOrText(), and ToWxString().

SetSearchFunc()

void CMacroStringConstraintPanel::SetSearchFunc ( const CSearch_func &  search_func )

virtual

Implements CSearch_func_provider.

Definition at line 1710 of file suspect_product_rule_editor.cpp.

References eMatchType_Contains, eMatchType_DoesNotContain, eMatchType_DoesNotEndWith, eMatchType_DoesNotEqual, eMatchType_DoesNotStartWith, eMatchType_EndsWith, eMatchType_Equals, eMatchType_IsNotOneOf, eMatchType_IsOneOf, eMatchType_StartsWith, eString_location_contains, eString_location_ends, eString_location_equals, eString_location_inlist, eString_location_starts, CString_constraint_Base::GetCase_sensitive(), CString_constraint_Base::GetIgnore_punct(), CString_constraint_Base::GetIgnore_space(), CString_constraint_Base::GetIgnore_weasel(), CString_constraint_Base::GetIgnore_words(), CString_constraint_Base::GetIs_all_caps(), CString_constraint_Base::GetIs_all_lower(), CString_constraint_Base::GetIs_all_punct(), CString_constraint_Base::GetMatch_location(), CString_constraint_Base::GetMatch_text(), CString_constraint_Base::GetNot_present(), CSearch_func_Base::GetString_constraint(), CString_constraint_Base::GetWhole_word(), CString_constraint_Base::IsSetCase_sensitive(), CString_constraint_Base::IsSetIgnore_punct(), CString_constraint_Base::IsSetIgnore_space(), CString_constraint_Base::IsSetIgnore_weasel(), CString_constraint_Base::IsSetIgnore_words(), CString_constraint_Base::IsSetIs_all_caps(), CString_constraint_Base::IsSetIs_all_lower(), CString_constraint_Base::IsSetIs_all_punct(), CString_constraint_Base::IsSetMatch_location(), CString_constraint_Base::IsSetMatch_text(), CString_constraint_Base::IsSetNot_present(), CString_constraint_Base::IsSetWhole_word(), CSearch_func_Base::IsString_constraint(), m_AllLower, m_AllPunct, m_AllUpper, m_IgnoreCase, m_IgnorePunct, m_IgnoreSpace, m_IgnoreSyn, m_is_choice, m_MatchText, m_MatchType, m_WholeWord, m_word_subst, and CRef< C, Locker >::Reset().

ShowChoiceOrText()

void CMacroStringConstraintPanel::ShowChoiceOrText

(

void

)

Definition at line 1568 of file suspect_product_rule_editor.cpp.

References eMatchType_DoesNotEqual, eMatchType_Equals, m_is_choice, m_MatchChoice, m_MatchText, m_MatchType, and m_TextSizer.

Referenced by Create(), OnMatchTypeSelected(), and SetChoices().

ShowToolTips()

bool CMacroStringConstraintPanel::ShowToolTips ( )

static

Should we show tooltips?

Should we show tooltips?

Definition at line 1604 of file suspect_product_rule_editor.cpp.

Member Data Documentation

m_AllLower

wxRadioButton* CMacroStringConstraintPanel::m_AllLower

private

Definition at line 328 of file suspect_product_rule_editor.hpp.

Referenced by ClearValues(), CreateControls(), GetStringConstraint(), Init(), and SetSearchFunc().

m_AllPunct

wxRadioButton* CMacroStringConstraintPanel::m_AllPunct

private

Definition at line 329 of file suspect_product_rule_editor.hpp.

Referenced by ClearValues(), CreateControls(), GetStringConstraint(), Init(), and SetSearchFunc().

m_AllUpper

wxRadioButton* CMacroStringConstraintPanel::m_AllUpper

private

Definition at line 327 of file suspect_product_rule_editor.hpp.

Referenced by ClearValues(), CreateControls(), GetStringConstraint(), Init(), and SetSearchFunc().

m_AnyLetters

wxRadioButton* CMacroStringConstraintPanel::m_AnyLetters

private

Definition at line 326 of file suspect_product_rule_editor.hpp.

Referenced by ClearValues(), CreateControls(), and Init().

m_ClearButton

wxButton* CMacroStringConstraintPanel::m_ClearButton

private

Definition at line 331 of file suspect_product_rule_editor.hpp.

Referenced by CreateControls(), and Init().

m_IgnoreCase

wxCheckBox* CMacroStringConstraintPanel::m_IgnoreCase

private

Definition at line 321 of file suspect_product_rule_editor.hpp.

Referenced by ClearValues(), CreateControls(), GetStringConstraint(), Init(), and SetSearchFunc().

m_IgnorePunct

wxCheckBox* CMacroStringConstraintPanel::m_IgnorePunct

private

Definition at line 324 of file suspect_product_rule_editor.hpp.

Referenced by ClearValues(), CreateControls(), GetStringConstraint(), Init(), and SetSearchFunc().

m_IgnoreSpace

wxCheckBox* CMacroStringConstraintPanel::m_IgnoreSpace

private

Definition at line 322 of file suspect_product_rule_editor.hpp.

Referenced by ClearValues(), CreateControls(), GetStringConstraint(), Init(), and SetSearchFunc().

m_IgnoreSyn

wxCheckBox* CMacroStringConstraintPanel::m_IgnoreSyn

private

Definition at line 325 of file suspect_product_rule_editor.hpp.

Referenced by ClearValues(), CreateControls(), GetStringConstraint(), Init(), and SetSearchFunc().

m_is_choice

bool CMacroStringConstraintPanel::m_is_choice

private

Definition at line 336 of file suspect_product_rule_editor.hpp.

Referenced by ClearValues(), GetStringConstraint(), Init(), SetSearchFunc(), and ShowChoiceOrText().

m_MatchChoice

wxComboBox* CMacroStringConstraintPanel::m_MatchChoice

private

Definition at line 330 of file suspect_product_rule_editor.hpp.

Referenced by ClearValues(), CreateControls(), GetStringConstraint(), Init(), SetChoices(), and ShowChoiceOrText().

m_MatchText

wxTextCtrl* CMacroStringConstraintPanel::m_MatchText

private

Definition at line 320 of file suspect_product_rule_editor.hpp.

Referenced by ClearValues(), CreateControls(), GetStringConstraint(), Init(), SetSearchFunc(), and ShowChoiceOrText().

m_MatchType

wxChoice* CMacroStringConstraintPanel::m_MatchType

private

Definition at line 319 of file suspect_product_rule_editor.hpp.

Referenced by ClearValues(), CreateControls(), GetStringConstraint(), Init(), SetSearchFunc(), and ShowChoiceOrText().

m_TextSizer

wxBoxSizer* CMacroStringConstraintPanel::m_TextSizer

private

Definition at line 335 of file suspect_product_rule_editor.hpp.

Referenced by ClearValues(), CreateControls(), Init(), and ShowChoiceOrText().

m_WholeWord

wxCheckBox* CMacroStringConstraintPanel::m_WholeWord

private

Definition at line 323 of file suspect_product_rule_editor.hpp.

Referenced by ClearValues(), CreateControls(), GetStringConstraint(), Init(), and SetSearchFunc().

m_word_subst

CRef<objects::CWord_substitution_set> CMacroStringConstraintPanel::m_word_subst

private

Definition at line 337 of file suspect_product_rule_editor.hpp.

Referenced by AddWordSubstSet(), ClearValues(), GetStringConstraint(), OnWordSubstitution(), and SetSearchFunc().

m_WordSubst

wxButton* CMacroStringConstraintPanel::m_WordSubst

private

Definition at line 332 of file suspect_product_rule_editor.hpp.

Referenced by CreateControls(), and Init().

---

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

• include/gui/packages/pkg_sequence_edit/suspect_product_rule_editor.hpp
• src/gui/packages/pkg_sequence_edit/suspect_product_rule_editor.cpp