sbRemoteCommands.h
Go to the documentation of this file.
1 /*
2 //
3 // BEGIN SONGBIRD GPL
4 //
5 // This file is part of the Songbird web player.
6 //
7 // Copyright(c) 2005-2008 POTI, Inc.
8 // http://songbirdnest.com
9 //
10 // This file may be licensed under the terms of of the
11 // GNU General Public License Version 2 (the "GPL").
12 //
13 // Software distributed under the License is distributed
14 // on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, either
15 // express or implied. See the GPL for the specific language
16 // governing rights and limitations.
17 //
18 // You should have received a copy of the GPL along with this
19 // program. If not, go to http://www.gnu.org/licenses/gpl.html
20 // or write to the Free Software Foundation, Inc.,
21 // 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
22 //
23 // END SONGBIRD GPL
24 //
25  */
26 
27 #ifndef __SB_REMOTE_COMMANDS_H__
28 #define __SB_REMOTE_COMMANDS_H__
29 
30 #include "sbRemoteAPI.h"
31 #include "sbRemotePlayer.h"
32 #include <sbIPlaylistCommands.h>
33 #include <sbIRemoteCommands.h>
34 #include <sbIRemotePlayer.h>
35 #include <sbISecurityAggregator.h>
36 #include <sbISecurityMixin.h>
37 
38 #include <nsIClassInfo.h>
39 #include <nsIGenericFactory.h>
40 #include <nsISecurityCheckedComponent.h>
41 #include <nsStringGlue.h>
42 #include <nsTArray.h>
43 #include <nsCOMPtr.h>
44 #include <map>
45 
46 class nsIDOMNode;
47 class nsIWeakReference;
48 
49 struct sbCommand {
50  nsString type;
51  nsString id;
52  nsString name;
53  nsString tooltip;
54 };
55 
57  public nsIClassInfo,
59  public sbIPlaylistCommands,
61 {
62 public:
63  NS_DECL_SBIREMOTECOMMANDS
65  NS_DECL_NSICLASSINFO
66  NS_DECL_SBISECURITYAGGREGATOR
67  NS_DECL_SBIPLAYLISTCOMMANDS
68 
69  NS_FORWARD_SAFE_NSISECURITYCHECKEDCOMPONENT(mSecurityMixin)
70 
72 
73  sbRemoteCommands(sbRemotePlayer* aRemotePlayer);
74 
75 protected:
76  virtual ~sbRemoteCommands();
77  void DoCommandsUpdated();
78 
79  // sbIPlaylistCommands stuff
80  nsCOMPtr<nsIWeakReference> mWeakOwner;
81  nsCOMPtr<sbIPlaylistCommandsContext> mContext;
82  nsTArray<sbCommand> mCommands;
83  std::map<nsString, nsString> mProperties;
84 
85  // SecurityCheckedComponent stuff
86  nsCOMPtr<nsISecurityCheckedComponent> mSecurityMixin;
87 
88  nsRefPtr<sbRemotePlayer> mRemotePlayer;
89 };
90 
91 #endif // __SB_REMOTE_COMMANDS_H__
nsString name
nsString tooltip
sbRemoteCommands(sbRemotePlayer *aRemotePlayer)
nsISecurityCheckedComponent
nsString id
An interface to specify playlist commands from remote web pages.
A marker interface for objects that aggregate the security mixin.
nsCOMPtr< nsISecurityCheckedComponent > mSecurityMixin
#define SB_DECL_SECURITYCHECKEDCOMP_INIT
Definition: sbRemoteAPI.h:42
An interface that represents the set of command buttons and context menu items available on a display...
std::map< nsString, nsString > mProperties
nsRefPtr< sbRemotePlayer > mRemotePlayer
nsCOMPtr< nsIWeakReference > mWeakOwner
nsTArray< sbCommand > mCommands
nsCOMPtr< sbIPlaylistCommandsContext > mContext
nsString type