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/classCFileLoadManager.html below:

NCBI C++ ToolKit: CFileLoadManager Class Reference

Search Toolkit Book for CFileLoadManager

CFileLoadManager CFileLoadManager - a Loader Manager implementing "File" option in "Open" dialog. More...

#include <gui/core/ui_file_load_manager.hpp>

CFileLoadManager () CFileLoadManager. More...
void LoadRegisteredManagers () void SetDialog (COpenDlg *dlg) virtual void AddFileFormat (IFileFormatLoaderManager *manager) virtual void SetFilenames (vector< wxString > &filenames) vector< wxString > GetFilenames () const virtual void OnFormatChanged () called by File Format panel when a user selects a format More...
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 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 IWizardPage * GetFirstPage () Returns first options page (if any) of the tool to be shown in wizard dialog. More...
virtual void SetPrevPage (IWizardPage *prevPage) Sets a wizard page which should show before the first page of the tool. 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 void ResetState () virtual string GetLabel () const virtual void SetRegistryPath (const string &path) virtual void LoadSettings () virtual void SaveSettings () const 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 wxPanel * GetMaxPanel () Return the panel that occupies max size on display, to calculate dialog window size. More...
virtual IWizardPage * GetOptionsPage () Returns page for tool options (long wizard path via "Options" button) 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 bool UsesSingleOMScope () virtual ~IUIToolManager () virtual ~IToolWizard () virtual IWizardPage * GetOptionsPage () Returns page for tool options (long wizard path via "Options" button) More...
virtual void SetNextPage (IWizardPage *) Sets a wizard page which should show after the last page of the tool. More...
virtual ~IRegSettings ()

CFileLoadManager CFileLoadManager - a Loader Manager implementing "File" option in "Open" dialog.

CFileLoadManager combines IFileFormatLoaderManager for different file formats and acts as a Facade for them.

Definition at line 119 of file ui_file_load_manager.hpp.

◆ TFormatMgrRef ◆ TMRUPathList ◆ TProjectId ◆ EState ◆ CFileLoadManager() CFileLoadManager::CFileLoadManager ( ) ◆ AddFileFormat() ◆ CanDo() ◆ CleanUI() void CFileLoadManager::CleanUI ( ) virtual ◆ DoTransition()

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 320 of file ui_file_load_manager.cpp.

References _ASSERT, IUIToolManager::eBack, eCompleted, eFormatDefined, IUIToolManager::eNext, eSelectFiles, eSelectProjects, CCompressedFile::FileExists(), filenames, CFileLoadOptionPanel::GetCheckFormat(), CFileAutoLoader::GetCurrentManager(), IFileFormatLoaderManager::GetFileLoaderId(), CFileLoadOptionPanel::GetFilenames(), CProjectSelectorPanel::GetParams(), CRef< C, Locker >::GetPointer(), CFileLoadOptionPanel::GetSelectedFormat(), ITERATE, m_AltToolManager, m_CurrFormat, m_FormatManagers, m_OptionPanel, m_ProjectParams, m_ProjectSelPanel, m_State, NcbiErrorBox(), NULL, CFileLoadOptionPanel::OnActivatePanel(), CProjectSelectorPanel::TransferDataFromWindow(), wxT, and x_CheckFormatConflict().

◆ 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 from IUIToolManager.

Definition at line 175 of file ui_file_load_manager.hpp.

References m_AltToolManager.

◆ GetCurrentPanel() wxPanel * CFileLoadManager::GetCurrentPanel ( ) virtual

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

Implements IUIToolManager.

Definition at line 196 of file ui_file_load_manager.cpp.

References eFormatDefined, eSelectFiles, eSelectProjects, IServiceLocator::GetServiceByType(), m_CurrFormat, m_FormatManagers, m_ParentWindow, m_ProjectParams, m_ProjectSelPanel, m_SrvLocator, m_State, NULL, CProjectSelectorPanel::SetParams(), CProjectSelectorPanel::SetProjectService(), CProjectSelectorPanel::TransferDataToWindow(), and x_GetOptionsPanel().

◆ GetDescriptor() ◆ GetExecuteUnit() ◆ GetFilenames() vector<wxString> CFileLoadManager::GetFilenames ( ) const inline ◆ GetFirstPage() ◆ GetLabel() virtual string CFileLoadManager::GetLabel ( void ) const inlinevirtual ◆ GetTask() IAppTask * CFileLoadManager::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 431 of file ui_file_load_manager.cpp.

References _ASSERT, CTimeMRUList< T >::Add(), CSelectProjectOptions::eCreateNewProject, filenames, CSelectProjectOptions::GetAction(), CSelectProjectOptions::GetFolderName(), CFileLoadOptionPanel::GetSelectedFormat(), IServiceLocator::GetServiceByType(), ITERATE, label, m_CurrFormat, m_FileMRUList, m_FormatManagers, m_OptionPanel, m_ProjectParams, m_SrvLocator, NULL, CSelectProjectOptions::Set_AddToExistingProject(), CDataLoadingAppTask::SetOptions(), SProjectSelectorParams::ToLoadingOptions(), ToWxString(), and x_CreateNewProject().

◆ InitUI() void CFileLoadManager::InitUI ( ) virtual

Initializes the Manager before using it in UI.

This function shall reset Internal state of the tool.

Implements IUIToolManager.

Definition at line 137 of file ui_file_load_manager.cpp.

References eSelectFiles, i, IUIToolManager::InitUI(), m_FormatManagers, m_OptionPanel, m_ParentWindow, m_SrvLocator, m_State, CFileLoadOptionPanel::OnActivatePanel(), IUIToolManager::SetParentWindow(), and IUIToolManager::SetServiceLocator().

◆ IsCompletedState() bool CFileLoadManager::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 273 of file ui_file_load_manager.cpp.

References eCompleted, and m_State.

◆ IsFinalState() bool CFileLoadManager::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 267 of file ui_file_load_manager.cpp.

References eSelectProjects, and m_State.

◆ LoadRegisteredManagers() void CFileLoadManager::LoadRegisteredManagers ( ) ◆ LoadSettings() void CFileLoadManager::LoadSettings ( ) virtual

Implements IRegSettings.

Definition at line 706 of file ui_file_load_manager.cpp.

References CTimeMRUList< T >::Add(), CTimeMRUList< T >::Clear(), CTimeFormat::eISO8601_DateTimeSec, FnToWxString(), format, CRegistryReadView::GetBool(), CGuiRegistry::GetInstance(), CRef< C, Locker >::GetPointer(), CTimeFormat::GetPredefined(), CGuiRegistry::GetReadView(), CRegistryReadView::GetString(), CRegistryReadView::GetStringVec(), CTime::GetTimeT(), i, int, kCheckFormatTag, kMRUTag, kSelectedFormatTag, IRegSettings::LoadSettings(), m_CheckFormat, m_CurrFormat, m_FileMRUList, m_FormatManagers, m_RegPath, and t.

◆ OnFormatChanged() void CFileLoadManager::OnFormatChanged ( ) virtual ◆ ResetState() void CFileLoadManager::ResetState ( ) virtual ◆ SaveSettings() void CFileLoadManager::SaveSettings ( ) const virtual

Implements IRegSettings.

Definition at line 655 of file ui_file_load_manager.cpp.

References CTime::AsString(), CTimeFormat::eISO8601_DateTimeSec, FnToStdString(), format, CFileLoadOptionPanel::GetCheckFormat(), CGuiRegistry::GetInstance(), CTimeMRUList< T >::GetMap(), CRef< C, Locker >::GetPointer(), CTimeFormat::GetPredefined(), CFileLoadOptionPanel::GetSelectedFormat(), CGuiRegistry::GetWriteView(), i, ITERATE, kCheckFormatTag, kMRUTag, kSelectedFormatTag, m_FileMRUList, m_FormatManagers, m_OptionPanel, m_RegPath, IRegSettings::SaveSettings(), CRegistryWriteView::Set(), and CTime::ToLocalTime().

◆ SetDialog() void CFileLoadManager::SetDialog ( COpenDlg * dlg ) ◆ SetFilenames() void CFileLoadManager::SetFilenames ( vector< wxString > & filenames ) virtual ◆ SetParentWindow() void CFileLoadManager::SetParentWindow ( wxWindow * parent ) virtual ◆ SetPrevPage() ◆ SetRegistryPath() void CFileLoadManager::SetRegistryPath ( const string & path ) virtual ◆ SetServiceLocator() ◆ x_AutoGuessFormat() void CFileLoadManager::x_AutoGuessFormat ( ) protected

Definition at line 567 of file ui_file_load_manager.cpp.

References _ASSERT, i, int, m_CurrFormat, m_Filenames, m_FormatManagers, m_OptionPanel, ok, IFileFormatLoaderManager::RecognizeFormat(), and CFileLoadOptionPanel::SelectFormat().

Referenced by SetFilenames(), and x_GetOptionsPanel().

◆ x_CanLeavePage() bool CFileLoadManager::x_CanLeavePage ( bool forward ) protected

Definition at line 535 of file ui_file_load_manager.cpp.

References CTimeMRUList< T >::Add(), filenames, CFileLoadOptionPanel::GetCheckFormat(), CFileLoadOptionPanel::GetFilenames(), CFileLoadOptionPanel::GetSelectedFormat(), ITERATE, label, m_CurrFormat, m_FileMRUList, m_FormatManagers, m_OptionPanel, NcbiErrorBox(), ToWxString(), and x_CheckFormatConflict().

Referenced by CFileLoadManager::CFilePage::CanLeavePage().

◆ x_CheckFormatConflict() bool CFileLoadManager::x_CheckFormatConflict ( const vector< wxString > & filenames, TFormatMgrRef & manager ) protected

Definition at line 281 of file ui_file_load_manager.cpp.

References eCancel, eDialog_YesNoCancel, eIcon_Exclamation, eNo, filenames, CFileAutoLoader::GetCurrentManager(), CFormatGuess::GetFormatName(), CFileLoadOptionPanel::GetSelectedFormat(), i, kFORMAT_CONFLICT_MSG, m_CurrFormat, m_FormatManagers, m_OptionPanel, NcbiMessageBoxW(), CRef< C, Locker >::Reset(), CFileLoadOptionPanel::SelectFormat(), CFileAutoLoader::SetFormatManager(), ToWxString(), and wxT.

Referenced by DoTransition(), and x_CanLeavePage().

◆ x_CreateNewProject() ◆ x_GetOptionsPanel()

Definition at line 589 of file ui_file_load_manager.cpp.

References IUIToolManager::GetDescriptor(), IFileFormatLoaderManager::GetFileLoaderId(), IFileFormatLoaderManager::GetFormatWildcard(), IUIObject::GetLabel(), i, label, m_CheckFormat, m_CurrFormat, m_FileMRUList, m_Filenames, m_FormatManagers, m_OptionPanel, m_ParentWindow, max(), CFileLoadOptionPanel::SelectFormat(), CFileLoadOptionPanel::SetCheckFormat(), CFileLoadOptionPanel::SetFilenames(), CFileLoadOptionPanel::SetFormats(), CFileLoadOptionPanel::SetManager(), CFileLoadOptionPanel::SetMRU(), IFileFormatLoaderManager::SingleFileLoader(), ToWxString(), and x_AutoGuessFormat().

Referenced by GetCurrentPanel(), GetFirstPage(), and CFileLoadManager::CFilePage::GetPanel().

◆ x_UpdateWizardPages() void CFileLoadManager::x_UpdateWizardPages ( ) protected

Definition at line 509 of file ui_file_load_manager.cpp.

References CWizardDlg::eCmdUpdateButtons, m_CurrFormat, m_FormatManagers, m_OpenDlg, m_OpenObjectsPage, m_ParentWindow, IWizardPage::SetNextPage(), IWizardPage::SetOptionsPage(), COpenDlg::Update(), and wxEVT_COMMAND_MENU_SELECTED.

Referenced by OnFormatChanged(), and SetPrevPage().

◆ m_AltToolManager ◆ m_AutodetectFormat ◆ m_CheckFormat bool CFileLoadManager::m_CheckFormat protected ◆ m_CurrFormat int CFileLoadManager::m_CurrFormat protected

Definition at line 244 of file ui_file_load_manager.hpp.

Referenced by CanDo(), CleanUI(), DoTransition(), GetCurrentPanel(), GetDescriptor(), GetExecuteUnit(), GetTask(), LoadSettings(), OnFormatChanged(), x_AutoGuessFormat(), x_CanLeavePage(), x_CheckFormatConflict(), x_GetOptionsPanel(), and x_UpdateWizardPages().

◆ m_Descriptor ◆ m_FileMRUList ◆ m_Filenames vector<wxString> CFileLoadManager::m_Filenames protected ◆ m_FilePage ◆ m_FormatManagers

Definition at line 243 of file ui_file_load_manager.hpp.

Referenced by AddFileFormat(), CanDo(), CleanUI(), DoTransition(), GetCurrentPanel(), GetDescriptor(), GetExecuteUnit(), GetTask(), InitUI(), LoadSettings(), SaveSettings(), SetRegistryPath(), x_AutoGuessFormat(), x_CanLeavePage(), x_CheckFormatConflict(), x_GetOptionsPanel(), and x_UpdateWizardPages().

◆ m_OpenDlg ◆ m_OpenObjectsPage ◆ m_OptionPanel

Definition at line 252 of file ui_file_load_manager.hpp.

Referenced by CleanUI(), DoTransition(), GetTask(), InitUI(), OnFormatChanged(), SaveSettings(), SetFilenames(), x_AutoGuessFormat(), x_CanLeavePage(), x_CheckFormatConflict(), and x_GetOptionsPanel().

◆ m_ParentWindow wxWindow* CFileLoadManager::m_ParentWindow protected ◆ m_ProjectParams ◆ m_ProjectSelPanel ◆ m_RegPath string CFileLoadManager::m_RegPath protected ◆ m_SrvLocator ◆ m_State EState CFileLoadManager::m_State protected

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

include/gui/core/ui_file_load_manager.hpp
src/gui/core/ui_file_load_manager.cpp

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