Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages

Dasher::CDasherWidgetInterface Class Reference

#include </home/clem/local/src/opie/inputmethods/dasher/DasherWidgetInterface.h>

Inheritance diagram for Dasher::CDasherWidgetInterface:

Inheritance graph
[legend]
List of all members.

Public Member Functions

virtual void Start ()=0
 Signal to the core that the model should be started.
virtual void TapOn (int MouseX, int MouseY, unsigned long Time)=0
 Signal an input location.
virtual void PauseAt (int MouseX, int MouseY)=0
 Signal an input event and pause the simulation.
virtual void Unpause (unsigned long Time)=0
 Unpause the simulation.
virtual void Redraw ()=0
 Signal that the core should redraw the screen.
virtual void ChangeScreen ()=0
 Signal the core that a change has occured to the screen. (Unneeded).
virtual void ChangeEdit ()=0
 Signal the core that a change has occued to the editbox. (Unneeded).
virtual unsigned int GetNumberSymbols ()=0
 Request the number of symbols in the current alphabet.
virtual const std::string & GetDisplayText (Dasher::symbol Symbol)=0
 Request the text that should be displayed on the Dasher canvas.
virtual const std::string & GetEditText (Dasher::symbol Symbol)=0
 Request the text that should be entered into the edit box.
virtual int GetTextColour (Dasher::symbol Symbol)=0
virtual Opts::ScreenOrientations GetAlphabetOrientation ()=0
 (Eg, left to right for English, right to left for Hebrew)
virtual Opts::AlphabetTypes GetAlphabetType ()=0
 Returns the codepage for the current alphabet.
virtual const std::string & GetTrainFile ()=0
 Provides a fully qualified path to the training file for the alphabet.

Member Function Documentation

virtual void Dasher::CDasherWidgetInterface::ChangeEdit  )  [pure virtual]
 

Signal the core that a change has occued to the editbox. (Unneeded).

Implemented in Dasher::CDasherInterface.

virtual void Dasher::CDasherWidgetInterface::ChangeScreen  )  [pure virtual]
 

Signal the core that a change has occured to the screen. (Unneeded).

Implemented in Dasher::CDasherInterface.

virtual Opts::ScreenOrientations Dasher::CDasherWidgetInterface::GetAlphabetOrientation  )  [pure virtual]
 

(Eg, left to right for English, right to left for Hebrew)

Implemented in Dasher::CDasherInterface.

virtual Opts::AlphabetTypes Dasher::CDasherWidgetInterface::GetAlphabetType  )  [pure virtual]
 

Returns the codepage for the current alphabet.

Implemented in Dasher::CDasherInterface.

virtual const std::string& Dasher::CDasherWidgetInterface::GetDisplayText Dasher::symbol  Symbol  )  [pure virtual]
 

Request the text that should be displayed on the Dasher canvas.

Note - the returned string is in UTF-8 encoding.

Parameters:
Symbol the symbol that is to be displayed

virtual const std::string& Dasher::CDasherWidgetInterface::GetEditText Dasher::symbol  Symbol  )  [pure virtual]
 

Request the text that should be entered into the edit box.

Note - the returned string is in UTF-8 encoding.

Parameters:
Symbol the symbol that is to be displayed

virtual unsigned int Dasher::CDasherWidgetInterface::GetNumberSymbols  )  [pure virtual]
 

Request the number of symbols in the current alphabet.

Implemented in Dasher::CDasherInterface.

virtual int Dasher::CDasherWidgetInterface::GetTextColour Dasher::symbol  Symbol  )  [pure virtual]
 

Request the foreground colour for the text to be drawn on the canvas

Parameters:
Symbol the symbol that is to be displayed

virtual const std::string& Dasher::CDasherWidgetInterface::GetTrainFile  )  [pure virtual]
 

Provides a fully qualified path to the training file for the alphabet.

Implemented in Dasher::CDasherInterface.

virtual void Dasher::CDasherWidgetInterface::PauseAt int  MouseX,
int  MouseY
[pure virtual]
 

Signal an input event and pause the simulation.

Implemented in Dasher::CDasherInterface.

virtual void Dasher::CDasherWidgetInterface::Redraw  )  [pure virtual]
 

Signal that the core should redraw the screen.

Implemented in Dasher::CDasherInterface.

virtual void Dasher::CDasherWidgetInterface::Start  )  [pure virtual]
 

Signal to the core that the model should be started.

Call this function before providing input coordinates and whenever reinitialising Dasher

Implemented in Dasher::CDasherInterface.

virtual void Dasher::CDasherWidgetInterface::TapOn int  MouseX,
int  MouseY,
unsigned long  Time
[pure virtual]
 

Signal an input location.

Signal an input event. This may be the current location of the mouse or a stylus tap, for example

Parameters:
MouseX The mouse X coordinate, in screen coordinates
MouseY The mouse Y coordinate, in screen coordinates
Time Time in milliseconds, required to keep Dasher running at the correct speed

Implemented in Dasher::CDasherInterface.

virtual void Dasher::CDasherWidgetInterface::Unpause unsigned long  Time  )  [pure virtual]
 

Unpause the simulation.

Parameters:
Time should be in milliscones and should be consistent with previous time values

Implemented in Dasher::CDasherInterface.


The documentation for this class was generated from the following file:
Generated on Sat Nov 5 17:58:37 2005 for OPIE by  doxygen 1.4.2