Search Toolkit Book for CSearchFormBase

#include <gui/core/search_form_base.hpp>

Inheritance diagram for CSearchFormBase:

Collaboration diagram for CSearchFormBase:

Public Types
typedef vector< IDataMiningContext * >	TContexts

typedef CMRUList< string >	TMRUInputs

typedef objects::CFeatListItem	TFeatTypeItem

typedef set< TFeatTypeItem >	TFeatTypeItemSet

typedef CSearchToolBase::EPatternType	TPatternType

typedef map< string, TPatternType >	TNameToType

Public Types inherited from CObject
enum	EAllocFillMode { eAllocFillNone = 1 , eAllocFillZero , eAllocFillPattern }
	Control filling of newly allocated memory. More...

typedef CObjectCounterLocker	TLockerType
	Default locker type for CRef. More...

typedef atomic< Uint8 >	TCounter
	Counter type is CAtomiCounter. More...

typedef Uint8	TCount
	Alias for value type of counter. More...

Public Types inherited from IDMSearchForm
enum	ECommands { eCmdDMSearch = 11000 }

enum	TDialogType { FEATURE_SEL_DIALOG }

Public Member Functions
	CSearchFormBase ()
	CSearchFormBase. More...

virtual	~CSearchFormBase ()

virtual void	SetController (IDMSearchFormController *controller)

virtual IDMSearchTool *	x_GetTool ()=0

virtual wxSizer *	GetWidget (wxWindow *parent)
	return a widget associated with the form; the form controls the lifetime of the widget (do not delete the widget) More...

virtual CIRef< IDMSearchQuery >	ConstructQuery ()

virtual void	UpdateContexts ()
	updates m_ContextCombo More...

void	UpdateContextCombo (wxChoice *combo)

virtual void	PopupADialog (TDialogType dt)
	TODO this function should be here - it should be move the the form that needs this dialog. More...

virtual void	SetDictionary (list< string > *ddd)

virtual void	Push ()

virtual void	SetRangeLimit (bool bLimit)

virtual string	GetMainValue ()
	get/set main search value, this is separate from settings More...

virtual void	SetMainValue (string val)

virtual void	SetRegistryPath (const string &reg_path)

virtual void	LoadSettings ()

virtual void	SaveSettings () const

Public Member Functions inherited from CObjectEx
	CObjectEx (void)

virtual	~CObjectEx (void)

Public Member Functions inherited from CObject
	CObject (void)
	Constructor. More...

	CObject (const CObject &src)
	Copy constructor. More...

virtual	~CObject (void)
	Destructor. More...

CObject &	operator= (const CObject &src) THROWS_NONE
	Assignment operator. More...

bool	CanBeDeleted (void) const THROWS_NONE
	Check if object can be deleted. More...

bool	IsAllocatedInPool (void) const THROWS_NONE
	Check if object is allocated in memory pool (not system heap) More...

bool	Referenced (void) const THROWS_NONE
	Check if object is referenced. More...

bool	ReferencedOnlyOnce (void) const THROWS_NONE
	Check if object is referenced only once. More...

void	AddReference (void) const
	Add reference to object. More...

void	RemoveReference (void) const
	Remove reference to object. More...

void	ReleaseReference (void) const
	Remove reference without deleting object. More...

virtual void	DoNotDeleteThisObject (void)
	Mark this object as not allocated in heap – do not delete this object. More...

virtual void	DoDeleteThisObject (void)
	Mark this object as allocated in heap – object can be deleted. More...

void *	operator new (size_t size)
	Define new operator for memory allocation. More...

void *	operator new[] (size_t size)
	Define new[] operator for 'array' memory allocation. More...

void	operator delete (void *ptr)
	Define delete operator for memory deallocation. More...

void	operator delete[] (void *ptr)
	Define delete[] operator for memory deallocation. More...

void *	operator new (size_t size, void *place)
	Define new operator. More...

void	operator delete (void ptr, void place)
	Define delete operator. More...

void *	operator new (size_t size, CObjectMemoryPool *place)
	Define new operator using memory pool. More...

void	operator delete (void ptr, CObjectMemoryPool place)
	Define delete operator. More...

virtual void	DebugDump (CDebugDumpContext ddc, unsigned int depth) const
	Define method for dumping debug information. More...

Public Member Functions inherited from CDebugDumpable
	CDebugDumpable (void)

virtual	~CDebugDumpable (void)

void	DebugDumpText (ostream &out, const string &bundle, unsigned int depth) const

void	DebugDumpFormat (CDebugDumpFormatter &ddf, const string &bundle, unsigned int depth) const

void	DumpToConsole (void) const

Public Member Functions inherited from CWeakObject
	CWeakObject (void)

virtual	~CWeakObject (void)

CPtrToObjectProxy *	GetPtrProxy (void) const
	Get pointer to proxy object containing pointer to this object. More...

Public Member Functions inherited from IDMSearchForm
virtual	~IDMSearchForm ()

virtual void	Create ()

virtual void	Init ()

virtual void	Update ()=0

virtual bool	IsRunning () const
	the tool associated with the form is running More...

virtual string	GetCurrentModeKey ()
	return a section name for the current mode or "" More...

Public Member Functions inherited from IRegSettings
virtual	~IRegSettings ()

Protected Member Functions
virtual void	x_LoadSettings (const CRegistryReadView &)=0

virtual void	x_SaveSettings (CRegistryWriteView) const =0

Protected Member Functions inherited from CObject
virtual void	DeleteThis (void)
	Virtual method "deleting" this object. More...

Protected Member Functions inherited from CWeakObject
void	CleanWeakRefs (void) const
	Method cleaning all CWeakRefs referencing at this moment to the object After calling to this method all existing CWeakRefs referencing to the object will return NULL, so it effectively will be equal to deleting the object. More...

Protected Attributes
TContexts	m_Contexts

IDataMiningContext *	m_ActiveContext

TFeatTypeItemSet	m_FeatTypesSet

IDMSearchFormController *	m_Controller

wxSizer *	m_Sizer

CSearchControl *	m_Text

string	m_RegPath

string	m_Input

bool	m_bRange

Private Member Functions
	CSearchFormBase (const CSearchFormBase &)

CSearchFormBase &	operator= (const CSearchFormBase &)

Additional Inherited Members
Static Public Member Functions inherited from CObject
static NCBI_XNCBI_EXPORT void	ThrowNullPointerException (void)
	Define method to throw null pointer exception. More...

static NCBI_XNCBI_EXPORT void	ThrowNullPointerException (const type_info &type)

static EAllocFillMode	GetAllocFillMode (void)

static void	SetAllocFillMode (EAllocFillMode mode)

static void	SetAllocFillMode (const string &value)
	Set mode from configuration parameter value. More...

Static Public Member Functions inherited from CDebugDumpable
static void	EnableDebugDump (bool on)

Static Public Attributes inherited from CObject
static const TCount	eCounterBitsCanBeDeleted = 1 << 0
	Define possible object states. More...

static const TCount	eCounterBitsInPlainHeap = 1 << 1
	Heap signature was found. More...

static const TCount	eCounterBitsPlaceMask
	Mask for 'in heap' state flags. More...

static const int	eCounterStep = 1 << 2
	Skip over the "in heap" bits. More...

static const TCount	eCounterValid = TCount(1) << (sizeof(TCount) * 8 - 2)
	Minimal value for valid objects (reference counter is zero) Must be a single bit value. More...

static const TCount	eCounterStateMask
	Valid object, and object in heap. More...