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 <AppKit/NSSpellChecker.h>
30#import <WebCore/AlternativeTextClient.h>
31#import <wtf/RetainPtr.h>
32
33#if USE(AUTOCORRECTION_PANEL)
34
35@class WebView;
36
37class CorrectionPanel {
38    WTF_MAKE_NONCOPYABLE(CorrectionPanel);
39public:
40    CorrectionPanel();
41    ~CorrectionPanel();
42    void show(WebView*, WebCore::AlternativeTextType, const WebCore::FloatRect& boundingBoxOfReplacedString, const String& replacedString, const String& replacementString, const Vector<String>& alternativeReplacementStrings);
43    String dismiss(WebCore::ReasonForDismissingAlternativeText);
44    static void recordAutocorrectionResponse(WebView*, NSCorrectionResponse, const String& replacedString, const String& replacementString);
45
46private:
47    bool isShowing() const { return m_view; }
48    String dismissInternal(WebCore::ReasonForDismissingAlternativeText, bool dismissingExternally);
49    void handleAcceptedReplacement(NSString* acceptedReplacement, NSString* replaced, NSString* proposedReplacement, NSCorrectionIndicatorType);
50
51    bool m_wasDismissedExternally;
52    WebCore::ReasonForDismissingAlternativeText m_reasonForDismissing;
53    RetainPtr<WebView> m_view;
54    RetainPtr<NSString> m_resultForDismissal;
55};
56
57#endif // USE(AUTOCORRECTION_PANEL)
58
59#endif // CorrectionPanel_h
60