258039 - nsCWebBrowser.idl should be part of the gecko SDK

Status: RESOLVED FIXED

(Core Graveyard :: Embedding: APIs, enhancement)

Description

[Christian :Biesinger (don't email me, ping me on IRC)]

(see also
news://news.mozilla.org:119/[e-mail]%3E)

A lot of samples use NS_WEBBROWSER_CONTRACTID to refer to the component
implementing nsIWebBrowser, we should allow using that from the SDK and make
nsCWebBrowser part of it. It only defines a CID and ContractID for nsIWebBrowser.

Comment 1

[Benjamin Smedberg]

This is crap ;) We shouldn't be defining NS_WEBBROWSER_CID anywhere public, and
we shouldn't be defining NS_WEBBROWSER_CONTRACTID in an IDL file. Let's create
an nsEmbedCID.h like nsXPCOMCID.h (for frozen contractIDs only, unlike nsNetCID).

Comment 2

[Nico]

Because the samples all use do_CreateInstance() it should be added to the SDK as
well (see the same newsgroup posting).

Comment 3

[Christian :Biesinger (don't email me, ping me on IRC)]

*** Bug 284297 has been marked as a duplicate of this bug. ***

Comment 4

[Boris Zbarsky [:bzbarsky]]

I like the idea of nsEmbedCID.h.  Is anyone actually opposed to it?  If not,
let's just do it.

Comment 5

[Darin Fisher]

> I like the idea of nsEmbedCID.h.  Is anyone actually opposed to it?  If not,
> let's just do it.

I agree.

Comment 6

[Boris Zbarsky [:bzbarsky]]

Attachment: Possible patch

This creates nsEmbedCID.h, puts NS_WEBBROWSER_CONTRACTID in it, and exports it
as part of the SDK.  I only documented frozen interfaces as being implemented
by the contract for the time being.  I also left nsICWebBrowser.idl almost
as-is, since a lot of the Mozilla embedding code includes it and it includes a
whole slew of IDL files; I'd have to either include those all over or
test-compile on a bazillion platforms.	I think all the includers ought to be
ok with including nsEmbedCID.h, since they already include nsEmbedAPI.h... (so
already REQUIRE embed_base).

Not sure whether Adam should review this; your call, Darin.

Comment 7

[Darin Fisher]

Comment on attachment 176011 [details] [diff] [review]
Possible patch

>Index: embedding/base/nsEmbedCID.h

>+ * Web Browser contract id

I've been writing ContractID elsewhere in Gecko documention, and I
think it works well since it really is a jargon term.


r=darin

Comment 8

[Boris Zbarsky [:bzbarsky]]

Checked in.  I'll post to n.p.m.embedding.

Comment 9

[Boris Zbarsky [:bzbarsky]]

Bug 285080 filed on putting more things in nsEmbedCID.h.