~ubuntu-branches/ubuntu/gutsy/virtualbox-ose/gutsy

for the method. The macro NS_DECL_ISUPPORTS, defined in <a href="http://lxr.mozilla.org/mozilla/source/xpcom/base/nsISupportsUtils.h">mozilla/xpcom/public/nsISupportsUtils.h</a>

defines the inherited methods from nsISupports.h.

<br><tt>NS_IMPL_ISUPPORTS1(SampleImpl, nsISample)</tt>

<br>In the constructor, the macro NS_INIT_REFCNT is called which sets the

reference count to 0.<p>

Note that the methods in the C++ bindings use InterCaps style, while the IDL

and JavaScript versions should use interCaps naming. The JavaScript binding

matches the case of the IDL, <b>except</b> <a

href="http://bugzilla.mozilla.org/show_bug.cgi?id=14460">QueryInterface</a>.

<p><b><a href="http://lxr.mozilla.org/mozilla/source/xpcom/sample/nsSampleFactory.cpp">nsSampleFactory.cpp</a></b>

<p>This is the class which builds the instance of the nsSample class.

The COM framework uses factories to create instance of implementations

rather than having the implementations instatiate themselves in order to

increase portability of code. This factory inherits from nsFactory,

which is also an XPCOM object. To gain more knowledge of factories

see the <a href="http://www.mozilla.org/projects/xpcom/generic-factory.html">generic

factory document</a> or the <a href="http://www.mozilla.org/docs/modunote.htm#Basics">Modularization techniques document</a>.

<p><b><a href="http://lxr.mozilla.org/mozilla/source/xpcom/sample/nsSample.js">nsSample.js</a></b>

<p>This file implements the nsISample interface, and associated factory glue,

in JavaScript.

<p><b>Compiling the idl</b>

<p>The XPIDL compiler (xpidl on Unix, xpidl.exe on Windows, and a CodeWarrior plugin on Mac)

is compiled at build time (except on Mac) thus

you will have to build mozilla in order to test this out. If you

have already built mozilla then the compiler will be located at <tt>mozilla\dist\WIN32_D.OBJ\bin\xpidl.exe</tt>.

<p>Once you have the XPIDL compiler enter the following command at your

prompt:

<br><tt>D:\mozilla\xpcom\sample>d:\mozilla\dist\WIN32_D.OBJ\bin\xpidl -I

d:\mozilla\dist\idl -m header nsISample.idl</tt>

<p>The <tt>-I d:\mozilla\dist\idl</tt> points the compiler to the folder

containing the other idl files, needed because nsISample.idl inherits from

nsISupports.idl. The <tt>-m header</tt> instruction tells the compiler

to build the C++ header. To build the .xpt file substitute <tt>-m

typelib</tt>.

<p>

For more information on compilation see the <a href="http://www.mozilla.org/scriptable/xpidl/">xpidl

100

compiler page</a>.

101

102

<p><b>Building the Sample</b>

103

104

<p>To build the Sample just enter

105

<br><tt>d:\mozilla\xpcom\sample>nmake /f makefile.win</tt>

106

107

<p>In order to do this you need to have your environment variables set

108

correctly. See the <a href="http://www.mozilla.org/build/">Build</a>

109

page for more information.

110

111

<p><b>Running the sample</b>

112

<p>Using Mozilla, load

113

<a href="resource://res/samples/xpconnect-sample.html">resource://res/samples/xpconnect-sample.html</a> (i.e. what

114

you're reading now). Pay attention

115

to the console when clicking "write". Notice that the value

116

printed is calculated in C++ code defined in <a href="http://lxr.mozilla.org/seamonkey/source/xpcom/sample/nsSample.cpp">nsSample.cpp</a>.

117

118

119

120

/* to use nsSample.js version, use "@mozilla.org/jssample;1" */

121

netscape.security.PrivilegeManager.enablePrivilege("UniversalXPConnect");

122

var sample = Components.classes["@mozilla.org/sample;1"].createInstance();

123

sample = sample.QueryInterface(Components.interfaces.nsISample);

124

dump("sample = " + sample + "\n");

125

126

function get()

127

{

128

netscape.security.PrivilegeManager.enablePrivilege("UniversalXPConnect");

129

var field = document.getElementById('Value');

130

field.value = sample.value;

131

}

132

133

function set()

134

{

135

netscape.security.PrivilegeManager.enablePrivilege("UniversalXPConnect");

136

var field = document.getElementById('Value');

137

sample.value = field.value;

138

}

139

140

function poke()

141

{

142

netscape.security.PrivilegeManager.enablePrivilege("UniversalXPConnect");

143

var field = document.getElementById('Value');

144

sample.poke(field.value);

145

}

146

147

function sampleWrite()

148

{

149

netscape.security.PrivilegeManager.enablePrivilege("UniversalXPConnect");

150

sample.writeValue("here is what I'm writing: ");

151

}

152

</script>

153

154

<p>

155

156

157

158

159

160

161

<form>

162

163

<hr>

164

165

<p>

166

JavaScript and form source:

167

168

169

<pre>

170

171

/* to use nsSample.js version, use "@mozilla.org/jssample;1" */

172

netscape.security.PrivilegeManager.enablePrivilege("UniversalXPConnect");

173

var sample = Components.classes["@mozilla.org/sample;1"].createInstance();

174

sample = sample.QueryInterface(Components.interfaces.nsISample);

175

dump("sample = " + sample + "\n");

176

177

function get()

178

{

179

netscape.security.PrivilegeManager.enablePrivilege("UniversalXPConnect"); var field = document.getElementById('Value');

180

field.value = sample.value;

181

}

182

183

function set()

184

{

185

netscape.security.PrivilegeManager.enablePrivilege("UniversalXPConnect"); var field = document.getElementById('Value');

186

sample.value = field.value;

187

}

188

189

function poke()

190

{

191

netscape.security.PrivilegeManager.enablePrivilege("UniversalXPConnect"); var field = document.getElementById('Value');

192

sample.poke(field.value);

193

}

194

195

function sampleWrite()

196

{

197

netscape.security.PrivilegeManager.enablePrivilege("UniversalXPConnect");

198

sample.writeValue("here is what I'm writing: ");

199

}

200

</script>

201

202

203

204

205

206

207

208

<form>

209

210

</pre>

211

212

<p>

213

<hr>

214

<b>Resources:</b>

215

<ul>

216

<li><a href="http://lxr.mozilla.org/seamonkey/source/xpcom/sample/">mozilla/xpcom/sample source directory</a>

217

</ul>

218

<hr>

219

<b>Comments to:</b>

220

<a href="mailto:mang@subcarrier.org?Subject=XPCOM sample documentation">Michael Ang <mang@subcarrier.org></a>

Older »