NCBI C++ ToolKit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
CFieldNamePanel Class Referenceabstract

Search Toolkit Book for CFieldNamePanel

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

+ Inheritance diagram for CFieldNamePanel:
+ Collaboration diagram for CFieldNamePanel:

Public Types

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

 CFieldNamePanel ()
 Constructors. More...
 
 ~CFieldNamePanel ()
 Destructor. More...
 
virtual string GetFieldName (const bool subfield=false)=0
 Returns the name of the field as selected in the panel. More...
 
virtual bool SetFieldName (const string &field)=0
 
virtual vector< string > GetChoices (bool &allow_other)
 
virtual vector< string > GetMacroValues ()
 
virtual void ClearValues (void)
 
virtual void SetShowLegalOnly (bool show)
 
virtual string GetMacroFieldName (const string &target, const string &selected_field=kEmptyStr)
 
virtual string GetMacroFieldLabel (const string &target, const string &selected_field=kEmptyStr)
 

Static Public Member Functions

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)
 

Protected Member Functions

void x_UpdateParent (void)
 
bool x_IsParentAECRDlg (void)
 
void x_UpdateAECRDlgLayout (void)
 
bool x_ShouldDecreaseStrConstrPanel (void)
 

Detailed Description

CFieldNamePanel class declaration

Definition at line 50 of file field_name_panel.hpp.

Member Enumeration Documentation

◆ EFieldType

enum CFieldNamePanel::EFieldType
Enumerator
eFieldType_Unknown 
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 

Definition at line 70 of file field_name_panel.hpp.

Constructor & Destructor Documentation

◆ CFieldNamePanel()

CFieldNamePanel::CFieldNamePanel ( )
inline

Constructors.

Definition at line 54 of file field_name_panel.hpp.

◆ ~CFieldNamePanel()

CFieldNamePanel::~CFieldNamePanel ( )
inline

Destructor.

Definition at line 57 of file field_name_panel.hpp.

Member Function Documentation

◆ ClearValues()

virtual void CFieldNamePanel::ClearValues ( void  )
inlinevirtual

Reimplemented in CStructCommentFieldPanel, CSourceFieldNamePanel, CDualRNAFieldNamePanel, CRNAFieldNamePanel, CFieldHandlerNamePanel, CFeatureTypePanel, CFeatureFieldNamePanel, and CCDSGeneProtFieldNamePanel.

Definition at line 65 of file field_name_panel.hpp.

Referenced by CQualApplyPanel::ClearValues(), CQualEditPanel::ClearValues(), CQualConvertPanel::ClearValues(), CQualParsePanel::ClearValues(), CQualRemoveOutsidePanel::ClearValues(), CQualCopyPanel::ClearValues(), CQualSwapPanel::ClearValues(), CQualRemovePanel::ClearValues(), and CConstraintPanel::ClearValues().

◆ GetChoices()

vector< string > CFieldNamePanel::GetChoices ( bool &  allow_other)
virtual

Reimplemented in CSourceFieldNamePanel, CFieldHandlerNamePanel, CFeatureFieldNamePanel, CCDSGeneProtFieldNamePanel, CSingleChoicePanel, CFieldConstraintPanel, and CFieldChoicePanel.

Definition at line 45 of file field_name_panel.cpp.

Referenced by CAdvStringConstraintPanel< T >::CreateControls(), CMacroAdvStringConstraintPanel< T >::CreateControls(), CFieldChoicePanel::GetChoices(), CConstraintPanel::UpdateEditor(), CAdvStringConstraintPanel< T >::UpdateEditor(), and CMacroAdvStringConstraintPanel< T >::UpdateEditor().

◆ GetFieldName()

virtual string CFieldNamePanel::GetFieldName ( const bool  subfield = false)
pure 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.

Implemented in CSourceFieldNamePanel, CFileIdPanel, CSeqIdPanel, CDualRNAFieldNamePanel, CRNAFieldNamePanel, CFieldHandlerNamePanel, CFeatureTypePanel, CFeatureFieldNamePanel, CCDSGeneProtFieldNamePanel, CProteinFieldPanel, CMiscFieldPanel, CGeneralIDPanel, CGeneFieldPanel, CFieldConstraintPanel, CFieldChoicePanel, CDbxrefNamePanel, CStructFieldValuePanel, and CStructCommentFieldPanel.

Referenced by CConvertCdsToMiscFeat::GetCommand(), CParseTextDlg::GetCommand(), CConstraintPanel::GetConstraint(), CQualChoicePanel::GetField(), CFieldChoicePanel::GetField1(), CFieldChoicePanel::GetField2(), CMacroAdvStringConstraintPanel< T >::GetFuncWithArgs(), CPresentMatcherPanel< T >::GetLabel(), CSameMatcherPanel< T >::GetLabel(), CAdvStringConstraintPanel< T >::GetLabel(), CPresentMatcherPanel< T >::GetMatcher(), CSameMatcherPanel< T >::GetMatcher(), CAdvStringConstraintPanel< T >::GetMatcher(), CMacroAdvStringConstraintPanel< T >::GetMatcher(), CSelectQualdDlg::OnSelect(), CTextSubpanel::OnSelectButton(), CTextSubpanel::SetClusters(), CSelectQualdDlg::SetField(), CCorrectGenesDialog::x_GetConstrainedList(), CAttribTableColumnIdPanel::x_GetConstraintField(), and CTableReaderMacro::x_GetStringConstraint().

◆ GetFieldTypeFromName()

CFieldNamePanel::EFieldType CFieldNamePanel::GetFieldTypeFromName ( const string &  field_type_name)
static

Definition at line 170 of file field_name_panel.cpp.

References eFieldType_BankITComment, eFieldType_CDSGeneProt, eFieldType_Comment, eFieldType_DBLink, eFieldType_Dbxref, eFieldType_DefLine, eFieldType_Feature, eFieldType_FileId, eFieldType_FlatFile, eFieldType_Gene, eFieldType_GeneralId, eFieldType_LocalId, eFieldType_Misc, eFieldType_MolInfo, eFieldType_Protein, eFieldType_Pub, eFieldType_RNA, eFieldType_SeqId, eFieldType_Source, eFieldType_StructuredComment, eFieldType_Taxname, eFieldType_TaxnameAfterBinomial, eFieldType_Unknown, NStr::eNocase, NStr::EqualNocase(), kBankITComment, kComment, kDefinitionLineLabel, kFieldTypeSeqId, kFileSeqId, kFlatFile, kGeneralId, kLocalId, kTaxnameAfterBinomial, NStr::StartsWith(), and val.

Referenced by CFieldChoicePanel::AutoMatch(), IActionPanel::CreateAction1(), IActionPanel::CreateAction2_imp(), CQualChoicePanel::CreateEditingAction(), IActionPanel::GetAutopopulateValue(), CAECRFrame::GetCommand(), CParseTextDlg::GetCommand(), CConstraintPanel::GetConstraint(), CFieldChoicePanel::GetFieldType(), CFieldChoicePanel::GetFieldTypes(), CAddConstraint::OnAccept(), CFieldChoicePanel::OnFieldTypeChoiceSelected(), CSelectQualdDlg::OnFieldTypeSelected(), CAttribTableColumnIdPanel::OnMatchColumnClick(), CSelectQualdDlg::OnSelect(), CFieldChoicePanel::SetFieldName(), CSelectQualdDlg::UpdateEditor(), and CAttribTableColumnIdPanel::x_GuessQualifiers().

◆ GetFieldTypeName()

string CFieldNamePanel::GetFieldTypeName ( EFieldType  field_type)
static

Definition at line 92 of file field_name_panel.cpp.

References eFieldType_BankITComment, eFieldType_CDSGeneProt, eFieldType_Comment, eFieldType_DBLink, eFieldType_Dbxref, eFieldType_DefLine, eFieldType_Feature, eFieldType_FileId, eFieldType_FlatFile, eFieldType_Gene, eFieldType_GeneralId, eFieldType_LocalId, eFieldType_Misc, eFieldType_MolInfo, eFieldType_Protein, eFieldType_Pub, eFieldType_RNA, eFieldType_SeqId, eFieldType_Source, eFieldType_StructuredComment, eFieldType_Taxname, eFieldType_TaxnameAfterBinomial, eFieldType_Unknown, kBankITComment, kComment, kDefinitionLineLabel, kFieldTypeSeqId, kFileSeqId, kFlatFile, kGeneralId, kLocalId, kTaxnameAfterBinomial, and val.

Referenced by CFieldChoicePanel::AutoMatch(), CFieldChoicePanel::CreateControls(), CSelectQualdDlg::CreateControls(), CPresentMatcherPanel< T >::GetMatcher(), CSameMatcherPanel< T >::GetMatcher(), CAdvStringConstraintPanel< T >::GetMatcher(), CAttribTableColumnIdPanel::OnMatchColumnClick(), CAttribTableColumnIdPanel::OnMatchTypeSelected(), CFieldChoicePanel::SetFieldName(), CFieldChoicePanel::SetFieldType(), CAttribTableColumnIdPanel::UpdateCol(), and CAttribTableColumnIdPanel::x_GuessQualifiers().

◆ GetMacroFieldLabel()

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

Reimplemented in CFieldHandlerNamePanel.

Definition at line 69 of file field_name_panel.hpp.

References kEmptyStr.

Referenced by CMacroAdvStringConstraintPanel< T >::GetMatcher().

◆ GetMacroFieldName()

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

Reimplemented in CStructCommentFieldPanel, CSourceFieldNamePanel, CFileIdPanel, CSeqIdPanel, CRNAFieldNamePanel, CFieldHandlerNamePanel, CFeatureFieldNamePanel, and CCDSGeneProtFieldNamePanel.

Definition at line 68 of file field_name_panel.hpp.

References kEmptyStr.

Referenced by CMacroAdvStringConstraintPanel< T >::GetMatcher(), CMacroAdvStringConstraintPanel< T >::GetQualName(), CSelectQualdDlg::OnSelect(), CSelectQualdDlg::SetField(), and CTableReaderMacro::x_GetStringConstraint().

◆ GetMacroValues()

vector< string > CFieldNamePanel::GetMacroValues ( )
virtual

Reimplemented in CFieldHandlerNamePanel.

Definition at line 51 of file field_name_panel.cpp.

Referenced by CMacroAdvStringConstraintPanel< T >::CreateControls(), CConstraintPanel::UpdateEditor(), and CMacroAdvStringConstraintPanel< T >::UpdateEditor().

◆ IsDescriptor()

bool CFieldNamePanel::IsDescriptor ( const string &  target)
static

Definition at line 242 of file field_name_panel.cpp.

Referenced by CMacroFeatsOnSeqPanel::GetFuncWithArgs(), and CMacroFeatsOnSeqPanel::GetLocationConstraint().

◆ IsFeature()

bool CFieldNamePanel::IsFeature ( const string &  target)
static

Definition at line 228 of file field_name_panel.cpp.

Referenced by CMacroAddConstraint::CreateControls(), CMacroFeatsOnSeqPanel::GetFuncWithArgs(), CMacroFeatsOnSeqPanel::GetLocationConstraint(), CFieldHandlerNamePanel::GetMacroFieldName(), CSourceFieldNamePanel::GetMacroFieldName(), CFeatureFieldNamePanel::s_GetMacroFieldName(), CCDSGeneProtFieldNamePanel::s_GetMacroFieldName(), CRNAFieldNamePanel::s_GetMacroFieldName(), and CTableReaderMacro::x_GetMatchFieldConstraint().

◆ SetFieldName()

virtual bool CFieldNamePanel::SetFieldName ( const string &  field)
pure virtual

Implemented in CStructFieldValuePanel, CStructCommentFieldPanel, CSourceFieldNamePanel, CFileIdPanel, CSeqIdPanel, CDualRNAFieldNamePanel, CRNAFieldNamePanel, CFieldHandlerNamePanel, CFeatureTypePanel, CFeatureFieldNamePanel, CCDSGeneProtFieldNamePanel, CProteinFieldPanel, CMiscFieldPanel, CGeneralIDPanel, CGeneFieldPanel, CFieldConstraintPanel, CFieldChoicePanel, and CDbxrefNamePanel.

Referenced by CSelectQualdDlg::SetField(), CConstraintPanel::SetFieldName(), CFieldChoicePanel::SetFieldName(), CSelectQualdDlg::SetFieldType(), CFieldChoicePanel::SetFieldType(), and CFieldChoicePanel::SetOneFieldName().

◆ SetShowLegalOnly()

virtual void CFieldNamePanel::SetShowLegalOnly ( bool  show)
inlinevirtual

Reimplemented in CFieldChoicePanel, CFeatureTypePanel, and CFeatureFieldNamePanel.

Definition at line 66 of file field_name_panel.hpp.

Referenced by CFieldChoicePanel::SetFieldType().

◆ x_IsParentAECRDlg()

bool CFieldNamePanel::x_IsParentAECRDlg ( void  )
protected

Definition at line 70 of file field_name_panel.cpp.

Referenced by CFieldChoicePanel::SetFieldType(), and CFieldConstraintPanel::UpdateEditor().

◆ x_ShouldDecreaseStrConstrPanel()

bool CFieldNamePanel::x_ShouldDecreaseStrConstrPanel ( void  )
protected

Definition at line 79 of file field_name_panel.cpp.

Referenced by CFieldConstraintPanel::CreateControls().

◆ x_UpdateAECRDlgLayout()

void CFieldNamePanel::x_UpdateAECRDlgLayout ( void  )
protected

Definition at line 75 of file field_name_panel.cpp.

Referenced by CFieldConstraintPanel::UpdateEditor().

◆ x_UpdateParent()

void CFieldNamePanel::x_UpdateParent ( void  )
protected

Definition at line 57 of file field_name_panel.cpp.

References NULL, and CFieldNamePanelParent::UpdateEditor().

Referenced by CSingleChoicePanel::OnFieldChoiceSelected(), CStructCommentFieldPanel::OnFieldNameEnter(), CCDSGeneProtFieldNamePanel::OnFieldSelected(), CFieldHandlerNamePanel::OnFieldSelected(), CFieldChoicePanel::OnFieldTypeChoiceSelected(), CFeatureTypePanel::OnListbox1Selected(), CSourceFieldNamePanel::OnLocationBtnSelected(), CRNAFieldNamePanel::OnncRNAClassSelected(), CSourceFieldNamePanel::OnOriginBtnSelected(), CFeatureFieldNamePanel::OnQualifierListboxSelected(), CRNAFieldNamePanel::OnRnaFieldSelected(), CDualRNAFieldNamePanel::OnRnaFieldSelected(), CRNAFieldNamePanel::OnRnaTypeSelected(), CDualRNAFieldNamePanel::OnRnaTypeSelected(), CSourceFieldNamePanel::OnSrcSublistSelected(), CSourceFieldNamePanel::OnTaxonomyBtnSelected(), CSourceFieldNamePanel::OnTextQualBtnSelected(), CFieldChoicePanel::SetFieldName(), CGeneFieldPanel::SetFieldName(), CMiscFieldPanel::SetFieldName(), CProteinFieldPanel::SetFieldName(), CFieldHandlerNamePanel::SetFieldName(), CRNAFieldNamePanel::SetFieldName(), CDualRNAFieldNamePanel::SetFieldName(), CSourceFieldNamePanel::SetFieldName(), CDualRNAFieldNamePanel::SetFieldName2(), CFieldConstraintPanel::UpdateEditor(), and CStructCommentFieldPanel::x_UpdatePanel().

The documentation for this class was generated from the following files:
Generated by doxygen 1.9.0
Modified on Wed Dec 06 07:13:15 2023 by modify_doxy.py rev. 669887