Ferry Extensions library

Set of components extending basic text editing functionality provided by Ferry Core library. More...

Classes
class	fe::CharClassConfigurator< ErrorType, ICharacterClassBuilderAutoPtrType, ICharacterClassAutoPtrType >
	Helper class to simplify character class configuration. More...
struct	fe::FontDesc
	Platform independent font description. More...
class	fe::ICharacterClass
	Character class. More...
class	fe::ICharacterClassBuilder
	Character class builder. More...
class	fe::ICharacterDecoratorFactory
	Factory to create editor extensions providing custom characters decoration. More...
class	fe::IColorerDecoratorFactory
	Factory to create editor extensions encapsulating decorators based on Colorer syntax highlighting and text parsing library. More...
class	fe::IDecoratorExtensionFactory
	Base class for factory classes that produce editor extensions that provide multiple text decoration schemes. More...
class	fe::IExtension
	Interface to control external components customizing editor from outside of an editor. More...
class	fe::IExtensionFactory
	Base class of all editor extension factories. More...
class	fe::IScintillaDecoratorFactory
	Factory to create editor extensions encapsulating decorators based on Scintilla lexers. More...
class	fe::ITextScalerFactory
	Factory to create text scaler editor extension. More...
Files
file	character_class.h
	Character class API.
file	character_decorator_factory.h
	Editor extension to provide custom characters decoration.
file	colorer_decorator_factory.h
	Editor extension encapsulating decorator based on Colorer syntax highlighting and text parsing library.
file	decorator_extension_factory.h
	Declares fe::IDecoratorExtensionFactory.
file	extension.h
	Declares fe::IExtension.
file	extension_factory.h
	Declares fe::IExtensionFactory.
file	ferry_extensions.h
	Top level Ferry Extensions library header.
file	font_builder.h
	Platform independent font API.
file	scintilla_decorator_factory.h
	Editor extension encapsulating decorator based on Scintilla lexers API.
file	text_scaler_factory.h
	Text scaler editor extension API.
Enumerations
enum	fe::ICharacterDecoratorFactory::CharacterClassDecorator {   fe::ICharacterDecoratorFactory::ccdDot, fe::ICharacterDecoratorFactory::ccdArrow, fe::ICharacterDecoratorFactory::ccdCharCodeUtf32, fe::ICharacterDecoratorFactory::ccdCharCodeUtf16,   fe::ICharacterDecoratorFactory::ccdCharCodeUtf8, fe::ICharacterDecoratorFactory::ccdUnknown, fe::ICharacterDecoratorFactory::ccdCustom }
	Character class decorator IDs. More...
enum	fe::ICharacterDecoratorFactory::CharacterClassType { fe::ICharacterDecoratorFactory::cctWhiteSpace, fe::ICharacterDecoratorFactory::cctTab, fe::ICharacterDecoratorFactory::cctControl, fe::ICharacterDecoratorFactory::cctCustom }
	Character class type IDs. More...
Functions
fe::ICharacterDecoratorFactory *	Fe_CreateCharacterDecoratorFactory ()
	Creates character decorator editor extension factory.
fe::IColorerDecoratorFactory *	Fe_CreateColorerDecoratorFactory ()
	Creates factory to build editor extensions encapsulating decorator based on Colorer syntax highlighting and text parsing library.
fe::IScintillaDecoratorFactory *	Fe_CreateScintillaDecoratorFactory ()
	Creates factory to build editor extensions encapsulating decorator based on Scintilla lexers.
fe::ITextScalerFactory *	Fe_CreateTextScalerFactory ()
	Creates text scaler factory.
fe::PlatformTypes::font_handle_type	Fe_FontCreate (const fe::FontDesc &desc)
	Creates font from description.
void	Fe_FontDelete (fe::PlatformTypes::font_handle_type font)
	Destroys font.
fe::FontDesc *	Fe_FontGetDesc (fe::PlatformTypes::font_handle_type font, fe::FontDesc &desc)
	Calculates font description.

---

Detailed Description

Set of components extending basic text editing functionality provided by Ferry Core library.

• fe::ICharacterDecoratorFactory;
• fe::IScintillaDecoratorFactory;
• fe::IColorerDecoratorFactory;
• fe::ITextScalerFactory.

---

Enumeration Type Documentation

enum fe::ICharacterDecoratorFactory::CharacterClassDecorator [inherited]

Character class decorator IDs.

See also:

fe::ICharacterDecoratorFactory::setCharacterClassDecoratorId()

Enumerator:

ccdDot	Character decorator that draws a dot in the center of a rectangle reserved for a character glyph. This decorator is intended to be applied to whitespace characters. Before decorator is applied to all characters: After decorator is applied:
ccdArrow	Character decorator that draws a horizontal arrow in a rectangle reserved for a character glyph. This decorator is intended to be applied to TAB characters. Before decorator is applied to all characters: After decorator is applied:
ccdCharCodeUtf32	Character decorator that draws a hexadecimal value of a UTF32 code unit encoding a character instead of a corresponding glyph. This decorator is intended to be applied to unprintable characters. Before decorator is applied to all characters: After decorator is applied:
ccdCharCodeUtf16	Character decorator that draws a hexademical value of a UTF16 code unit sequence encoding a character instead of a corresponding glyph. This decorator is intended to be applied to unprintable characters. Before decorator is applied to all characters: After decorator is applied:
ccdCharCodeUtf8	Character decorator that draws a hexademical value of a UTF8 code units encoding a character instead of a corresponding glyph. This decorator is intended to be applied to unprintable characters. Before decorator is applied to all characters: After decorator is applied:
ccdUnknown	Invalid character decorator ID.
ccdCustom	The first ID for user-supplied decorators.

enum fe::ICharacterDecoratorFactory::CharacterClassType [inherited]

Character class type IDs.

See also:

fe::ICharacterDecoratorFactory::createCharacterClassBuilder()

Enumerator:

cctWhiteSpace	White space character class. Includes white space characters: '0x0020', '0x00A0', etc. See generated_utf32_characters_whitespace.h generated source file for the complete list of characters in this class.
cctTab	Tab character class. Includes a single '\t' character.
cctControl	Control character class. Includes control characters: '\0', '\r' etc. See generated_utf32_characters_control.h generated source file for the complete list of characters in this class.
cctCustom	User-defined character class. Includes no characters.

---

Function Documentation

fe::ICharacterDecoratorFactory* Fe_CreateCharacterDecoratorFactory

(

)

Creates character decorator editor extension factory.

Returns pointer to a heap allocated object or 0 if error occurred.

Note:

Editor extensions created with fe::ICharacterDecoratorFactory::createExtension() function called on the object created with Fe_CreateCharacterDecoratorFactory() function can be attached to multiple editors at a time on condition all these editors run their event loops in the same thread.

fe::ICharacterDecoratorFactory::addCharacterClass() function called on the object created with Fe_CreateCharacterDecoratorFactory() function will fail and return false if the given character class was not created with the character class builder other than one created with the fe::ICharacterDecoratorFactory::createCharacterClassBuilder() called on the same object.

fe::IColorerDecoratorFactory* Fe_CreateColorerDecoratorFactory

(

)

Creates factory to build editor extensions encapsulating decorator based on Colorer syntax highlighting and text parsing library.

Returns pointer to a heap allocated object or 0 if error occurred.

Note:

Editor extensions created with fe::IColorerDecoratorFactory::createExtension() function called on the object created with Fe_CreateColorerDecoratorFactory() fucntion can be attached only to one editor at a time.

fe::PlatformTypes::font_handle_type Fe_FontCreate

(

const fe::FontDesc &

desc

)

Creates font from description.

Returns platform specific handle to a font created from the given platform independent font description or 0 if error occurred.

Parameters:

desc

platform independent font description.

void Fe_FontDelete

(

fe::PlatformTypes::font_handle_type

font

)

Destroys font.

Destroys font addressed with the given platform specific font handle.

Note:

It is safe to use platform specific API to destroy fonts created with Fe_FontCreate().

Parameters:

font

platform specific handle to a font to destroy or 0.

fe::FontDesc* Fe_FontGetDesc	(	fe::PlatformTypes::font_handle_type	font,
		fe::FontDesc &	desc
	)

Calculates font description.

Initializes platform independent font description from the given platform specific handle to a font. Initializes desc and returns &desc if succeeded, otherwise doesn't touch desc and returns 0.

Parameters:

	font	platform specific handle to a font;
	desc	uninitialized platform independent font description.

fe::IScintillaDecoratorFactory* Fe_CreateScintillaDecoratorFactory

(

)

Creates factory to build editor extensions encapsulating decorator based on Scintilla lexers.

Returns pointer to a heap allocated object or 0 if error occurred.

Note:

Editor extensions created with fe::IScintillaDecoratorFactory::createExtension() function called on the object created with Fe_CreateScintillaDecoratorFactory() fucntion can be attached only to one editor at a time.

fe::ITextScalerFactory* Fe_CreateTextScalerFactory

(

)

Creates text scaler factory.

Returns pointer to a heap allocated object or 0 if error occurred.

Note:

Editor extensions created with fe::ITextScalerFactory::createExtension() function called on the object created with Fe_CreateTextScalerFactory() fucntion can be attached to multiple editors at a time on condition all these editors run their event loops in the same thread.