Interface for Objects that display informations based on a Navigation Instruction. More...

Inheritance diagram for VgMyInstructionDisplay:

Public Member Functions
virtual void	updateWithInstruction (VgEngine::VgConstRefPtr< VgNavigationModule::VgINavigation > const &pNavigation, unsigned int pIndex)=0
	Updates this Display with an instruction. More...

virtual void	clear ()=0
	Clears the content. More...

virtual void	show ()=0
	Declaration from interface : VgMyDisplayable. More...

virtual void	hide ()=0
	Hides this Object. More...

virtual bool	isVisible ()=0

Detailed Description

Interface for Objects that display informations based on a Navigation Instruction.

See VgNavigationModule::VgINavigationInstruction.

These methods are called if the VgMyInstructionDisplay has been registered with the addInstructionDisplay() method within VgMyBasicApplicationController.

Note: VgMyInstructionDisplay subclasses do not need to implement VgNavigationModule::VgINavigationListener. They will be notified by the VgMyBasicApplicationController via the updateWithInstruction() method.

Member Function Documentation

virtual void VgMyInstructionDisplay::clear ( )

pure virtual

Clears the content.

virtual void VgMyInstructionDisplay::hide ( )

pure virtual

Hides this Object.

No effect if it is already hidden.

virtual bool VgMyInstructionDisplay::isVisible ( )

pure virtual

virtual void VgMyInstructionDisplay::show ( )

pure virtual

Declaration from interface : VgMyDisplayable.

virtual void VgMyInstructionDisplay::updateWithInstruction	(	VgEngine::VgConstRefPtr< VgNavigationModule::VgINavigation > const &	pNavigation,
		unsigned int	pIndex
	)

pure virtual

Updates this Display with an instruction.

Parameters

pNavigation	The navigation object used.
pIndex	The instruction index to use.

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