Back to index

lightning-sunbird  0.9+nobinonly
nsISplashScreen.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 Version
00006  * 1.1 (the "License"); you may not use this file except in compliance with
00007  * 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 Communicator client 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) 1998
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *   Bill Law       law@netscape.com
00024  *
00025  * Alternatively, the contents of this file may be used under the terms of
00026  * either of the GNU General Public License Version 2 or later (the "GPL"),
00027  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00028  * in which case the provisions of the GPL or the LGPL are applicable instead
00029  * of those above. If you wish to allow use of your version of this file only
00030  * under the terms of either the GPL or the LGPL, and not to allow others to
00031  * use your version of this file under the terms of the MPL, indicate your
00032  * decision by deleting the provisions above and replace them with the notice
00033  * and other provisions required by the GPL or the LGPL. If you do not delete
00034  * the provisions above, a recipient may use your version of this file under
00035  * the terms of any one of the MPL, the GPL or the LGPL.
00036  *
00037  * ***** END LICENSE BLOCK ***** */
00038 #ifndef nsISplashScreen_h__
00039 #define nsISplashScreen_h__
00040 
00041 #include "nsISupports.h"
00042 
00043 // {B5030250-D530-11d3-8070-00600811A9C3}
00044 #define NS_ISPLASHSCREEN_IID \
00045  { 0xb5030250, 0xd530, 0x11d3, { 0x80, 0x70, 0x0, 0x60, 0x8, 0x11, 0xa9, 0xc3 } }
00046 
00047 /*
00048  * This class specifies the interface to be used by xp code to manage the
00049    platform-specific splash screen.  Each platform (that has a splash screen)
00050    should implement this interface and return a instance of that class from
00051    the function NS_CreateSplashScreen.
00052 
00053    Note that the nature of the splash screen object is such that it is
00054    impossible to obtain an instance of this interface via standard XPCOM
00055    means (componenter manager/service manager).
00056 
00057    For the same reason, implementors should take care to implement this
00058    interface without introducing any dependencies on other components.
00059    This includes XPCOM itself as it will not have been initialized when
00060    an object that implements this interface will be created.  Implementors
00061    should implement the nsISupports member functions "manually" (rather
00062    than via the standard NS_*IMPL macros) to avoid any dependencies
00063    lurking in those macros.
00064  */
00065 class nsISplashScreen : public nsISupports {
00066 public:
00067     NS_DEFINE_STATIC_IID_ACCESSOR( NS_ISPLASHSCREEN_IID )
00068     NS_IMETHOD Show() = 0;
00069     NS_IMETHOD Hide() = 0;
00070 }; // class nsISplashScreen
00071 
00072 #endif // nsISplashScreen_h__