ICU 74.2: i18n/unicode/fpositer.h Source File

ICU 74.2 74.2

fpositer.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) 2010-2012, International Business Machines
6* Corporation and others. All Rights Reserved.
7********************************************************************************
8*
9* File attiter.h
10*
11* Modification History:
12*
13* Date Name Description
14* 12/15/2009 dougfelt Created
15********************************************************************************
16*/
17
18#ifndef FPOSITER_H
19#define FPOSITER_H
20
21#include "unicode/utypes.h"
22
23#if U_SHOW_CPLUSPLUS_API
24
25#include "unicode/uobject.h"
26
32#if UCONFIG_NO_FORMATTING
33
34U_NAMESPACE_BEGIN
35
36/*
37 * Allow the declaration of APIs with pointers to FieldPositionIterator
38 * even when formatting is removed from the build.
39 */
40class FieldPositionIterator;
41
42U_NAMESPACE_END
43
44#else
45
46#include "unicode/fieldpos.h"
47#include "unicode/umisc.h"
48
49U_NAMESPACE_BEGIN
50
51class UVector32;
52
58 class U_I18N_API FieldPositionIterator : public UObject {
59public:
64 ~FieldPositionIterator();
65
70 FieldPositionIterator(void);
71
77 FieldPositionIterator(const FieldPositionIterator&);
78
87 bool operator==(const FieldPositionIterator&) const;
88
95 bool operator!=(const FieldPositionIterator& rhs) const { return !operator==(rhs); }
96
102 UBool next(FieldPosition& fp);
103
104private:
110 void setData(UVector32 *adopt, UErrorCode& status);
111
112 friend class FieldPositionIteratorHandler;
113
114 UVector32 *data;
115 int32_t pos;
116};
117
118U_NAMESPACE_END
119
120#endif /* #if !UCONFIG_NO_FORMATTING */
121
122#endif /* U_SHOW_CPLUSPLUS_API */
123
124#endif // FPOSITER_H
icu::FieldPositionIterator
FieldPositionIterator returns the field ids and their start/limit positions generated by a call to Fo...
Definition fpositer.h:58
icu::FieldPositionIterator::FieldPositionIterator
FieldPositionIterator(const FieldPositionIterator &)
Copy constructor.
icu::FieldPositionIterator::next
UBool next(FieldPosition &fp)
If the current position is valid, updates the FieldPosition values, advances the iterator,...
icu::FieldPositionIterator::operator!=
bool operator!=(const FieldPositionIterator &rhs) const
Returns the complement of the result of operator==.
Definition fpositer.h:95
icu::FieldPositionIterator::~FieldPositionIterator
~FieldPositionIterator()
Destructor.
icu::FieldPositionIterator::FieldPositionIterator
FieldPositionIterator(void)
Constructs a new, empty iterator.
icu::FieldPositionIterator::operator==
bool operator==(const FieldPositionIterator &) const
Return true if another object is semantically equal to this one.
icu::FieldPosition
FieldPosition is a simple class used by Format and its subclasses to identify fields in formatted out...
Definition fieldpos.h:110
icu::UObject
UObject is the common ICU "boilerplate" class.
Definition uobject.h:223
fieldpos.h
C++ API: FieldPosition identifies the fields in a formatted output.
icu::operator==
U_EXPORT UBool operator==(const StringPiece &x, const StringPiece &y)
Global operator == for StringPiece.
UBool
int8_t UBool
The ICU boolean type, a signed-byte integer.
Definition umachine.h:247
umisc.h
C API: Miscellaneous definitions.
uobject.h
C++ API: Common ICU base class UObject.
utypes.h
Basic definitions for ICU, for both C and C++ APIs.
UErrorCode
UErrorCode
Standard ICU4C error code type, a substitute for exceptions.
Definition utypes.h:415
U_I18N_API
#define U_I18N_API
Set to export library symbols from inside the i18n library, and to import them from outside.
Definition utypes.h:301