sbDefaultBaseDeviceInfoRegistrar.h
Go to the documentation of this file.
1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
2 /* vim: set sw=2 :miv */
3 /*
4  *=BEGIN SONGBIRD GPL
5  *
6  * This file is part of the Songbird web player.
7  *
8  * Copyright(c) 2005-2010 POTI, Inc.
9  * http://www.songbirdnest.com
10  *
11  * This file may be licensed under the terms of of the
12  * GNU General Public License Version 2 (the ``GPL'').
13  *
14  * Software distributed under the License is distributed
15  * on an ``AS IS'' basis, WITHOUT WARRANTY OF ANY KIND, either
16  * express or implied. See the GPL for the specific language
17  * governing rights and limitations.
18  *
19  * You should have received a copy of the GPL along with this
20  * program. If not, go to http://www.gnu.org/licenses/gpl.html
21  * or write to the Free Software Foundation, Inc.,
22  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
23  *
24  *=END SONGBIRD GPL
25  */
26 
27 #ifndef SBIDEFAULTBASEDEVICEINFOREGISTRAR_H_
28 #define SBIDEFAULTBASEDEVICEINFOREGISTRAR_H_
29 
30 // Mozilla includes
31 #include <nsAutoLock.h>
32 #include <nsAutoPtr.h>
33 #include <nsCOMArray.h>
34 
35 // Songibrd includes
36 #include <sbDeviceXMLInfo.h>
37 #include <sbIDeviceInfoRegistrar.h>
38 
39 class sbIDevice;
40 
47 {
48 public:
49  NS_DECL_SBIDEVICEINFOREGISTRAR
50 
52 
53 protected:
54  //
55  // mDevice Device info device.
56  // mDeviceXMLInfo Device XML info data record.
57  // mDeviceXMLInfoPresent If true, device info is present in the device
58  // XML info data record.
59  //
60 
62  nsAutoPtr<sbDeviceXMLInfo> mDeviceXMLInfo;
64 
73  nsresult GetDeviceXMLInfo(sbIDevice* aDevice,
74  sbDeviceXMLInfo** aDeviceXMLInfo);
75 
83  nsresult GetDeviceXMLInfo(const nsACString& aDeviceXMLInfoSpec,
84  sbIDevice* aDevice);
85 
91  virtual nsresult GetDeviceXMLInfoSpec(nsACString& aDeviceXMLInfoSpec);
92 
102  virtual nsresult GetDeviceXMLInfoExtensions(
103  nsACString& aDeviceXMLInfoExtensions);
104 
113  virtual nsresult GetDefaultDeviceXMLInfoSpec(nsACString& aDeviceXMLInfoSpec);
114 
116 };
117 
118 #endif /* SBIDEFAULTBASEDEVICEINFOREGISTRAR_H_ */
119 
nsresult GetDeviceXMLInfo(sbIDevice *aDevice, sbDeviceXMLInfo **aDeviceXMLInfo)
virtual nsresult GetDefaultDeviceXMLInfoSpec(nsACString &aDeviceXMLInfoSpec)
virtual nsresult GetDeviceXMLInfoSpec(nsACString &aDeviceXMLInfoSpec)
NS_DECL_SBIDEVICEINFOREGISTRAR sbDefaultBaseDeviceInfoRegistrar()
virtual nsresult GetDeviceXMLInfoExtensions(nsACString &aDeviceXMLInfoExtensions)
Songbird Device XML Info Definitions.