1/*
2 * Copyright (C) 2011 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 INC. AND ITS CONTRIBUTORS ``AS IS''
14 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23 * THE POSSIBILITY OF SUCH DAMAGE.
24 */
25
26#ifndef CorrectionPanel_h
27#define CorrectionPanel_h
28
29#import <WebCore/TextChecking.h>
30
31#if USE(AUTOCORRECTION_PANEL)
32
33#import <AppKit/NSSpellChecker.h>
34#import <WebCore/AlternativeTextClient.h>
35#import <wtf/RetainPtr.h>
36
37@class WKView;
38
39namespace WebKit {
40
41class CorrectionPanel {
42public:
43    CorrectionPanel();
44    ~CorrectionPanel();
45    void show(WKView*, WebCore::AlternativeTextType, const WebCore::FloatRect& boundingBoxOfReplacedString, const String& replacedString, const String& replacementString, const Vector<String>& alternativeReplacementStrings);
46    String dismiss(WebCore::ReasonForDismissingAlternativeText);
47    static void recordAutocorrectionResponse(WKView*, NSCorrectionResponse, const String& replacedString, const String& replacementString);
48
49private:
50    bool isShowing() const { return m_view; }
51    String dismissInternal(WebCore::ReasonForDismissingAlternativeText, bool dismissingExternally);
52    void handleAcceptedReplacement(NSString* acceptedReplacement, NSString* replaced, NSString* proposedReplacement, NSCorrectionIndicatorType);
53
54    bool m_wasDismissedExternally;
55    WebCore::ReasonForDismissingAlternativeText m_reasonForDismissing;
56    RetainPtr<WKView> m_view;
57    RetainPtr<NSString> m_resultForDismissal;
58};
59
60} // namespace WebKit
61
62#endif // USE(AUTOCORRECTION_PANEL)
63
64#endif // CorrectionPanel_h
65