MAKLogger::DtLoggerPreviewWidget Class Reference

Inheritance diagram for MAKLogger::DtLoggerPreviewWidget:

Collaboration diagram for MAKLogger::DtLoggerPreviewWidget:

Public Types
enum	PreviewValidity {   VALIDITY_INVALID, VALIDITY_EMPTY_STRING, VALIDITY_NON_LGR_FILE, VALIDITY_NO_FILE,   VALIDITY_DIRECTORY, VALIDITY_VALID }

Public Slots
virtual void	toggleEditMode ()
	Toggle the preview widget between Preview and Edit mode.
virtual PreviewValidity	previewInformation (const QString &)
	If displaying information, previews the contents of the scenario in the scenario preview widget.

Public Member Functions
	DtLoggerPreviewWidget (QWidget *parent, Qt::WindowFlags f=Qt::SubWindow)
	Ctor.
virtual	~DtLoggerPreviewWidget ()
	Dtor.
virtual void	setAppProtocol (const QString &protocol, bool display=false)
	Set the protocol string for the current application run.
virtual bool	isEditMode ()
	Set and get whether the current state is Edit Mode.
virtual void	setSaveMode (bool save)
	Set save mode true shows fom widgets, false hides them.
virtual void	setShowDescriptionOnly ()
	Set whether to show the description widget by itself.
virtual void	setShowPreviewButton (bool show)
	Set whether to show the Preview/Edit button.
virtual void	setEnablePreviewButton (bool enable)
	Set whether the Preview/Edit button is enabled or not.
virtual void	setNeedUpgradeForDescription (bool current, int loadedVersion)
	Set whether the file format is current.
virtual void	setDescription (const QString &description)
	Set the description text where a description already exists but is not saved.
virtual QString	description ()
	Get the description string associated with the currently inspected logger file.
virtual bool	descriptionChanged ()
	Get whether the description string has been changed in the Edit panel.
virtual PreviewValidity	validSelection ()
	Whether the currently inspected file is valid for opening.
virtual void	clearContent ()
	Clear content from all display widgets.

Public Attributes
Ui_DtLgrTapePreviewWidgetUi	myUiImpl

Protected Slots
virtual void	onOK ()
virtual void	onCancel ()
virtual void	onDescriptionChanged ()

Protected Member Functions
virtual QString	timeAndDateString (double time)
	Convert the given time value into a Date/Time string.
virtual QString	durationString (double time)
	Convert the given time value into a recording duration string in the form [DD:]HH:MM:SS.fff, where DD is days and fff is the fractional part of a second.
virtual void	displayFomFileWidgets (bool show)
	Set whether to display the FOM File text widget.
virtual void	displayFomModuleWidgets (bool show)
	Set whether to display the FOM Module list widget.
virtual void	hideFomWidgets ()
	Set to hide all FOM widgets, which includes the FOM File text widget and its label, along with the FOM Module list widget and its label.
virtual void	setEditableBackground ()
	Set the background color for the editable QTextEdit widget to off-white.
virtual void	setNonEditableBackground ()
	Set the background color for all non-editable widgets (those other than the QTextEdit widget) to light gray.
virtual void	setBgColor (QWidget *widget, QColor &color)
	Overloaded function to set the background color for all non-QWebView widgets.
virtual void	setBgColor (QWebView *wview, QColor &color)
	Overloaded function to set the background color for the QWebView widget.
virtual QString	paddedDescription ()
	Pads the description text if it has been changed and the new text is of lesser length than the initial text.
virtual void	trimRight (QString &description)
	Trim all whitespace found at the end of the given text.

Protected Attributes
QWebView *	myDescriptionView
QTextEdit *	myDescriptionEdit
DtLgrGuiMetaDataInterface *	myMetaDataReader
QString	myFilename
QString	myProtocol
bool	mySaveMode
bool	myDescriptionChanged
PreviewValidity	myValidSelection
int	myInitialDescriptionLength

Member Enumeration Documentation

enum MAKLogger::DtLoggerPreviewWidget::PreviewValidity

Enumerator:

VALIDITY_INVALID
VALIDITY_EMPTY_STRING
VALIDITY_NON_LGR_FILE
VALIDITY_NO_FILE
VALIDITY_DIRECTORY
VALIDITY_VALID

Constructor & Destructor Documentation

MAKLogger::DtLoggerPreviewWidget::DtLoggerPreviewWidget	(	QWidget *	parent,
		Qt::WindowFlags	f = Qt::SubWindow
	)

Ctor.

virtual MAKLogger::DtLoggerPreviewWidget::~DtLoggerPreviewWidget ( )

virtual

Dtor.

Member Function Documentation

virtual void MAKLogger::DtLoggerPreviewWidget::clearContent ( )

virtual

Clear content from all display widgets.

virtual QString MAKLogger::DtLoggerPreviewWidget::description ( )

virtual

Get the description string associated with the currently inspected logger file.

virtual bool MAKLogger::DtLoggerPreviewWidget::descriptionChanged ( )

virtual

Get whether the description string has been changed in the Edit panel.

virtual void MAKLogger::DtLoggerPreviewWidget::displayFomFileWidgets ( bool  show )

protectedvirtual

Set whether to display the FOM File text widget.

virtual void MAKLogger::DtLoggerPreviewWidget::displayFomModuleWidgets ( bool  show )

protectedvirtual

Set whether to display the FOM Module list widget.

virtual QString MAKLogger::DtLoggerPreviewWidget::durationString ( double  time )

protectedvirtual

Convert the given time value into a recording duration string in the form [DD:]HH:MM:SS.fff, where DD is days and fff is the fractional part of a second.

virtual void MAKLogger::DtLoggerPreviewWidget::hideFomWidgets ( )

protectedvirtual

Set to hide all FOM widgets, which includes the FOM File text widget and its label, along with the FOM Module list widget and its label.

virtual bool MAKLogger::DtLoggerPreviewWidget::isEditMode ( )

virtual

Set and get whether the current state is Edit Mode.

virtual void MAKLogger::DtLoggerPreviewWidget::onCancel ( )

protectedvirtualslot

virtual void MAKLogger::DtLoggerPreviewWidget::onDescriptionChanged ( )

protectedvirtualslot

virtual void MAKLogger::DtLoggerPreviewWidget::onOK ( )

protectedvirtualslot

virtual QString MAKLogger::DtLoggerPreviewWidget::paddedDescription ( )

protectedvirtual

Pads the description text if it has been changed and the new text is of lesser length than the initial text.

virtual PreviewValidity MAKLogger::DtLoggerPreviewWidget::previewInformation ( const QString &  )

virtualslot

If displaying information, previews the contents of the scenario in the scenario preview widget.

virtual void MAKLogger::DtLoggerPreviewWidget::setAppProtocol ( const QString &  protocol, bool  display = false  )

virtual

Set the protocol string for the current application run.

Used to set file validity to enable the Open button by checking against the new file's protocol string. If the optional bool is passed as true, the protocol string is displayed as well. This is used when there is only a temporary file created during a Record process without a Save.

virtual void MAKLogger::DtLoggerPreviewWidget::setBgColor ( QWidget *  widget, QColor &  color  )

protectedvirtual

Overloaded function to set the background color for all non-QWebView widgets.

virtual void MAKLogger::DtLoggerPreviewWidget::setBgColor ( QWebView *  wview, QColor &  color  )

protectedvirtual

Overloaded function to set the background color for the QWebView widget.

virtual void MAKLogger::DtLoggerPreviewWidget::setDescription ( const QString &  description )

virtual

Set the description text where a description already exists but is not saved.

virtual void MAKLogger::DtLoggerPreviewWidget::setEditableBackground ( )

protectedvirtual

Set the background color for the editable QTextEdit widget to off-white.

virtual void MAKLogger::DtLoggerPreviewWidget::setEnablePreviewButton ( bool  enable )

virtual

Set whether the Preview/Edit button is enabled or not.

virtual void MAKLogger::DtLoggerPreviewWidget::setNeedUpgradeForDescription ( bool  current, int  loadedVersion  )

virtual

Set whether the file format is current.

On false, if the loaded file version requires an upgrade for writing a description, this will disable the Preview/Edit button and add a tooltip stating that it is necessary to upgrade the logger file in order to add a description.

virtual void MAKLogger::DtLoggerPreviewWidget::setNonEditableBackground ( )

protectedvirtual

Set the background color for all non-editable widgets (those other than the QTextEdit widget) to light gray.

virtual void MAKLogger::DtLoggerPreviewWidget::setSaveMode ( bool  save )

virtual

Set save mode true shows fom widgets, false hides them.

virtual void MAKLogger::DtLoggerPreviewWidget::setShowDescriptionOnly ( )

virtual

Set whether to show the description widget by itself.

Used for displaying Save, Save As, and Record As dialogs.

virtual void MAKLogger::DtLoggerPreviewWidget::setShowPreviewButton ( bool  show )

virtual

Set whether to show the Preview/Edit button.

Used for displaying all dialogs except the Open File dialog.

virtual QString MAKLogger::DtLoggerPreviewWidget::timeAndDateString ( double  time )

protectedvirtual

Convert the given time value into a Date/Time string.

virtual void MAKLogger::DtLoggerPreviewWidget::toggleEditMode ( )

virtualslot

Toggle the preview widget between Preview and Edit mode.

Preview mode shows an Edit button and the QWebView widget, while Edit mode shows a Preview button and the QTextEdit widget.

virtual void MAKLogger::DtLoggerPreviewWidget::trimRight ( QString &  description )

protectedvirtual

Trim all whitespace found at the end of the given text.

virtual PreviewValidity MAKLogger::DtLoggerPreviewWidget::validSelection ( )

virtual

Whether the currently inspected file is valid for opening.

Member Data Documentation

bool MAKLogger::DtLoggerPreviewWidget::myDescriptionChanged

protected

QTextEdit* MAKLogger::DtLoggerPreviewWidget::myDescriptionEdit

protected

QWebView* MAKLogger::DtLoggerPreviewWidget::myDescriptionView

protected

QString MAKLogger::DtLoggerPreviewWidget::myFilename

protected

int MAKLogger::DtLoggerPreviewWidget::myInitialDescriptionLength

protected

DtLgrGuiMetaDataInterface* MAKLogger::DtLoggerPreviewWidget::myMetaDataReader

protected

QString MAKLogger::DtLoggerPreviewWidget::myProtocol

protected

bool MAKLogger::DtLoggerPreviewWidget::mySaveMode

protected

Ui_DtLgrTapePreviewWidgetUi MAKLogger::DtLoggerPreviewWidget::myUiImpl

PreviewValidity MAKLogger::DtLoggerPreviewWidget::myValidSelection

protected

---

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

• lgrTapePreviewWidget.h