makVrf::DtScenarioPreviewPage Class Reference

A DtScenarioPreviewPage lets users see the reference content of the current scenario. More...

Inheritance diagram for makVrf::DtScenarioPreviewPage:

Public Slots
virtual void	previewScenario (const QString &)
	If displaying information, previews the contents of the scenario in the scenario preview widget.

Signals
void	simulationModelSetFilesChanged (const QString &)

Public Member Functions
	DtScenarioPreviewPage (makVrv::DtDe &de, QWidget *parent, Qt::WindowFlags f=Qt::SubWindow, bool isNewScenario=false)
	CTOR.
virtual	~DtScenarioPreviewPage ()
	DTOR.
virtual bool	chooseInitialScenarioOptions ()
	Returns true if user selects simulation terrain.
virtual void	setDisplayInformation (bool)
	Sets whether or not to show scenario information as selected in dialog.
virtual DtScenario *	updateScenario ()
	Updates contents of dialog into myScenario object and returns it.
DtScenario *	scenario ()
	Returns scenario object.
virtual bool	valid () const
const QString &	selectedScenarioFile () const
virtual QIcon	icon ()
	Get the icon of the page.
virtual QString	title ()
	Get the title of the page.
virtual const std::string &	pageClassName () const
	Get the class name of the page.
virtual void	activate ()
	Called by the Pager when this page becomes active.
virtual void	deactivate ()
	Called by the Pager when this page becomes active.
virtual time_t	startDateAndTimeOfDay () const
	Returns the start time of day (in seconds)
virtual void	setAdvancedInformationEnabled (bool)
	Enable advanced information.
virtual void	setCanSelectTerrain (bool)
virtual void	showAdvanced (bool)
virtual void	setShowComponentAttachCombo (bool)
virtual void	setShowPreview (bool)
	Show/hide description preview.
virtual void	setDisplayChangeWarningIcon (DtScenarioInformationWidget::DisplayElement, bool)
	Whether or not to show the change warning icon for elements.
virtual void	setShowScreenElement (DtScenarioInformationWidget::DisplayElement, bool)
	Whether or not to show the particular screen element.
virtual void	setEnableScreenElement (DtScenarioInformationWidget::DisplayElement, bool)
	Whether or not to enable the display element.
Public Member Functions inherited from makVrv::DtPage
	DtPage (DtDe &de, QWidget *parent=0, Qt::WindowFlags f=0)
	CTOR for page.
virtual	~DtPage ()
	DTOR for page.
virtual PageAction	pageAction ()
	return the current action on the page
virtual void	setPageAction (PageAction action)
	set the curret action on the page
virtual void	setActionFlag (int flag)
	set the action flag of the page
virtual int	actionFlag ()
	return the action flag of the page
virtual void	setParentDialog (QWidget *paraentDialog)
	set the parent dialog that owns this page
virtual QWidget *	parentDialog ()
	return the parent dialog that own this page
virtual bool	shouldAskBeforeAction (PageAction action)
	test the action flag with the action, return true if we should ask before executing the action /param action the current page action
virtual void	askBeforeAction ()
	Called when the action flag is set and before the action is beind executed, default do nothing.
virtual void	executeAfterAsk (bool revert)
	Called after askBeforeAction(), whether user wants to revert the action or resume the action /param revert if true, the user wants to revert the action, otherwise resume it.
virtual void	resumeLastAction ()
	resume the last action of the page
virtual void	onCloseEvent ()
	will be called when user hit the close button of this page, default do nothing.
virtual void	onSwitchEvent ()
	will be called when user try switch to another page, default do nothing.

Static Public Member Functions
static const std::string &	thePageClassName ()
	Static accessor for the class name.

Public Attributes
DtScenarioPreviewWidget *	myWidget

Protected Member Functions
virtual void	initializeNewScenarioInformation (DtScenario *scenario)
virtual void	cleanupDefaultScenario (DtScenario *scn)
virtual std::string	defaultScenarioFile () const
virtual std::vector< DtString >	defaultSimulationModelSetFiles () const
void	setupGui ()
	Setting up the GUI, called by CTOR.

Protected Attributes
DtScenario *	myScenario
bool	myIsNewScenario
Protected Attributes inherited from makVrv::DtPage
DtDe &	myDe
QWidget *	myParentDialog
PageAction	myCurrentPageAction
int	myActionFlag

Additional Inherited Members
Public Types inherited from makVrv::DtPage
enum	PageAction { None = 0x0000, Switching = 0x0001, Closing = 0x0010 }

Detailed Description

A DtScenarioPreviewPage lets users see the reference content of the current scenario.

Constructor & Destructor Documentation

makVrf::DtScenarioPreviewPage::DtScenarioPreviewPage	(	makVrv::DtDe &	de,
		QWidget *	parent,
		Qt::WindowFlags	f = Qt::SubWindow,
		bool	isNewScenario = false
	)

CTOR.

virtual makVrf::DtScenarioPreviewPage::~DtScenarioPreviewPage ( )

virtual

DTOR.

Member Function Documentation

virtual bool makVrf::DtScenarioPreviewPage::chooseInitialScenarioOptions ( )

virtual

Returns true if user selects simulation terrain.

Also allows for selection of simulation model set. Calls down to scenario preview widget to do the actual select

virtual void makVrf::DtScenarioPreviewPage::setDisplayInformation ( bool  )

virtual

Sets whether or not to show scenario information as selected in dialog.

virtual DtScenario* makVrf::DtScenarioPreviewPage::updateScenario ( )

virtual

Updates contents of dialog into myScenario object and returns it.

DtScenario* makVrf::DtScenarioPreviewPage::scenario

(

)

Returns scenario object.

virtual bool makVrf::DtScenarioPreviewPage::valid ( ) const

virtual

const QString& makVrf::DtScenarioPreviewPage::selectedScenarioFile

(

)

const

virtual QIcon makVrf::DtScenarioPreviewPage::icon ( )

virtual

Get the icon of the page.

Implements makVrv::DtPage.

virtual QString makVrf::DtScenarioPreviewPage::title ( )

virtual

Get the title of the page.

Implements makVrv::DtPage.

virtual const std::string& makVrf::DtScenarioPreviewPage::pageClassName ( ) const

virtual

Get the class name of the page.

Implements makVrv::DtPage.

static const std::string& makVrf::DtScenarioPreviewPage::thePageClassName ( )

static

Static accessor for the class name.

virtual void makVrf::DtScenarioPreviewPage::activate ( )

virtual

Called by the Pager when this page becomes active.

Implements makVrv::DtPage.

virtual void makVrf::DtScenarioPreviewPage::deactivate ( )

virtual

Called by the Pager when this page becomes active.

Implements makVrv::DtPage.

virtual time_t makVrf::DtScenarioPreviewPage::startDateAndTimeOfDay ( ) const

virtual

Returns the start time of day (in seconds)

virtual void makVrf::DtScenarioPreviewPage::setAdvancedInformationEnabled ( bool  )

virtual

Enable advanced information.

virtual void makVrf::DtScenarioPreviewPage::setCanSelectTerrain ( bool  )

virtual

virtual void makVrf::DtScenarioPreviewPage::showAdvanced ( bool  )

virtual

virtual void makVrf::DtScenarioPreviewPage::setShowComponentAttachCombo ( bool  )

virtual

virtual void makVrf::DtScenarioPreviewPage::setShowPreview ( bool  )

virtual

Show/hide description preview.

virtual void makVrf::DtScenarioPreviewPage::setDisplayChangeWarningIcon ( DtScenarioInformationWidget::DisplayElement  , bool    )

virtual

Whether or not to show the change warning icon for elements.

Only the following elements have the change warning icon SimulationModelSet SimulationTerrain FrontEndTerrain ComponentAttachmentTable RandomNumberSeed FrameMode FrameTime

virtual void makVrf::DtScenarioPreviewPage::setShowScreenElement ( DtScenarioInformationWidget::DisplayElement  , bool    )

virtual

Whether or not to show the particular screen element.

virtual void makVrf::DtScenarioPreviewPage::setEnableScreenElement ( DtScenarioInformationWidget::DisplayElement  , bool    )

virtual

Whether or not to enable the display element.

The setting of editable after making individual changes will clear all editable items, so, only call this after calling the main setEditable

virtual void makVrf::DtScenarioPreviewPage::previewScenario ( const QString &  )

virtualslot

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

virtual void makVrf::DtScenarioPreviewPage::initializeNewScenarioInformation ( DtScenario *  scenario )

protectedvirtual

virtual void makVrf::DtScenarioPreviewPage::cleanupDefaultScenario ( DtScenario *  scn )

protectedvirtual

virtual std::string makVrf::DtScenarioPreviewPage::defaultScenarioFile ( ) const

protectedvirtual

virtual std::vector<DtString> makVrf::DtScenarioPreviewPage::defaultSimulationModelSetFiles ( ) const

protectedvirtual

void makVrf::DtScenarioPreviewPage::setupGui ( )

protected

Setting up the GUI, called by CTOR.

void makVrf::DtScenarioPreviewPage::simulationModelSetFilesChanged ( const QString &  )

signal

Member Data Documentation

DtScenarioPreviewWidget* makVrf::DtScenarioPreviewPage::myWidget

DtScenario* makVrf::DtScenarioPreviewPage::myScenario

protected

bool makVrf::DtScenarioPreviewPage::myIsNewScenario

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfGuiCoreQt/scenarioPreviewPage.h