/image/decoders/icon/gtk/nsIconChannel.h

 1/* ***** BEGIN LICENSE BLOCK *****
 2 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
 3 *
 4 * The contents of this file are subject to the Mozilla Public License Version
 5 * 1.1 (the "License"); you may not use this file except in compliance with
 6 * the License. You may obtain a copy of the License at
 7 * http://www.mozilla.org/MPL/
 8 *
 9 * Software distributed under the License is distributed on an "AS IS" basis,
10 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
11 * for the specific language governing rights and limitations under the
12 * License.
13 *
14 * The Original Code is the Mozilla icon channel for gnome.
15 *
16 * The Initial Developer of the Original Code is
17 * Christian Biesinger <cbiesinger@web.de>.
18 * Portions created by the Initial Developer are Copyright (C) 2004
19 * the Initial Developer. All Rights Reserved.
20 *
21 * Contributor(s):
22 *
23 * Alternatively, the contents of this file may be used under the terms of
24 * either the GNU General Public License Version 2 or later (the "GPL"), or
25 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
26 * in which case the provisions of the GPL or the LGPL are applicable instead
27 * of those above. If you wish to allow use of your version of this file only
28 * under the terms of either the GPL or the LGPL, and not to allow others to
29 * use your version of this file under the terms of the MPL, indicate your
30 * decision by deleting the provisions above and replace them with the notice
31 * and other provisions required by the GPL or the LGPL. If you do not delete
32 * the provisions above, a recipient may use your version of this file under
33 * the terms of any one of the MPL, the GPL or the LGPL.
34 *
35 * ***** END LICENSE BLOCK ***** */
36
37#ifndef nsIconChannel_h_
38#define nsIconChannel_h_
39
40#include "mozilla/Attributes.h"
41
42#include "nsIChannel.h"
43#include "nsIStreamListener.h"
44#include "nsIURI.h"
45#include "nsIIconURI.h"
46#include "nsCOMPtr.h"
47
48/**
49 * This class is the gnome implementation of nsIconChannel. It basically asks
50 * gtk/gnome for an icon, saves it as a tmp icon, and creates a new channel for
51 * that file to which all calls will be proxied.
52 */
53class nsIconChannel MOZ_FINAL : public nsIChannel {
54  public:
55    NS_DECL_ISUPPORTS
56    NS_FORWARD_NSIREQUEST(mRealChannel->)
57    NS_FORWARD_NSICHANNEL(mRealChannel->)
58
59    nsIconChannel() {}
60    ~nsIconChannel() {}
61
62    static void Shutdown();
63
64    /**
65     * Called by nsIconProtocolHandler after it creates this channel.
66     * Must be called before calling any other function on this object.
67     * If this method fails, no other function must be called on this object.
68     */
69    NS_HIDDEN_(nsresult) Init(nsIURI* aURI);
70  private:
71    /**
72     * The channel to the temp icon file (e.g. to /tmp/2qy9wjqw.html).
73     * Will always be non-null after a successful Init.
74     */
75    nsCOMPtr<nsIChannel> mRealChannel;
76
77    /**
78     * Called by Init if we need to use the gnomeui library.
79     */
80    nsresult InitWithGnome(nsIMozIconURI *aURI);
81    nsresult InitWithGIO(nsIMozIconURI *aIconURI);
82};
83
84#endif