DISPLIB::FiffRawViewSettings Class Reference

Display-style settings panel for the FIFF raw browser (zoom, colours, distance, scope). More...

#include <fiffrawviewsettings.h>

Public Types
typedef QSharedPointer< FiffRawViewSettings >	SPtr
typedef QSharedPointer< const FiffRawViewSettings >	ConstSPtr
Public Types inherited from DISPLIB::AbstractView
enum	StyleMode { Default , Dark }
enum	GuiMode { Clinical , Research }
enum	ProcessingMode { RealTime , Offline }
typedef QSharedPointer< AbstractView >	SPtr
typedef QSharedPointer< const AbstractView >	ConstSPtr

Signals
void	timeWindowChanged (int value)
void	zoomChanged (double value)
void	distanceTimeSpacerChanged (int value)
void	signalColorChanged (const QColor &signalColor)
void	backgroundColorChanged (const QColor &backgroundColor)
void	makeScreenshot (const QString &imageType)
Signals inherited from DISPLIB::AbstractView
void	guiStyleChanged (DISPLIB::AbstractView::StyleMode style)

Public Member Functions
	FiffRawViewSettings (const QString &sSettingsPath="", QWidget *parent=0, Qt::WindowFlags f=Qt::Widget)
	~FiffRawViewSettings ()
void	setWidgetList (const QStringList &lVisibleWidgets=QStringList())
void	setWindowSize (int windowSize)
void	setZoom (double zoomFactor)
int	getDistanceTimeSpacer ()
void	setDistanceTimeSpacer (int value)
void	setBackgroundColor (const QColor &backgroundColor)
void	setSignalColor (const QColor &signalColor)
const QColor &	getSignalColor ()
const QColor &	getBackgroundColor ()
double	getZoom ()
int	getWindowSize ()
void	saveSettings ()
void	loadSettings ()
void	clearView ()
Public Member Functions inherited from DISPLIB::AbstractView
	AbstractView (QWidget *parent=0, Qt::WindowFlags f=Qt::Widget)
virtual void	setGuiMode (GuiMode mode)
virtual void	setProcessingMode (ProcessingMode mode)

Protected Member Functions
void	updateGuiMode (GuiMode mode)
void	updateProcessingMode (ProcessingMode mode)
void	onTimeWindowChanged (int value)
void	onZoomChanged (double value)
void	onDistanceTimeSpacerChanged (qint32 value)
void	onViewColorButtonClicked ()
void	onMakeScreenshot ()

Protected Attributes
std::unique_ptr< Ui::FiffRawViewSettingsWidget >	m_pUi
QColor	m_colCurrentSignalColor
QColor	m_colCurrentBackgroundColor
QString	m_sSettingsPath
Protected Attributes inherited from DISPLIB::AbstractView
bool	m_bResearchModeIsActive
bool	m_bOfflineModeIsActive
QString	m_sSettingsPath

Detailed Description

Display-style settings panel for the FIFF raw browser (zoom, colours, distance, scope).

Bundles the visible time window, signal / background / trigger colours and the distance-to-axis spinbox with an embedded ApplyToView so the user controls whether changes affect selected / visible / all channels.

Definition at line 74 of file fiffrawviewsettings.h.

Inheritance diagram for DISPLIB::FiffRawViewSettings:

Member Typedef Documentation

ConstSPtr

typedef QSharedPointer<const FiffRawViewSettings> DISPLIB::FiffRawViewSettings::ConstSPtr

Const shared pointer type for FiffRawViewSettings.

Definition at line 80 of file fiffrawviewsettings.h.

SPtr

typedef QSharedPointer<FiffRawViewSettings> DISPLIB::FiffRawViewSettings::SPtr

Shared pointer type for FiffRawViewSettings.

Definition at line 79 of file fiffrawviewsettings.h.

Constructor & Destructor Documentation

FiffRawViewSettings()

FiffRawViewSettings::FiffRawViewSettings	(	const QString &	sSettingsPath = "",
		QWidget *	parent = 0,
		Qt::WindowFlags	f = Qt::Widget )

Constructs a FiffRawViewSettings which is a child of parent.

Parameters

[in]	sSettingsPath	Settings path under which the widget persists its state (empty = no persistence).
[in]	parent	parent of widget.
[in]	f	Qt window flags passed to the QWidget constructor.

Definition at line 45 of file fiffrawviewsettings.cpp.

~FiffRawViewSettings()

FiffRawViewSettings::~FiffRawViewSettings

(

)

Destroys the FiffRawViewSettings.

Definition at line 64 of file fiffrawviewsettings.cpp.

Member Function Documentation

backgroundColorChanged

void DISPLIB::FiffRawViewSettings::backgroundColorChanged ( const QColor & backgroundColor )

signal

Emit this signal whenever the user changed the background color.

clearView()

void FiffRawViewSettings::clearView ( )

virtual

Clears the view

Implements DISPLIB::AbstractView.

Definition at line 359 of file fiffrawviewsettings.cpp.

distanceTimeSpacerChanged

void DISPLIB::FiffRawViewSettings::distanceTimeSpacerChanged ( int value )

signal

Emit this signal whenever the user changed the time spacer distance.

getBackgroundColor()

const QColor & FiffRawViewSettings::getBackgroundColor

(

)

Returns the current background color.

Returns

The current background color.

Definition at line 185 of file fiffrawviewsettings.cpp.

getDistanceTimeSpacer()

int FiffRawViewSettings::getDistanceTimeSpacer

(

)

Get current distance time spacer.

Returns

the current distance time spacer.

Definition at line 146 of file fiffrawviewsettings.cpp.

getSignalColor()

const QColor & FiffRawViewSettings::getSignalColor

(

)

Returns the current signal color.

Returns

The current signal color.

Definition at line 178 of file fiffrawviewsettings.cpp.

getWindowSize()

int FiffRawViewSettings::getWindowSize

(

)

Returns the current window size.

Returns

The current window size.

Definition at line 199 of file fiffrawviewsettings.cpp.

getZoom()

double FiffRawViewSettings::getZoom

(

)

Returns the current zoom.

Returns

The current zoom.

Definition at line 192 of file fiffrawviewsettings.cpp.

loadSettings()

void FiffRawViewSettings::loadSettings ( )

virtual

Loads and inits all important settings of this view via QSettings.

Implements DISPLIB::AbstractView.

Definition at line 223 of file fiffrawviewsettings.cpp.

makeScreenshot

void DISPLIB::FiffRawViewSettings::makeScreenshot ( const QString & imageType )

signal

Emit this signal whenever the user wants to make a screenshot.

Parameters

[out]

imageType

The current image type: png, svg.

onDistanceTimeSpacerChanged()

void FiffRawViewSettings::onDistanceTimeSpacerChanged ( qint32 value )

protected

Slot called when time spacer distance changes

Parameters

[in]

value

for time spacer distance.

Definition at line 271 of file fiffrawviewsettings.cpp.

onMakeScreenshot()

void FiffRawViewSettings::onMakeScreenshot ( )

protected

Call this slot whenever you want to make a screenshot of the butterfly or layout view.

Definition at line 352 of file fiffrawviewsettings.cpp.

onTimeWindowChanged()

void FiffRawViewSettings::onTimeWindowChanged ( int value )

protected

Slot called when time window size changes

Parameters

[in]

value

New visible window size in seconds.

Definition at line 334 of file fiffrawviewsettings.cpp.

onViewColorButtonClicked()

void FiffRawViewSettings::onViewColorButtonClicked ( )

protected

Slot called when the user changes the signal or background color.

Definition at line 298 of file fiffrawviewsettings.cpp.

onZoomChanged()

void FiffRawViewSettings::onZoomChanged ( double value )

protected

Slot called when zoome changes

Parameters

[in]

value

New number of visible channels (row-height zoom).

Definition at line 343 of file fiffrawviewsettings.cpp.

saveSettings()

void FiffRawViewSettings::saveSettings ( )

virtual

Saves all important settings of this view via QSettings.

Implements DISPLIB::AbstractView.

Definition at line 206 of file fiffrawviewsettings.cpp.

setBackgroundColor()

void FiffRawViewSettings::setBackgroundColor

(

const QColor &

backgroundColor

)

Set current background color.

Parameters

[in]

backgroundColor

The new background color.

Definition at line 160 of file fiffrawviewsettings.cpp.

setDistanceTimeSpacer()

void FiffRawViewSettings::setDistanceTimeSpacer

(

int

value

)

Set current distance time spacer combo box.

Parameters

[in]

value

the new value of the combo box.

Definition at line 153 of file fiffrawviewsettings.cpp.

setSignalColor()

void FiffRawViewSettings::setSignalColor

(

const QColor &

signalColor

)

Set current signal color.

Parameters

[in]

signalColor

The new signal color.

Definition at line 169 of file fiffrawviewsettings.cpp.

setWidgetList()

void FiffRawViewSettings::setWidgetList

(

const QStringList &

lVisibleWidgets = QStringList()

)

Init the view.

Parameters

[in]

lVisibleWidgets

The widgets to be visible: numberChannels, windowSize, distanceSpacers,. backgroundcolor, signalColor, screenshot

Definition at line 71 of file fiffrawviewsettings.cpp.

setWindowSize()

void FiffRawViewSettings::setWindowSize

(

int

windowSize

)

Sets the values of the windowSize spin box

Parameters

[in]

windowSize

new window size value.

Definition at line 132 of file fiffrawviewsettings.cpp.

setZoom()

void FiffRawViewSettings::setZoom

(

double

zoomFactor

)

Sets the values of the zoomFactor spin box

Parameters

[in]

zoomFactor

new zoomFactor value.

Definition at line 139 of file fiffrawviewsettings.cpp.

signalColorChanged

void DISPLIB::FiffRawViewSettings::signalColorChanged ( const QColor & signalColor )

signal

Emit this signal whenever the user changed the signal color.

timeWindowChanged

void DISPLIB::FiffRawViewSettings::timeWindowChanged ( int value )

signal

Emit this signal whenever the user changes the window size.

updateGuiMode()

void FiffRawViewSettings::updateGuiMode ( GuiMode mode )

protectedvirtual

Update the views GUI based on the set GuiMode (Clinical=0, Research=1).

Parameters

[in]

mode

The new mode (Clinical=0, Research=1).

Implements DISPLIB::AbstractView.

Definition at line 247 of file fiffrawviewsettings.cpp.

updateProcessingMode()

void FiffRawViewSettings::updateProcessingMode ( ProcessingMode mode )

protectedvirtual

Update the views GUI based on the set ProcessingMode (RealTime=0, Offline=1).

Parameters

[in]

mode

The new mode (RealTime=0, Offline=1).

Implements DISPLIB::AbstractView.

Definition at line 259 of file fiffrawviewsettings.cpp.

zoomChanged

void DISPLIB::FiffRawViewSettings::zoomChanged ( double value )

signal

Emit this signal whenever the user changes the row height (zoom) of the channels.

Member Data Documentation

m_colCurrentBackgroundColor

QColor DISPLIB::FiffRawViewSettings::m_colCurrentBackgroundColor

protected

Current color of the background.

Definition at line 263 of file fiffrawviewsettings.h.

m_colCurrentSignalColor

QColor DISPLIB::FiffRawViewSettings::m_colCurrentSignalColor

protected

Current color of the signal.

Definition at line 262 of file fiffrawviewsettings.h.

m_pUi

std::unique_ptr<Ui::FiffRawViewSettingsWidget> DISPLIB::FiffRawViewSettings::m_pUi

protected

Definition at line 260 of file fiffrawviewsettings.h.

m_sSettingsPath

QString DISPLIB::FiffRawViewSettings::m_sSettingsPath

protected

The settings path to store the GUI settings to.

Definition at line 264 of file fiffrawviewsettings.h.

---

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

• src/libraries/disp/viewers/fiffrawviewsettings.h
• src/libraries/disp/viewers/fiffrawviewsettings.cpp