Back to index

lightning-sunbird  0.9+nobinonly
nsMediaDocument.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  *
00024  * Alternatively, the contents of this file may be used under the terms of
00025  * either of the GNU General Public License Version 2 or later (the "GPL"),
00026  * or 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 MPL, the GPL or the LGPL.
00035  *
00036  * ***** END LICENSE BLOCK ***** */
00037 
00038 #ifndef nsMediaDocument_h___
00039 #define nsMediaDocument_h___
00040 
00041 #include "nsHTMLDocument.h"
00042 #include "nsGenericHTMLElement.h"
00043 #include "nsAutoPtr.h"
00044 #include "nsIStringBundle.h"
00045 
00046 #define NSMEDIADOCUMENT_PROPERTIES_URI "chrome://global/locale/layout/MediaDocument.properties"
00047 
00048 class nsMediaDocument : public nsHTMLDocument
00049 {
00050 public:
00051   nsMediaDocument();
00052   virtual ~nsMediaDocument();
00053 
00054   virtual nsresult Init();
00055 
00056   virtual nsresult StartDocumentLoad(const char*         aCommand,
00057                                      nsIChannel*         aChannel,
00058                                      nsILoadGroup*       aLoadGroup,
00059                                      nsISupports*        aContainer,
00060                                      nsIStreamListener** aDocListener,
00061                                      PRBool              aReset = PR_TRUE,
00062                                      nsIContentSink*     aSink = nsnull);
00063 
00064 protected:
00065   virtual nsresult CreateSyntheticDocument();
00066 
00067   friend class nsMediaDocumentStreamListener;
00068   nsresult StartLayout();
00069 
00070   // |aFormatNames[]| needs to have four elements in the following order: 
00071   // a format name with neither dimension nor file, a format name with
00072   // filename but w/o dimension, a format name with dimension but w/o filename,
00073   // a format name with both of them.  For instance, it can have
00074   // "ImageTitleWithNeitherDimensionsNorFile", "ImageTitleWithoutDimensions",
00075   // "ImageTitleWithDimesions",  "ImageTitleWithDimensionsAndFile".
00076   //
00077   // Also see MediaDocument.properties if you want to define format names
00078   // for a new subclass. aWidth and aHeight are pixels for |nsImageDocument|,
00079   // but could be in other units for other 'media', in which case you have to 
00080   // define format names accordingly. 
00081   void UpdateTitleAndCharset(const nsACString&  aTypeStr,
00082                              const char* const* aFormatNames = sFormatNames,
00083                              PRInt32            aWidth = 0,
00084                              PRInt32            aHeight = 0,
00085                              const nsAString&   aStatus = EmptyString());
00086 
00087   nsCOMPtr<nsIStringBundle>     mStringBundle;
00088   static const char* const      sFormatNames[4];
00089 
00090 private:
00091   enum                          {eWithNoInfo, eWithFile, eWithDim, eWithDimAndFile};
00092 };
00093 
00094 
00095 class nsMediaDocumentStreamListener: public nsIStreamListener
00096 {
00097 public:
00098   nsMediaDocumentStreamListener(nsMediaDocument *aDocument);
00099   virtual ~nsMediaDocumentStreamListener();
00100   void SetStreamListener(nsIStreamListener *aListener);
00101 
00102   NS_DECL_ISUPPORTS
00103 
00104   NS_DECL_NSIREQUESTOBSERVER
00105 
00106   NS_DECL_NSISTREAMLISTENER
00107 
00108 protected:
00109   nsRefPtr<nsMediaDocument>    mDocument;
00110   nsCOMPtr<nsIStreamListener>  mNextStream;
00111 };
00112 
00113 
00114 #endif /* nsMediaDocument_h___ */