1/*
2 * Copyright (C) 2012 Apple Inc. All rights reserved.
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 AlternativeTextClient_h
27#define AlternativeTextClient_h
28
29#include "FloatRect.h"
30#include "TextChecking.h"
31#include <wtf/Vector.h>
32#include <wtf/text/WTFString.h>
33
34#if PLATFORM(MAC) && (PLATFORM(IOS) || __MAC_OS_X_VERSION_MIN_REQUIRED >= 1080)
35// Some platforms provide UI for suggesting alternative dictation text.
36#define WTF_USE_DICTATION_ALTERNATIVES 1
37#endif // PLATFORM(MAC) && (PLATFORM(IOS) || __MAC_OS_X_VERSION_MIN_REQUIRED >= 1080)
38
39namespace WebCore {
40
41enum ReasonForDismissingAlternativeText {
42    ReasonForDismissingAlternativeTextCancelled = 0,
43    ReasonForDismissingAlternativeTextIgnored,
44    ReasonForDismissingAlternativeTextAccepted
45};
46
47enum AlternativeTextType {
48    AlternativeTextTypeCorrection = 0,
49    AlternativeTextTypeReversion,
50    AlternativeTextTypeSpellingSuggestions,
51    AlternativeTextTypeDictationAlternatives
52};
53
54enum AutocorrectionResponseType {
55    AutocorrectionEdited,
56    AutocorrectionReverted
57};
58
59class AlternativeTextClient {
60public:
61    virtual ~AlternativeTextClient() { }
62    virtual void pageDestroyed() = 0;
63#if USE(AUTOCORRECTION_PANEL)
64    virtual void showCorrectionAlternative(AlternativeTextType, const FloatRect& boundingBoxOfReplacedString, const String& replacedString, const String& replacmentString, const Vector<String>& alternativeReplacementStrings) = 0;
65    virtual void dismissAlternative(ReasonForDismissingAlternativeText) = 0;
66    virtual String dismissAlternativeSoon(ReasonForDismissingAlternativeText) = 0;
67    virtual void recordAutocorrectionResponse(AutocorrectionResponseType, const String& replacedString, const String& replacementString) = 0;
68#endif
69#if USE(DICTATION_ALTERNATIVES)
70    virtual void showDictationAlternativeUI(const WebCore::FloatRect& boundingBoxOfDictatedText, uint64_t dictationContext) = 0;
71    virtual void removeDictationAlternatives(uint64_t dictationContext) = 0;
72    virtual Vector<String> dictationAlternatives(uint64_t dictationContext) = 0;
73#endif
74};
75
76}
77
78#endif // AlternativeTextClient_h
79