makVrv::DtEntitySoundSelectionDialog Class Reference

A base class dialog for creating sound selection maps. More...

Inheritance diagram for makVrv::DtEntitySoundSelectionDialog:

Public Member Functions
	DtEntitySoundSelectionDialog (DtDe &de, const QString &entity=QString("-1:-1:-1:-1:-1:-1:-1"), const QString &filename=QString(""), QWidget *parent=NULL, Qt::WindowFlags flags=Qt::Widget|Qt::Tool)
	Default CTOR.
virtual	~DtEntitySoundSelectionDialog ()
	Virtual DTOR.
void	setEntityType (QString entity)
	Set the Entity Type.
QString	entityType () const
	Get the Entity Type.
void	setSoundFile (const QString &filename)
	Set the sound filename.
QString	soundFile () const
	Get the sound filename.
Public Member Functions inherited from makVrv::DtBaseSoundSelectionDialog
	DtBaseSoundSelectionDialog (DtDe &de, QWidget *parent=NULL, Qt::WindowFlags flags=Qt::Widget|Qt::Tool)
	Default CTOR.
virtual	~DtBaseSoundSelectionDialog ()
	Virtual DTOR.

Static Public Member Functions
static const QString &	browserCaption ()
	Get the caption string for the sound-file browser.
static const QString &	entityTypeTooltip ()
	Get the tooltip for the Entity Type.
static const QString &	soundFileTooltip ()
	Get the tooltip for the sound filename.

Protected Slots
virtual void	onUpdateEntityType (const QString &entity)
	Called when user is typing in the entity type field.
void	onUpdateSoundFile (QString filename)
	Called when user changes the sound file.
virtual void	onFileBrowser ()
	Called when user clicks on the 'Open' button to open a file browser.
Protected Slots inherited from makVrv::DtBaseSoundSelectionDialog
virtual void	onFileBrowser ()
	Called when user clicks on the 'Open' button.

Private Member Functions
void	setupGui ()
	Set up the structure and layout of the dialog.

Private Attributes
QLineEdit *	myEntityType
	The text-box for the Entity Type.
bool	myEntityTypeValid
QLineEdit *	mySoundFile
	The text-box for the sound filename.
bool	mySoundFileValid

Additional Inherited Members
Signals inherited from makVrv::DtBaseSoundSelectionDialog
void	signal_AcceptingSelections (bool enable)
	Signal emitted when enabled state of selection acceptance changes.
Protected Types inherited from makVrv::DtBaseSoundSelectionDialog
enum	DataRow { EntityRow, DetonationRow, FileRow, ChannelRow }
	Indices to set which row widgets use in the dialog. More...
Protected Member Functions inherited from makVrv::DtBaseSoundSelectionDialog
void	setSelectionEnabled (bool enable)
	Switch to enable or disable accepting the selection.
bool	selectionEnabled () const
	Get the selection enabled state.
QString	titleCreateNew (const QString &name=QString(""))
	Get the title string used for creating a new sound mapping.
QString	titleCopyNew (const QString &name=QString(""))
	Get the title string used for copying a new sound mapping.
Protected Attributes inherited from makVrv::DtBaseSoundSelectionDialog
DtDe &	myDe
	The display engine.
QGridLayout *	myWidgetLayout
	The layout for derived classes to populate.

Detailed Description

A base class dialog for creating sound selection maps.

Constructor & Destructor Documentation

makVrv::DtEntitySoundSelectionDialog::DtEntitySoundSelectionDialog	(	DtDe &	de,
		const QString &	entity = QString("-1:-1:-1:-1:-1:-1:-1"),
		const QString &	filename = QString(""),
		QWidget *	parent = NULL,
		Qt::WindowFlags	flags = Qt::Widget|Qt::Tool
	)

Default CTOR.

Parameters

[in]	de	is the display engine.
[in]	entity	is the default Entity Type ID to display.
[in]	filename	is the default path and name of the sound file.
[in]	parent	is the parent widget for this dialog.
[in]	flags	is an OR'd list of Qt window flags.

virtual makVrv::DtEntitySoundSelectionDialog::~DtEntitySoundSelectionDialog ( )

virtual

Virtual DTOR.

Member Function Documentation

static const QString& makVrv::DtEntitySoundSelectionDialog::browserCaption ( )

static

Get the caption string for the sound-file browser.

Returns

The caption used when instantiating the file browser.

void makVrv::DtEntitySoundSelectionDialog::setEntityType

(

QString

entity

)

Set the Entity Type.

Parameters

[in]

entity

is the Entity Type ID (should be in a valid form).

QString makVrv::DtEntitySoundSelectionDialog::entityType

(

)

const

Get the Entity Type.

Returns

The Entity Type ID as written by the user.

static const QString& makVrv::DtEntitySoundSelectionDialog::entityTypeTooltip ( )

static

Get the tooltip for the Entity Type.

Returns

The tooltip.

void makVrv::DtEntitySoundSelectionDialog::setSoundFile

(

const QString &

filename

)

Set the sound filename.

Parameters

[in]

filename

is the path and name of a sound file.

Note

No validation or checks for existence is made on this filename.

QString makVrv::DtEntitySoundSelectionDialog::soundFile

(

)

const

Get the sound filename.

Returns

The path to the sound file.

Note

Users should validation and check for existence on filename.

static const QString& makVrv::DtEntitySoundSelectionDialog::soundFileTooltip ( )

static

Get the tooltip for the sound filename.

Returns

The tooltip.

virtual void makVrv::DtEntitySoundSelectionDialog::onUpdateEntityType ( const QString &  entity )

protectedvirtualslot

Called when user is typing in the entity type field.

Parameters

[in]

entity

is the new entity type.

void makVrv::DtEntitySoundSelectionDialog::onUpdateSoundFile ( QString  filename )

protectedslot

Called when user changes the sound file.

Parameters

[in]

filename

is the path and name of the sound file.

virtual void makVrv::DtEntitySoundSelectionDialog::onFileBrowser ( )

protectedvirtualslot

Called when user clicks on the 'Open' button to open a file browser.

void makVrv::DtEntitySoundSelectionDialog::setupGui ( )

private

Set up the structure and layout of the dialog.

Member Data Documentation

QLineEdit* makVrv::DtEntitySoundSelectionDialog::myEntityType

private

The text-box for the Entity Type.

bool makVrv::DtEntitySoundSelectionDialog::myEntityTypeValid

private

QLineEdit* makVrv::DtEntitySoundSelectionDialog::mySoundFile

private

The text-box for the sound filename.

bool makVrv::DtEntitySoundSelectionDialog::mySoundFileValid

private

---

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

• include/vrvAudioQt/DtEntitySoundSelectionDialog.h