Showing content from http://www.ncbi.nlm.nih.gov/IEB/ToolBox/CPP_DOC/doxyhtml/classCASNFormatLoadManager.html below:
NCBI C++ ToolKit: CASNFormatLoadManager Class Reference
Search Toolkit Book for CASNFormatLoadManager
CASNFormatLoadManager. More...
#include <gui/core/asn_format_load_manager.hpp>
CASNFormatLoadManager () CASNFormatLoadManager. More...
virtual string GetLabel () const virtual wxString GetFormatWildcard () const return file wildcard for the format (example - "*.txt;*.tab" ) More...
virtual string GetFileLoaderId () const virtual void SetServiceLocator (IServiceLocator *srv_locator) Sets / unsets Service Locator. More...
virtual void SetParentWindow (wxWindow *parent) virtual const IUIObject & GetDescriptor () const Returns the object describing this tool (UI meta data). More...
virtual void InitUI () Initializes the Manager before using it in UI. More...
virtual void CleanUI () CleanUI() is called after the host finished using the manager. 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 IWizardPage * GetFirstPage () Returns first options page (if any) of the tool to be shown in wizard dialog. More...
virtual IAppTask * GetTask () 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 IExecuteUnit * GetExecuteUnit () virtual wxString GetFormatWildcard () virtual bool ValidateFilenames (const vector< wxString > &filenames) checks given filenames and returns true if the manager can handle them, otherwise - shows an error message More...
virtual void SetFilenames (const vector< wxString > &filenames) initilize the manager with the given filenames More...
virtual void GetFilenames (vector< wxString > &filenames) const get actual filenames that will be opened More...
virtual bool IsInitialState () return true if the current state of the loader UI is the first valid state (first step in a wizard-like sequence) More...
virtual bool RecognizeFormat (const wxString &filename) return true if the given file format is supported by this manager More...
virtual bool RecognizeFormat (CFormatGuess::EFormat fmt) return true if the given file format is supported by this manager More...
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...
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...
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 virtual bool SingleFileLoader () const returns true if loader can handle only one file More...
virtual bool CanGuessFormat () const returns true if loader's format can be guessed More...
virtual wxPanel * GetMaxPanel () Return the panel that occupies max size on display, to calculate dialog window size. More...
virtual IUIToolManager * 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. More...
virtual IWizardPage * GetOptionsPage () 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 RestoreDefaults () Restores the default options for the current panel. More...
virtual void ResetState () virtual bool UsesSingleOMScope () virtual ~IUIToolManager () virtual ~IFileLoadPanelClient () virtual bool SingleFileLoader () const returns true if loader can handle only one file More...
virtual ~IToolWizard () virtual IWizardPage * GetOptionsPage () 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 ~IExtension ()
CASNFormatLoadManager.
CASNFormatLoadManager - a Load Manager for ASN format. This class implements IFileFormatLoaderManager interface in order to work with generic Format Load Manager.
Definition at line 55 of file asn_format_load_manager.hpp.
◆ CASNFormatLoadManager() CASNFormatLoadManager::CASNFormatLoadManager ( ) ◆ CanDo() ◆ CleanUI() void CASNFormatLoadManager::CleanUI ( ) virtual ◆ DoTransition() bool CASNFormatLoadManager::DoTransition ( EAction action ) 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.
Implements IUIToolManager.
Definition at line 126 of file asn_format_load_manager.cpp.
References _ASSERT.
◆ GetCurrentPanel() wxPanel * CASNFormatLoadManager::GetCurrentPanel ( ) virtual ◆ GetDescriptor() ◆ GetExecuteUnit() ◆ GetExtensionIdentifier() string CASNFormatLoadManager::GetExtensionIdentifier ( ) const virtual
returns the unique human-readable identifier for the extension the id should use lowercase letters separated by underscores - "like_this"
Implements IExtension.
Definition at line 188 of file asn_format_load_manager.cpp.
◆ GetExtensionLabel() string CASNFormatLoadManager::GetExtensionLabel ( ) const virtual ◆ GetFileLoaderId() virtual string CASNFormatLoadManager::GetFileLoaderId ( ) const inlinevirtual ◆ GetFilenames() void CASNFormatLoadManager::GetFilenames ( vector< wxString > & filenames ) const virtual ◆ GetFirstPage() virtual IWizardPage* CASNFormatLoadManager::GetFirstPage ( ) inlinevirtual ◆ GetFormatWildcard() [1/2] wxString CASNFormatLoadManager::GetFormatWildcard ( ) virtual ◆ GetFormatWildcard() [2/2] wxString CASNFormatLoadManager::GetFormatWildcard ( ) const virtual ◆ GetLabel() string CASNFormatLoadManager::GetLabel ( void ) const virtual ◆ GetTask() IAppTask * CASNFormatLoadManager::GetTask ( ) 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.
Implements IUIToolManager.
Definition at line 133 of file asn_format_load_manager.cpp.
◆ Id() ◆ InitUI() void CASNFormatLoadManager::InitUI ( ) virtual ◆ IsCompletedState() bool CASNFormatLoadManager::IsCompletedState ( ) 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.
Implements IUIToolManager.
Definition at line 120 of file asn_format_load_manager.cpp.
◆ IsFinalState() bool CASNFormatLoadManager::IsFinalState ( ) 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.
Implements IUIToolManager.
Definition at line 114 of file asn_format_load_manager.cpp.
◆ IsInitialState() bool CASNFormatLoadManager::IsInitialState ( ) virtual ◆ Label() ◆ RecognizeFormat() [1/2] ◆ RecognizeFormat() [2/2] bool CASNFormatLoadManager::RecognizeFormat ( const wxString & filename ) virtual ◆ SetFilenames() void CASNFormatLoadManager::SetFilenames ( const vector< wxString > & filenames ) virtual ◆ SetParentWindow() void CASNFormatLoadManager::SetParentWindow ( wxWindow * parent ) virtual ◆ SetServiceLocator() void CASNFormatLoadManager::SetServiceLocator ( IServiceLocator * srv_locator ) virtual ◆ ValidateFilenames() bool CASNFormatLoadManager::ValidateFilenames ( const vector< wxString > & filenames ) virtual ◆ m_Descr ◆ m_FileNames vector<wxString> CASNFormatLoadManager::m_FileNames protected ◆ m_ParentWindow wxWindow* CASNFormatLoadManager::m_ParentWindow protected ◆ m_SrvLocator
The documentation for this class was generated from the following files:
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