sptk2 logo
SPTK Home Page
Public Member Functions | List of all members
sptk::CEditorSpellChecker Class Reference

#include <CEditorSpellChecker.h>

Inheritance diagram for sptk::CEditorSpellChecker:
sptk::CSpellChecker sptk::CSpellOptions sptk::CDialog sptk::CWindow sptk::CLayoutManager sptk::CWindowShape sptk::CLayoutClient

Public Member Functions

 CEditorSpellChecker (CEditor *editor)
 
virtual void textStart ()
 
virtual bool getNextWord (String &w, int &wordStart, int &wordEnd)
 
virtual bool replaceWord (const String &w, int wordStart, int wordEnd)
 
- Public Member Functions inherited from sptk::CSpellChecker
 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 ()
 
CSpellOptionoperator[] (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)
 
PoolDatabaseConnectiondatabase () 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)
 
CButtonaddExtraButton (CButtonKind buttonKind, const char *label, Fl_Callback_p callback)
 
uint32_t fieldCount () const
 
CControloperator[] (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 Stringlabel () 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 Stringlabel () 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 CFrameframe () 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 Stringlabel () const
 
void name (const char *aname)
 
void name (const String &aname)
 
const Stringname () 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...
 

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 Member Functions inherited from sptk::CSpellChecker
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 inherited from sptk::CSpellChecker
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 *)
 
- Protected Attributes inherited from sptk::CDialog
CButtonm_okButton
 
CButtonm_cancelButton
 
CButtonm_defaultButton
 
String m_tableName
 
String m_keyField
 
int m_keyValue
 
CControlList m_defaultFields
 
CControlList m_allFields
 
CGroupm_buttonGroup
 
CDialogTabsm_pages
 
Querym_selectQuery
 
Querym_updateQuery
 
Querym_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
 
CFramem_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< CShapePointm_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

Specialized spell checker to use with CEditor class.

Constructor & Destructor Documentation

◆ CEditorSpellChecker()

sptk::CEditorSpellChecker::CEditorSpellChecker ( CEditor editor)
inlineexplicit

Constructor

Parameters
editorCEditor *, widget to work with

Member Function Documentation

◆ getNextWord()

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

Gets the next word and advances the spell check position

Reimplemented from sptk::CSpellChecker.

◆ replaceWord()

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

Replaces the word and advances the spell check position

Reimplemented from sptk::CSpellChecker.

◆ textStart()

virtual void sptk::CEditorSpellChecker::textStart ( )
virtual

Resets the spell check position

Implements sptk::CSpellChecker.


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

Fri Oct 14 2022 09:58:35: SPTK 5.4.1