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

Search Toolkit Book for CFileLoadWizard

#include <gui/widgets/loaders/file_load_wizard.hpp>

+ Inheritance diagram for CFileLoadWizard:
+ Collaboration diagram for CFileLoadWizard:

Classes

class  CFilePage
 

Public Member Functions

 CFileLoadWizard ()
 CFileLoadWizard. More...
 
void LoadFormats (const vector< string > &format_ids)
 
void SetWorkDir (const wxString &workDir)
 
const vector< CIRef< IFileLoadPanelClient > > & GetFormatManagers () const
 
CFileLoadMRUListGetFileMRUList ()
 
void SetFilenames (vector< wxString > &filenames)
 
vector< wxString > GetFilenames () const
 
void OnFormatChanged (int format)
 
IOpenObjectsPanelClient interface implementation
virtual string GetLabel () const
 
virtual IExecuteUnitGetExecuteUnit ()
 
IToolWizard interface implementation
virtual void SetParentWindow (wxWindow *parent)
 
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 *prevPage)
 Sets a wizard page which should show before the first page of the tool. More...
 
virtual void SetNextPage (IWizardPage *nexPage)
 Sets a wizard page which should show after the last page of the tool. More...
 
IRegSettings interface implementation
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 IOpenObjectsPanelClient
virtual ~IOpenObjectsPanelClient ()
 
- Public Member Functions inherited from IToolWizard
virtual ~IToolWizard ()
 
- Public Member Functions inherited from IRegSettings
virtual ~IRegSettings ()
 

Protected Member Functions

CFileLoadPanelx_GetFileSelectPanel ()
 
bool x_CanLeavePage ()
 
IWizardPagex_GetNextPage ()
 
IWizardPagex_GetOptionsPage ()
 
bool x_CheckFormatConflict (const vector< wxString > &filenames)
 
- Protected Member Functions inherited from CObject
virtual void DeleteThis (void)
 Virtual method "deleting" this object. More...
 

Protected Attributes

wxWindow * m_ParentWindow
 
IWizardPagem_StartPage
 
string m_RegPath
 
vector< CIRef< IFileLoadPanelClient > > m_FormatManagers
 
int m_CurrFormat
 
vector< wxString > m_Filenames
 
CFileLoadPanelm_FileSelectPanel
 
CFileLoadMRUList m_FileMRUList
 
CFilePage m_FileSelectPage
 
wxString m_WorkDir
 

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...
 
- 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...
 

Detailed Description

Definition at line 54 of file file_load_wizard.hpp.

Constructor & Destructor Documentation

◆ CFileLoadWizard()

CFileLoadWizard::CFileLoadWizard ( )

CFileLoadWizard.

Definition at line 51 of file file_load_wizard.cpp.

Member Function Documentation

◆ GetExecuteUnit()

IExecuteUnit * CFileLoadWizard::GetExecuteUnit ( )
virtual

Reimplemented from IOpenObjectsPanelClient.

Definition at line 74 of file file_load_wizard.cpp.

References m_CurrFormat, and m_FormatManagers.

◆ GetFileMRUList()

CFileLoadMRUList& CFileLoadWizard::GetFileMRUList ( )
inline

Definition at line 90 of file file_load_wizard.hpp.

References m_FileMRUList.

Referenced by CFileLoadPanel::x_FillMRUList().

◆ GetFilenames()

vector<wxString> CFileLoadWizard::GetFilenames ( ) const
inline

Definition at line 94 of file file_load_wizard.hpp.

References m_Filenames.

◆ GetFirstPage()

IWizardPage * CFileLoadWizard::GetFirstPage ( )
virtual

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

Reimplemented from IToolWizard.

Definition at line 95 of file file_load_wizard.cpp.

References m_FileSelectPage, and x_GetFileSelectPanel().

◆ GetFormatManagers()

const vector<CIRef<IFileLoadPanelClient> >& CFileLoadWizard::GetFormatManagers ( ) const
inline

◆ GetLabel()

string CFileLoadWizard::GetLabel ( void  ) const
virtual

Implements IOpenObjectsPanelClient.

Definition at line 69 of file file_load_wizard.cpp.

◆ GetOptionsPage()

IWizardPage * CFileLoadWizard::GetOptionsPage ( )
virtual

Returns page for tool options (long wizard path via "Options" button)

Reimplemented from IToolWizard.

Definition at line 101 of file file_load_wizard.cpp.

References m_CurrFormat, and m_FormatManagers.

◆ LoadFormats()

void CFileLoadWizard::LoadFormats ( const vector< string > &  format_ids)

◆ LoadSettings()

void CFileLoadWizard::LoadSettings ( )
virtual

◆ OnFormatChanged()

void CFileLoadWizard::OnFormatChanged ( int  format)

◆ SaveSettings()

void CFileLoadWizard::SaveSettings ( ) const
virtual

◆ SetFilenames()

void CFileLoadWizard::SetFilenames ( vector< wxString > &  filenames)

◆ SetNextPage()

void CFileLoadWizard::SetNextPage ( IWizardPage )
virtual

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

Reimplemented from IToolWizard.

Definition at line 115 of file file_load_wizard.cpp.

References i, m_FormatManagers, and IToolWizard::SetNextPage().

◆ SetParentWindow()

void CFileLoadWizard::SetParentWindow ( wxWindow *  parent)
virtual

Implements IToolWizard.

Definition at line 87 of file file_load_wizard.cpp.

References i, m_FormatManagers, m_ParentWindow, and IToolWizard::SetParentWindow().

◆ SetPrevPage()

void CFileLoadWizard::SetPrevPage ( IWizardPage )
virtual

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

Reimplemented from IToolWizard.

Definition at line 109 of file file_load_wizard.cpp.

References i, m_FormatManagers, and IToolWizard::SetPrevPage().

◆ SetRegistryPath()

void CFileLoadWizard::SetRegistryPath ( const string path)
virtual

◆ SetWorkDir()

void CFileLoadWizard::SetWorkDir ( const wxString &  workDir)

◆ x_CanLeavePage()

bool CFileLoadWizard::x_CanLeavePage ( )
protected

◆ x_CheckFormatConflict()

bool CFileLoadWizard::x_CheckFormatConflict ( const vector< wxString > &  filenames)
protected

◆ x_GetFileSelectPanel()

CFileLoadPanel * CFileLoadWizard::x_GetFileSelectPanel ( )
protected

◆ x_GetNextPage()

IWizardPage * CFileLoadWizard::x_GetNextPage ( )
protected

◆ x_GetOptionsPage()

IWizardPage * CFileLoadWizard::x_GetOptionsPage ( )
protected

Member Data Documentation

◆ m_CurrFormat

int CFileLoadWizard::m_CurrFormat
protected

◆ m_FileMRUList

CFileLoadMRUList CFileLoadWizard::m_FileMRUList
protected

Definition at line 134 of file file_load_wizard.hpp.

Referenced by GetFileMRUList(), LoadSettings(), SaveSettings(), and x_CanLeavePage().

◆ m_Filenames

vector<wxString> CFileLoadWizard::m_Filenames
protected

Definition at line 132 of file file_load_wizard.hpp.

Referenced by GetFilenames(), SetFilenames(), and x_GetFileSelectPanel().

◆ m_FileSelectPage

CFilePage CFileLoadWizard::m_FileSelectPage
protected

Definition at line 135 of file file_load_wizard.hpp.

Referenced by GetFirstPage().

◆ m_FileSelectPanel

CFileLoadPanel* CFileLoadWizard::m_FileSelectPanel
protected

◆ m_FormatManagers

vector<CIRef<IFileLoadPanelClient> > CFileLoadWizard::m_FormatManagers
protected

◆ m_ParentWindow

wxWindow* CFileLoadWizard::m_ParentWindow
protected

Definition at line 124 of file file_load_wizard.hpp.

Referenced by OnFormatChanged(), SetParentWindow(), and x_GetFileSelectPanel().

◆ m_RegPath

string CFileLoadWizard::m_RegPath
protected

Definition at line 127 of file file_load_wizard.hpp.

Referenced by LoadSettings(), SaveSettings(), and SetRegistryPath().

◆ m_StartPage

IWizardPage* CFileLoadWizard::m_StartPage
protected

Definition at line 125 of file file_load_wizard.hpp.

◆ m_WorkDir

wxString CFileLoadWizard::m_WorkDir
protected

Definition at line 136 of file file_load_wizard.hpp.

Referenced by SetWorkDir(), and x_GetFileSelectPanel().


The documentation for this class was generated from the following files:
Modified on Mon Jul 08 04:17:00 2024 by modify_doxy.py rev. 669887