NCBI C++ ToolKit
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | Private Types | Private Attributes | List of all members
COpenDlg Class Reference

Search Toolkit Book for COpenDlg

COpenDlg. More...

#include <gui/core/open_dlg.hpp>

+ Inheritance diagram for COpenDlg:
+ Collaboration diagram for COpenDlg:

Public Types

typedef CIRef< IUIToolManagerTManagerRef
 

Public Member Functions

 COpenDlg ()
 
 COpenDlg (wxWindow *parent, wxWindowID id=ID_COPENDLG, const wxString &caption=_("Open"), const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxSize(450, 275), long style=wxCAPTION|wxRESIZE_BORDER|wxSYSTEM_MENU|wxCLOSE_BOX|wxMAXIMIZE_BOX|wxTAB_TRAVERSAL)
 
bool Create (wxWindow *parent, wxWindowID id=ID_COPENDLG, const wxString &caption=_("Open"), const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxSize(450, 275), long style=wxCAPTION|wxRESIZE_BORDER|wxSYSTEM_MENU|wxCLOSE_BOX|wxMAXIMIZE_BOX|wxTAB_TRAVERSAL)
 
 ~COpenDlg ()
 
void Init ()
 
void CreateControls ()
 
void OnOptionListSelected (wxCommandEvent &event)
 
void OnBackwardClick (wxCommandEvent &event)
 
void OnForwardClick (wxCommandEvent &event)
 
void OnCancelClick (wxCommandEvent &event)
 
void OnSkipClick (wxCommandEvent &event)
 
void OnListItemActivate (wxListEvent &event)
 
wxString GetBaseTitle () const
 
void SetBaseTitle (wxString value)
 
wxBitmap GetBitmapResource (const wxString &name)
 
wxIcon GetIconResource (const wxString &name)
 
virtual void SetManagers (vector< TManagerRef > &managers)
 
virtual void SetServiceLocator (IServiceLocator *srv_locator)
 
virtual void SetFilenames (const vector< wxString > &filenames)
 
virtual void SelectOptionByLabel (const string &label)
 select loading options By Extension ID More...
 
virtual void Update ()
 
virtual void InitDialog ()
 
virtual CIRef< IAppTaskGetLoadingTask ()
 
virtual void EndModal (int ret_code)
 
IRegSettings interface
virtual void SetRegistryPath (const string &path)
 
- Public Member Functions inherited from CDialog
 CDialog ()
 
virtual void LoadSettings ()
 
virtual void SaveSettings () const
 

Static Public Member Functions

static bool ShowToolTips ()
 

Public Attributes

CSplitterm_Splitter
 
wxListBox * m_OptionList
 
wxButton * m_BackBtn
 
wxButton * m_NextBtn
 

Protected Member Functions

void x_AppendOptionForManager (IUIToolManager &manager)
 add a Loading Option (displayed in the list on the left) for the given Manager More...
 
void x_SelectManager (int index)
 
void x_SetCurrentPanel (wxPanel *panel, bool firstPage)
 
void x_DoTransition (IUIToolManager::EAction action)
 
void x_UpdateTitle ()
 
void x_UpdateButtons ()
 
virtual void x_LoadSettings (const CRegistryReadView &view)
 override these functions in derived classes More...
 
virtual void x_SaveSettings (CRegistryWriteView view) const
 
- Protected Member Functions inherited from CDialog
void x_CorrectDisplay (wxRect &rc)
 move to the parent display More...
 

Protected Attributes

IServiceLocatorm_SrvLocator
 
vector< TManagerRefm_Managers
 Load Managers corresponding to Loading Options. More...
 
int m_RequestedManager
 if >= 0, than the dialog shall show a particualr option More...
 
vector< wxString > m_Filenames
 
int m_CurrManager
 
wxPanel * m_CurrPanel
 
wxPanel * m_OptionPanel
 
wxCheckBox * m_OpenExportFolder
 
CIRef< IAppTaskm_AppTask
 
- Protected Attributes inherited from CDialog
string m_RegPath
 

Private Types

enum  { ID_COPENDLG = 10002 , ID_MAIN_PANEL = 10003 , ID_option_list = 10004 }
 
enum  { ID_OPTION_PANEL = 10005 , ID_OPEN_FOLDER_CHECKBOX = 10006 }
 

Private Attributes

wxString m_BaseTitle
 

Detailed Description

COpenDlg.

Definition at line 77 of file open_dlg.hpp.

Member Typedef Documentation

◆ TManagerRef

Definition at line 141 of file open_dlg.hpp.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
private
Enumerator
ID_COPENDLG 
ID_MAIN_PANEL 
ID_option_list 

Definition at line 129 of file open_dlg.hpp.

◆ anonymous enum

anonymous enum
private
Enumerator
ID_OPTION_PANEL 
ID_OPEN_FOLDER_CHECKBOX 

Definition at line 136 of file open_dlg.hpp.

Constructor & Destructor Documentation

◆ COpenDlg() [1/2]

COpenDlg::COpenDlg ( )

Definition at line 78 of file open_dlg.cpp.

References Init().

◆ COpenDlg() [2/2]

COpenDlg::COpenDlg ( wxWindow *  parent,
wxWindowID  id = ID_COPENDLG,
const wxString &  caption = _("Open"),
const wxPoint &  pos = wxDefaultPosition,
const wxSize &  size = wxSize(450, 275),
long  style = wxCAPTION|wxRESIZE_BORDER|wxSYSTEM_MENU|wxCLOSE_BOX|wxMAXIMIZE_BOX|wxTAB_TRAVERSAL 
)

Definition at line 84 of file open_dlg.cpp.

References Create(), Init(), and ncbi::grid::netcache::search::fields::size.

◆ ~COpenDlg()

COpenDlg::~COpenDlg ( )

Definition at line 107 of file open_dlg.cpp.

Member Function Documentation

◆ Create()

bool COpenDlg::Create ( wxWindow *  parent,
wxWindowID  id = ID_COPENDLG,
const wxString &  caption = _("Open"),
const wxPoint &  pos = wxDefaultPosition,
const wxSize &  size = wxSize(450, 275),
long  style = wxCAPTION|wxRESIZE_BORDER|wxSYSTEM_MENU|wxCLOSE_BOX|wxMAXIMIZE_BOX|wxTAB_TRAVERSAL 
)

Definition at line 91 of file open_dlg.cpp.

References CreateControls(), ncbi::grid::netcache::search::fields::size, and SYMBOL_COPENDLG_SIZE.

Referenced by COpenDlg().

◆ CreateControls()

void COpenDlg::CreateControls ( )

◆ EndModal()

void COpenDlg::EndModal ( int  ret_code)
virtual

Reimplemented from CDialog.

Definition at line 581 of file open_dlg.cpp.

References m_Managers, and CDialog::SaveSettings().

Referenced by x_DoTransition().

◆ GetBaseTitle()

wxString COpenDlg::GetBaseTitle ( ) const
inline

Definition at line 112 of file open_dlg.hpp.

References m_BaseTitle.

◆ GetBitmapResource()

wxBitmap COpenDlg::GetBitmapResource ( const wxString &  name)

Definition at line 347 of file open_dlg.cpp.

◆ GetIconResource()

wxIcon COpenDlg::GetIconResource ( const wxString &  name)

Definition at line 356 of file open_dlg.cpp.

◆ GetLoadingTask()

CIRef< IAppTask > COpenDlg::GetLoadingTask ( )
virtual

Definition at line 335 of file open_dlg.cpp.

References m_AppTask.

Referenced by CAppDialogs::COpenDialog(), and CAppDialogs::ExportDialog().

◆ Init()

void COpenDlg::Init ( void  )

◆ InitDialog()

void COpenDlg::InitDialog ( )
virtual

◆ OnBackwardClick()

void COpenDlg::OnBackwardClick ( wxCommandEvent &  event)

Definition at line 453 of file open_dlg.cpp.

References IUIToolManager::eBack, and x_DoTransition().

◆ OnCancelClick()

void COpenDlg::OnCancelClick ( wxCommandEvent &  event)

Definition at line 671 of file open_dlg.cpp.

◆ OnForwardClick()

void COpenDlg::OnForwardClick ( wxCommandEvent &  event)

Definition at line 459 of file open_dlg.cpp.

References IUIToolManager::eNext, and x_DoTransition().

◆ OnListItemActivate()

void COpenDlg::OnListItemActivate ( wxListEvent &  event)

Definition at line 465 of file open_dlg.cpp.

References IUIToolManager::eNext, and x_DoTransition().

◆ OnOptionListSelected()

void COpenDlg::OnOptionListSelected ( wxCommandEvent &  event)

Definition at line 440 of file open_dlg.cpp.

References m_OptionList, and x_SelectManager().

◆ OnSkipClick()

void COpenDlg::OnSkipClick ( wxCommandEvent &  event)

Definition at line 447 of file open_dlg.cpp.

References IUIToolManager::eSkip, and x_DoTransition().

◆ SelectOptionByLabel()

void COpenDlg::SelectOptionByLabel ( const string label)
virtual

select loading options By Extension ID

Definition at line 278 of file open_dlg.cpp.

References i, int, label, m_Managers, and m_RequestedManager.

Referenced by CAppDialogs::COpenDialog().

◆ SetBaseTitle()

void COpenDlg::SetBaseTitle ( wxString  value)
inline

Definition at line 113 of file open_dlg.hpp.

References m_BaseTitle, and value.

Referenced by CAppDialogs::ExportDialog().

◆ SetFilenames()

void COpenDlg::SetFilenames ( const vector< wxString > &  filenames)
virtual

Definition at line 272 of file open_dlg.cpp.

References filenames, and m_Filenames.

Referenced by CAppDialogs::COpenDialog().

◆ SetManagers()

void COpenDlg::SetManagers ( vector< TManagerRef > &  managers)
virtual

◆ SetRegistryPath()

void COpenDlg::SetRegistryPath ( const string path)
virtual

◆ SetServiceLocator()

void COpenDlg::SetServiceLocator ( IServiceLocator srv_locator)
virtual

Definition at line 237 of file open_dlg.cpp.

References m_SrvLocator.

Referenced by CAppDialogs::COpenDialog(), and CAppDialogs::ExportDialog().

◆ ShowToolTips()

bool COpenDlg::ShowToolTips ( )
static

Definition at line 341 of file open_dlg.cpp.

◆ Update()

void COpenDlg::Update ( void  )
virtual

Definition at line 291 of file open_dlg.cpp.

References x_UpdateButtons(), and x_UpdateTitle().

Referenced by CFileLoadManager::x_UpdateWizardPages().

◆ x_AppendOptionForManager()

void COpenDlg::x_AppendOptionForManager ( IUIToolManager manager)
protected

add a Loading Option (displayed in the list on the left) for the given Manager

Definition at line 433 of file open_dlg.cpp.

References IUIToolManager::GetDescriptor(), IUIObject::GetLabel(), and m_OptionList.

Referenced by SetManagers().

◆ x_DoTransition()

void COpenDlg::x_DoTransition ( IUIToolManager::EAction  action)
protected

◆ x_LoadSettings()

void COpenDlg::x_LoadSettings ( const CRegistryReadView )
protectedvirtual

◆ x_SaveSettings()

void COpenDlg::x_SaveSettings ( CRegistryWriteView  view) const
protectedvirtual

◆ x_SelectManager()

void COpenDlg::x_SelectManager ( int  index)
protected

◆ x_SetCurrentPanel()

void COpenDlg::x_SetCurrentPanel ( wxPanel *  panel,
bool  firstPage 
)
protected

◆ x_UpdateButtons()

void COpenDlg::x_UpdateButtons ( )
protected

◆ x_UpdateTitle()

void COpenDlg::x_UpdateTitle ( )
protected

Definition at line 567 of file open_dlg.cpp.

References m_BaseTitle, m_CurrManager, m_Managers, SetTitle(), ToWxString(), and wxT.

Referenced by Update(), and x_SelectManager().

Member Data Documentation

◆ m_AppTask

CIRef<IAppTask> COpenDlg::m_AppTask
protected

Definition at line 190 of file open_dlg.hpp.

Referenced by GetLoadingTask(), and x_DoTransition().

◆ m_BackBtn

wxButton* COpenDlg::m_BackBtn

Definition at line 125 of file open_dlg.hpp.

Referenced by CreateControls(), Init(), and x_UpdateButtons().

◆ m_BaseTitle

wxString COpenDlg::m_BaseTitle
private

◆ m_CurrManager

int COpenDlg::m_CurrManager
protected

◆ m_CurrPanel

wxPanel* COpenDlg::m_CurrPanel
protected

Definition at line 186 of file open_dlg.hpp.

Referenced by Init(), x_DoTransition(), and x_SetCurrentPanel().

◆ m_Filenames

vector<wxString> COpenDlg::m_Filenames
protected

Definition at line 183 of file open_dlg.hpp.

Referenced by InitDialog(), and SetFilenames().

◆ m_Managers

vector<TManagerRef> COpenDlg::m_Managers
protected

◆ m_NextBtn

wxButton* COpenDlg::m_NextBtn

Definition at line 126 of file open_dlg.hpp.

Referenced by CreateControls(), Init(), and x_UpdateButtons().

◆ m_OpenExportFolder

wxCheckBox* COpenDlg::m_OpenExportFolder
protected

Definition at line 188 of file open_dlg.hpp.

Referenced by CreateControls(), Init(), x_DoTransition(), and x_SetCurrentPanel().

◆ m_OptionList

wxListBox* COpenDlg::m_OptionList

◆ m_OptionPanel

wxPanel* COpenDlg::m_OptionPanel
protected

Definition at line 187 of file open_dlg.hpp.

Referenced by CreateControls(), Init(), and x_SetCurrentPanel().

◆ m_RequestedManager

int COpenDlg::m_RequestedManager
protected

if >= 0, than the dialog shall show a particualr option

Definition at line 181 of file open_dlg.hpp.

Referenced by Init(), InitDialog(), and SelectOptionByLabel().

◆ m_Splitter

CSplitter* COpenDlg::m_Splitter

Definition at line 123 of file open_dlg.hpp.

Referenced by CreateControls(), Init(), x_LoadSettings(), x_SaveSettings(), and x_SetCurrentPanel().

◆ m_SrvLocator

IServiceLocator* COpenDlg::m_SrvLocator
protected

Definition at line 175 of file open_dlg.hpp.

Referenced by Init(), SetManagers(), and SetServiceLocator().


The documentation for this class was generated from the following files:
Modified on Fri Feb 23 11:49:25 2024 by modify_doxy.py rev. 669887