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

Search Toolkit Book for C5ColExportPage

#include "5col_export_page.hpp"
(Private to src/gui/packages/pkg_sequence.)

+ Inheritance diagram for C5ColExportPage:
+ Collaboration diagram for C5ColExportPage:

Public Member Functions

 C5ColExportPage ()
 Constructors. More...
 
 C5ColExportPage (wxWindow *parent, wxWindowID id=ID_C5COLEXPORTPAGE, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxSize(400, 300), long style=wxTAB_TRAVERSAL)
 
bool Create (wxWindow *parent, wxWindowID id=ID_C5COLEXPORTPAGE, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxSize(400, 300), long style=wxTAB_TRAVERSAL)
 Creation. More...
 
 ~C5ColExportPage ()
 Destructor. More...
 
void Init ()
 Initialises member variables. More...
 
virtual void SetRegistryPath (const string &path)
 IRegSettings. More...
 
virtual void SaveSettings () const
 
virtual void LoadSettings ()
 
void CreateControls ()
 Creates the controls and sizers. More...
 
virtual bool TransferDataFromWindow ()
 Transfer data from the window. More...
 
void OnSelectFileClcik (wxCommandEvent &event)
 wxEVT_COMMAND_BUTTON_CLICKED event handler for ID_BITMAPBUTTON2 More...
 
wxString GetFileName () const
 
void SetFileName (wxString value)
 
C5ColExportParamsGetData ()
 Data access. More...
 
const C5ColExportParamsGetData () const
 
void SetData (const C5ColExportParams &data)
 
wxBitmap GetBitmapResource (const wxString &name)
 Retrieves bitmap resources. More...
 
wxIcon GetIconResource (const wxString &name)
 Retrieves icon resources. More...
 
void SetObjects (map< string, TConstScopedObjects > *objects)
 
SConstScopedObject GetSeqLoc () const
 
- Public Member Functions inherited from IRegSettings
virtual ~IRegSettings ()
 

Static Public Member Functions

static bool ShowToolTips ()
 Should we show tooltips? More...
 

Public Attributes

CObjectListWidgetSelm_LocationSel
 
wxTextCtrl * m_FileNameCtrl
 

Private Types

enum  {
  ID_C5COLEXPORTPAGE = 10068 , ID_OBJECT_LIST = 10069 , ID_TEXTCTRL10 = 10087 , ID_CHECKBOX17 = 10088 ,
  ID_TEXTCTRL11 = 10089 , ID_BITMAPBUTTON2 = 10014
}
 Control identifiers. More...
 

Private Attributes

wxString m_FileName
 
C5ColExportParams m_data
 The data edited by this window. More...
 
SConstScopedObject m_SeqLoc
 
string m_RegPath
 
std::unique_ptr< CSaveFileHelperm_SaveFile
 

Detailed Description

C5ColExportPage class declaration

Definition at line 68 of file 5col_export_page.hpp.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
private

Control identifiers.

Enumerator
ID_C5COLEXPORTPAGE 
ID_OBJECT_LIST 
ID_TEXTCTRL10 
ID_CHECKBOX17 
ID_TEXTCTRL11 
ID_BITMAPBUTTON2 

Definition at line 137 of file 5col_export_page.hpp.

Constructor & Destructor Documentation

◆ C5ColExportPage() [1/2]

C5ColExportPage::C5ColExportPage ( )

Constructors.

C5ColExportPage type definition

C5ColExportPage event table definition

C5ColExportPage constructors

Definition at line 82 of file 5col_export_page.cpp.

References Init().

◆ C5ColExportPage() [2/2]

C5ColExportPage::C5ColExportPage ( wxWindow *  parent,
wxWindowID  id = ID_C5COLEXPORTPAGE,
const wxPoint &  pos = wxDefaultPosition,
const wxSize &  size = wxSize(400, 300),
long  style = wxTAB_TRAVERSAL 
)

Definition at line 87 of file 5col_export_page.cpp.

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

◆ ~C5ColExportPage()

C5ColExportPage::~C5ColExportPage ( )

Destructor.

C5ColExportPage destructor

Definition at line 119 of file 5col_export_page.cpp.

Member Function Documentation

◆ Create()

bool C5ColExportPage::Create ( wxWindow *  parent,
wxWindowID  id = ID_C5COLEXPORTPAGE,
const wxPoint &  pos = wxDefaultPosition,
const wxSize &  size = wxSize(400, 300),
long  style = wxTAB_TRAVERSAL 
)

Creation.

C5ColExportPage creator

Definition at line 98 of file 5col_export_page.cpp.

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

Referenced by C5ColExportPage().

◆ CreateControls()

void C5ColExportPage::CreateControls ( )

◆ GetBitmapResource()

wxBitmap C5ColExportPage::GetBitmapResource ( const wxString &  name)

Retrieves bitmap resources.

Get bitmap resources

Definition at line 210 of file 5col_export_page.cpp.

Referenced by CreateControls().

◆ GetData() [1/2]

C5ColExportParams& C5ColExportPage::GetData ( void  )
inline

Data access.

Definition at line 112 of file 5col_export_page.hpp.

References m_data.

Referenced by CreateControls(), and C5ColExporter::DoTransition().

◆ GetData() [2/2]

const C5ColExportParams& C5ColExportPage::GetData ( void  ) const
inline

Definition at line 113 of file 5col_export_page.hpp.

References m_data.

◆ GetFileName()

wxString C5ColExportPage::GetFileName ( void  ) const
inline

Definition at line 108 of file 5col_export_page.hpp.

References m_FileName.

Referenced by C5ColExporter::DoTransition().

◆ GetIconResource()

wxIcon C5ColExportPage::GetIconResource ( const wxString &  name)

Retrieves icon resources.

Get icon resources

Definition at line 219 of file 5col_export_page.cpp.

◆ GetSeqLoc()

SConstScopedObject C5ColExportPage::GetSeqLoc ( ) const
inline

Definition at line 124 of file 5col_export_page.hpp.

References m_SeqLoc.

Referenced by C5ColExporter::DoTransition().

◆ Init()

void C5ColExportPage::Init ( void  )

Initialises member variables.

Member initialisation

Definition at line 130 of file 5col_export_page.cpp.

References m_FileNameCtrl, m_LocationSel, and NULL.

Referenced by C5ColExportPage().

◆ LoadSettings()

void C5ColExportPage::LoadSettings ( )
virtual

Implements IRegSettings.

Definition at line 278 of file 5col_export_page.cpp.

References CObjectListWidgetSel::LoadSettings(), and m_LocationSel.

Referenced by C5ColExporter::GetCurrentPanel().

◆ OnSelectFileClcik()

void C5ColExportPage::OnSelectFileClcik ( wxCommandEvent &  event)

wxEVT_COMMAND_BUTTON_CLICKED event handler for ID_BITMAPBUTTON2

wxEVT_COMMAND_BUTTON_CLICKED event handler for ID_BUTTON7

Definition at line 259 of file 5col_export_page.cpp.

References _ASSERT, CFileExtensions::k5Column, and m_SaveFile.

◆ SaveSettings()

void C5ColExportPage::SaveSettings ( ) const
virtual

Implements IRegSettings.

Definition at line 273 of file 5col_export_page.cpp.

References m_LocationSel, and CObjectListWidgetSel::SaveSettings().

Referenced by C5ColExporter::SaveSettings().

◆ SetData()

void C5ColExportPage::SetData ( const C5ColExportParams data)
inline

Definition at line 114 of file 5col_export_page.hpp.

References data, and m_data.

Referenced by C5ColExporter::GetCurrentPanel().

◆ SetFileName()

void C5ColExportPage::SetFileName ( wxString  value)
inline

Definition at line 109 of file 5col_export_page.hpp.

References m_FileName, and rapidjson::value.

Referenced by C5ColExporter::GetCurrentPanel().

◆ SetObjects()

void C5ColExportPage::SetObjects ( map< string, TConstScopedObjects > *  objects)

◆ SetRegistryPath()

void C5ColExportPage::SetRegistryPath ( const string path)
virtual

◆ ShowToolTips()

bool C5ColExportPage::ShowToolTips ( )
static

Should we show tooltips?

Should we show tooltips?

Definition at line 201 of file 5col_export_page.cpp.

Referenced by CreateControls().

◆ TransferDataFromWindow()

bool C5ColExportPage::TransferDataFromWindow ( )
virtual

Transfer data from the window.

Transfer data from the window

Definition at line 232 of file 5col_export_page.cpp.

References _ASSERT, CObjectListWidgetSel::GetSelection(), m_FileName, m_LocationSel, m_SaveFile, m_SeqLoc, and wxT.

Referenced by C5ColExporter::DoTransition().

Member Data Documentation

◆ m_data

C5ColExportParams C5ColExportPage::m_data
private

The data edited by this window.

Definition at line 135 of file 5col_export_page.hpp.

Referenced by GetData(), and SetData().

◆ m_FileName

wxString C5ColExportPage::m_FileName
private

◆ m_FileNameCtrl

wxTextCtrl* C5ColExportPage::m_FileNameCtrl

Definition at line 131 of file 5col_export_page.hpp.

Referenced by CreateControls(), and Init().

◆ m_LocationSel

CObjectListWidgetSel* C5ColExportPage::m_LocationSel

◆ m_RegPath

string C5ColExportPage::m_RegPath
private

Definition at line 149 of file 5col_export_page.hpp.

Referenced by SetRegistryPath().

◆ m_SaveFile

std::unique_ptr<CSaveFileHelper> C5ColExportPage::m_SaveFile
private

Definition at line 150 of file 5col_export_page.hpp.

Referenced by CreateControls(), OnSelectFileClcik(), and TransferDataFromWindow().

◆ m_SeqLoc

SConstScopedObject C5ColExportPage::m_SeqLoc
private

Definition at line 148 of file 5col_export_page.hpp.

Referenced by GetSeqLoc(), and TransferDataFromWindow().


The documentation for this class was generated from the following files:
Modified on Fri Sep 20 14:57:33 2024 by modify_doxy.py rev. 669887