fe Namespace Reference

A scope for Ferry API. More...


Namespaces

namespace  imp
 A scope for imported stuff.

Classes

class  ActionGroupTrigger
 Helper to control grouping of text editing actions in editor. More...
class  CachingTextIterator
 Caching iterator over editor's text. More...
struct  castResourceHandle
 Helper to cast ResourceHandle* to some specific type. More...
struct  CellInfo
 Parameters of a text character. More...
class  CharClassConfigurator
 Helper class to simplify character class configuration. More...
class  CreateEditorArgs
 Arguments for Fe_CreateEditor(). More...
class  DecoratorFilterStub
 Stubbed fe::IDecoratorFilter implementation. More...
class  DecoratorStub
 Stubbed fe::IDecorator implementation. More...
class  DecorMetrics
 Wrapper for attributes of a decorated part of text line. More...
class  EditorFacadeListenerProxy
 Proxy fe::IEditorFacadeListener implementation. More...
class  EditorFacadeListenerStub
 Stubbed fe::IEditorFacadeListener implementation. More...
class  EditorFacadePeerBase
 Main class to access editor from user code. More...
class  EditorFacadePolicy
 Editor configuration. More...
struct  enc_traits_utf16
 UTF16 encoding traits. More...
struct  enc_traits_utf8
 UTF8 encoding traits. More...
class  FeError
 Editor error. More...
struct  FontDesc
 Platform independent font description. More...
struct  HitTest
 Result of a point hit test within an editor's window. More...
class  ICharacterClass
 Character class. More...
class  ICharacterClassBuilder
 Character class builder. More...
class  ICharacterDecoratorFactory
 Factory to create editor extensions providing custom characters decoration. More...
class  IColorerDecoratorFactory
 Factory to create editor extensions encapsulating decorators based on Colorer syntax highlighting and text parsing library. More...
class  IDecorator
 Instructs editor how to render text. More...
class  IDecoratorExtensionFactory
 Base class for factory classes that produce editor extensions that provide multiple text decoration schemes. More...
class  IDecoratorFilter
 Instructs editor how to render text filtering output of another fe::IDecorator. More...
class  IDecoratorListener
 Editor provided listener to gather information on a text line decoration. More...
class  IEditorFacade
 Main editor interface. More...
class  IEditorFacadeListener
 The listener class for receiving editor events. More...
class  IEditorFacadeTask
 Provides common protocol for objects that wish to perform some action in the context of the thread running editor's event loop. More...
class  IExtension
 Interface to control external components customizing editor from outside of an editor. More...
class  IExtensionFactory
 Base class of all editor extension factories. More...
class  IFontEnumerator
 Font enumerator. More...
class  IFontMapper
 Font mapper. More...
class  IPluggable
 Interface to control external components from within an editor. More...
class  IResourceLifecycle
 Resource lifecycle. More...
class  IResourcePool
 Resource pool. More...
class  IScintillaDecoratorFactory
 Factory to create editor extensions encapsulating decorators based on Scintilla lexers. More...
class  IStringSource
 An abstraction of a series of fe::String-s. More...
class  ISubstringDecorator
 Interface to provide custom decoration of the part of a text line. More...
class  ISubstringFiller
 Interface to provide custom filling of the part of a text line segment. More...
class  ITextIterator
 Iterator over editor's text. More...
class  ITextScalerFactory
 Factory to create text scaler editor extension. More...
struct  LineInfo
 Parameters of a text line segment. More...
class  PeerBase
 RAII for FeHandle* value. More...
class  PlatformTypes
 A scope for platform specific typedef-s. More...
class  ProxyBase
 Helper base class for proxy classes. More...
class  ReadOnlyTrigger
 Helper to control interactive text modifications in editor. More...
class  Resource
 Resource entity. More...
class  ResourceDesc
 Resource description. More...
class  SingleItemStringSource
 fe::IStringSource-based facade for fe::String instance. More...
struct  String
 Unmanaged byte array. More...
struct  Substring
 Part of editor's text line. More...
class  TextIteratorProxy
 Proxy fe::ITextIterator implementation. More...
class  TextStyle
 Defines a set of styles that editor should apply to a part of a text line. More...
class  UTF32Iterator
 Iterates over UTF-encoded code unit sequence and reads UTF32-encoded characters from it. More...

Typedefs

typedef unsigned ColorRGB
 24bit RGB color type.
typedef EditorFacadePeerBase
< false > 
EditorFacadePeer
typedef EditorFacadePeerBase
< true > 
EditorFacadePeerNoThrow
typedef UTF32Iterator
< enc_traits_utf16< imp::UTF16 >
, false > 
ReverseUTF16Decoder
typedef UTF32Iterator
< enc_traits_utf8< byte_type >
, false > 
ReverseUTF8Decoder
typedef UTF32Iterator
< enc_traits_utf16< imp::UTF16 >
, true > 
UTF16Decoder
typedef UTF32Iterator
< enc_traits_utf8< byte_type >
, true > 
UTF8Decoder

Enumerations

enum  { InvalidColor = (unsigned)-1 }
 'Not a 24bit RGB color value' constant. More...
enum  ClipboardId { ciMain }
 Clipboard IDs. More...
enum  EndOfLine {
  eolKeep, eolVoid, eolLF, eolCR,
  eolCRLF, eolNEL, eolFF, eolLS,
  eolPS
}
 Line terminators. More...
enum  TextLayoutQuality { tlqHigh, tlqDefault, tlqAuto }
 Quality of text layout and rendering. More...

Functions

 FE_RESOURCE_TYPE_DECLARE (ResourceDesc::tFont, PlatformTypes::font_handle_type)
ColorRGB invertColor (ColorRGB v)
 Inverts 24bit RGB color value.


Detailed Description

A scope for Ferry API.

All Ferry classes, typedef-s, etc. are declared in this namespace. The only exception are exported functions, i.e. functions with names started with 'Fe_' prefix. These functions have 'C' linkage for interoperability, thus declared in the global scope.


Typedef Documentation


Function Documentation

fe::FE_RESOURCE_TYPE_DECLARE ( ResourceDesc::tFont  ,
PlatformTypes::font_handle_type   
)


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