webengine/osswebengine/WebKit/Carbon/HIWebView.h
changeset 0 dd21522fd290
equal deleted inserted replaced
-1:000000000000 0:dd21522fd290
       
     1 /*
       
     2  * Copyright (C) 2004, 2005 Apple Computer, 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  *
       
     8  * 1.  Redistributions of source code must retain the above copyright
       
     9  *     notice, this list of conditions and the following disclaimer. 
       
    10  * 2.  Redistributions in binary form must reproduce the above copyright
       
    11  *     notice, this list of conditions and the following disclaimer in the
       
    12  *     documentation and/or other materials provided with the distribution. 
       
    13  * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
       
    14  *     its contributors may be used to endorse or promote products derived
       
    15  *     from this software without specific prior written permission. 
       
    16  *
       
    17  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
       
    18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
       
    19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
       
    20  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
       
    21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
       
    22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
       
    23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
       
    24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
       
    25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
       
    26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
       
    27  */
       
    28 
       
    29 #ifndef __HIWebView__
       
    30 #define __HIWebView__
       
    31 
       
    32 #ifndef __LP64__
       
    33 
       
    34 #include <Carbon/Carbon.h>
       
    35 
       
    36 #include <AvailabilityMacros.h>
       
    37 
       
    38 #if PRAGMA_ONCE
       
    39 #pragma once
       
    40 #endif
       
    41 
       
    42 #ifdef __cplusplus
       
    43 extern "C" {
       
    44 #endif
       
    45 
       
    46 #ifdef __OBJC__
       
    47 @class WebView;
       
    48 #endif
       
    49 
       
    50 /*
       
    51  *  HIWebViewCreate()
       
    52  *  
       
    53  *  Summary:
       
    54  *    Creates a new web view.
       
    55  *  
       
    56  *  Parameters:
       
    57  *    
       
    58  *    outControl:
       
    59  *      The new web view.
       
    60  *  
       
    61  *  Result:
       
    62  *    An operating system status code.
       
    63  *  
       
    64  *  Availability:
       
    65  *    Mac OS X:         in version 10.2.7 and later [32-bit only]
       
    66  *    CarbonLib:        not available
       
    67  *    Non-Carbon CFM:   not available
       
    68  */
       
    69 extern OSStatus 
       
    70 HIWebViewCreate(HIViewRef * outControl);
       
    71 
       
    72 #ifdef __OBJC__
       
    73 
       
    74 /*
       
    75  *  HIWebViewCreateWithClass(HIViewRef * outControl, Class aClass)
       
    76  *  
       
    77  *  Summary:
       
    78  *    Creates a new web view using the specified subclass of WebView.
       
    79  *  
       
    80  *  Parameters:
       
    81  *    
       
    82  *    aClass:
       
    83  *      Either WebView, or a subclass, to be created and wrapped in an HIWebView.
       
    84  *    outControl:
       
    85  *      The new web view.
       
    86  *  
       
    87  *  Result:
       
    88  *    An operating system status code.
       
    89  *  
       
    90  *  Availability:
       
    91  *    Mac OS X:         in version 10.4 and later [32-bit only]
       
    92  *    CarbonLib:        not available
       
    93  *    Non-Carbon CFM:   not available
       
    94  */
       
    95 extern OSStatus
       
    96 HIWebViewCreateWithClass(
       
    97   Class       aClass,
       
    98   HIViewRef * outControl);
       
    99 
       
   100 /*
       
   101  *  HIWebViewGetWebView()
       
   102  *  
       
   103  *  Summary:
       
   104  *    Returns the WebKit WebView for a given HIWebView.
       
   105  *  
       
   106  *  Parameters:
       
   107  *    
       
   108  *    inView:
       
   109  *      The view to inspect.
       
   110  *  
       
   111  *  Result:
       
   112  *    A pointer to a web view object, or NULL.
       
   113  *  
       
   114  *  Availability:
       
   115  *    Mac OS X:         in version 10.2.7 and later [32-bit only]
       
   116  *    CarbonLib:        not available
       
   117  *    Non-Carbon CFM:   not available
       
   118  */
       
   119 extern WebView *
       
   120 HIWebViewGetWebView(HIViewRef inView);
       
   121 
       
   122 #endif
       
   123 
       
   124 #ifdef __cplusplus
       
   125 }
       
   126 #endif
       
   127 
       
   128 #endif
       
   129 #endif /* __HIWebView__ */