#include <CEditorSpellChecker.h>

Inheritance diagram for sptk::CSpellChecker:

Public Member Functions
	CSpellChecker ()

virtual	~CSpellChecker ()

void	getDictionaries (Strings &dictionaries)

void	getOptions (CSpellOptions &options)

virtual void	textStart ()=0

virtual bool	getNextWord (String &w, int &wordStart, int &wordEnd)

virtual bool	replaceWord (const String &w, int wordStart, int wordEnd)

bool	spellCheck ()

CSpellOption &	operator[] (const String &optionName)

Public Member Functions inherited from sptk::CSpellOptions
	CSpellOptions ()

Public Member Functions inherited from sptk::CDialog
	CDialog (int w, int h, const char *label=nullptr)

	~CDialog () override

virtual bool	reset ()

int	handle (int event) override

bool	showModal ()

void	alert (const String &s) const

void	defaultButton (CButton *btn)

virtual void	database (PoolDatabaseConnection *db)

PoolDatabaseConnection *	database () const

void	table (const String &tableName)

String	table () const

void	table (PoolDatabaseConnection *db, const String &tableName, const String &keyFieldName)
	Fast setup of the database connection. More...

void	keyField (const String &keyFieldName)

String	keyField () const

void	keyValue (int val)

int	keyValue () const

virtual Fl_Group *	newPage (const char *label, bool autoColor)

virtual Fl_Group *	newScroll (const char *label, bool autoColor)

CButton *	addExtraButton (CButtonKind buttonKind, const char *label, Fl_Callback_p callback)

uint32_t	fieldCount () const

CControl &	operator[] (const String &fieldName)
	Index operator to access controls with defined field name. More...

void	rescan ()
	Makes dialog to scan the widgets inside.

void	load (const xdoc::SNode &node) override

void	save (const xdoc::SNode &node) const override

CDialogModalResult	modalResult () const

String	className () const override
	Returns widget class name (internal SPTK RTTI). More...

Public Member Functions inherited from sptk::CWindow
	CWindow (int w, int h, const char *label=0L)
	Constructor. More...

	CWindow (int x, int y, int w, int h, const char *label=0L)
	Constructor. More...

void	draw () override
	Draws a window, including an optional background image.

void	show () override
	Custom show method.

void	show (int argc, char *argv[])
	Custom show method. More...

void	hide () override
	Custom hide method.

virtual void	relayout ()
	Relayouts window's widgets that have CLayoutClient interface.

void	clear () override
	Removes all the widgets inside the window. More...

void	resize (int x, int y, int w, int h) override
	Resizes the window and inside widgets. More...

bool	preferredSize (int &w, int &h) override
	Computes the optimal window size. More...

int	handle (int event) override
	Custom window events handle. More...

void	load (const std::shared_ptr< xdoc::Node > &node, CLayoutXMLmode xmlMode) override
	Loads window coordinates and widgets from XML node. More...

void	load (const std::shared_ptr< xdoc::Node > &node) override
	Loads window coordinates and widgets from XML node. More...

void	save (const std::shared_ptr< xdoc::Node > &node, CLayoutXMLmode xmlMode) const override
	Saves window coordinates and widgets into XML node. More...

virtual void	save (const xdoc::SNode &node) const
	Saves window coordinates and widgets into XML node. More...

void	loadPosition (const xdoc::SNode &node)
	Loads the window position from XML node. More...

void	savePosition (const xdoc::SNode &node) const
	Saves the window position into XML node. More...

const String &	label () const override
	Returns the current label. More...

String	className () const override
	Returns widget class name (internal SPTK RTTI). More...

virtual void	label (const String &l)

virtual const String &	label () const

Public Member Functions inherited from sptk::CLayoutManager
	CLayoutManager (Fl_Group *group, int layoutSize, CLayoutAlign ca)

	~CLayoutManager () override=default

virtual void	clear ()
	Removes all the children. More...

int	layoutSpacing () const

void	layoutSpacing (int ls)

void	layoutGrowMode (CLayoutGrowMode gm=CLayoutGrowMode::LGM_AUTO_GROW)

CLayoutGrowMode	layoutGrowMode () const

void	relayout ()

void	frame (CFrame *frame, bool drawBackground=true)
	Defines frame. More...

const CFrame *	frame () const
	Returnes the current frame.

uint32_t	frameWidth () const
	Returns frame width.

virtual void	loadLayout (const xdoc::SNode &node, CLayoutXMLmode xmlMode)
	Loads group controls data from XML node. More...

virtual void	saveLayout (const xdoc::SNode &node, CLayoutXMLmode xmlMode) const
	Saves group controls data into XML node. More...

void	nameIndex (CWidgetNamesMap &index, bool recursive, bool clean=true) const
	Builds an index of internal widget names. More...

bool	noXml () const
	Returns flag of blocking XML processing. More...

void	noXml (bool noXml)
	Sets flag of blocking XML processing. More...

Public Member Functions inherited from sptk::CLayoutClient
	CLayoutClient (Fl_Widget *widget, int layoutSize, CLayoutAlign ca)

virtual	~CLayoutClient ()

CLayoutAlign	layoutAlign () const

void	layoutAlign (CLayoutAlign al)

int	layoutSize () const

void	layoutSize (int ls)

virtual void	label (const String &l)

virtual const String &	label () const

void	name (const char *aname)

void	name (const String &aname)

const String &	name () const

virtual bool	preferredSize (int &w, int &h)

virtual bool	computeSize (int &w, int &h)

virtual String	className () const

Fl_Widget *	widget () const

virtual void	load (const xdoc::SNode &node, CLayoutXMLmode xmlMode)

virtual void	load (const std::shared_ptr< xdoc::Node > &node)

virtual void	save (const std::shared_ptr< xdoc::Node > &node, CLayoutXMLmode xmlMode) const

Public Member Functions inherited from sptk::CWindowShape
	CWindowShape (sptk::CWindow *window)
	Constructor. More...

virtual	~CWindowShape ()
	Destructor.

bool	shapeResizing ()
	Returns true if the window is resizing as a result of border drag. More...

Protected Member Functions
void	learnAndClose ()

void	ignoreAndClose ()

void	checkForError ()

Protected Member Functions inherited from sptk::CDialog
virtual bool	okPressed ()

virtual bool	cancelPressed ()

virtual void	scanControls ()

virtual bool	buildQueries ()

virtual bool	load ()

virtual bool	save ()

Protected Member Functions inherited from sptk::CLayoutManager
bool	autoLayout (int x, int y, int &w, int &h, bool resizeWidgets) const

virtual void	paintBackground ()

Protected Member Functions inherited from sptk::CLayoutClient
int	lastPreferredH () const

int	lastPreferredW () const

void	lastPreferredH (int height)

void	lastPreferredW (int width)

Protected Member Functions inherited from sptk::CWindowShape
int	mouseZone (int mouseX, int mouseY) const
	Computes mouse zone from window coordinates. More...

void	changeSize (int mouseX, int mouseY)
	Resizes the window based on mouse zone and mouse screen coordinates. More...

virtual int	shapeCursorHandle (int event)
	Changes the window cursor based on the mouse position in the window. More...

void	initShapeExtension ()
	Initializes shape extension. More...

bool	borderCleared () const
	Returns true if border was cleared for the shape.

void	shapeApply ()
	Sets the shape to the window during window->draw()

void	resizingShape (int w, int h)
	Calls resizeShape() from inside CWindow::resize()

virtual void	shapeResize (int w, int h)
	Shape resize. More...

Static Protected Member Functions
static void	cb_learn (Fl_Widget , void )

static void	cb_ignore (Fl_Widget , void )

static void	cb_suggest (Fl_Widget , void )

static void	cb_replaceword (Fl_Widget , void )

Additional Inherited Members
Static Public Member Functions inherited from sptk::CLayoutManager
static void	registerControl (std::string typeName, createControlCallback creator) noexcept
	Register control type for loading layouts. More...

static const std::map< std::string, Fl_Boxtype > &	boxTypeNames ()
	Returns a read-only map of box type names and corresponding constants.

Protected Attributes inherited from sptk::CDialog
CButton *	m_okButton

CButton *	m_cancelButton

CButton *	m_defaultButton

String	m_tableName

String	m_keyField

int	m_keyValue

CControlList	m_defaultFields

CControlList	m_allFields

CGroup *	m_buttonGroup

CDialogTabs *	m_pages

Query *	m_selectQuery

Query *	m_updateQuery

Query *	m_insertQuery

bool	m_queriesBuilt

bool	m_controlsScanned

CControlList	m_specialProcessingControls

CDialogModalResult	m_modalResult

Protected Attributes inherited from sptk::CLayoutManager
int	m_layoutSpacing

CLayoutGrowMode	m_layoutGrowMode

Fl_Group *	m_group

CFrame *	m_frame

bool	m_frameDrawBackground

bool	m_noXml

Protected Attributes inherited from sptk::CLayoutClient
Fl_Widget *	m_widget

String	m_name

String	m_label

CLayoutAlign	m_layoutAlign

Protected Attributes inherited from sptk::CWindowShape
int	m_resizingZone {0}

int	m_pushedX {0}

int	m_pushedY {0}

std::vector< CShapePoint >	m_shapePoints

bool	m_shapeChanged {true}

int	m_borderWidth {6}

bool	m_borderCleared {false}

bool	m_shapeExtension {false}

Static Protected Attributes inherited from sptk::CLayoutManager
static std::map< std::string, Fl_Boxtype >	m_boxTypeNames

static createControlCallbackMap	controlCreator

Detailed Description

CSpellChecker is a base class for Aspell interface.

Constructor & Destructor Documentation

◆ CSpellChecker()

sptk::CSpellChecker::CSpellChecker ( )

Default constructor

◆ ~CSpellChecker()

virtual sptk::CSpellChecker::~CSpellChecker ( )

inlinevirtual

Destructor

Member Function Documentation

◆ cb_ignore()

static void sptk::CSpellChecker::cb_ignore	(	Fl_Widget *	,
		void *
	)

staticprotected

Callback for the ignore word button

◆ cb_learn()

static void sptk::CSpellChecker::cb_learn	(	Fl_Widget *	,
		void *
	)

staticprotected

Callback for the add word button

◆ cb_replaceword()

static void sptk::CSpellChecker::cb_replaceword	(	Fl_Widget *	,
		void *
	)

staticprotected

Callback for the replace word button

◆ cb_suggest()

static void sptk::CSpellChecker::cb_suggest	(	Fl_Widget *	,
		void *
	)

staticprotected

Callback for the suggestion list click

◆ checkForError()

void sptk::CSpellChecker::checkForError ( )

protected

Checks for error after the operation and throws CException if error is detected

◆ getDictionaries()

void sptk::CSpellChecker::getDictionaries ( Strings & dictionaries )

Downloads the list of installed dictionaries

◆ getNextWord()

virtual bool sptk::CSpellChecker::getNextWord	(	String &	w,
		int &	wordStart,
		int &	wordEnd
	)

inlinevirtual

Gets the next word and advances the spell check position. Purely virtual, should be implemented in the derived class.

Reimplemented in sptk::CEditorSpellChecker.

◆ getOptions()

void sptk::CSpellChecker::getOptions ( CSpellOptions & options )

Downloads the Aspell options

◆ ignoreAndClose()

void sptk::CSpellChecker::ignoreAndClose ( )

protected

Adds a word to ignore list and hides window to continue spelling

◆ learnAndClose()

void sptk::CSpellChecker::learnAndClose ( )

protected

Adds a word to personal dictionary and hides window to continue spelling

◆ operator[]()

CSpellOption & sptk::CSpellChecker::operator[] ( const String & optionName )

Access (read and write) to the particular Aspell option.

◆ replaceWord()

virtual bool sptk::CSpellChecker::replaceWord	(	const String &	w,
		int	wordStart,
		int	wordEnd
	)

inlinevirtual

Replaces the word and advances the spell check position. Purely virtual, should be implemented in the derived class.

Reimplemented in sptk::CEditorSpellChecker.

◆ spellCheck()

bool sptk::CSpellChecker::spellCheck ( )

Spell checks the text. Uses textStart(), getNextWord(), and replaceWord() to go through the text.

◆ textStart()

virtual void sptk::CSpellChecker::textStart ( )

pure virtual

Resets the spell check position. Purely virtual, should be implemented in the derived class.

Implemented in sptk::CEditorSpellChecker.

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

CEditorSpellChecker.h

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CSpellChecker()

◆ ~CSpellChecker()

Member Function Documentation

◆ cb_ignore()

◆ cb_learn()

◆ cb_replaceword()

◆ cb_suggest()

◆ checkForError()

◆ getDictionaries()

◆ getNextWord()

◆ getOptions()

◆ ignoreAndClose()

◆ learnAndClose()

◆ operator[]()

◆ replaceWord()

◆ spellCheck()

◆ textStart()