NCBI C++ ToolKit
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
CWindowMaskerTool Class Reference

Search Toolkit Book for CWindowMaskerTool

CWindowMaskerTool. More...

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

+ Inheritance diagram for CWindowMaskerTool:
+ Collaboration diagram for CWindowMaskerTool:

Public Member Functions

 CWindowMaskerTool ()
 CWindowMaskerTool. More...
 
overriding IUIToolManager functions implemented in CAlgoToolManagerBase
virtual void InitUI ()
 override this function in a derived class and initialize extra members More...
 
virtual void CleanUI ()
 override this function in a derived class and clean extra members More...
 
virtual bool UsesSingleOMScope ()
 
IExtension interface implementation
virtual string GetExtensionIdentifier () const
 returns the unique human-readable identifier for the extension the id should use lowercase letters separated by underscores - "like_this" More...
 
virtual string GetExtensionLabel () const
 returns a displayable label for this extension ( please capitalize the key words - "My Extension" ) More...
 
- Public Member Functions inherited from CAlgoToolManagerBase
 CAlgoToolManagerBase (const string &label, const string &icon_alias, const string &hint=kEmptyStr, const string &description=kEmptyStr, const string &help_id=kEmptyStr, const string &category="Unknown")
 CAlgoToolManagerBase. More...
 
virtual void SetServiceLocator (IServiceLocator *srv_locator)
 Sets / unsets Service Locator. More...
 
virtual void SetParentWindow (wxWindow *parent)
 
virtual const IUIObjectGetDescriptor () const
 Returns the object describing this tool (UI meta data). More...
 
virtual wxPanel * GetCurrentPanel ()
 Return the panel corresponding to the current state of Tool Manager. More...
 
virtual bool CanDo (EAction action)
 Indicates whether given transition is possible in the current state. More...
 
virtual bool IsFinalState ()
 True if Tool Manager has reached its final state, i.e. More...
 
virtual bool IsCompletedState ()
 Manager goes into "Complete" state when "Finish" button is pressed and all input data is gatherred and validated. More...
 
virtual bool DoTransition (EAction action)
 Performs transition if possible and returns true, otherwise the function shall warn the user about the problem preventing the transition (such as insufficient or invalid input) and return false. More...
 
virtual IAppTaskGetTask ()
 Once parameters are gathered and validated this function is called to produce the final Task object that will be executed to do the actual computational work. More...
 
virtual void RestoreDefaults ()
 Restores the default options for the current panel. More...
 
virtual string GetCategory ()
 returns the name for the ToolCategory to which the tool belongs. More...
 
virtual string SetInputObjects (const vector< TConstScopedObjects > &input)
 sets input objects that can be used as arguments for the tool. More...
 
virtual bool CanQuickLaunch () const
 
virtual IAppTaskQuickLaunch ()
 
virtual void SetRegistryPath (const string &path)
 
virtual void LoadSettings ()
 
virtual void SaveSettings () const
 
- Public Member Functions inherited from CObject
 CObject (void)
 Constructor. More...
 
 CObject (const CObject &src)
 Copy constructor. More...
 
virtual ~CObject (void)
 Destructor. More...
 
CObjectoperator= (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 IUIToolManager
virtual wxPanel * GetMaxPanel ()
 Return the panel that occupies max size on display, to calculate dialog window size. More...
 
virtual IUIToolManagerGetAlternateToolManager ()
 If a transition fails, it may make sense to switch to a different tool manger When a tool manager identifies a more appropriate manager for a task, it returns it here, otherwise NULL. More...
 
virtual IExecuteUnitGetExecuteUnit ()
 
virtual IWizardPageGetFirstPage ()
 Returns first options page (if any) of the tool to be shown in wizard dialog. More...
 
virtual IWizardPageGetOptionsPage ()
 Returns page for tool options (long wizard path via "Options" button) More...
 
virtual void SetPrevPage (IWizardPage *)
 Sets a wizard page which should show before the first page of the tool. More...
 
virtual void SetNextPage (IWizardPage *)
 Sets a wizard page which should show after the last page of the tool. More...
 
virtual void ResetState ()
 
virtual ~IUIToolManager ()
 
- Public Member Functions inherited from IExtension
virtual ~IExtension ()
 
- Public Member Functions inherited from IRegSettings
virtual ~IRegSettings ()
 

Protected Member Functions

virtual void x_SelectCompatibleInputObjects ()
 
overriding CAlgoToolManagerBase virtual functions
virtual CAlgoToolManagerParamsPanelx_GetParamsPanel ()
 returns a pointer to the parameters panel, override in derived classes More...
 
virtual IRegSettingsx_GetParamsAsRegSetting ()
 return a pointer to Parameters object as IRegSettings interface More...
 
virtual bool x_CreateParamsPanelIfNeeded ()
 returns / creates Parameters panel, override in derived classes see cpp file for example More...
 
virtual bool x_ValidateParams ()
 validates user input in Parameters panel, report errors if any More...
 
virtual CDataLoadingAppJobx_CreateLoadingJob ()
 factory method for creating the job that executes the tool algorithm override in derived classes More...
 
- Protected Member Functions inherited from CAlgoToolManagerBase
virtual void x_InitProjectParams ()
 init m_ProjectParams, in particular can select target project based on the tool input More...
 
virtual void x_CreateProjectPanelIfNeeded ()
 returns / creates Project panel More...
 
virtual void x_SetInputObjects (const vector< TConstScopedObjects > &input)
 
virtual string x_ValidateInputObjects ()
 
void x_ConvertInputObjects (const CTypeInfo *typeInfo, map< string, TConstScopedObjects > &results)
 
void x_ConvertInputObjects (const CTypeInfo *typeInfo, TConstScopedObjects &results)
 
ILockerx_GetDataLocker ()
 
- Protected Member Functions inherited from CObject
virtual void DeleteThis (void)
 Virtual method "deleting" this object. More...
 

Protected Attributes

TConstScopedObjects m_Objects
 
CWindowMaskerParams m_Params
 
CWindowMaskerPanelm_Panel
 
- Protected Attributes inherited from CAlgoToolManagerBase
CUIObject m_Descriptor
 describes the Manager's UI properties More...
 
const string m_Category
 defines tool category More...
 
IServiceLocatorm_SrvLocator
 
wxWindow * m_ParentWindow
 a window that will serve as a parent for our panels More...
 
string m_RegPath
 registry path to the settings More...
 
EState m_State
 tool manager state (int the Run Tool wizard) More...
 
vector< TConstScopedObjectsm_InputObjects
 original input objects, the tool needs to select a subset of objects that can serve as valid input More...
 
SProjectSelectorParams m_ProjectParams
 
CProjectSelectorPanelm_ProjectSelPanel
 

Additional Inherited Members

- 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< Uint8TCounter
 Counter type is CAtomiCounter. More...
 
typedef Uint8 TCount
 Alias for value type of counter. More...
 
- Public Types inherited from IUIToolManager
enum  EAction { eBack = 0 , eNext , eSkip }
 
- 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...
 
- Protected Types inherited from CAlgoToolManagerBase
enum  EState { eInvalid = -1 , eParams , eSelectProject , eCompleted }
 defines states of the Tool Manager More...
 

Detailed Description

CWindowMaskerTool.

Definition at line 46 of file windowmasker_tool.hpp.

Constructor & Destructor Documentation

◆ CWindowMaskerTool()

CWindowMaskerTool::CWindowMaskerTool ( )

CWindowMaskerTool.

Definition at line 67 of file windowmasker_tool.cpp.

Member Function Documentation

◆ CleanUI()

void CWindowMaskerTool::CleanUI ( )
virtual

override this function in a derived class and clean extra members

Reimplemented from CAlgoToolManagerBase.

Definition at line 97 of file windowmasker_tool.cpp.

References CAlgoToolManagerBase::CleanUI(), m_Objects, m_Panel, and NULL.

◆ GetExtensionIdentifier()

string CWindowMaskerTool::GetExtensionIdentifier ( ) const
virtual

returns the unique human-readable identifier for the extension the id should use lowercase letters separated by underscores - "like_this"

Implements CAlgoToolManagerBase.

Definition at line 79 of file windowmasker_tool.cpp.

◆ GetExtensionLabel()

string CWindowMaskerTool::GetExtensionLabel ( ) const
virtual

returns a displayable label for this extension ( please capitalize the key words - "My Extension" )

Implements CAlgoToolManagerBase.

Definition at line 85 of file windowmasker_tool.cpp.

◆ InitUI()

void CWindowMaskerTool::InitUI ( )
virtual

override this function in a derived class and initialize extra members

Reimplemented from CAlgoToolManagerBase.

Definition at line 90 of file windowmasker_tool.cpp.

References CAlgoToolManagerBase::InitUI(), m_Objects, m_Panel, and NULL.

◆ UsesSingleOMScope()

virtual bool CWindowMaskerTool::UsesSingleOMScope ( )
inlinevirtual

Reimplemented from IUIToolManager.

Definition at line 55 of file windowmasker_tool.hpp.

◆ x_CreateLoadingJob()

CDataLoadingAppJob * CWindowMaskerTool::x_CreateLoadingJob ( )
protectedvirtual

factory method for creating the job that executes the tool algorithm override in derived classes

Implements CAlgoToolManagerBase.

Definition at line 228 of file windowmasker_tool.cpp.

References CWindowMaskerPanel::GetData(), m_Panel, and m_Params.

◆ x_CreateParamsPanelIfNeeded()

bool CWindowMaskerTool::x_CreateParamsPanelIfNeeded ( )
protectedvirtual

◆ x_GetParamsAsRegSetting()

IRegSettings * CWindowMaskerTool::x_GetParamsAsRegSetting ( )
protectedvirtual

return a pointer to Parameters object as IRegSettings interface

Implements CAlgoToolManagerBase.

Definition at line 204 of file windowmasker_tool.cpp.

References m_Params.

◆ x_GetParamsPanel()

CAlgoToolManagerParamsPanel * CWindowMaskerTool::x_GetParamsPanel ( )
protectedvirtual

returns a pointer to the parameters panel, override in derived classes

Implements CAlgoToolManagerBase.

Definition at line 199 of file windowmasker_tool.cpp.

References m_Panel.

◆ x_SelectCompatibleInputObjects()

void CWindowMaskerTool::x_SelectCompatibleInputObjects ( )
protectedvirtual

◆ x_ValidateParams()

bool CWindowMaskerTool::x_ValidateParams ( )
protectedvirtual

validates user input in Parameters panel, report errors if any

validate parameters after Params page override this function in derived classes

Reimplemented from CAlgoToolManagerBase.

Definition at line 145 of file windowmasker_tool.cpp.

References eDialog_Ok, eIcon_Stop, CWindowMaskerPanel::GetData(), CWindowMaskerParams::GetTaxId(), m_Panel, m_Params, NcbiMessageBoxW(), NULL, s_GetPath(), and wxT.

Member Data Documentation

◆ m_Objects

TConstScopedObjects CWindowMaskerTool::m_Objects
protected

◆ m_Panel

CWindowMaskerPanel* CWindowMaskerTool::m_Panel
protected

◆ m_Params

CWindowMaskerParams CWindowMaskerTool::m_Params
protected

The documentation for this class was generated from the following files:
Modified on Thu Jun 13 17:26:47 2024 by modify_doxy.py rev. 669887