llpreeditor.h
上传用户:king477883
上传日期:2021-03-01
资源大小:9553k
文件大小:4k
源码类别:

游戏引擎

开发平台:

C++ Builder

  1. /** 
  2.  * @file llpreeditor.h
  3.  * @brief I believe this is used for languages like Japanese that require
  4.  * an "input method editor" to type Kanji.
  5.  * @author Open source patch, incorporated by Dave Simmons
  6.  *
  7.  * $LicenseInfo:firstyear=2007&license=viewergpl$
  8.  * 
  9.  * Copyright (c) 2007-2010, Linden Research, Inc.
  10.  * 
  11.  * Second Life Viewer Source Code
  12.  * The source code in this file ("Source Code") is provided by Linden Lab
  13.  * to you under the terms of the GNU General Public License, version 2.0
  14.  * ("GPL"), unless you have obtained a separate licensing agreement
  15.  * ("Other License"), formally executed by you and Linden Lab.  Terms of
  16.  * the GPL can be found in doc/GPL-license.txt in this distribution, or
  17.  * online at http://secondlifegrid.net/programs/open_source/licensing/gplv2
  18.  * 
  19.  * There are special exceptions to the terms and conditions of the GPL as
  20.  * it is applied to this Source Code. View the full text of the exception
  21.  * in the file doc/FLOSS-exception.txt in this software distribution, or
  22.  * online at
  23.  * http://secondlifegrid.net/programs/open_source/licensing/flossexception
  24.  * 
  25.  * By copying, modifying or distributing this software, you acknowledge
  26.  * that you have read and understood your obligations described above,
  27.  * and agree to abide by those obligations.
  28.  * 
  29.  * ALL LINDEN LAB SOURCE CODE IS PROVIDED "AS IS." LINDEN LAB MAKES NO
  30.  * WARRANTIES, EXPRESS, IMPLIED OR OTHERWISE, REGARDING ITS ACCURACY,
  31.  * COMPLETENESS OR PERFORMANCE.
  32.  * $/LicenseInfo$
  33.  */
  34. #ifndef LL_PREEDITOR
  35. #define LL_PREEDITOR
  36. class LLPreeditor
  37. {
  38. public:
  39. typedef std::vector<S32> segment_lengths_t;
  40. typedef std::vector<BOOL> standouts_t;
  41. // We don't delete against LLPreeditor, but compilers complain without this...
  42. virtual ~LLPreeditor() {};
  43. // Discard any preedit info. on this preeditor.
  44. virtual void resetPreedit() = 0;
  45. // Update the preedit feedback using specified details.
  46. // Existing preedit is discarded and replaced with the new one.  (I.e., updatePreedit is not cumulative.) 
  47. // All arguments are IN.
  48. // preedit_count is the number of elements in arrays preedit_list and preedit_standouts.
  49. // preedit list is an array of preedit texts (clauses.)
  50. // preedit_standouts indicates whether each preedit text should be shown as standout clause.
  51. // caret_position is the preedit-local position of text editing caret, in # of llwchar.
  52. virtual void updatePreedit(const LLWString &preedit_string,
  53. const segment_lengths_t &preedit_segment_lengths, const standouts_t &preedit_standouts, S32 caret_position) = 0;
  54. // Turn the specified sub-contents into an active preedit.
  55. // Both position and length are IN and count with UTF-32 (llwchar) characters.
  56. // This method primarily facilitates reconversion.
  57. virtual void markAsPreedit(S32 position, S32 length) = 0;
  58. // Get the position and the length of the active preedit in the contents.
  59. // Both position and length are OUT and count with UTF-32 (llwchar) characters.
  60. // When this preeditor has no active preedit, position receives
  61. // the caret position, and length receives 0.
  62. virtual void getPreeditRange(S32 *position, S32 *length) const = 0;
  63. // Get the position and the length of the current selection in the contents.
  64. // Both position and length are OUT and count with UTF-32 (llwchar) characters.
  65. // When this preeditor has no selection, position receives
  66. // the caret position, and length receives 0.
  67. virtual void getSelectionRange(S32 *position, S32 *length) const = 0;
  68. // Get the locations where the preedit and related UI elements are displayed.
  69. // Locations are relative to the app window and measured in GL coordinate space (before scaling.)
  70. // query_position is IN argument, and other three are OUT.
  71. virtual BOOL getPreeditLocation(S32 query_position, LLCoordGL *coord, LLRect *bounds, LLRect *control) const = 0;
  72. // Get the size (height) of the current font used in this preeditor.
  73. virtual S32 getPreeditFontSize() const = 0;
  74. // Get the contents of this preeditor as a LLWString.  If there is an active preedit,
  75. // the returned LLWString contains it.
  76. virtual LLWString getPreeditString() const = 0;
  77. // Handle a UTF-32 char on this preeditor, i.e., add the character
  78. // to the contents.
  79. // This is a back door of the method of same name of LLWindowCallback.
  80. // called_from_parent should be set to FALSE if calling through LLPreeditor.
  81. virtual BOOL handleUnicodeCharHere(llwchar uni_char) = 0;
  82. };
  83. #endif