#include <swmodule.h>
Inheritance diagram for SWModule::
Public Methods | |
SWModule (const char *imodname=0, const char *imoddesc=0, SWDisplay *idisp=0, char *imodtype=0, bool unicode=false) | |
Initializes data for instance of SWModule. More... | |
virtual | ~SWModule () |
Cleans up instance of SWModule. | |
virtual char | Error () |
Gets and clears error status. More... | |
virtual const bool | isUnicode () const |
virtual const int | getEntrySize () const |
virtual char | SetKey (const SWKey *ikey) |
Sets a key to this module for position to a particular record or set of records. More... | |
virtual char | SetKey (const SWKey &ikey) |
Sets the key of this module. More... | |
virtual SWKey& | Key () const |
Gets the current module key. More... | |
virtual char | Key (const SWKey &ikey) |
Sets the current key of the module to ikey, and returns the keytext. More... | |
virtual const char* | KeyText (const char *imodtype=0) |
Sets/gets module KeyText. More... | |
virtual char | Display () |
Calls this modules display object and passes itself. More... | |
virtual SWDisplay* | Disp (SWDisplay *idisp=0) |
Sets/gets display driver. More... | |
virtual char* | Name (const char *imodname=0) |
Sets/gets module name. More... | |
virtual char* | Description (const char *imoddesc=0) |
Sets/gets module description. More... | |
virtual char* | Type (const char *imodtype=0) |
Sets/gets module type. More... | |
virtual ListKey& | Search (const char *istr, int searchType=0, int flags=0, SWKey *scope=0, bool *justCheckIfSupported=0, void(*percent)(char, void *)=&nullPercent, void *percentUserData=0) |
Searches a module for a string. More... | |
virtual char | createSearchFramework () |
virtual bool | hasSearchFramework () |
virtual bool | isSearchOptimallySupported (const char *istr, int searchType, int flags, SWKey *scope) |
virtual SWKey* | CreateKey () |
Allocates a key of specific type for module. More... | |
virtual | operator char * () |
Renders and returns the current module text. More... | |
virtual char* | getRawEntry ()=0 |
This function is reimplemented by the different kinds of module objects. More... | |
virtual | operator SWKey & () |
virtual | operator SWKey * () |
virtual bool | isWritable () |
Is the module writable? :). More... | |
virtual SWModule& | operator<< (const char *) |
Modify the current module entry text only if module isWritable. More... | |
virtual SWModule& | operator<< (const SWKey *) |
Link the current module entry to another module entry only if module isWritable. More... | |
virtual void | deleteEntry () |
Delete current module entry - only if module isWritable. | |
virtual SWModule& | operator-= (int decrement) |
Decrements module key a number of entries. More... | |
virtual SWModule& | operator+= (int increment) |
Increments module key a number of entries. More... | |
virtual SWModule& | operator++ (int) |
Increments module key by 1 entry. | |
virtual SWModule& | operator-- (int) |
Decrements module key by 1 entry. | |
virtual SWModule& | operator= (SW_POSITION p) |
Positions this modules to an entry. More... | |
virtual SWModule& | AddRenderFilter (SWFilter *newfilter) |
Adds a RenderFilter to this module's. More... | |
virtual SWModule& | RemoveRenderFilter (SWFilter *oldfilter) |
Removes a RenderFilter to this module's. More... | |
virtual void | renderFilter (char *buf, long size, SWKey *key) |
RenderFilter a text buffer. More... | |
virtual SWModule& | AddStripFilter (SWFilter *newfilter) |
Adds a StripFilter to this module's stripfilters queue. More... | |
virtual void | stripFilter (char *buf, long size, SWKey *key) |
StripFilter a text buffer. More... | |
virtual SWModule& | AddRawFilter (SWFilter *newfilter) |
Adds a RawFilter to this module's rawfilters queue. More... | |
virtual void | filterBuffer (FilterList *filters, char *buf, long size, SWKey *key) |
FilterBuffer a text buffer. More... | |
virtual void | rawFilter (char *buf, long size, SWKey *key) |
RawFilter a text buffer. More... | |
virtual SWModule& | AddOptionFilter (SWFilter *newfilter) |
Adds an OptionFilter to this module's optionfilters queue. More... | |
virtual void | optionFilter (char *buf, long size, SWKey *key) |
OptionFilter a text buffer. More... | |
virtual const char* | StripText (char *buf=0, int len=-1) |
calls all StripFilters on buffer or current text. More... | |
virtual const char* | RenderText (char *buf=0, int len=-1) |
calls all RenderFilters on buffer or current text. More... | |
virtual const char* | StripText (SWKey *tmpKey) |
calls all StripFilters on current text. More... | |
virtual const char* | RenderText (SWKey *tmpKey) |
calls all RenderFilters on current text. More... | |
Public Attributes | |
bool | terminateSearch |
Set this bool to false to terminate the search which is executed by this module (Search). More... | |
Static Public Methods | |
void | nullPercent (char percent, void *userData) |
This is the default callback function for searching. More... | |
char | createModule (const char *) |
Creates a new module. More... | |
Protected Attributes | |
char | error |
SWKey* | key |
the current key. | |
ListKey | listkey |
char* | modname |
char* | moddesc |
char* | modtype |
SWDisplay* | disp |
this module's display object. | |
char* | entrybuf |
FilterList* | stripFilters |
executed to remove all markup (for searches). | |
FilterList* | rawFilters |
executed immediately upon fileread. | |
FilterList* | renderFilters |
executed to format for display. | |
FilterList* | optionFilters |
executed to change markup to user prefs. | |
bool | render |
bool | unicode |
int | entrySize |
Static Protected Attributes | |
SWDisplay | rawdisp |
Definition at line 47 of file swmodule.h.
|
Initializes data for instance of SWModule.
|
|
Adds an OptionFilter to this module's optionfilters queue.
Definition at line 443 of file swmodule.h. |
|
Adds a RawFilter to this module's rawfilters queue.
Definition at line 410 of file swmodule.h. |
|
Adds a RenderFilter to this module's.
Definition at line 363 of file swmodule.h. |
|
Adds a StripFilter to this module's stripfilters queue.
Definition at line 391 of file swmodule.h. |
|
Allocates a key of specific type for module.
|
|
Sets/gets module description.
|
|
Sets/gets display driver.
|
|
Calls this modules display object and passes itself.
|
|
Gets and clears error status.
|
|
Sets the current key of the module to ikey, and returns the keytext.
Definition at line 161 of file swmodule.h. |
|
Gets the current module key.
Definition at line 151 of file swmodule.h. |
|
Sets/gets module KeyText.
Reimplemented in SWLD. |
|
Sets/gets module name.
|
|
Removes a RenderFilter to this module's.
Definition at line 372 of file swmodule.h. |
|
calls all RenderFilters on current text.
|
|
calls all RenderFilters on buffer or current text.
|
|
Searches a module for a string.
|
|
Sets the key of this module. Similair to
|
|
Sets a key to this module for position to a particular record or set of records.
Referenced by Key(). |
|
calls all StripFilters on current text.
|
|
calls all StripFilters on buffer or current text.
|
|
Sets/gets module type.
|
|
Creates a new module.
Definition at line 296 of file swmodule.h. |
|
FilterBuffer a text buffer.
Definition at line 422 of file swmodule.h. Referenced by optionFilter(), rawFilter(), renderFilter(), and stripFilter(). |
|
Definition at line 130 of file swmodule.h. |
|
This function is reimplemented by the different kinds of module objects.
|
|
Definition at line 126 of file swmodule.h. |
|
Is the module writable? :).
Definition at line 288 of file swmodule.h. |
|
This is the default callback function for searching. This function is a placeholder and does nothing. You can define your own function for search progress evaluation, and pass it over to Search. |
|
Renders and returns the current module text.
|
|
Increments module key a number of entries.
|
|
Decrements module key a number of entries.
|
|
Link the current module entry to another module entry only if module isWritable.
Definition at line 312 of file swmodule.h. |
|
Modify the current module entry text only if module isWritable.
Definition at line 304 of file swmodule.h. |
|
Positions this modules to an entry.
|
|
OptionFilter a text buffer.
Definition at line 454 of file swmodule.h. |
|
RawFilter a text buffer.
Definition at line 435 of file swmodule.h. |
|
RenderFilter a text buffer.
Definition at line 383 of file swmodule.h. |
|
StripFilter a text buffer.
Definition at line 402 of file swmodule.h. |
|
Set this bool to false to terminate the search which is executed by this module (Search). This is useful for threaded applications to terminate the search in another thread. Definition at line 97 of file swmodule.h. |