1 : /*
2 : * DO NOT EDIT. THIS FILE IS GENERATED FROM /builds/slave/m-beta-lnx-codecoverage/build/widget/nsISound.idl
3 : */
4 :
5 : #ifndef __gen_nsISound_h__
6 : #define __gen_nsISound_h__
7 :
8 :
9 : #ifndef __gen_nsISupports_h__
10 : #include "nsISupports.h"
11 : #endif
12 :
13 : /* For IDL files that don't want to include root IDL files. */
14 : #ifndef NS_NO_VTABLE
15 : #define NS_NO_VTABLE
16 : #endif
17 : class nsIURL; /* forward declaration */
18 :
19 :
20 : /* starting interface: nsISound */
21 : #define NS_ISOUND_IID_STR "c3c28d92-a17f-43df-976d-4eeae6f995fc"
22 :
23 : #define NS_ISOUND_IID \
24 : {0xc3c28d92, 0xa17f, 0x43df, \
25 : { 0x97, 0x6d, 0x4e, 0xea, 0xe6, 0xf9, 0x95, 0xfc }}
26 :
27 0 : class NS_NO_VTABLE NS_SCRIPTABLE nsISound : public nsISupports {
28 : public:
29 :
30 : NS_DECLARE_STATIC_IID_ACCESSOR(NS_ISOUND_IID)
31 :
32 : /* void play (in nsIURL aURL); */
33 : NS_SCRIPTABLE NS_IMETHOD Play(nsIURL *aURL) = 0;
34 :
35 : /* void playSystemSound (in AString soundAlias); */
36 : NS_SCRIPTABLE NS_IMETHOD PlaySystemSound(const nsAString & soundAlias) = 0;
37 :
38 : /* void beep (); */
39 : NS_SCRIPTABLE NS_IMETHOD Beep(void) = 0;
40 :
41 : /* void init (); */
42 : NS_SCRIPTABLE NS_IMETHOD Init(void) = 0;
43 :
44 : enum {
45 : EVENT_NEW_MAIL_RECEIVED = 0U,
46 : EVENT_ALERT_DIALOG_OPEN = 1U,
47 : EVENT_CONFIRM_DIALOG_OPEN = 2U,
48 : EVENT_PROMPT_DIALOG_OPEN = 3U,
49 : EVENT_SELECT_DIALOG_OPEN = 4U,
50 : EVENT_MENU_EXECUTE = 5U,
51 : EVENT_MENU_POPUP = 6U,
52 : EVENT_EDITOR_MAX_LEN = 7U
53 : };
54 :
55 : /* void playEventSound (in unsigned long aEventId); */
56 : NS_SCRIPTABLE NS_IMETHOD PlayEventSound(PRUint32 aEventId) = 0;
57 :
58 : };
59 :
60 : NS_DEFINE_STATIC_IID_ACCESSOR(nsISound, NS_ISOUND_IID)
61 :
62 : /* Use this macro when declaring classes that implement this interface. */
63 : #define NS_DECL_NSISOUND \
64 : NS_SCRIPTABLE NS_IMETHOD Play(nsIURL *aURL); \
65 : NS_SCRIPTABLE NS_IMETHOD PlaySystemSound(const nsAString & soundAlias); \
66 : NS_SCRIPTABLE NS_IMETHOD Beep(void); \
67 : NS_SCRIPTABLE NS_IMETHOD Init(void); \
68 : NS_SCRIPTABLE NS_IMETHOD PlayEventSound(PRUint32 aEventId);
69 :
70 : /* Use this macro to declare functions that forward the behavior of this interface to another object. */
71 : #define NS_FORWARD_NSISOUND(_to) \
72 : NS_SCRIPTABLE NS_IMETHOD Play(nsIURL *aURL) { return _to Play(aURL); } \
73 : NS_SCRIPTABLE NS_IMETHOD PlaySystemSound(const nsAString & soundAlias) { return _to PlaySystemSound(soundAlias); } \
74 : NS_SCRIPTABLE NS_IMETHOD Beep(void) { return _to Beep(); } \
75 : NS_SCRIPTABLE NS_IMETHOD Init(void) { return _to Init(); } \
76 : NS_SCRIPTABLE NS_IMETHOD PlayEventSound(PRUint32 aEventId) { return _to PlayEventSound(aEventId); }
77 :
78 : /* Use this macro to declare functions that forward the behavior of this interface to another object in a safe way. */
79 : #define NS_FORWARD_SAFE_NSISOUND(_to) \
80 : NS_SCRIPTABLE NS_IMETHOD Play(nsIURL *aURL) { return !_to ? NS_ERROR_NULL_POINTER : _to->Play(aURL); } \
81 : NS_SCRIPTABLE NS_IMETHOD PlaySystemSound(const nsAString & soundAlias) { return !_to ? NS_ERROR_NULL_POINTER : _to->PlaySystemSound(soundAlias); } \
82 : NS_SCRIPTABLE NS_IMETHOD Beep(void) { return !_to ? NS_ERROR_NULL_POINTER : _to->Beep(); } \
83 : NS_SCRIPTABLE NS_IMETHOD Init(void) { return !_to ? NS_ERROR_NULL_POINTER : _to->Init(); } \
84 : NS_SCRIPTABLE NS_IMETHOD PlayEventSound(PRUint32 aEventId) { return !_to ? NS_ERROR_NULL_POINTER : _to->PlayEventSound(aEventId); }
85 :
86 : #if 0
87 : /* Use the code below as a template for the implementation class for this interface. */
88 :
89 : /* Header file */
90 : class nsSound : public nsISound
91 : {
92 : public:
93 : NS_DECL_ISUPPORTS
94 : NS_DECL_NSISOUND
95 :
96 : nsSound();
97 :
98 : private:
99 : ~nsSound();
100 :
101 : protected:
102 : /* additional members */
103 : };
104 :
105 : /* Implementation file */
106 : NS_IMPL_ISUPPORTS1(nsSound, nsISound)
107 :
108 : nsSound::nsSound()
109 : {
110 : /* member initializers and constructor code */
111 : }
112 :
113 : nsSound::~nsSound()
114 : {
115 : /* destructor code */
116 : }
117 :
118 : /* void play (in nsIURL aURL); */
119 : NS_IMETHODIMP nsSound::Play(nsIURL *aURL)
120 : {
121 : return NS_ERROR_NOT_IMPLEMENTED;
122 : }
123 :
124 : /* void playSystemSound (in AString soundAlias); */
125 : NS_IMETHODIMP nsSound::PlaySystemSound(const nsAString & soundAlias)
126 : {
127 : return NS_ERROR_NOT_IMPLEMENTED;
128 : }
129 :
130 : /* void beep (); */
131 : NS_IMETHODIMP nsSound::Beep()
132 : {
133 : return NS_ERROR_NOT_IMPLEMENTED;
134 : }
135 :
136 : /* void init (); */
137 : NS_IMETHODIMP nsSound::Init()
138 : {
139 : return NS_ERROR_NOT_IMPLEMENTED;
140 : }
141 :
142 : /* void playEventSound (in unsigned long aEventId); */
143 : NS_IMETHODIMP nsSound::PlayEventSound(PRUint32 aEventId)
144 : {
145 : return NS_ERROR_NOT_IMPLEMENTED;
146 : }
147 :
148 : /* End of implementation class template. */
149 : #endif
150 :
151 :
152 : /**
153 : * NS_SYSSOUND_* can be used for playSystemSound but they are obsolete.
154 : * Use nsISound::playEventSound instead.
155 : */
156 : #define NS_SYSSOUND_PREFIX NS_LITERAL_STRING("_moz_")
157 : #define NS_SYSSOUND_MAIL_BEEP NS_LITERAL_STRING("_moz_mailbeep")
158 : #define NS_SYSSOUND_ALERT_DIALOG NS_LITERAL_STRING("_moz_alertdialog")
159 : #define NS_SYSSOUND_CONFIRM_DIALOG NS_LITERAL_STRING("_moz_confirmdialog")
160 : #define NS_SYSSOUND_PROMPT_DIALOG NS_LITERAL_STRING("_moz_promptdialog")
161 : #define NS_SYSSOUND_SELECT_DIALOG NS_LITERAL_STRING("_moz_selectdialog")
162 : #define NS_SYSSOUND_MENU_EXECUTE NS_LITERAL_STRING("_moz_menucommand")
163 : #define NS_SYSSOUND_MENU_POPUP NS_LITERAL_STRING("_moz_menupopup")
164 : #define NS_IsMozAliasSound(aSoundAlias) \
165 : StringBeginsWith(aSoundAlias, NS_SYSSOUND_PREFIX)
166 :
167 : #endif /* __gen_nsISound_h__ */
|