87f5bf7c9f9536fa7756c6803fee181f0bb1ed58
[WebKit-https.git] / Source / WebCore / platform / gtk / CompositionResults.h
1 /*
2  * Copyright (C) 2012 Igalia S.L.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
24  */
25
26 #ifndef CompositionResults_h
27 #define CompositionResults_h
28
29 #include <wtf/text/WTFString.h>
30
31 namespace WebCore {
32
33 struct CompositionResults {
34     CompositionResults()
35         : preeditCursorOffset(0)
36     {
37     }
38
39     CompositionResults(String simpleString)
40         : simpleString(simpleString)
41         , preeditCursorOffset(0)
42     {
43     }
44
45     CompositionResults(String confirmedComposition, String preedit, int preeditCursorOffset)
46         : confirmedComposition(confirmedComposition)
47         , preedit(preedit)
48         , preeditCursorOffset(preeditCursorOffset)
49     {
50     }
51
52     bool compositionUpdated() const
53     {
54         return !confirmedComposition.isNull() || !preedit.isNull();
55     }
56
57     // Some simple input methods return a string for all keyboard events. This
58     // value should be treated as the string representation of the keycode.
59     String simpleString;
60
61     // If the input method had a "real" composition it will be stored here.
62     String confirmedComposition;
63
64     // The event may have caused the preedit to update.
65     String preedit;
66     int preeditCursorOffset;
67 };
68
69 }
70
71 #endif // CompositionResults_h