1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
|
/**
* @file llpreeditor.h
* @brief I believe this is used for languages like Japanese that require
* an "input method editor" to type Kanji.
* @author Open source patch, incorporated by Dave Simmons
*
* $LicenseInfo:firstyear=2007&license=viewerlgpl$
* Second Life Viewer Source Code
* Copyright (C) 2010, Linden Research, Inc.
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation;
* version 2.1 of the License only.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*
* Linden Research, Inc., 945 Battery Street, San Francisco, CA 94111 USA
* $/LicenseInfo$
*/
#ifndef LL_PREEDITOR
#define LL_PREEDITOR
class LLPreeditor
{
public:
typedef std::vector<S32> segment_lengths_t;
typedef std::deque<bool> standouts_t;
// We don't delete against LLPreeditor, but compilers complain without this...
virtual ~LLPreeditor() {};
// Discard any preedit info. on this preeditor.
virtual void resetPreedit() = 0;
// Update the preedit feedback using specified details.
// Existing preedit is discarded and replaced with the new one. (I.e., updatePreedit is not cumulative.)
// All arguments are IN.
// preedit_count is the number of elements in arrays preedit_list and preedit_standouts.
// preedit list is an array of preedit texts (clauses.)
// preedit_standouts indicates whether each preedit text should be shown as standout clause.
// caret_position is the preedit-local position of text editing caret, in # of llwchar.
virtual void updatePreedit(const LLWString &preedit_string,
const segment_lengths_t &preedit_segment_lengths, const standouts_t &preedit_standouts, S32 caret_position) = 0;
// Turn the specified sub-contents into an active preedit.
// Both position and length are IN and count with UTF-32 (llwchar) characters.
// This method primarily facilitates reconversion.
virtual void markAsPreedit(S32 position, S32 length) = 0;
// Get the position and the length of the active preedit in the contents.
// Both position and length are OUT and count with UTF-32 (llwchar) characters.
// When this preeditor has no active preedit, position receives
// the caret position, and length receives 0.
virtual void getPreeditRange(S32 *position, S32 *length) const = 0;
// Get the position and the length of the current selection in the contents.
// Both position and length are OUT and count with UTF-32 (llwchar) characters.
// When this preeditor has no selection, position receives
// the caret position, and length receives 0.
virtual void getSelectionRange(S32 *position, S32 *length) const = 0;
// Get the locations where the preedit and related UI elements are displayed.
// Locations are relative to the app window and measured in GL coordinate space (before scaling.)
// query_position is IN argument, and other three are OUT.
virtual bool getPreeditLocation(S32 query_position, LLCoordGL *coord, LLRect *bounds, LLRect *control) const = 0;
// Get the size (height) of the current font used in this preeditor.
virtual S32 getPreeditFontSize() const = 0;
// Get the contents of this preeditor as a LLWString. If there is an active preedit,
// the returned LLWString contains it.
virtual LLWString getPreeditString() const = 0;
// Handle a UTF-32 char on this preeditor, i.e., add the character
// to the contents.
// This is a back door of the method of same name of LLWindowCallback.
// called_from_parent should be set to false if calling through LLPreeditor.
virtual bool handleUnicodeCharHere(llwchar uni_char) = 0;
};
#endif
|
