ICU 63.1 63.1

filteredbrk.h
Go to the documentation of this file.
1 // © 2016 and later: Unicode, Inc. and others.
2 // License & terms of use: http://www.unicode.org/copyright.html
3 /*
4 ********************************************************************************
5 * Copyright (C) 1997-2015, International Business Machines
6 * Corporation and others. All Rights Reserved.
7 ********************************************************************************
8 */
9
10 #ifndef FILTEREDBRK_H
11 #define FILTEREDBRK_H
12
13 #include "unicode/utypes.h"
14 #include "unicode/brkiter.h"
15
16 #if !UCONFIG_NO_BREAK_ITERATION && !UCONFIG_NO_FILTERED_BREAK_ITERATION
17
18 U_NAMESPACE_BEGIN
19
36 class U_COMMON_API FilteredBreakIteratorBuilder : public UObject {
37 public:
42 virtual ~FilteredBreakIteratorBuilder();
43
56 static FilteredBreakIteratorBuilder *createInstance(const Locale& where, UErrorCode& status);
57
58 #ifndef U_HIDE_DEPRECATED_API
59
67 static FilteredBreakIteratorBuilder *createInstance(UErrorCode &status);
68 #endif /* U_HIDE_DEPRECATED_API */
69
77 static FilteredBreakIteratorBuilder *createEmptyInstance(UErrorCode &status);
78
89 virtual UBool suppressBreakAfter(const UnicodeString& string, UErrorCode& status) = 0;
90
102 virtual UBool unsuppressBreakAfter(const UnicodeString& string, UErrorCode& status) = 0;
103
113 virtual BreakIterator *build(BreakIterator* adoptBreakIterator, UErrorCode& status) = 0;
114
128 inline BreakIterator *wrapIteratorWithFilter(BreakIterator* adoptBreakIterator, UErrorCode& status) {
129 return build(adoptBreakIterator, status);
130 }
131
132 protected:
137 FilteredBreakIteratorBuilder();
138 };
139
140
141 U_NAMESPACE_END
142
143 #endif // #if !UCONFIG_NO_BREAK_ITERATION && !UCONFIG_NO_FILTERED_BREAK_ITERATION
144
145 #endif // #ifndef FILTEREDBRK_H
brkiter.h
C++ API: Break Iterator.
U_NAMESPACE_BEGIN
#define U_NAMESPACE_BEGIN
This is used to begin a declaration of a public ICU C++ API.
Definition: uversion.h:137
icu::BreakIterator
The BreakIterator class implements methods for finding the location of boundaries in text...
Definition: brkiter.h:102
U_NAMESPACE_END
#define U_NAMESPACE_END
This is used to end a declaration of a public ICU C++ API.
Definition: uversion.h:138
icu::FilteredBreakIteratorBuilder::wrapIteratorWithFilter
BreakIterator * wrapIteratorWithFilter(BreakIterator *adoptBreakIterator, UErrorCode &status)
Wrap (adopt) an existing break iterator in a new filtered instance.
Definition: filteredbrk.h:128
UErrorCode
UErrorCode
Error code to replace exception handling, so that the code is compatible with all C++ compilers...
Definition: utypes.h:401
utypes.h
Basic definitions for ICU, for both C and C++ APIs.
U_COMMON_API
#define U_COMMON_API
Set to export library symbols from inside the common library, and to import them from outside...
Definition: utypes.h:300
icu::UnicodeString
UnicodeString is a string class that stores Unicode characters directly and provides similar function...
Definition: unistr.h:289
icu::FilteredBreakIteratorBuilder
The BreakIteratorFilter is used to modify the behavior of a BreakIterator by constructing a new Break...
Definition: filteredbrk.h:36
icu::UObject
UObject is the common ICU "boilerplate" class.
Definition: uobject.h:220
UBool
int8_t UBool
The ICU boolean type.
Definition: umachine.h:225
icu::Locale
A Locale object represents a specific geographical, political, or cultural region.
Definition: locid.h:192