---

Dasher::CDashEditbox Class Reference

#include <DashEdit.h>

List of all members.

Public Member Functions
	CDashEditbox ()
virtual void	SetInterface (CDasherWidgetInterface *DasherInterface)
	Provide the Editbox with a widget interface.
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	flush (symbol Symbol)=0
	Enter a character into the text box and remember that it is flushed.
virtual void	TimeStampNewFiles (bool Value)
	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 &filename)
	Generate a new file (optional).
virtual bool	Open (const std::string &filename)
	Open a file (optional).
virtual bool	OpenAppendMode (const std::string &filename)
	Open a file and append to it (optional).
virtual bool	SaveAs (const std::string &filename)
	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]

---

Member Function Documentation

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

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

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

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

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

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

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 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.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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 to Name and size Size (in points)

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

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

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

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

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

---

Member Data Documentation

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

bool Dasher::CDashEditbox::m_dirty [protected]

int Dasher::CDashEditbox::m_iFlushed [protected]

---

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

• DashEdit.h

---