librime: rime::Filter Class Reference

| librime 1.2 Rime Input Method Engine, the core library

Public Member Functions | Protected Attributes | List of all members
rime::Filter Class Referenceabstract

`#include <filter.h>`

Inheritance diagram for rime::Filter:
[legend]
Collaboration diagram for rime::Filter:
[legend]

## Public Member Functions
| Filter (const Ticket &ticket)
virtual | ~Filter ()=default
virtual an< Translation > | Apply (an< Translation > translation, CandidateList *candidates)=0
virtual bool | AppliesToSegment (Segment *segment)
string | name_space () const

## Protected Attributes
Engine * | engine_
string | name_space_

## Additional Inherited Members
Public Types inherited from rime::Class< Filter, const Ticket & >
using | Initializer
Static Public Member Functions inherited from rime::Class< Filter, const Ticket & >
static Component * | Require (const string &name)

## Constructor & Destructor Documentation

## ◆ Filter()

rime::Filter::Filter | ( | const Ticket & | ticket | ) |
| inlineexplicit

## ◆ ~Filter()

virtual rime::Filter::~Filter | ( |  | ) |
| virtualdefault

## Member Function Documentation

## ◆ AppliesToSegment()

virtual bool rime::Filter::AppliesToSegment | ( | Segment * | segment | ) |
| inlinevirtual

Reimplemented in rime::CharsetFilter, rime::ReverseLookupFilter, and rime::Simplifier.

## ◆ Apply()

virtual an< Translation > rime::Filter::Apply | ( | an< Translation > | translation,
|  | CandidateList * | candidates )
| pure virtual

Implemented in rime::CharsetFilter, rime::ReverseLookupFilter, rime::Simplifier, rime::SingleCharFilter, and rime::Uniquifier.

## ◆ name_space()

string rime::Filter::name_space | ( |  | ) | const
| inline

## Member Data Documentation

## ◆ engine_

Engine* rime::Filter::engine_
| protected

## ◆ name_space_

string rime::Filter::name_space_
| protected

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

- filter.h