WebView.h

Go to the documentation of this file.

/*
 * Copyright (C) 2003, 2004, 2005, 2006 Apple Inc.  All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1.  Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer. 
 * 2.  Redistributions in binary form must reproduce the above copyright
 *     notice, this list of conditions and the following disclaimer in the
 *     documentation and/or other materials provided with the distribution. 
 * 3.  Neither the name of Apple Inc. ("Apple") nor the names of
 *     its contributors may be used to endorse or promote products derived
 *     from this software without specific prior written permission. 
 *
 * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#import <Foundation/Foundation.h>

#if !TARGET_OS_IPHONE
#import <AppKit/AppKit.h>
#else
#import <WebKitLegacy/WAKAppKitStubs.h>
#import <WebKitLegacy/WAKView.h>
#if !defined(IBAction)
#define IBAction void
#endif
#endif

@class DOMCSSStyleDeclaration;
@class DOMDocument;
@class DOMElement;
@class DOMNode;
@class DOMRange;

@class WebArchive;
@class WebBackForwardList;
@class WebDataSource;
@class WebFrame;
@class WebFrameView;
@class WebHistoryItem;
@class WebPreferences;
@class WebScriptObject;
@class WebViewPrivate;

@protocol WebDownloadDelegate;
@protocol WebEditingDelegate;
@protocol WebFrameLoadDelegate;
@protocol WebPolicyDelegate;
@protocol WebResourceLoadDelegate;
@protocol WebUIDelegate;

// Element dictionary keys
extern NSString *WebElementDOMNodeKey;          // DOMNode of the element
extern NSString *WebElementFrameKey;            // WebFrame of the element
extern NSString *WebElementImageAltStringKey;   // NSString of the ALT attribute of the image element
extern NSString *WebElementImageKey;            // NSImage of the image element
extern NSString *WebElementImageRectKey;        // NSValue of an NSRect, the rect of the image element
extern NSString *WebElementImageURLKey;         // NSURL of the image element
extern NSString *WebElementIsSelectedKey;       // NSNumber of BOOL indicating whether the element is selected or not 
extern NSString *WebElementLinkURLKey;          // NSURL of the link if the element is within an anchor
extern NSString *WebElementLinkTargetFrameKey;  // WebFrame of the target of the anchor
extern NSString *WebElementLinkTitleKey;        // NSString of the title of the anchor
extern NSString *WebElementLinkLabelKey;        // NSString of the text within the anchor

/*
    @discussion Notifications sent by WebView to mark the progress of loads.
    @constant WebViewProgressStartedNotification Posted whenever a load begins in the WebView, including
    a load that is initiated in a subframe.  After receiving this notification zero or more
    WebViewProgressEstimateChangedNotifications will be sent.  The userInfo will be nil.
    @constant WebViewProgressEstimateChangedNotification Posted whenever the value of
    estimatedProgress changes.  The userInfo will be nil.
    @constant WebViewProgressFinishedNotification Posted when the load for a WebView has finished.
    The userInfo will be nil.
*/
extern NSString *WebViewProgressStartedNotification;
extern NSString *WebViewProgressEstimateChangedNotification;
#if !TARGET_OS_IPHONE
extern NSString *WebViewProgressFinishedNotification;
#endif

@interface WebView : NSView
{
@private
    WebViewPrivate *_private;
}

+ (BOOL)canShowMIMEType:(NSString *)MIMEType;


+ (BOOL)canShowMIMETypeAsHTML:(NSString *)MIMEType;

+ (NSArray *)MIMETypesShownAsHTML;

+ (void)setMIMETypesShownAsHTML:(NSArray *)MIMETypes;

#if !TARGET_OS_IPHONE

+ (NSURL *)URLFromPasteboard:(NSPasteboard *)pasteboard;

+ (NSString *)URLTitleFromPasteboard:(NSPasteboard *)pasteboard;
#endif

+ (void)registerURLSchemeAsLocal:(NSString *)scheme;

- (instancetype)initWithFrame:(NSRect)frame frameName:(NSString *)frameName groupName:(NSString *)groupName;

- (void)close;

@property (nonatomic) BOOL shouldCloseWithWindow;

@property (nonatomic, assign) id <WebUIDelegate> UIDelegate;

@property (nonatomic, assign) id <WebResourceLoadDelegate> resourceLoadDelegate;

@property (nonatomic, assign) id <WebDownloadDelegate> downloadDelegate;

@property (nonatomic, assign) id <WebFrameLoadDelegate> frameLoadDelegate;

@property (nonatomic, assign) id <WebPolicyDelegate> policyDelegate;

@property (nonatomic, readonly, strong) WebFrame *mainFrame;

@property (nonatomic, readonly, strong) WebFrame *selectedFrame;

@property (nonatomic, readonly, strong) WebBackForwardList *backForwardList;

- (void)setMaintainsBackForwardList:(BOOL)flag;

- (BOOL)goBack;

- (BOOL)goForward;

- (BOOL)goToBackForwardItem:(WebHistoryItem *)item;

@property (nonatomic) float textSizeMultiplier;

@property (nonatomic, copy) NSString *applicationNameForUserAgent;

@property (nonatomic, copy) NSString *customUserAgent;

- (NSString *)userAgentForURL:(NSURL *)URL;


@property (nonatomic, readonly) BOOL supportsTextEncoding;

@property (nonatomic, copy) NSString *customTextEncodingName;

@property (nonatomic, copy) NSString *mediaStyle;

- (NSString *)stringByEvaluatingJavaScriptFromString:(NSString *)script;

@property (nonatomic, readonly, strong) WebScriptObject *windowScriptObject;

@property (nonatomic, strong) WebPreferences *preferences;

@property (nonatomic, copy) NSString *preferencesIdentifier;

@property (nonatomic, strong) NSWindow *hostWindow;

- (BOOL)searchFor:(NSString *)string direction:(BOOL)forward caseSensitive:(BOOL)caseFlag wrap:(BOOL)wrapFlag;

+ (void)registerViewClass:(Class)viewClass representationClass:(Class)representationClass forMIMEType:(NSString *)MIMEType;

@property (nonatomic, copy) NSString *groupName;

@property (nonatomic, readonly) double estimatedProgress;

@property (nonatomic, getter=isLoading, readonly) BOOL loading;

- (NSDictionary *)elementAtPoint:(NSPoint)point;

#if !TARGET_OS_IPHONE

@property (nonatomic, readonly, copy) NSArray *pasteboardTypesForSelection;

- (void)writeSelectionWithPasteboardTypes:(NSArray *)types toPasteboard:(NSPasteboard *)pasteboard;

- (NSArray *)pasteboardTypesForElement:(NSDictionary *)element;

- (void)writeElement:(NSDictionary *)element withPasteboardTypes:(NSArray *)types toPasteboard:(NSPasteboard *)pasteboard;

- (void)moveDragCaretToPoint:(NSPoint)point;

- (void)removeDragCaret;
#endif /* !TARGET_OS_IPHONE */

@property (nonatomic) BOOL drawsBackground;

@property (nonatomic) BOOL shouldUpdateWhileOffscreen;

@property (nonatomic, copy) NSString *mainFrameURL;

@property (nonatomic, readonly, strong) DOMDocument *mainFrameDocument;

@property (nonatomic, readonly, copy) NSString *mainFrameTitle;

#if TARGET_OS_IPHONE

- (NSURL *)mainFrameIconURL;
#else

@property (nonatomic, readonly, strong) NSImage *mainFrameIcon;
#endif

@end

#if TARGET_OS_IPHONE
@interface WebView (WebIBActions)
#else
@interface WebView (WebIBActions) <NSUserInterfaceValidations>
#endif
- (IBAction)takeStringURLFrom:(id)sender;
- (IBAction)stopLoading:(id)sender;
- (IBAction)reload:(id)sender;
- (IBAction)reloadFromOrigin:(id)sender;
@property (nonatomic, readonly) BOOL canGoBack;
- (IBAction)goBack:(id)sender;
@property (nonatomic, readonly) BOOL canGoForward;
- (IBAction)goForward:(id)sender;
@property (nonatomic, readonly) BOOL canMakeTextLarger;
- (IBAction)makeTextLarger:(id)sender;
@property (nonatomic, readonly) BOOL canMakeTextSmaller;
- (IBAction)makeTextSmaller:(id)sender;
@property (nonatomic, readonly) BOOL canMakeTextStandardSize;
- (IBAction)makeTextStandardSize:(id)sender;
#if !TARGET_OS_IPHONE
- (IBAction)toggleContinuousSpellChecking:(id)sender;
- (IBAction)toggleSmartInsertDelete:(id)sender;
#endif
#if TARGET_OS_IPHONE
- (void)stopLoadingAndClear;
#endif
@end


// WebView editing support

extern NSString * const WebViewDidBeginEditingNotification;
extern NSString * const WebViewDidChangeNotification;
extern NSString * const WebViewDidEndEditingNotification;
extern NSString * const WebViewDidChangeTypingStyleNotification;
extern NSString * const WebViewDidChangeSelectionNotification;

@interface WebView (WebViewCSS)
- (DOMCSSStyleDeclaration *)computedStyleForElement:(DOMElement *)element pseudoElement:(NSString *)pseudoElement;
@end

@interface WebView (WebViewEditing)
- (DOMRange *)editableDOMRangeForPoint:(NSPoint)point;
- (void)setSelectedDOMRange:(DOMRange *)range affinity:(NSSelectionAffinity)selectionAffinity;
@property (nonatomic, readonly, strong) DOMRange *selectedDOMRange;
@property (nonatomic, readonly) NSSelectionAffinity selectionAffinity;
@property (nonatomic, readonly) BOOL maintainsInactiveSelection;
@property (nonatomic, getter=isEditable) BOOL editable;
@property (nonatomic, strong) DOMCSSStyleDeclaration *typingStyle;
@property (nonatomic) BOOL smartInsertDeleteEnabled;
@property (nonatomic, getter=isContinuousSpellCheckingEnabled) BOOL continuousSpellCheckingEnabled;
#if !TARGET_OS_IPHONE
@property (nonatomic, readonly) NSInteger spellCheckerDocumentTag;
#endif
@property (nonatomic, readonly, strong) NSUndoManager *undoManager;
@property (nonatomic, assign) id <WebEditingDelegate> editingDelegate;
- (DOMCSSStyleDeclaration *)styleDeclarationWithText:(NSString *)text;
@end

@interface WebView (WebViewUndoableEditing)
- (void)replaceSelectionWithNode:(DOMNode *)node; 
- (void)replaceSelectionWithText:(NSString *)text;    
- (void)replaceSelectionWithMarkupString:(NSString *)markupString;
- (void)replaceSelectionWithArchive:(WebArchive *)archive;
- (void)deleteSelection;    
- (void)applyStyle:(DOMCSSStyleDeclaration *)style;
@end

@interface WebView (WebViewEditingActions)

- (void)copy:(id)sender;
- (void)cut:(id)sender;
- (void)paste:(id)sender;
- (void)copyFont:(id)sender;
- (void)pasteFont:(id)sender;
- (void)delete:(id)sender;
- (void)pasteAsPlainText:(id)sender;
- (void)pasteAsRichText:(id)sender;

- (void)changeFont:(id)sender;
- (void)changeAttributes:(id)sender;
- (void)changeDocumentBackgroundColor:(id)sender;
- (void)changeColor:(id)sender;

- (void)alignCenter:(id)sender;
- (void)alignJustified:(id)sender;
- (void)alignLeft:(id)sender;
- (void)alignRight:(id)sender;

- (void)checkSpelling:(id)sender;
- (void)showGuessPanel:(id)sender;
- (void)performFindPanelAction:(id)sender;

- (void)startSpeaking:(id)sender;
- (void)stopSpeaking:(id)sender;

- (void)moveToBeginningOfSentence:(id)sender;
- (void)moveToBeginningOfSentenceAndModifySelection:(id)sender;
- (void)moveToEndOfSentence:(id)sender;
- (void)moveToEndOfSentenceAndModifySelection:(id)sender;
- (void)selectSentence:(id)sender;

- (void)overWrite:(id)sender;

#if TARGET_OS_IPHONE
- (void)clearText:(id)sender;
- (void)insertDictationPhrases:(NSArray *)dictationPhrases metadata:(id)metadata;
- (void)toggleBold:(id)sender;
- (void)toggleItalic:(id)sender;
- (void)toggleUnderline:(id)sender;
#endif

/* 
The following methods are declared in NSResponder.h.
WebView overrides each method in this list, providing
a custom implementation for each.
    
- (void)capitalizeWord:(id)sender;
- (void)centerSelectionInVisibleArea:(id)sender;
- (void)changeCaseOfLetter:(id)sender;
- (void)complete:(id)sender;
- (void)deleteBackward:(id)sender;
- (void)deleteBackwardByDecomposingPreviousCharacter:(id)sender;
- (void)deleteForward:(id)sender;
- (void)deleteToBeginningOfLine:(id)sender;
- (void)deleteToBeginningOfParagraph:(id)sender;
- (void)deleteToEndOfLine:(id)sender;
- (void)deleteToEndOfParagraph:(id)sender;
- (void)deleteWordBackward:(id)sender;
- (void)deleteWordForward:(id)sender;
- (void)indent:(id)sender;
- (void)insertBacktab:(id)sender;
- (void)insertNewline:(id)sender;
- (void)insertParagraphSeparator:(id)sender;
- (void)insertTab:(id)sender;
- (void)lowercaseWord:(id)sender;
- (void)moveBackward:(id)sender;
- (void)moveBackwardAndModifySelection:(id)sender;
- (void)moveDown:(id)sender;
- (void)moveDownAndModifySelection:(id)sender;
- (void)moveForward:(id)sender;
- (void)moveForwardAndModifySelection:(id)sender;
- (void)moveLeft:(id)sender;
- (void)moveLeftAndModifySelection:(id)sender;
- (void)moveRight:(id)sender;
- (void)moveRightAndModifySelection:(id)sender;
- (void)moveToBeginningOfDocument:(id)sender;
- (void)moveToBeginningOfDocumentAndModifySelection:(id)sender;
- (void)moveToBeginningOfLine:(id)sender;
- (void)moveToBeginningOfLineAndModifySelection:(id)sender;
- (void)moveToBeginningOfParagraph:(id)sender;
- (void)moveToBeginningOfParagraphAndModifySelection:(id)sender;
- (void)moveToEndOfDocument:(id)sender;
- (void)moveToEndOfDocumentAndModifySelection:(id)sender;
- (void)moveToEndOfLine:(id)sender;
- (void)moveToEndOfLineAndModifySelection:(id)sender;
- (void)moveToEndOfParagraph:(id)sender;
- (void)moveToEndOfParagraphAndModifySelection:(id)sender;
- (void)moveUp:(id)sender;
- (void)moveUpAndModifySelection:(id)sender;
- (void)moveWordBackward:(id)sender;
- (void)moveWordBackwardAndModifySelection:(id)sender;
- (void)moveWordForward:(id)sender;
- (void)moveWordForwardAndModifySelection:(id)sender;
- (void)moveWordLeft:(id)sender;
- (void)moveWordLeftAndModifySelection:(id)sender;
- (void)moveWordRight:(id)sender;
- (void)moveWordRightAndModifySelection:(id)sender;
- (void)pageDown:(id)sender;
- (void)pageUp:(id)sender;
- (void)scrollLineDown:(id)sender;
- (void)scrollLineUp:(id)sender;
- (void)scrollPageDown:(id)sender;
- (void)scrollPageUp:(id)sender;
- (void)selectAll:(id)sender;
- (void)selectLine:(id)sender;
- (void)selectParagraph:(id)sender;
- (void)selectWord:(id)sender;
- (void)uppercaseWord:(id)sender;
*/
 
@end

#if TARGET_OS_IPHONE

@interface WebView (WebViewIOS)
+ (void)enableWebThread;
+ (BOOL)isCharacterSmartReplaceExempt:(unichar)character isPreviousCharacter:(BOOL)b;

+ (void)willEnterBackgroundWithCompletionHandler:(void(^)(void))handler;

- (void)updateLayoutIgnorePendingStyleSheets;
@end

@interface NSObject (WebViewClassDelegate)
- (BOOL)viewClass:(Class *)vClass andRepresentationClass:(Class *)rClass forMIMEType:(NSString *)MIMEType;
@end

#endif /* TARGET_OS_IPHONE */