RetroSearch Browse

Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from http://www.ncbi.nlm.nih.gov/IEB/ToolBox/CPP_DOC/doxyhtml/classIUIToolManager.html below:

NCBI C++ ToolKit: IUIToolManager Class Reference

Search Toolkit Book for IUIToolManager

#include <gui/core/ui_tool_manager.hpp>

Definition at line 74 of file ui_tool_manager.hpp.

◆ EAction ◆ ~IUIToolManager() ◆ CanDo()

Indicates whether given transition is possible in the current state.

◆ CleanUI() virtual void IUIToolManager::CleanUI ( ) pure virtual

CleanUI() is called after the host finished using the manager.

This function shall free resources associated with the session and reset internal state.

Implemented in CWiggleExporter, CWigLoadManager, CVCFLoaderManager, CGtfExporter, CGffLoadManager, CGffExporter, CFlatFileExporter, CFASTAFormatLoadManager, CFastaExporter, CColumnarVCFLoaderManager, CBedLoadManager, CAgpLoader, CAgpExporter, C5ColLoadManager, C5ColExporter, CTextAlignLoaderManager, CRMLoader, CPslLoadManager, CPhyLoader, CPhyExporter, CFastaAlignExporter, CCreateNeedlemanWunschToolManager, CAlignTabExporter, CAdvancedCleanupTool, CAsnExporter, CSrcEditTool, CQualTableLoadManager, CDebugMacroTool, CAutodefToolManager, CWindowMaskerTool, CMergeTool, CGenBankUILoadManager, CGBFlatFileLoadManager, CCleanupTool, CBamUILoadManager, CTreeBuilderTool, CCommonTaxTreeTool, CSplignTool, CProSplignTool, CNGAlignTool, CNetBLASTUILoadManager, CMuscleTool, CMergeAlignmentsToolManager, CMafftTool, CLBLASTUILoadManager, CKalignTool, CGroupAlignmentsToolManager, CFindOverlapTool, CCreateGeneModelToolManager, CClustalwTool, CClustalOmegaTool, CCleanupAlignmentsToolManager, CBLASTToolManager, CProjectFormatLoadManager, CProjectLoadManager, CGCAssemblyLoadManager, CFileLoadManager, CTableFileLoadManager, CFileAutoLoader, CASNFormatLoadManager, and CAlgoToolManagerBase.

Referenced by CFileLoadManager::CleanUI().

◆ DoTransition() virtual bool IUIToolManager::DoTransition ( EAction action ) pure virtual

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.

Typically this function would take user input from the current panel, validate the input and go to the next state creating new UI panel if needed.

◆ GetAlternateToolManager()

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.

Reimplemented in CFileLoadManager.

Definition at line 133 of file ui_tool_manager.hpp.

References NULL.

◆ GetCurrentPanel() virtual wxPanel* IUIToolManager::GetCurrentPanel ( ) pure virtual

Return the panel corresponding to the current state of Tool Manager.

◆ GetDescriptor()

Returns the object describing this tool (UI meta data).

Referenced by COpenDlg::x_AppendOptionForManager(), and CFileLoadManager::x_GetOptionsPanel().

◆ GetExecuteUnit()

Reimplemented in CWigLoadManager, CVCFLoaderManager, CGffLoadManager, CFASTAFormatLoadManager, CColumnarVCFLoaderManager, CBedLoadManager, CAgpLoader, C5ColLoadManager, CTextAlignLoaderManager, CRMLoader, CPslLoadManager, CPhyLoader, CQualTableLoadManager, CGBFlatFileLoadManager, CFileLoadManager, CTableFileLoadManager, CFileAutoLoader, and CASNFormatLoadManager.

Definition at line 140 of file ui_tool_manager.hpp.

◆ GetFirstPage()

Returns first options page (if any) of the tool to be shown in wizard dialog.

Definition at line 143 of file ui_tool_manager.hpp.

◆ GetMaxPanel() virtual wxPanel* IUIToolManager::GetMaxPanel ( ) inlinevirtual

Return the panel that occupies max size on display, to calculate dialog window size.

Reimplemented in CAdvancedCleanupTool, CDebugMacroTool, CCommonTaxTreeTool, CSplignTool, CProSplignTool, CMuscleTool, CMafftTool, CKalignTool, CClustalwTool, CClustalOmegaTool, and CBLASTToolManager.

Definition at line 105 of file ui_tool_manager.hpp.

◆ GetOptionsPage() virtual IWizardPage* IUIToolManager::GetOptionsPage ( ) inlinevirtual ◆ GetTask() virtual IAppTask* IUIToolManager::GetTask ( ) pure virtual

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.

Implemented in CWiggleExporter, CWigLoadManager, CVCFLoaderManager, CGtfExporter, CGffLoadManager, CGffExporter, CFlatFileExporter, CFASTAFormatLoadManager, CFastaExporter, CColumnarVCFLoaderManager, CBedLoadManager, CAgpLoader, CAgpExporter, C5ColLoadManager, C5ColExporter, CTextAlignLoaderManager, CRMLoader, CPslLoadManager, CPhyLoader, CPhyExporter, CFastaAlignExporter, CAlignTabExporter, CAsnExporter, CSrcEditTool, CQualTableLoadManager, CAutodefToolManager, CMergeTool, CGenBankUILoadManager, CGBFlatFileLoadManager, CCleanupTool, CBamUILoadManager, CNetBLASTUILoadManager, CLBLASTUILoadManager, CCreateGeneModelToolManager, CBLASTToolManager, CProjectFormatLoadManager, CProjectLoadManager, CGCAssemblyLoadManager, CFileLoadManager, CTableFileLoadManager, CFileAutoLoader, CASNFormatLoadManager, and CAlgoToolManagerBase.

◆ InitUI() virtual void IUIToolManager::InitUI ( ) pure virtual

Initializes the Manager before using it in UI.

This function shall reset Internal state of the tool.

Referenced by CFileLoadManager::InitUI().

◆ IsCompletedState() virtual bool IUIToolManager::IsCompletedState ( ) pure virtual

Manager goes into "Complete" state when "Finish" button is pressed and all input data is gatherred and validated.

Typically this is the last state after Final state. This state does not have an associated UI panel. When manager reaches the Completed state the framework hides the dialog and calls GetTask() function.

◆ IsFinalState() virtual bool IUIToolManager::IsFinalState ( ) pure virtual

True if Tool Manager has reached its final state, i.e.

the last page (panel) in the sequence is displayed and "Finish" button is shown. The framework calls this function to decide whether Finish or Next button needs to be shown.

◆ ResetState() virtual void IUIToolManager::ResetState ( ) inlinevirtual ◆ RestoreDefaults() virtual void IUIToolManager::RestoreDefaults ( ) inlinevirtual ◆ SetNextPage() virtual void IUIToolManager::SetNextPage ( IWizardPage * ) inlinevirtual

Sets a wizard page which should show after the last page of the tool.

Definition at line 149 of file ui_tool_manager.hpp.

◆ SetParentWindow() virtual void IUIToolManager::SetParentWindow ( wxWindow * parent ) pure virtual

Referenced by CFileLoadManager::InitUI().

◆ SetPrevPage() virtual void IUIToolManager::SetPrevPage ( IWizardPage * ) inlinevirtual

Sets a wizard page which should show before the first page of the tool.

Reimplemented in CWigLoadManager, CVCFLoaderManager, CGffLoadManager, CFASTAFormatLoadManager, CColumnarVCFLoaderManager, CBedLoadManager, CAgpLoader, CTextAlignLoaderManager, CQualTableLoadManager, CGBFlatFileLoadManager, CFileLoadManager, and CTableFileLoadManager.

Definition at line 147 of file ui_tool_manager.hpp.

◆ SetServiceLocator() virtual void IUIToolManager::SetServiceLocator ( IServiceLocator * srv_locator ) pure virtual

Sets / unsets Service Locator.

Tool Manager can use the locator to obtain the services necessary services.

Referenced by CFileLoadManager::CleanUI(), and CFileLoadManager::InitUI().

◆ UsesSingleOMScope() virtual bool IUIToolManager::UsesSingleOMScope ( ) inlinevirtual

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

include/gui/core/ui_tool_manager.hpp

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4