fe::IDecoratorExtensionFactory Class Reference
[Ferry Extensions library]

Base class for factory classes that produce editor extensions that provide multiple text decoration schemes. More...

Inheritance diagram for fe::IDecoratorExtensionFactory:

fe::IExtensionFactory fe::IColorerDecoratorFactory fe::IScintillaDecoratorFactory

List of all members.

Public Member Functions

virtual void UC_DLL_CALL setSuffix (const char *suffix)=0


Detailed Description

Base class for factory classes that produce editor extensions that provide multiple text decoration schemes.

Member Function Documentation

virtual void UC_DLL_CALL fe::IDecoratorExtensionFactory::setSuffix ( const char *  suffix  )  [pure virtual]

Instructs the factory that it should use a filename suffix as a key to select appropriate text decoration scheme for editor extension when createExtension() is called.

The suffix is normally extracted from the name of a text file whose contents are loaded in a Ferry editor, e.g.: 'h', 'html', 'sh', etc. Though there are some well-known filenames like 'Makefile', 'configure', etc. that don't have suffixes. In these cases pass the file basename prefixed with the '/' character to the function, e.g.: '/Makefile'. This is needed so that implementation can distinguish between suffixes and well-known filenames.

The exact set of recognized suffixes and well-known filenames is implementation specific.

Parameters:
suffix a null-terminated ISO-8859-1 encoded string that specifies the filename suffix or the well-known filename; if the value specifies a well-known filename the suffix[0] should be the '/' character.


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

Generated on Tue Nov 18 21:08:23 2008 for Ferry by doxygen 1.5.7.1
http://sourceforge.net