Back to index

lightning-sunbird  0.9+nobinonly
nsEmbedAPI.h
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*-
00002  *
00003  * ***** BEGIN LICENSE BLOCK *****
00004  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00005  *
00006  * The contents of this file are subject to the Mozilla Public License Version
00007  * 1.1 (the "License"); you may not use this file except in compliance with
00008  * the License. You may obtain a copy of the License at
00009  * http://www.mozilla.org/MPL/
00010  *
00011  * Software distributed under the License is distributed on an "AS IS" basis,
00012  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00013  * for the specific language governing rights and limitations under the
00014  * License.
00015  *
00016  * The Original Code is the Mozilla browser.
00017  *
00018  * The Initial Developer of the Original Code is
00019  * Netscape Communications, Inc.
00020  * Portions created by the Initial Developer are Copyright (C) 1999
00021  * the Initial Developer. All Rights Reserved.
00022  *
00023  * Contributor(s):
00024  *   Adam Lock <adamlock@netscape.com>
00025  *   Benjamin Smedberg <benjamin@smedbergs.us>
00026  *
00027  * Alternatively, the contents of this file may be used under the terms of
00028  * either the GNU General Public License Version 2 or later (the "GPL"), or
00029  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00030  * in which case the provisions of the GPL or the LGPL are applicable instead
00031  * of those above. If you wish to allow use of your version of this file only
00032  * under the terms of either the GPL or the LGPL, and not to allow others to
00033  * use your version of this file under the terms of the MPL, indicate your
00034  * decision by deleting the provisions above and replace them with the notice
00035  * and other provisions required by the GPL or the LGPL. If you do not delete
00036  * the provisions above, a recipient may use your version of this file under
00037  * the terms of any one of the MPL, the GPL or the LGPL.
00038  *
00039  * ***** END LICENSE BLOCK ***** */
00040 
00041 #ifndef NSEMBEDAPI_H
00042 #define NSEMBEDAPI_H
00043 
00044 #include "nscore.h"
00045 #include "nsXPCOM.h"
00046 #include "nsILocalFile.h"
00047 #include "nsIDirectoryService.h"
00048 
00088 extern "C" NS_HIDDEN NS_METHOD
00089 NS_InitEmbedding(nsILocalFile *aMozBinDirectory,
00090                  nsIDirectoryServiceProvider *aAppFileLocProvider,
00091                  nsStaticModuleInfo const *aStaticComponents = nsnull,
00092                  PRUint32 aStaticComponentCount = 0);
00093 
00094 
00107 extern "C" NS_HIDDEN NS_METHOD
00108 NS_TermEmbedding();
00109 
00110 /*---------------------------------------------------------------------------*/
00111 /* Event processing APIs. The native OS dependencies mean you must be        */
00112 /* building on a supported platform to get the functions below.              */
00113 /*---------------------------------------------------------------------------*/
00114 
00115 #undef MOZ_SUPPORTS_EMBEDDING_EVENT_PROCESSING
00116 
00117 /* Win32 specific stuff */
00118 #if defined (WIN32) || defined (WINCE)
00119 #include "windows.h"
00125 typedef MSG nsEmbedNativeEvent;
00126 #define MOZ_SUPPORTS_EMBEDDING_EVENT_PROCESSING
00127 #endif
00128 
00129 /* OS/2 specific stuff */
00130 #ifdef XP_OS2
00131 #include "os2.h"
00132 
00138 typedef QMSG nsEmbedNativeEvent;
00139 #define MOZ_SUPPORTS_EMBEDDING_EVENT_PROCESSING
00140 #endif
00141 
00142 /* Mac specific stuff */
00143 /* TODO implementation left as an exercise for the reader */
00144 
00145 /* GTK specific stuff */
00146 /* TODO implementation left as an exercise for the reader */
00147 
00148 
00149 #ifdef MOZ_SUPPORTS_EMBEDDING_EVENT_PROCESSING
00150 
00166 extern "C" NS_HIDDEN NS_METHOD
00167 NS_HandleEmbeddingEvent(nsEmbedNativeEvent &aEvent, PRBool &aWasHandled);
00168 
00169 #endif /* MOZ_SUPPORTS_EMBEDDING_EVENT_PROCESSING */
00170 
00171 #endif /* NSEMBEDAPI_H */
00172