Search Toolkit Book for CSourceFieldNamePanel

#include <gui/widgets/edit/source_field_name_panel.hpp>

Inheritance diagram for CSourceFieldNamePanel:

Collaboration diagram for CSourceFieldNamePanel:

Public Types
enum	{ ID_CSOURCEFIELDNAMEPANEL = 6040 , ID_CSOURCEFIELD_TEXT_QUAL_BTN , ID_CSOURCEFIELD_TAXONOMY_BTN , ID_CSOURCEFIELD_LOCATION_BTN , ID_CSOURCEFIELD_ORIGIN_BTN , ID_CSOURCEFIELD_SRC_SUBLIST , ID_CSOURCEFIELD_SRCTYPES }

Public Types inherited from CFieldNamePanel
enum	EFieldType { eFieldType_Unknown = 0 , eFieldType_Source , eFieldType_Feature , eFieldType_CDSGeneProt , eFieldType_RNA , eFieldType_Gene , eFieldType_Protein , eFieldType_MolInfo , eFieldType_Pub , eFieldType_StructuredComment , eFieldType_BankITComment , eFieldType_Comment , eFieldType_DBLink , eFieldType_Dbxref , eFieldType_Misc , eFieldType_DefLine , eFieldType_TaxnameAfterBinomial , eFieldType_FlatFile , eFieldType_FileId , eFieldType_GeneralId , eFieldType_LocalId , eFieldType_SeqId , eFieldType_Taxname }

Public Member Functions
	CSourceFieldNamePanel ()
	Constructors. More...

	CSourceFieldNamePanel (wxWindow *parent, bool additional_items=false, wxWindowID id=ID_CSOURCEFIELDNAMEPANEL, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxSize(400, 300), long style=wxTAB_TRAVERSAL)

bool	Create (wxWindow *parent, wxWindowID id=ID_CSOURCEFIELDNAMEPANEL, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxSize(400, 300), long style=wxTAB_TRAVERSAL)
	Creation. More...

	~CSourceFieldNamePanel ()
	Destructor. More...

void	Init ()
	Initialises member variables. More...

void	CreateControls ()
	Creates the controls and sizers. More...

void	OnTextQualBtnSelected (wxCommandEvent &event)
	wxEVT_COMMAND_RADIOBUTTON_SELECTED event handler for ID_TEXT_QUAL_BTN More...

void	OnTaxonomyBtnSelected (wxCommandEvent &event)
	wxEVT_COMMAND_RADIOBUTTON_SELECTED event handler for ID_TAXONOMY_BTN More...

void	OnLocationBtnSelected (wxCommandEvent &event)
	wxEVT_COMMAND_RADIOBUTTON_SELECTED event handler for ID_LOCATION_BTN More...

void	OnOriginBtnSelected (wxCommandEvent &event)
	wxEVT_COMMAND_RADIOBUTTON_SELECTED event handler for ID_ORIGIN_BTN More...

void	OnSrcSublistSelected (wxCommandEvent &event)
	wxEVT_COMMAND_LISTBOX_SELECTED event handler for ID_SRC_SUBLIST More...

wxBitmap	GetBitmapResource (const wxString &name)
	Retrieves bitmap resources. More...

wxIcon	GetIconResource (const wxString &name)
	Retrieves icon resources. More...

void	HideSourceType ()

void	DoNotShowSubList (bool val)

virtual string	GetFieldName (const bool subfield=false)
	Returns the name of the field as selected in the panel. More...

virtual bool	SetFieldName (const string &field)

virtual vector< string >	GetChoices (bool &allow_other)

virtual string	GetMacroFieldName (const string &target, const string &selected_field=kEmptyStr)

void	SetSourceSubpanelSelection (const string &sel)

void	AddAdditionalItems (void)

virtual void	ClearValues (void)

Public Member Functions inherited from CFieldNamePanel
	CFieldNamePanel ()
	Constructors. More...

	~CFieldNamePanel ()
	Destructor. More...

virtual vector< string >	GetMacroValues ()

virtual void	SetShowLegalOnly (bool show)

virtual string	GetMacroFieldLabel (const string &target, const string &selected_field=kEmptyStr)

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

static vector< string >	s_GetSourceOriginOptions ()

static vector< string >	s_GetSourceLocationOptions ()

Static Public Member Functions inherited from CFieldNamePanel
static string	GetFieldTypeName (EFieldType field_type)

static EFieldType	GetFieldTypeFromName (const string &field_type_name)

static bool	IsFeature (const string &target)

static bool	IsDescriptor (const string &target)

Public Attributes
wxRadioButton *	m_TextQualifier

wxRadioButton *	m_Taxonomy

wxRadioButton *	m_Location

wxRadioButton *	m_Origin

wxListBox *	m_SourceSubList

wxRadioBox *	m_SourceType

Private Member Functions
void	x_ChooseTextQualifier ()

void	x_ChooseTaxonomy ()

void	x_ChooseLocation ()

Private Attributes
bool	m_AdditionalItems

bool	m_DoNotShowSubList

bool	m_is_taxonomy_panel

bool	m_first_run

Additional Inherited Members
Protected Member Functions inherited from CFieldNamePanel
void	x_UpdateParent (void)

bool	x_IsParentAECRDlg (void)

void	x_UpdateAECRDlgLayout (void)

bool	x_ShouldDecreaseStrConstrPanel (void)

Detailed Description

CSourceFieldNamePanel class declaration

Definition at line 57 of file source_field_name_panel.hpp.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Enumerator
ID_CSOURCEFIELDNAMEPANEL
ID_CSOURCEFIELD_TEXT_QUAL_BTN
ID_CSOURCEFIELD_TAXONOMY_BTN
ID_CSOURCEFIELD_LOCATION_BTN
ID_CSOURCEFIELD_ORIGIN_BTN
ID_CSOURCEFIELD_SRC_SUBLIST
ID_CSOURCEFIELD_SRCTYPES

Definition at line 122 of file source_field_name_panel.hpp.

Constructor & Destructor Documentation

◆ CSourceFieldNamePanel() [1/2]

CSourceFieldNamePanel::CSourceFieldNamePanel ( )

Constructors.

CSourceFieldNamePanel type definition

CSourceFieldNamePanel event table definition

CSourceFieldNamePanel constructors

Definition at line 80 of file source_field_name_panel.cpp.

References Init().

◆ CSourceFieldNamePanel() [2/2]

CSourceFieldNamePanel::CSourceFieldNamePanel	(	wxWindow *	parent,
		bool	additional_items = `false`,
		wxWindowID	id = `ID_CSOURCEFIELDNAMEPANEL`,
		const wxPoint &	pos = `wxDefaultPosition`,
		const wxSize &	size = `wxSize(400, 300)`,
		long	style = `wxTAB_TRAVERSAL`
	)

Definition at line 85 of file source_field_name_panel.cpp.

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

◆ ~CSourceFieldNamePanel()

CSourceFieldNamePanel::~CSourceFieldNamePanel ( )

Destructor.

CSourceFieldNamePanel destructor

Definition at line 117 of file source_field_name_panel.cpp.

Member Function Documentation

◆ AddAdditionalItems()

void CSourceFieldNamePanel::AddAdditionalItems ( void )

inline

Definition at line 145 of file source_field_name_panel.hpp.

References m_AdditionalItems, and x_ChooseTextQualifier().

◆ ClearValues()

void CSourceFieldNamePanel::ClearValues ( void )

virtual

Reimplemented from CFieldNamePanel.

Definition at line 195 of file source_field_name_panel.cpp.

References m_is_taxonomy_panel, m_Location, m_Origin, m_SourceSubList, m_SourceType, m_Taxonomy, m_TextQualifier, x_ChooseTaxonomy(), and x_ChooseTextQualifier().

◆ Create()

bool CSourceFieldNamePanel::Create	(	wxWindow *	parent,
		wxWindowID	id = `ID_CSOURCEFIELDNAMEPANEL`,
		const wxPoint &	pos = `wxDefaultPosition`,
		const wxSize &	size = `wxSize(400, 300)`,
		long	style = `wxTAB_TRAVERSAL`
	)

Creation.

CSourceFieldNamePanel creator

Definition at line 97 of file source_field_name_panel.cpp.

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

Referenced by CSourceFieldNamePanel().

◆ CreateControls()

void CSourceFieldNamePanel::CreateControls ( )

Creates the controls and sizers.

Control creation for CSourceFieldNamePanel

Definition at line 144 of file source_field_name_panel.cpp.

References _, ID_CSOURCEFIELD_LOCATION_BTN, ID_CSOURCEFIELD_ORIGIN_BTN, ID_CSOURCEFIELD_SRC_SUBLIST, ID_CSOURCEFIELD_SRCTYPES, ID_CSOURCEFIELD_TAXONOMY_BTN, ID_CSOURCEFIELD_TEXT_QUAL_BTN, m_Location, m_Origin, m_SourceSubList, m_SourceType, m_Taxonomy, m_TextQualifier, and x_ChooseTextQualifier().

Referenced by Create().

◆ DoNotShowSubList()

void CSourceFieldNamePanel::DoNotShowSubList ( bool val )

inline

Definition at line 120 of file source_field_name_panel.hpp.

References m_DoNotShowSubList, and val.

Referenced by CFieldChoicePanel::SetFieldType().

◆ GetBitmapResource()

wxBitmap CSourceFieldNamePanel::GetBitmapResource ( const wxString & name )

Retrieves bitmap resources.

Get bitmap resources

Definition at line 231 of file source_field_name_panel.cpp.

◆ GetChoices()

vector< string > CSourceFieldNamePanel::GetChoices ( bool & allow_other )

virtual

Reimplemented from CFieldNamePanel.

Definition at line 419 of file source_field_name_panel.cpp.

References CSubSource::eVocabulary_insdc, CSubSource::GetSubtypeValue(), NStr::IsBlank(), CSubSource::IsValidSubtypeName(), m_Location, m_Origin, m_SourceSubList, m_TextQualifier, CSubSource::NeedsNoText(), s_GetSourceLocationOptions(), s_GetSourceOriginOptions(), s_GetTrueFalseList(), ToStdString(), and val.

◆ GetFieldName()

string CSourceFieldNamePanel::GetFieldName ( const bool subfield = false )

virtual

Returns the name of the field as selected in the panel.

In case of names composed of multiple words, for example, feature_name + qualifier when the subfield parameter is true, the qualifier name is returned only.

Implements CFieldNamePanel.

Definition at line 262 of file source_field_name_panel.cpp.

References m_Location, m_Origin, m_SourceSubList, m_SourceType, m_Taxonomy, m_TextQualifier, ToStdString(), and val.