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

Dasher::CDashEditbox Class Reference

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

Inheritance diagram for Dasher::CDashEditbox:

Inheritance graph
[legend]
Collaboration diagram for Dasher::CDashEditbox:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 CDashEditbox ()
virtual void SetInterface (CDasherWidgetInterface *DasherInterface)
 Provide the Editbox with a widget interface.
virtual void write_to_file ()=0
 Write some buffered output to a file.
void set_flushed (int i)
 Set the number of flushed characters.
virtual void get_new_context (std::string &str, int max)=0
 Provide context from the editbox for the core.
virtual void unflush ()=0
 Delete flushed text from the editbox.
virtual void output (symbol Symbol)=0
 Enter a the character Symbol into the text box.
virtual void deletetext ()=0
 Delete the previous symbol from the text box.
virtual void flush (symbol Symbol)=0
 Enter a character into the text box and remember that it is flushed.
virtual void TimeStampNewFiles (bool)
 If Value is true, timestamp all new files (optional).
bool IsDirty ()
 Return true if any text has been modified since the last save (optional).
virtual void New (const std::string &)
 Generate a new file (optional).
virtual bool Open (const std::string &)
 Open a file (optional).
virtual bool OpenAppendMode (const std::string &)
 Open a file and append to it (optional).
virtual bool SaveAs (const std::string &)
 Save a file as a provided filename (optional).
virtual bool Save ()
 Save the current file (optional).
virtual void Cut ()
 Cut selected text (optional).
virtual void Copy ()
 Copy the selected text to the clipboard.
virtual void CopyAll ()
 Copy all text in the editbox to the clipboard.
virtual void Paste ()
 Paste text from clipboard (optional).
virtual void SelectAll ()
 Select all text in the editbox (optional).
virtual void Clear ()=0
 Clear all text from the editbox (REQUIRED).
virtual void SetEncoding (Opts::FileEncodingFormats Encoding)=0
 Set the file encoding.
virtual void SetFont (std::string Name, long Size)=0
 Set the font used in the editbox.

Protected Attributes

bool m_dirty
 Have the contents of the editbox been altered since the last save?
int m_iFlushed
 Record the number of characters that have been flushed.
CDasherWidgetInterface * m_DasherInterface
 Pointer to a DasherWidgetInterface for communication with the core.

Constructor & Destructor Documentation

Dasher::CDashEditbox::CDashEditbox (   )  [inline]
 

Definition at line 26 of file DashEdit.h.

Member Function Documentation

virtual void Dasher::CDashEditbox::Clear (   )  [pure virtual]
 

Clear all text from the editbox (REQUIRED).

Implemented in QtDasherPlugin.

virtual void Dasher::CDashEditbox::Copy (   )  [inline, virtual]
 

Copy the selected text to the clipboard.

Definition at line 117 of file DashEdit.h.

virtual void Dasher::CDashEditbox::CopyAll (   )  [inline, virtual]
 

Copy all text in the editbox to the clipboard.

Definition at line 122 of file DashEdit.h.

Referenced by Dasher::CDasherInterface::PauseAt().

virtual void Dasher::CDashEditbox::Cut (   )  [inline, virtual]
 

Cut selected text (optional).

Copy the selected text to the clipboard and remove it from the editbox

Definition at line 112 of file DashEdit.h.

virtual void Dasher::CDashEditbox::deletetext (   )  [pure virtual]
 

Delete the previous symbol from the text box.

Implemented in QtDasherPlugin.

Referenced by Dasher::CDasherModel::Reparent_root().

virtual void Dasher::CDashEditbox::flush (  symbol  Symbol  )  [pure virtual]
 

Enter a character into the text box and remember that it is flushed.

Output the character and increment m_iFlushed. When unflush is called, remove the previous m_iFlushed characters

virtual void Dasher::CDashEditbox::get_new_context (  std::string &  str,
int  max
)  [pure virtual]
 

Provide context from the editbox for the core.

Provide the context at the current position within the editbox to the core. Set str to up to max characters before the cursor position within the editbox.

Implemented in QtDasherPlugin.

Referenced by Dasher::CDasherModel::Start().

bool Dasher::CDashEditbox::IsDirty (   )  [inline]
 

Return true if any text has been modified since the last save (optional).

Definition at line 71 of file DashEdit.h.

References m_dirty.

virtual void Dasher::CDashEditbox::New (  const std::string &   )  [inline, virtual]
 

Generate a new file (optional).

New file - provide a file save dialogue and return the filename in filename, or provide a blank filename and present a file save dialogue when Save() is called

Definition at line 78 of file DashEdit.h.

Referenced by Dasher::CDasherInterface::ChangeEdit().

virtual bool Dasher::CDashEditbox::Open (  const std::string &   )  [inline, virtual]
 

Open a file (optional).

Provide a file open dialogue and set filename to the filename. Return true if a file is chosen and opened successfully, false otherwise

Definition at line 85 of file DashEdit.h.

virtual bool Dasher::CDashEditbox::OpenAppendMode (  const std::string &   )  [inline, virtual]
 

Open a file and append to it (optional).

Provide a file open dialogue and set filename to the filename. The file will then have any new text appended to it. Return true if a file is chosen and opened successfully, false otherwise

Definition at line 93 of file DashEdit.h.

virtual void Dasher::CDashEditbox::output (  symbol  Symbol  )  [pure virtual]
 

Enter a the character Symbol into the text box.

Referenced by Dasher::CDasherModel::Make_root().

virtual void Dasher::CDashEditbox::Paste (   )  [inline, virtual]
 

Paste text from clipboard (optional).

Paste text from the clipboard into the editbox at the current position

Definition at line 128 of file DashEdit.h.

virtual bool Dasher::CDashEditbox::Save (   )  [inline, virtual]
 

Save the current file (optional).

Save file to the current filename. If there is no current filename, or if saving fails, return false

Definition at line 105 of file DashEdit.h.

virtual bool Dasher::CDashEditbox::SaveAs (  const std::string &   )  [inline, virtual]
 

Save a file as a provided filename (optional).

Provide a file save dialogue and set filename to the filename. Return true if a file is chosen and saved successfully, false otherwise

Definition at line 99 of file DashEdit.h.

virtual void Dasher::CDashEditbox::SelectAll (   )  [inline, virtual]
 

Select all text in the editbox (optional).

Definition at line 131 of file DashEdit.h.

void Dasher::CDashEditbox::set_flushed (  int  i  )  [inline]
 

Set the number of flushed characters.

Set the number of flushed characters to an arbitrary number. Usually used to reset it to 0 after unflushing

Definition at line 38 of file DashEdit.h.

References m_iFlushed.

Referenced by Dasher::CDasherModel::Start().

virtual void Dasher::CDashEditbox::SetEncoding (  Opts::FileEncodingFormats  Encoding  )  [pure virtual]
 

Set the file encoding.

Set the file encoding to the provided encoding Encoding. The editbox is responsible for saving the file in the encoding desired by the user. As Dasher is internally UTF8, it may well be necessary to save in an alternative format based on locale and OS.

virtual void Dasher::CDashEditbox::SetFont (  std::string  Name,
long  Size
)  [pure virtual]
 

Set the font used in the editbox.

Set the font used in the editbox to Name and size Size (in points)

Implemented in QtDasherPlugin.

Referenced by Dasher::CDasherInterface::ChangeEdit(), and Dasher::CDasherInterface::SetEditFont().

virtual void Dasher::CDashEditbox::SetInterface (  CDasherWidgetInterface *  DasherInterface  )  [inline, virtual]
 

Provide the Editbox with a widget interface.

Definition at line 29 of file DashEdit.h.

References m_DasherInterface.

Referenced by Dasher::CDasherInterface::ChangeAlphabet(), and Dasher::CDasherInterface::ChangeEdit().

virtual void Dasher::CDashEditbox::TimeStampNewFiles (  bool   )  [inline, virtual]
 

If Value is true, timestamp all new files (optional).

If switched on, all new files should be timestamped, either in the filename or in file metadata

Definition at line 68 of file DashEdit.h.

Referenced by Dasher::CDasherInterface::ChangeEdit(), and Dasher::CDasherInterface::TimeStampNewFiles().

virtual void Dasher::CDashEditbox::unflush (   )  [pure virtual]
 

Delete flushed text from the editbox.

Implemented in QtDasherPlugin.

Referenced by Dasher::CDasherInterface::Unpause().

virtual void Dasher::CDashEditbox::write_to_file (   )  [pure virtual]
 

Write some buffered output to a file.

Implemented in QtDasherPlugin.

Referenced by Dasher::CDasherInterface::PauseAt().

Member Data Documentation

CDasherWidgetInterface* Dasher::CDashEditbox::m_DasherInterface [protected]
 

Pointer to a DasherWidgetInterface for communication with the core.

Definition at line 159 of file DashEdit.h.

Referenced by SetInterface().

bool Dasher::CDashEditbox::m_dirty [protected]
 

Have the contents of the editbox been altered since the last save?

Definition at line 153 of file DashEdit.h.

Referenced by IsDirty().

int Dasher::CDashEditbox::m_iFlushed [protected]
 

Record the number of characters that have been flushed.

Definition at line 156 of file DashEdit.h.

Referenced by set_flushed().

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