| // Copyright (c) 2012 The Chromium Authors. All rights reserved. |
| // Use of this source code is governed by a BSD-style license that can be |
| // found in the LICENSE file. |
| |
| #ifndef PPAPI_CPP_DEV_IME_INPUT_EVENT_DEV_H_ |
| #define PPAPI_CPP_DEV_IME_INPUT_EVENT_DEV_H_ |
| |
| #include <stdint.h> |
| |
| #include <utility> |
| #include <vector> |
| |
| #include "ppapi/c/dev/ppb_ime_input_event_dev.h" |
| #include "ppapi/cpp/input_event.h" |
| |
| /// @file |
| /// This file defines the API used to handle IME input events. |
| |
| namespace pp { |
| |
| class Var; |
| |
| class IMEInputEvent_Dev : public InputEvent { |
| public: |
| /// Constructs an is_null() IME input event object. |
| IMEInputEvent_Dev(); |
| |
| /// Constructs an IME input event object from the provided generic input |
| /// event. If the given event is itself is_null() or is not an IME input |
| /// event, the object will be is_null(). |
| /// |
| /// @param[in] event A generic input event. |
| explicit IMEInputEvent_Dev(const InputEvent& event); |
| |
| /// This constructor manually constructs an IME event from the provided |
| /// parameters. |
| /// |
| /// @param[in] instance The instance for which this event occurred. |
| /// |
| /// @param[in] type A <code>PP_InputEvent_Type</code> identifying the type of |
| /// input event. The type must be one of the ime event types. |
| /// |
| /// @param[in] time_stamp A <code>PP_TimeTicks</code> indicating the time |
| /// when the event occurred. |
| /// |
| /// @param[in] text The string returned by <code>GetText</code>. |
| /// |
| /// @param[in] segment_offsets The array of numbers returned by |
| /// <code>GetSegmentOffset</code>. |
| /// |
| /// @param[in] target_segment The number returned by |
| /// <code>GetTargetSegment</code>. |
| /// |
| /// @param[in] selection The range returned by <code>GetSelection</code>. |
| IMEInputEvent_Dev(const InstanceHandle& instance, |
| PP_InputEvent_Type type, |
| PP_TimeTicks time_stamp, |
| const Var& text, |
| const std::vector<uint32_t>& segment_offsets, |
| int32_t target_segment, |
| const std::pair<uint32_t, uint32_t>& selection); |
| |
| /// Returns the composition text as a UTF-8 string for the given IME event. |
| /// |
| /// @return A string var representing the composition text. For non-IME |
| /// input events the return value will be an undefined var. |
| Var GetText() const; |
| |
| /// Returns the number of segments in the composition text. |
| /// |
| /// @return The number of segments. For events other than COMPOSITION_UPDATE, |
| /// returns 0. |
| uint32_t GetSegmentNumber() const; |
| |
| /// Returns the position of the index-th segmentation point in the composition |
| /// text. The position is given by a byte-offset (not a character-offset) of |
| /// the string returned by GetText(). It always satisfies |
| /// 0=GetSegmentOffset(0) < ... < GetSegmentOffset(i) < GetSegmentOffset(i+1) |
| /// < ... < GetSegmentOffset(GetSegmentNumber())=(byte-length of GetText()). |
| /// Note that [GetSegmentOffset(i), GetSegmentOffset(i+1)) represents the |
| /// range of the i-th segment, and hence GetSegmentNumber() can be a valid |
| /// argument to this function instead of an off-by-1 error. |
| /// |
| /// @param[in] ime_event A <code>PP_Resource</code> corresponding to an IME |
| /// event. |
| /// |
| /// @param[in] index An integer indicating a segment. |
| /// |
| /// @return The byte-offset of the segmentation point. If the event is not |
| /// COMPOSITION_UPDATE or index is out of range, returns 0. |
| uint32_t GetSegmentOffset(uint32_t index) const; |
| |
| /// Returns the index of the current target segment of composition. |
| /// |
| /// @return An integer indicating the index of the target segment. When there |
| /// is no active target segment, or the event is not COMPOSITION_UPDATE, |
| /// returns -1. |
| int32_t GetTargetSegment() const; |
| |
| /// Returns the range selected by caret in the composition text. |
| /// |
| /// @return A pair of integers indicating the selection range. |
| std::pair<uint32_t, uint32_t> GetSelection() const; |
| }; |
| |
| } // namespace pp |
| |
| #endif // PPAPI_CPP_DEV_IME_INPUT_EVENT_DEV_H_ |