PTLib  Version 2.10.4
PVXMLGrammar Class Reference

#include <vxml.h>

Inheritance diagram for PVXMLGrammar:
PObject PVXMLDigitsGrammar PVXMLMenuGrammar

List of all members.

Public Types

enum  GrammarState {
  Idle, Started, Filled, NoInput,
  NoMatch, Help
}

Public Member Functions

 PVXMLGrammar (PVXMLSession &session, PXMLElement &field)
virtual void OnUserInput (const char ch)=0
virtual void Start ()
virtual bool Process ()
GrammarState GetState () const

Protected Member Functions

 PDECLARE_NOTIFIER (PTimer, PVXMLGrammar, OnTimeout)

Protected Attributes

PVXMLSessionm_session
PXMLElementm_field
PString m_value
GrammarState m_state
PTimer m_timer
PMutex m_mutex

Member Enumeration Documentation

Enumerator:
Idle 

Not yet started.

Started 

Grammar awaiting input.

Filled 

got something that matched the grammar

NoInput 

timeout or still waiting to match

NoMatch 

recognized something but didn't match the grammar

Help 

help keyword


Constructor & Destructor Documentation

PVXMLGrammar::PVXMLGrammar ( PVXMLSession session,
PXMLElement field 
)

Member Function Documentation

References m_state.

virtual void PVXMLGrammar::OnUserInput ( const char  ch) [pure virtual]

Implemented in PVXMLDigitsGrammar, and PVXMLMenuGrammar.

PVXMLGrammar::PDECLARE_NOTIFIER ( PTimer  ,
PVXMLGrammar  ,
OnTimeout   
) [protected]
virtual bool PVXMLGrammar::Process ( ) [virtual]

Reimplemented in PVXMLMenuGrammar.

virtual void PVXMLGrammar::Start ( ) [virtual]

Member Data Documentation

Referenced by GetState().


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines