Back to index

lightning-sunbird  0.9+nobinonly
mozView.h
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
00002 /* ***** BEGIN LICENSE BLOCK *****
00003  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00004  *
00005  * The contents of this file are subject to the Mozilla Public License
00006  * Version 1.1 (the "License"); you may not use this file except in
00007  * compliance with the License. You may obtain a copy of the License at
00008  * http://www.mozilla.org/MPL/
00009  *
00010  * Software distributed under the License is distributed on an "AS IS" basis,
00011  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00012  * for the specific language governing rights and limitations under the
00013  * License.
00014  *
00015  * The Original Code is mozilla.org code.
00016  *
00017  * The Initial Developer of the Original Code is 
00018  * Netscape Communications Corporation.
00019  * Portions created by the Initial Developer are Copyright (C) 2002
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *
00024  * Alternatively, the contents of this file may be used under the terms of
00025  * either the GNU General Public License Version 2 or later (the "GPL"), or 
00026  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00027  * in which case the provisions of the GPL or the LGPL are applicable instead
00028  * of those above. If you wish to allow use of your version of this file only
00029  * under the terms of either the GPL or the LGPL, and not to allow others to
00030  * use your version of this file under the terms of the MPL, indicate your
00031  * decision by deleting the provisions above and replace them with the notice
00032  * and other provisions required by the GPL or the LGPL. If you do not delete
00033  * the provisions above, a recipient may use your version of this file under
00034  * the terms of any one of the NPL, the GPL or the LGPL.
00035  *
00036  * ***** END LICENSE BLOCK ***** */
00037 
00038 #undef DARWIN
00039 #import <Cocoa/Cocoa.h>
00040 class nsIWidget;
00041 
00042 
00043 //
00044 // protocol mozView
00045 //
00046 // A protocol listing all the methods that an object which wants
00047 // to live in gecko's widget hierarchy must implement. |nsChildView|
00048 // makes assumptions that any NSView with which it comes in contact will
00049 // implement this protocol.
00050 //
00051 
00052 @protocol mozView
00053 
00054   // access the nsIWidget associated with this view. DOES NOT ADDREF.
00055 - (nsIWidget*)widget;
00056 
00057   // access the native cocoa window (NSWindow) that this view
00058   // is in. It's necessary for a gecko NSView to keep track of the
00059   // window because |-window| returns nil when the view has been
00060   // removed from the view hierarchy (as is the case when it's hidden, 
00061   // since you can't just hide a view, that would make too much sense).
00062 - (NSWindow*)getNativeWindow;
00063 - (void)setNativeWindow:(NSWindow*)aWindow;
00064 
00065   // return a context menu for this view
00066 - (NSMenu*)getContextMenu;
00067 
00068   // Allows callers to do a delayed invalidate (e.g., if an invalidate
00069   // happens during drawing)
00070 - (void)setNeedsPendingDisplay;
00071 - (void)setNeedsPendingDisplayInRect:(NSRect)invalidRect;
00072 
00073   // called when our corresponding Gecko view goes away
00074 - (void)widgetDestroyed;
00075 
00076 @end
00077 
00078 
00079 // 
00080 // An informal protocol implemented by the NSWindow of the host application.
00081 // 
00082 // It's used to prevent re-entrant calls to -makeKeyAndOrderFront: when gecko
00083 // focus/activate events propagate out to the embedder's
00084 // nsIEmbeddingSiteWindow::SetFocus implementation.
00085 // 
00086 
00087 @interface NSObject(mozWindow)
00088 
00089 - (BOOL)suppressMakeKeyFront;
00090 - (void)setSuppressMakeKeyFront:(BOOL)inSuppress;
00091 
00092 @end