/image/decoders/icon/qt/nsIconChannel.h

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