CDebugMacroToolPanel Class Reference

Search Toolkit Book for CDebugMacroToolPanel

#include "debug_macro_tool_panel.hpp"
(Private to src/gui/packages/pkg_sequence_edit.)

Inheritance diagram for CDebugMacroToolPanel:

Collaboration diagram for CDebugMacroToolPanel:

Public Types
enum	{ ID_CDEBUGMACROTOOL = 10330 , ID_PANEL = 10331 , ID_TEXTCTRL9 = 10332 }
	Control identifiers. More...

Public Member Functions
	CDebugMacroToolPanel ()
	Constructors. More...
	CDebugMacroToolPanel (wxWindow *parent, wxWindowID id=ID_CDEBUGMACROTOOL, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxSize(400, 300), long style=wxNO_BORDER|wxTAB_TRAVERSAL)
bool	Create (wxWindow *parent, wxWindowID id=ID_CDEBUGMACROTOOL, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxSize(400, 300), long style=wxNO_BORDER|wxTAB_TRAVERSAL)
	Creation. More...
	~CDebugMacroToolPanel ()
	Destructor. More...
void	Init ()
	Initialises member variables. More...
void	CreateControls ()
	Creates the controls and sizers. More...
virtual bool	TransferDataFromWindow ()
	Transfer data from the window. More...
CDebugMacroToolParams &	GetData ()
	Data access. More...
const CDebugMacroToolParams &	GetData () const
void	SetData (const CDebugMacroToolParams &data)
wxBitmap	GetBitmapResource (const wxString &name)
	Retrieves bitmap resources. More...
wxIcon	GetIconResource (const wxString &name)
	Retrieves icon resources. More...
void	SetObjects (map< string, TConstScopedObjects > *objects)
CAlgoToolManagerParamsPanel implementation
void	RestoreDefaults ()
	override in derived classes More...
IRegSettings interface implementation
virtual void	SetRegistryPath (const string &path)
	CAlgoToolManagerParamsPanel. More...
virtual void	LoadSettings ()
virtual void	SaveSettings () const
	override in derived classes More...
IRegSettings interface implementation
Public Member Functions inherited from IRegSettings
virtual	~IRegSettings ()

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

Public Attributes
CObjectListWidgetSel *	m_ObjectSel
CDebugMacroToolParams	m_data
	The data edited by this window. More...

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

Detailed Description

CDebugMacroToolPanel class declaration

Definition at line 69 of file debug_macro_tool_panel.hpp.

Member Enumeration Documentation

anonymous enum

anonymous enum

Control identifiers.

Enumerator
ID_CDEBUGMACROTOOL
ID_PANEL
ID_TEXTCTRL9

Definition at line 132 of file debug_macro_tool_panel.hpp.

Constructor & Destructor Documentation

CDebugMacroToolPanel() [1/2]

CDebugMacroToolPanel::CDebugMacroToolPanel

(

)

Constructors.

CDebugMacroToolPanel type definition

CDebugMacroToolPanel event table definition

CDebugMacroToolPanel constructors

Definition at line 75 of file debug_macro_tool_panel.cpp.

References Init().

CDebugMacroToolPanel() [2/2]

CDebugMacroToolPanel::CDebugMacroToolPanel	(	wxWindow *	parent,
		wxWindowID	id = ID_CDEBUGMACROTOOL,
		const wxPoint &	pos = wxDefaultPosition,
		const wxSize &	size = wxSize(400, 300),
		long	style = wxNO_BORDER|wxTAB_TRAVERSAL
	)

Definition at line 80 of file debug_macro_tool_panel.cpp.

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

~CDebugMacroToolPanel()

CDebugMacroToolPanel::~CDebugMacroToolPanel

(

)

Destructor.

CDebugMacroToolPanel destructor

Definition at line 112 of file debug_macro_tool_panel.cpp.

Member Function Documentation

Create()

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

Creation.

CDebugMacroTool creator

Definition at line 91 of file debug_macro_tool_panel.cpp.

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

Referenced by CDebugMacroToolPanel(), and CDebugMacroTool::GetMaxPanel().

CreateControls()

void CDebugMacroToolPanel::CreateControls

(

)

Creates the controls and sizers.

Control creation for CDebugMacroTool

Definition at line 135 of file debug_macro_tool_panel.cpp.

References GetData(), ID_PANEL, ID_TEXTCTRL9, m_ObjectSel, CObjectListWidgetSel::SetTitle(), and wxT.

Referenced by Create().

GetBitmapResource()

wxBitmap CDebugMacroToolPanel::GetBitmapResource

(

const wxString &

name

)

Retrieves bitmap resources.

Get bitmap resources

Definition at line 184 of file debug_macro_tool_panel.cpp.

GetData() [1/2]

CDebugMacroToolParams& CDebugMacroToolPanel::GetData ( void  )

inline

Data access.

Definition at line 111 of file debug_macro_tool_panel.hpp.

References m_data.

Referenced by CreateControls(), RestoreDefaults(), TransferDataFromWindow(), and CDebugMacroTool::x_CreateLoadingJob().

GetData() [2/2]

const CDebugMacroToolParams& CDebugMacroToolPanel::GetData ( void  ) const

inline

Definition at line 112 of file debug_macro_tool_panel.hpp.

References m_data.

GetIconResource()

wxIcon CDebugMacroToolPanel::GetIconResource

(

const wxString &

name

)

Retrieves icon resources.

Get icon resources

Definition at line 197 of file debug_macro_tool_panel.cpp.

Init()

void CDebugMacroToolPanel::Init

(

void

)

Initialises member variables.

Member initialisation

Definition at line 123 of file debug_macro_tool_panel.cpp.

References m_ObjectSel, and NULL.

Referenced by CDebugMacroToolPanel().

LoadSettings()

void CDebugMacroToolPanel::LoadSettings ( )

virtual

Implements CAlgoToolManagerParamsPanel.

Definition at line 234 of file debug_macro_tool_panel.cpp.

References CObjectListWidgetSel::LoadSettings(), and m_ObjectSel.

Referenced by CDebugMacroTool::x_CreateParamsPanelIfNeeded().

RestoreDefaults()

void CDebugMacroToolPanel::RestoreDefaults ( )

virtual

override in derived classes

Restores the default options for the panel

Implements CAlgoToolManagerParamsPanel.

Definition at line 239 of file debug_macro_tool_panel.cpp.

References GetData(), and CDebugMacroToolParams::Init().

SaveSettings()

void CDebugMacroToolPanel::SaveSettings ( ) const

virtual

override in derived classes

Implements CAlgoToolManagerParamsPanel.

Definition at line 229 of file debug_macro_tool_panel.cpp.

References m_ObjectSel, and CObjectListWidgetSel::SaveSettings().

SetData()

void CDebugMacroToolPanel::SetData ( const CDebugMacroToolParams &  data )

inline

Definition at line 113 of file debug_macro_tool_panel.hpp.

References data, and m_data.

Referenced by CDebugMacroTool::x_CreateParamsPanelIfNeeded().

SetObjects()

void CDebugMacroToolPanel::SetObjects

(

map< string, TConstScopedObjects > *

objects

)

Definition at line 166 of file debug_macro_tool_panel.cpp.

References m_ObjectSel, and CObjectListWidgetSel::SetObjects().

Referenced by CDebugMacroTool::x_CreateParamsPanelIfNeeded().

SetRegistryPath()

void CDebugMacroToolPanel::SetRegistryPath ( const string &  reg_path )

virtual

CAlgoToolManagerParamsPanel.

Reimplemented from CAlgoToolManagerParamsPanel.

Definition at line 223 of file debug_macro_tool_panel.cpp.

References kObjectSel, m_ObjectSel, CAlgoToolManagerParamsPanel::m_RegPath, and CObjectListWidgetSel::SetRegistryPath().

Referenced by CDebugMacroTool::x_CreateParamsPanelIfNeeded().

ShowToolTips()

bool CDebugMacroToolPanel::ShowToolTips ( )

static

Should we show tooltips?

Should we show tooltips?

Definition at line 175 of file debug_macro_tool_panel.cpp.

TransferDataFromWindow()

bool CDebugMacroToolPanel::TransferDataFromWindow ( )

virtual

Transfer data from the window.

Transfer data from the window

Definition at line 210 of file debug_macro_tool_panel.cpp.

References GetData(), CObjectListWidgetSel::GetSelection(), m_ObjectSel, and CDebugMacroToolParams::SetObjects().

Member Data Documentation

m_data

CDebugMacroToolParams CDebugMacroToolPanel::m_data

The data edited by this window.

Definition at line 130 of file debug_macro_tool_panel.hpp.

Referenced by GetData(), and SetData().

m_ObjectSel

CObjectListWidgetSel* CDebugMacroToolPanel::m_ObjectSel

Definition at line 128 of file debug_macro_tool_panel.hpp.

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

---

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

• src/gui/packages/pkg_sequence_edit/debug_macro_tool_panel.hpp
• src/gui/packages/pkg_sequence_edit/debug_macro_tool_panel.cpp