NCBI C++ ToolKit
Classes | Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Protected Attributes | List of all members
CWindowMaskerPanel Class Reference

Search Toolkit Book for CWindowMaskerPanel

#include <gui/packages/pkg_sequence/windowmasker_panel.hpp>

+ Inheritance diagram for CWindowMaskerPanel:
+ Collaboration diagram for CWindowMaskerPanel:

Classes

struct  SMaskerInfo
 

Public Types

enum  {
  ID_CWINDOWMASKERPANEL = 10015 , ID_COBJECTLISTWIDGET = 10000 , ID_CHOICE7 = 10017 , ID_BUTTON5 = 10073 ,
  ID_COMBOBOX2 = 10018 , ID_LOCALRUN = 10063
}
 Control identifiers. More...
 
enum  { ID_LOADING_TEXT = 10100 , ID_LOADING_PROGRESS = 10101 }
 
typedef map< string, SMaskerInfo > TMaskerPaths
 

Public Member Functions

 CWindowMaskerPanel ()
 Constructors. More...
 
 CWindowMaskerPanel (wxWindow *parent, wxWindowID id=ID_CWINDOWMASKERPANEL, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxSize(400, 300), long style=wxTAB_TRAVERSAL)
 
bool Create (wxWindow *parent, wxWindowID id=ID_CWINDOWMASKERPANEL, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxSize(400, 300), long style=wxTAB_TRAVERSAL)
 Creation. More...
 
 ~CWindowMaskerPanel ()
 Destructor. More...
 
void Init ()
 Initialises member variables. More...
 
void CreateControls ()
 Creates the controls and sizers. More...
 
virtual bool TransferDataToWindow ()
 Transfer data to the window. More...
 
virtual bool TransferDataFromWindow ()
 Transfer data from the window. More...
 
void OnWMDownload (wxCommandEvent &event)
 wxEVT_COMMAND_BUTTON_CLICKED event handler for ID_BUTTON5 More...
 
CWindowMaskerParams & GetData ()
 Data access. More...
 
const CWindowMaskerParams & GetData () const
 
void SetData (const CWindowMaskerParams &data)
 
wxBitmap GetBitmapResource (const wxString &name)
 Retrieves bitmap resources. More...
 
wxIcon GetIconResource (const wxString &name)
 Retrieves icon resources. More...
 
void SetObjects (TConstScopedObjects *objects)
 
CTaxIdHelper::ICallback interface implementation
virtual void TaxonsLoaded (bool local)
 
CAlgoToolManagerParamsPanel implementation
void RestoreDefaults ()
 override in derived classes More...
 
IRegSettings interface implementation
virtual void LoadSettings ()
 
virtual void SaveSettings () const
 override in derived classes More...
 
- Public Member Functions inherited from CAlgoToolManagerParamsPanel
virtual void SetRegistryPath (const string &reg_path)
 CAlgoToolManagerParamsPanel. More...
 
- Public Member Functions inherited from IRegSettings
virtual ~IRegSettings ()
 
- Public Member Functions inherited from CTaxIdHelper::ICallback
virtual ~ICallback ()
 

Static Public Member Functions

static bool ShowToolTips ()
 Should we show tooltips? More...
 

Public Attributes

CObjectListWidget * m_ObjectList
 
wxBoxSizer * m_WMStaticBoxSizer
 
wxStaticText * m_WMStatic
 
wxChoice * m_WMTaxIds
 
wxButton * m_WMDownload
 
CWindowMaskerParams m_data
 The data edited by this window. More...
 
TConstScopedObjects * m_InputObjects
 

Static Public Attributes

static TMaskerPaths sm_MaskerPaths
 

Protected Member Functions

void x_InitTaxons ()
 
void x_ShowWM (bool show)
 

Protected Attributes

CTaxIdHelper::CAutoDelete m_AutoDelete
 
- Protected Attributes inherited from CAlgoToolManagerParamsPanel
string m_RegPath
 registry path to the settings More...
 

Detailed Description

Definition at line 59 of file windowmasker_panel.hpp.

Member Typedef Documentation

◆ TMaskerPaths

typedef map<string, SMaskerInfo> CWindowMaskerPanel::TMaskerPaths

Definition at line 166 of file windowmasker_panel.hpp.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Control identifiers.

Enumerator
ID_CWINDOWMASKERPANEL 
ID_COBJECTLISTWIDGET 
ID_CHOICE7 
ID_BUTTON5 
ID_COMBOBOX2 
ID_LOCALRUN 

Definition at line 130 of file windowmasker_panel.hpp.

◆ anonymous enum

anonymous enum
Enumerator
ID_LOADING_TEXT 
ID_LOADING_PROGRESS 

Definition at line 140 of file windowmasker_panel.hpp.

Constructor & Destructor Documentation

◆ CWindowMaskerPanel() [1/2]

CWindowMaskerPanel::CWindowMaskerPanel ( )

Constructors.

CWindowMaskerPanel constructors

Definition at line 84 of file windowmasker_panel.cpp.

References Init().

◆ CWindowMaskerPanel() [2/2]

CWindowMaskerPanel::CWindowMaskerPanel ( wxWindow *  parent,
wxWindowID  id = ID_CWINDOWMASKERPANEL,
const wxPoint &  pos = wxDefaultPosition,
const wxSize &  size = wxSize(400, 300),
long  style = wxTAB_TRAVERSAL 
)

Definition at line 90 of file windowmasker_panel.cpp.

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

◆ ~CWindowMaskerPanel()

CWindowMaskerPanel::~CWindowMaskerPanel ( )

Destructor.

CWindowMaskerPanel destructor

Definition at line 122 of file windowmasker_panel.cpp.

Member Function Documentation

◆ Create()

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

Creation.

CWindowMaskerPanel creator

Definition at line 102 of file windowmasker_panel.cpp.

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

Referenced by CWindowMaskerPanel(), and CWindowMaskerTool::x_CreateParamsPanelIfNeeded().

◆ CreateControls()

void CWindowMaskerPanel::CreateControls ( )

Creates the controls and sizers.

Control creation for CWindowMaskerPanel

Definition at line 149 of file windowmasker_panel.cpp.

References _, GetData(), ID_BUTTON5, ID_CHOICE7, ID_COBJECTLISTWIDGET, ID_COMBOBOX2, ID_LOADING_PROGRESS, ID_LOADING_TEXT, ID_LOCALRUN, m_ObjectList, m_WMDownload, m_WMStatic, m_WMStaticBoxSizer, m_WMTaxIds, and wxT.

Referenced by Create().

◆ GetBitmapResource()

wxBitmap CWindowMaskerPanel::GetBitmapResource ( const wxString &  name)

Retrieves bitmap resources.

Get bitmap resources

Definition at line 225 of file windowmasker_panel.cpp.

◆ GetData() [1/2]

CWindowMaskerParams& CWindowMaskerPanel::GetData ( void  )
inline

Data access.

Definition at line 107 of file windowmasker_panel.hpp.

References m_data.

Referenced by CreateControls(), RestoreDefaults(), TaxonsLoaded(), TransferDataFromWindow(), CWindowMaskerTool::x_CreateLoadingJob(), x_InitTaxons(), and CWindowMaskerTool::x_ValidateParams().

◆ GetData() [2/2]

const CWindowMaskerParams& CWindowMaskerPanel::GetData ( void  ) const
inline

Definition at line 108 of file windowmasker_panel.hpp.

References m_data.

◆ GetIconResource()

wxIcon CWindowMaskerPanel::GetIconResource ( const wxString &  name)

Retrieves icon resources.

Get icon resources

Definition at line 238 of file windowmasker_panel.cpp.

◆ Init()

void CWindowMaskerPanel::Init ( void  )

Initialises member variables.

Member initialisation

Definition at line 133 of file windowmasker_panel.cpp.

References m_ObjectList, m_WMDownload, m_WMStatic, m_WMStaticBoxSizer, m_WMTaxIds, and NULL.

Referenced by CWindowMaskerPanel().

◆ LoadSettings()

void CWindowMaskerPanel::LoadSettings ( )
virtual

Implements CAlgoToolManagerParamsPanel.

Definition at line 265 of file windowmasker_panel.cpp.

References CGuiRegistry::GetInstance(), CGuiRegistry::GetReadView(), kTableTag, CwxTableListCtrl::LoadTableSettings(), m_ObjectList, CAlgoToolManagerParamsPanel::m_RegPath, and CGuiRegistryUtil::MakeKey().

Referenced by CWindowMaskerTool::x_CreateParamsPanelIfNeeded().

◆ OnWMDownload()

void CWindowMaskerPanel::OnWMDownload ( wxCommandEvent &  event)

wxEVT_COMMAND_BUTTON_CLICKED event handler for ID_BUTTON5

Definition at line 247 of file windowmasker_panel.cpp.

References CWinMaskerFileStorage::GetInstance(), CWinMaskerFileStorage::ShowOptionsDlg(), and x_InitTaxons().

◆ RestoreDefaults()

void CWindowMaskerPanel::RestoreDefaults ( )
virtual

override in derived classes

Restores the default options for the panel

Implements CAlgoToolManagerParamsPanel.

Definition at line 357 of file windowmasker_panel.cpp.

References GetData(), CWindowMaskerParams::Init(), and TransferDataToWindow().

◆ SaveSettings()

void CWindowMaskerPanel::SaveSettings ( ) const
virtual

override in derived classes

Implements CAlgoToolManagerParamsPanel.

Definition at line 255 of file windowmasker_panel.cpp.

References CGuiRegistry::GetInstance(), CGuiRegistry::GetWriteView(), kTableTag, m_ObjectList, CAlgoToolManagerParamsPanel::m_RegPath, CGuiRegistryUtil::MakeKey(), and CwxTableListCtrl::SaveTableSettings().

◆ SetData()

void CWindowMaskerPanel::SetData ( const CWindowMaskerParams &  data)
inline

Definition at line 109 of file windowmasker_panel.hpp.

References data, and m_data.

Referenced by CWindowMaskerTool::x_CreateParamsPanelIfNeeded().

◆ SetObjects()

void CWindowMaskerPanel::SetObjects ( TConstScopedObjects *  objects)
inline

Definition at line 150 of file windowmasker_panel.hpp.

References m_InputObjects.

Referenced by CWindowMaskerTool::x_CreateParamsPanelIfNeeded().

◆ ShowToolTips()

bool CWindowMaskerPanel::ShowToolTips ( )
static

Should we show tooltips?

Should we show tooltips?

Definition at line 216 of file windowmasker_panel.cpp.

◆ TaxonsLoaded()

void CWindowMaskerPanel::TaxonsLoaded ( bool  local)
virtual

Implements CTaxIdHelper::ICallback.

Definition at line 299 of file windowmasker_panel.cpp.

References CTaxIdHelper::FillControl(), GetData(), CTaxIdHelper::GetInstance(), GetTaxId(), local, m_WMTaxIds, and x_ShowWM().

◆ TransferDataFromWindow()

bool CWindowMaskerPanel::TransferDataFromWindow ( )
virtual

Transfer data from the window.

Transfer data from the window

Definition at line 322 of file windowmasker_panel.cpp.

References GetData(), CObjectListWidget::GetSelection(), int, m_ObjectList, m_WMTaxIds, CWindowMaskerParams::SetObjects(), CWindowMaskerParams::SetTaxId(), and wxT.

◆ TransferDataToWindow()

bool CWindowMaskerPanel::TransferDataToWindow ( )
virtual

Transfer data to the window.

Definition at line 279 of file windowmasker_panel.cpp.

References m_InputObjects, m_ObjectList, CwxTableListCtrl::SelectAll(), CObjectListWidget::SetObjects(), and x_InitTaxons().

Referenced by RestoreDefaults().

◆ x_InitTaxons()

void CWindowMaskerPanel::x_InitTaxons ( )
protected

Definition at line 291 of file windowmasker_panel.cpp.

References GetData(), CTaxIdHelper::GetInstance(), GetTaxId(), m_WMTaxIds, and x_ShowWM().

Referenced by OnWMDownload(), and TransferDataToWindow().

◆ x_ShowWM()

void CWindowMaskerPanel::x_ShowWM ( bool  show)
protected

Definition at line 306 of file windowmasker_panel.cpp.

References ID_LOADING_PROGRESS, ID_LOADING_TEXT, m_WMDownload, m_WMStatic, m_WMStaticBoxSizer, and m_WMTaxIds.

Referenced by TaxonsLoaded(), and x_InitTaxons().

Member Data Documentation

◆ m_AutoDelete

CTaxIdHelper::CAutoDelete CWindowMaskerPanel::m_AutoDelete
protected

Definition at line 173 of file windowmasker_panel.hpp.

◆ m_data

CWindowMaskerParams CWindowMaskerPanel::m_data

The data edited by this window.

Definition at line 128 of file windowmasker_panel.hpp.

Referenced by GetData(), and SetData().

◆ m_InputObjects

TConstScopedObjects* CWindowMaskerPanel::m_InputObjects

Definition at line 152 of file windowmasker_panel.hpp.

Referenced by SetObjects(), and TransferDataToWindow().

◆ m_ObjectList

CObjectListWidget* CWindowMaskerPanel::m_ObjectList

Definition at line 122 of file windowmasker_panel.hpp.

Referenced by CreateControls(), Init(), LoadSettings(), SaveSettings(), TransferDataFromWindow(), and TransferDataToWindow().

◆ m_WMDownload

wxButton* CWindowMaskerPanel::m_WMDownload

Definition at line 126 of file windowmasker_panel.hpp.

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

◆ m_WMStatic

wxStaticText* CWindowMaskerPanel::m_WMStatic

Definition at line 124 of file windowmasker_panel.hpp.

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

◆ m_WMStaticBoxSizer

wxBoxSizer* CWindowMaskerPanel::m_WMStaticBoxSizer

Definition at line 123 of file windowmasker_panel.hpp.

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

◆ m_WMTaxIds

wxChoice* CWindowMaskerPanel::m_WMTaxIds

Definition at line 125 of file windowmasker_panel.hpp.

Referenced by CreateControls(), Init(), TaxonsLoaded(), TransferDataFromWindow(), x_InitTaxons(), and x_ShowWM().

◆ sm_MaskerPaths

CWindowMaskerPanel::TMaskerPaths CWindowMaskerPanel::sm_MaskerPaths
static

CWindowMaskerPanel event table definition

Definition at line 167 of file windowmasker_panel.hpp.

The documentation for this class was generated from the following files:
Generated by doxygen 1.9.0
Modified on Fri Sep 20 14:58:21 2024 by modify_doxy.py rev. 669887