wxStfTextImportDlg Class Reference

Dialog for text import filter settings. More...

#include <smalldlgs.h>

Inheritance diagram for wxStfTextImportDlg:

Collaboration diagram for wxStfTextImportDlg:

List of all members.

Public Member Functions
	wxStfTextImportDlg (wxWindow *parent, const wxString &textPreview=wxT("\0"), int hLines_=1, bool isSeries=false, int id=wxID_ANY, wxString title=wxT("Text file import settings"), wxPoint pos=wxDefaultPosition, wxSize size=wxDefaultSize, int style=wxCAPTION)
	Constructor.
int	GetHLines () const
	Get the number of header lines.
bool	ToSection () const
	Indicates whether columns should be put into section or into channels.
bool	FirstIsTime () const
	Indicates whether the first column contains time values.
int	GetNColumns () const
	Get the number of columns.
double	GetSR () const
	Get the sampling rate.
const wxString &	GetYUnits () const
	Get the y units of the first channel.
const wxString &	GetYUnitsCh2 () const
	Get the y units of the second channel.
const wxString &	GetXUnits () const
	Get the x units.
bool	ApplyToAll () const
	Indicates whether the settings apply to all files in a series.
stfio::txtImportSettings	GetTxtImport () const
	Get the text import filter settings struct.
virtual void	EndModal (int retCode)
	Called upon ending a modal dialog.

---

Detailed Description

Dialog for text import filter settings.

---

Constructor & Destructor Documentation

wxStfTextImportDlg::wxStfTextImportDlg	(	wxWindow *	parent,
		const wxString &	textPreview = wxT("\0"),
		int	hLines_ = 1,
		bool	isSeries = false,
		int	id = wxID_ANY,
		wxString	title = wxT("Text file import settings"),
		wxPoint	pos = wxDefaultPosition,
		wxSize	size = wxDefaultSize,
		int	style = wxCAPTION
	)

Constructor.

Parameters:

parent	Pointer to parent window.
textPreview	The preview text to be shown.
hLines_	The number of header lines that are initially set.
isSeries	Set this to true for file series so that they can be batch-opened.
id	Window id.
title	Dialog title.
pos	Initial position.
size	Initial size.
style	Dialog style.

---

Member Function Documentation

bool wxStfTextImportDlg::ApplyToAll

(

)

const [inline]

Indicates whether the settings apply to all files in a series.

Returns:

true if the settings apply to all files.

virtual void wxStfTextImportDlg::EndModal

(

int

retCode

)

[virtual]

Called upon ending a modal dialog.

Parameters:

retCode

The dialog button id that ended the dialog (e.g. wxID_OK)

bool wxStfTextImportDlg::FirstIsTime

(

)

const [inline]

Indicates whether the first column contains time values.

Returns:

true is the first column contains time values.

int wxStfTextImportDlg::GetHLines

(

)

const [inline]

Get the number of header lines.

Returns:

The number of header lines.

int wxStfTextImportDlg::GetNColumns

(

)

const [inline]

Get the number of columns.

Returns:

The number of columns.

double wxStfTextImportDlg::GetSR

(

)

const [inline]

Get the sampling rate.

Returns:

The sampling rate.

stfio::txtImportSettings wxStfTextImportDlg::GetTxtImport

(

)

const

Get the text import filter settings struct.

Returns:

The stf::txtImportSettings struct.

const wxString& wxStfTextImportDlg::GetXUnits

(

)

const [inline]

Get the x units.

Returns:

The x units.

const wxString& wxStfTextImportDlg::GetYUnits

(

)

const [inline]

Get the y units of the first channel.

Returns:

The y units of the first channel.

const wxString& wxStfTextImportDlg::GetYUnitsCh2

(

)

const [inline]

Get the y units of the second channel.

Returns:

The y units of the second channel.

bool wxStfTextImportDlg::ToSection

(

)

const [inline]

Indicates whether columns should be put into section or into channels.

Returns:

true if they should be put into sections.

---

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

• src/stimfit/gui/dlgs/smalldlgs.h