CSrcEditPanel Class Reference

Search Toolkit Book for CSrcEditPanel

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

Inheritance diagram for CSrcEditPanel:

Collaboration diagram for CSrcEditPanel:

Public Member Functions
	CSrcEditPanel ()
	Constructors. More...
	CSrcEditPanel (wxWindow *parent, wxWindowID id=10011, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxSize(400, 300), long style=wxTAB_TRAVERSAL)
bool	Create (wxWindow *parent, wxWindowID id=10011, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxSize(400, 300), long style=wxTAB_TRAVERSAL)
	Creation. More...
	~CSrcEditPanel ()
	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...
CSrcEditParams &	GetData ()
	Data access. More...
const CSrcEditParams &	GetData () const
void	SetData (const CSrcEditParams &data)
wxBitmap	GetBitmapResource (const wxString &name)
	Retrieves bitmap resources. More...
wxIcon	GetIconResource (const wxString &name)
	Retrieves icon resources. More...
void	SetObjects (TConstScopedObjects *objects)
objects::CSeq_entry_Handle	GetSeqEntryHandle ()
void	SetUndoManager (ICommandProccessor *cmdProccessor)
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 ()

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

Public Attributes
CObjectListWidget *	m_ObjectList
TConstScopedObjects *	m_InputObjects
CSrcEditParams	m_data
	The data edited by this window. More...
wxGrid *	m_Grid

Private Attributes
ICommandProccessor *	m_CmdProccessor

Additional Inherited Members
Protected Attributes inherited from CAlgoToolManagerParamsPanel
string	m_RegPath
	registry path to the settings More...

Detailed Description

CSrcEditPanel class declaration

Definition at line 76 of file srcedit_panel.hpp.

Constructor & Destructor Documentation

CSrcEditPanel() [1/2]

CSrcEditPanel::CSrcEditPanel

(

)

Constructors.

CSrcEditPanel type definition

CSrcEditPanel event table definition

CSrcEditPanel constructors

Definition at line 89 of file srcedit_panel.cpp.

References Init().

CSrcEditPanel() [2/2]

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

Definition at line 94 of file srcedit_panel.cpp.

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

~CSrcEditPanel()

CSrcEditPanel::~CSrcEditPanel

(

)

Destructor.

CSrcEditPanel destructor

Definition at line 125 of file srcedit_panel.cpp.

Member Function Documentation

Create()

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

Creation.

CSrcEditPanel creator

Definition at line 105 of file srcedit_panel.cpp.

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

Referenced by CSrcEditPanel(), and CSrcEditTool::x_CreateParamsPanelIfNeeded().

CreateControls()

void CSrcEditPanel::CreateControls

(

)

Creates the controls and sizers.

Control creation for CSrcEditPanel

Definition at line 148 of file srcedit_panel.cpp.

References _, ID_FOREIGN, ID_GRID, m_Grid, m_ObjectList, and wxID_ANY.

Referenced by Create().

GetBitmapResource()

wxBitmap CSrcEditPanel::GetBitmapResource

(

const wxString &

name

)

Retrieves bitmap resources.

Get bitmap resources

Definition at line 313 of file srcedit_panel.cpp.

GetData() [1/2]

CSrcEditParams& CSrcEditPanel::GetData ( void  )

inline

Data access.

Definition at line 114 of file srcedit_panel.hpp.

References m_data.

Referenced by RestoreDefaults(), TransferDataFromWindow(), and CSrcEditTool::x_CreateLoadingJob().

GetData() [2/2]

const CSrcEditParams& CSrcEditPanel::GetData ( void  ) const

inline

Definition at line 115 of file srcedit_panel.hpp.

References m_data.

GetIconResource()

wxIcon CSrcEditPanel::GetIconResource

(

const wxString &

name

)

Retrieves icon resources.

Get icon resources

Definition at line 326 of file srcedit_panel.cpp.

GetSeqEntryHandle()

objects::CSeq_entry_Handle CSrcEditPanel::GetSeqEntryHandle

(

void

)

Definition at line 262 of file srcedit_panel.cpp.

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

Referenced by TransferDataFromWindow(), and TransferDataToWindow().

Init()

void CSrcEditPanel::Init

(

void

)

Initialises member variables.

Member initialisation

Definition at line 136 of file srcedit_panel.cpp.

References m_ObjectList, and NULL.

Referenced by CSrcEditPanel().

LoadSettings()

void CSrcEditPanel::LoadSettings ( )

virtual

Implements CAlgoToolManagerParamsPanel.

Definition at line 248 of file srcedit_panel.cpp.

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

Referenced by CSrcEditTool::x_CreateParamsPanelIfNeeded().

RestoreDefaults()

void CSrcEditPanel::RestoreDefaults ( )

virtual

override in derived classes

Restores the default options for the panel

Implements CAlgoToolManagerParamsPanel.

Definition at line 335 of file srcedit_panel.cpp.

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

SaveSettings()

void CSrcEditPanel::SaveSettings ( ) const

virtual

override in derived classes

Implements CAlgoToolManagerParamsPanel.

Definition at line 237 of file srcedit_panel.cpp.

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

SetData()

void CSrcEditPanel::SetData ( const CSrcEditParams &  data )

inline

Definition at line 116 of file srcedit_panel.hpp.

References data, and m_data.

Referenced by CSrcEditTool::x_CreateParamsPanelIfNeeded().

SetObjects()

void CSrcEditPanel::SetObjects ( TConstScopedObjects *  objects )

inline

Definition at line 131 of file srcedit_panel.hpp.

References m_InputObjects.

Referenced by CSrcEditTool::x_CreateParamsPanelIfNeeded().

SetUndoManager()

void CSrcEditPanel::SetUndoManager ( ICommandProccessor *  cmdProccessor )

inline

Definition at line 146 of file srcedit_panel.hpp.

References m_CmdProccessor.

ShowToolTips()

bool CSrcEditPanel::ShowToolTips ( )

static

Should we show tooltips?

Should we show tooltips?

Definition at line 304 of file srcedit_panel.cpp.

TransferDataFromWindow()

bool CSrcEditPanel::TransferDataFromWindow ( )

virtual

Transfer data from the window.

Transfer data from the window

Definition at line 209 of file srcedit_panel.cpp.

References ApplySrcTableToSeqEntry(), cmd, GetData(), CObjectListWidget::GetSelection(), GetSeqEntryHandle(), CSeqTableGrid::GetValuesTable(), m_Grid, m_ObjectList, and wxT.

TransferDataToWindow()

bool CSrcEditPanel::TransferDataToWindow ( )

virtual

Transfer data to the window.

Transfer data to the window

Definition at line 183 of file srcedit_panel.cpp.

References GetSeqEntryHandle(), GetSeqTableFromSeqEntry(), m_Grid, and NULL.

Referenced by RestoreDefaults().

Member Data Documentation

m_CmdProccessor

ICommandProccessor* CSrcEditPanel::m_CmdProccessor

private

Definition at line 149 of file srcedit_panel.hpp.

Referenced by SetUndoManager().

m_data

CSrcEditParams CSrcEditPanel::m_data

The data edited by this window.

Definition at line 143 of file srcedit_panel.hpp.

Referenced by GetData(), and SetData().

m_Grid

wxGrid* CSrcEditPanel::m_Grid

Definition at line 144 of file srcedit_panel.hpp.

Referenced by CreateControls(), TransferDataFromWindow(), and TransferDataToWindow().

m_InputObjects

TConstScopedObjects* CSrcEditPanel::m_InputObjects

Definition at line 141 of file srcedit_panel.hpp.

Referenced by GetSeqEntryHandle(), and SetObjects().

m_ObjectList

CObjectListWidget* CSrcEditPanel::m_ObjectList

Definition at line 139 of file srcedit_panel.hpp.

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

---

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

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