---

Dasher::CDasherInterface Class Reference

#include <DasherInterface.h>

Inheritance diagram for Dasher::CDasherInterface:

List of all members.

Public Member Functions
	CDasherInterface ()
	~CDasherInterface ()
void	SetSettingsStore (CSettingsStore *SettingsStore)
	Tell the core which CSettingsStore should be used.
void	SetSettingsUI (CDasherSettingsInterface *SettingsUI)
	Tell the core which CDasherSettingsInterface should be used.
void	SetUserLocation (std::string UserLocation)
	Set the path for user specific configuration and files.
void	SetSystemLocation (std::string SystemLocation)
	Set the path for system-wide configuration and files.
void	Start ()
	Signal to the core that the model should be started.
void	TapOn (int MouseX, int MouseY, unsigned long Time)
	Signal an input location.
void	PauseAt (int MouseX, int MouseY)
	Signal an input event and pause the simulation.
void	Unpause (unsigned long Time)
	Unpause the simulation.
void	Redraw ()
	Signal that the core should redraw the screen.
void	ChangeScreen ()
	Signal the core that a change has occured to the screen. (Unneeded).
void	ChangeEdit ()
	Signal the core that a change has occued to the editbox. (Unneeded).
unsigned int	GetNumberSymbols ()
	Request the number of symbols in the current alphabet.
const std::string &	GetDisplayText (symbol Symbol)
	Request the text that should be displayed on the Dasher canvas.
const std::string &	GetEditText (symbol Symbol)
	Request the text that should be entered into the edit box.
Opts::ScreenOrientations	GetAlphabetOrientation ()
	(Eg, left to right for English, right to left for Hebrew)
Opts::AlphabetTypes	GetAlphabetType ()
	Returns the codepage for the current alphabet.
const std::string &	GetTrainFile ()
	Provides a fully qualified path to the training file for the alphabet.
void	ChangeScreen (CDasherScreen *NewScreen)
	Change the screen being used by the core to NewScreen.
void	ChangeEdit (CDashEditbox *NewEdit)
	Change the editbox being used by the core to NewEdit.
void	Train (std::string *TrainString, bool IsMore)
	Train the core on Trainstring.
void	TrainFile (std::string Filename)
	The file should contain UTF-8 encoded text.
double	GetCurCPM ()
	Provides the number of characters per minute input. (Not implemented).
double	GetCurFPS ()
	Provides the framerate that Dasher is runnin at. (Not implemented).
void	GetAlphabets (std::vector< std::string > *AlphabetList)
	Get a vector containing a list of alphabet names available to Dasher.
const CAlphIO::AlphInfo &	GetInfo (const std::string &AlphID)
	Return an AlphInfo object containing the alphabet with name AlphID.
void	SetInfo (const CAlphIO::AlphInfo &NewInfo)
	Save a new or modified AlphInfo object.
void	DeleteAlphabet (const std::string &AlphID)
	Delete the alphabet with name AlphID.
void	ChangeAlphabet (const std::string &NewAlphabetID)
	Change the alphabet in use to NewAlphabetID.
void	ChangeMaxBitRate (double NewMaxBitRate)
	Change the maximum bitrate (effectively the speed) of Dasher.
void	ChangeLanguageModel (unsigned int NewLanguageModelID)
	Generate a new langage model. Not usually needed.
void	ChangeView (unsigned int NewViewID)
	Generate a new view of the model. Call it with 0 when starting up.
void	ChangeOrientation (Opts::ScreenOrientations Orientation)
	Change the orientation (l->r, r->l, so on) of the model.
void	SetFileEncoding (Opts::FileEncodingFormats Encoding)
	Set the file encoding of output files to Encoding.
void	ShowToolbar (bool Value)
	True if toolbar should be shown, false otherwise.
void	ShowToolbarText (bool Value)
	True if toolbar should show text, false otherwse.
void	ShowToolbarLargeIcons (bool Value)
	True if toolbar should have large icons, false otherwise.
void	ShowSpeedSlider (bool Value)
	True if the speed slider should be shown, false otherwise.
void	FixLayout (bool Value)
	True if the window layout should be fixed, false otherwise.
void	TimeStampNewFiles (bool Value)
	True if new files should be timestamped, false otherwise.
void	CopyAllOnStop (bool Value)
	True if all text should be copied to clipboard when Dasher is stopped, false otherwise.
void	SetEditFont (std::string Name, long Size)
	Set the editbox font.
void	SetDasherFont (std::string Name)
	Set the canvas font.
void	SetDasherFontSize (FontSize fontsize)
	Set the size of the font used in the Dasher canvas.
void	SetDimensions (long dimensions)
Private Member Functions
void	CreateDasherModel ()
Private Attributes
CAlphabet *	m_Alphabet
CLanguageModel *	m_LanguageModel
CDasherModel *	m_DasherModel
CDashEditbox *	m_DashEditbox
CDasherScreen *	m_DasherScreen
CDasherView *	m_DasherView
CSettingsStore *	m_SettingsStore
CDasherSettingsInterface *	m_SettingsUI
CAlphIO *	m_AlphIO
CLanguageModel::CNodeContext *	TrainContext
std::string	AlphabetID
int	LanguageModelID
int	ViewID
double	m_MaxBitRate
bool	m_CopyAllOnStop
Opts::ScreenOrientations	m_Orientation
std::string	m_UserLocation
std::string	m_SystemLocation
std::string	m_TrainFile
std::string	m_DasherFont
std::string	m_EditFont
int	m_EditFontSize
Static Private Attributes
const std::string	EmptyString

---

Constructor & Destructor Documentation

Dasher::CDasherInterface::CDasherInterface (    )

Dasher::CDasherInterface::~CDasherInterface (    )

---

Member Function Documentation

void Dasher::CDasherInterface::ChangeAlphabet (  const std::string &    NewAlphabetID )  [virtual]

Reimplemented from Dasher::CDasherSettingsInterface.

void Dasher::CDasherInterface::ChangeEdit (  CDashEditbox *    NewEdit )  [virtual]

Implements Dasher::CDasherAppInterface.

void Dasher::CDasherInterface::ChangeEdit (    )  [virtual]

Implements Dasher::CDasherWidgetInterface.

void Dasher::CDasherInterface::ChangeLanguageModel (  unsigned int    NewLanguageModelID )  [virtual]

Reimplemented from Dasher::CDasherSettingsInterface.

void Dasher::CDasherInterface::ChangeMaxBitRate (  double    NewMaxBitRate )  [virtual]

Reimplemented from Dasher::CDasherSettingsInterface.

void Dasher::CDasherInterface::ChangeOrientation (  Opts::ScreenOrientations    Orientation )  [virtual]

Reimplemented from Dasher::CDasherSettingsInterface.

void Dasher::CDasherInterface::ChangeScreen (  CDasherScreen *    NewScreen )  [virtual]

Implements Dasher::CDasherAppInterface.

void Dasher::CDasherInterface::ChangeScreen (    )  [virtual]

Implements Dasher::CDasherWidgetInterface.

void Dasher::CDasherInterface::ChangeView (  unsigned int    NewViewID )  [virtual]

Reimplemented from Dasher::CDasherSettingsInterface.

void Dasher::CDasherInterface::CopyAllOnStop (  bool    Value )  [virtual]

Reimplemented from Dasher::CDasherSettingsInterface.

void Dasher::CDasherInterface::CreateDasherModel (    )  [private]

void Dasher::CDasherInterface::DeleteAlphabet (  const std::string &    AlphID )  [virtual]

Implements Dasher::CDasherAppInterface.

void Dasher::CDasherInterface::FixLayout (  bool    Value )  [virtual]

Reimplemented from Dasher::CDasherSettingsInterface.

Opts::ScreenOrientations Dasher::CDasherInterface::GetAlphabetOrientation (    )  [virtual]

Implements Dasher::CDasherWidgetInterface.

void Dasher::CDasherInterface::GetAlphabets (  std::vector< std::string > *    AlphabetList )  [virtual]

Implements Dasher::CDasherAppInterface.

Opts::AlphabetTypes Dasher::CDasherInterface::GetAlphabetType (    )  [virtual]

Implements Dasher::CDasherWidgetInterface.

double Dasher::CDasherInterface::GetCurCPM (    )  [virtual]

Implements Dasher::CDasherAppInterface.

double Dasher::CDasherInterface::GetCurFPS (    )  [virtual]

Implements Dasher::CDasherAppInterface.

const std::string& Dasher::CDasherInterface::GetDisplayText (  symbol    Symbol )  [virtual]

Note - the returned string is in UTF-8 encoding. Parameters: Symbol  the symbol that is to be displayed Implements Dasher::CDasherWidgetInterface.

const std::string& Dasher::CDasherInterface::GetEditText (  symbol    Symbol )  [virtual]

Note - the returned string is in UTF-8 encoding. Parameters: Symbol  the symbol that is to be displayed Implements Dasher::CDasherWidgetInterface.

const CAlphIO::AlphInfo& Dasher::CDasherInterface::GetInfo (  const std::string &    AlphID )  [virtual]

Implements Dasher::CDasherAppInterface.

unsigned int Dasher::CDasherInterface::GetNumberSymbols (    )  [virtual]

Implements Dasher::CDasherWidgetInterface.

const std::string& Dasher::CDasherInterface::GetTrainFile (    )  [virtual]

Implements Dasher::CDasherWidgetInterface.

void Dasher::CDasherInterface::PauseAt (  int    MouseX, int    MouseY )  [virtual]

Implements Dasher::CDasherWidgetInterface.

void Dasher::CDasherInterface::Redraw (    )  [virtual]

Implements Dasher::CDasherWidgetInterface.

void Dasher::CDasherInterface::SetDasherFont (  std::string    Name )  [virtual]

Reimplemented from Dasher::CDasherSettingsInterface.

void Dasher::CDasherInterface::SetDasherFontSize (  FontSize    fontsize )  [virtual]

Reimplemented from Dasher::CDasherSettingsInterface.

void Dasher::CDasherInterface::SetDimensions (  long    dimensions )

void Dasher::CDasherInterface::SetEditFont (  std::string    Name, long    Size )  [virtual]

Reimplemented from Dasher::CDasherSettingsInterface.

void Dasher::CDasherInterface::SetFileEncoding (  Opts::FileEncodingFormats    Encoding )  [virtual]

Reimplemented from Dasher::CDasherSettingsInterface.

void Dasher::CDasherInterface::SetInfo (  const CAlphIO::AlphInfo &    NewInfo )  [virtual]

Implements Dasher::CDasherAppInterface.

void Dasher::CDasherInterface::SetSettingsStore (  CSettingsStore *    SettingsStore )

void Dasher::CDasherInterface::SetSettingsUI (  CDasherSettingsInterface *    SettingsUI )

Provide a pointer to an instance of CDasherSettingsInterface in order to allow for platform dependent configuration of certain options

void Dasher::CDasherInterface::SetSystemLocation (  std::string    SystemLocation )

void Dasher::CDasherInterface::SetUserLocation (  std::string    UserLocation )

void Dasher::CDasherInterface::ShowSpeedSlider (  bool    Value )  [virtual]

Reimplemented from Dasher::CDasherSettingsInterface.

void Dasher::CDasherInterface::ShowToolbar (  bool    Value )  [virtual]

Reimplemented from Dasher::CDasherSettingsInterface.

void Dasher::CDasherInterface::ShowToolbarLargeIcons (  bool    Value )  [virtual]

Reimplemented from Dasher::CDasherSettingsInterface.

void Dasher::CDasherInterface::ShowToolbarText (  bool    Value )  [virtual]

Reimplemented from Dasher::CDasherSettingsInterface.

void Dasher::CDasherInterface::Start (    )  [virtual]

Call this function before providing input coordinates and whenever reinitialising Dasher Implements Dasher::CDasherWidgetInterface.

void Dasher::CDasherInterface::TapOn (  int    MouseX, int    MouseY, unsigned long    Time )  [virtual]

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 Implements Dasher::CDasherWidgetInterface.

void Dasher::CDasherInterface::TimeStampNewFiles (  bool    Value )  [virtual]

Reimplemented from Dasher::CDasherSettingsInterface.

void Dasher::CDasherInterface::Train (  std::string *    TrainString, bool    IsMore )  [virtual]

Parameters: TrainString  UTF-8 encoded string to train the core on IsMore  True if more text is to follow as part of the same logical sequence, false otherwise (this allows the model to make assumptions regarding whether the final character provided is in the middle of a word or not) Implements Dasher::CDasherAppInterface.

void Dasher::CDasherInterface::TrainFile (  std::string    Filename )  [virtual]

Implements Dasher::CDasherAppInterface.

void Dasher::CDasherInterface::Unpause (  unsigned long    Time )  [virtual]

Parameters: Time  should be in milliscones and should be consistent with previous time values Implements Dasher::CDasherWidgetInterface.

---

Member Data Documentation

std::string Dasher::CDasherInterface::AlphabetID [private]

const std::string Dasher::CDasherInterface::EmptyString [static, private]

int Dasher::CDasherInterface::LanguageModelID [private]

CAlphabet* Dasher::CDasherInterface::m_Alphabet [private]

CAlphIO* Dasher::CDasherInterface::m_AlphIO [private]

bool Dasher::CDasherInterface::m_CopyAllOnStop [private]

CDashEditbox* Dasher::CDasherInterface::m_DashEditbox [private]

std::string Dasher::CDasherInterface::m_DasherFont [private]

CDasherModel* Dasher::CDasherInterface::m_DasherModel [private]

CDasherScreen* Dasher::CDasherInterface::m_DasherScreen [private]

CDasherView* Dasher::CDasherInterface::m_DasherView [private]

std::string Dasher::CDasherInterface::m_EditFont [private]

int Dasher::CDasherInterface::m_EditFontSize [private]

CLanguageModel* Dasher::CDasherInterface::m_LanguageModel [private]

double Dasher::CDasherInterface::m_MaxBitRate [private]

Opts::ScreenOrientations Dasher::CDasherInterface::m_Orientation [private]

CSettingsStore* Dasher::CDasherInterface::m_SettingsStore [private]

CDasherSettingsInterface* Dasher::CDasherInterface::m_SettingsUI [private]

std::string Dasher::CDasherInterface::m_SystemLocation [private]

std::string Dasher::CDasherInterface::m_TrainFile [private]

std::string Dasher::CDasherInterface::m_UserLocation [private]

CLanguageModel::CNodeContext* Dasher::CDasherInterface::TrainContext [private]

int Dasher::CDasherInterface::ViewID [private]

---

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

• DasherInterface.h

---