embedding/tests/wxEmbed/GeckoContainer.cpp

   1 /* ***** BEGIN LICENSE BLOCK *****
   2  * Version: Mozilla-sample-code 1.0
   3  *
   4  * Copyright (c) 2002 Netscape Communications Corporation and
   5  * other contributors
   6  *
   7  * Permission is hereby granted, free of charge, to any person obtaining a
   8  * copy of this Mozilla sample software and associated documentation files
   9  * (the "Software"), to deal in the Software without restriction, including
  10  * without limitation the rights to use, copy, modify, merge, publish,
  11  * distribute, sublicense, and/or sell copies of the Software, and to permit
  12  * persons to whom the Software is furnished to do so, subject to the
  13  * following conditions:
  14  *
  15  * The above copyright notice and this permission notice shall be included
  16  * in all copies or substantial portions of the Software.
  17  *
  18  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  19  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  20  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
  21  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  22  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  23  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  24  * DEALINGS IN THE SOFTWARE.
  25  *
  26  * Contributor(s):
  27  *   Adam Lock <adamlock@netscape.com>
  28  *
  29  * ***** END LICENSE BLOCK ***** */
  30
  31 // Mozilla Includes
  32 //#include "nsIGenericFactory.h"
  33 #include "nsIComponentManager.h"
  34 #include "nsXPIDLString.h"
  35 #include "nsIURI.h"
  36 #include "nsIWebProgress.h"
  37 #include "nsIDocShellTreeItem.h"
  38 #include "nsIDOMWindow.h"
  39 #include "nsIDOMWindowInternal.h"
  40 #include "nsIInterfaceRequestor.h"
  41 #include "nsIInterfaceRequestorUtils.h"
  42 #include "nsIURIContentListener.h"
  43 #include "nsCWebBrowser.h"
  44 #include "nsCRT.h"
  45
  46 #include "GeckoContainer.h"
  47
  48
  49
  50 GeckoContainer::GeckoContainer(GeckoContainerUI *pUI, const char *aRole) :
  51     mUI(pUI),
  52     mNativeWindow(nsnull),
  53     mSizeSet(PR_FALSE),
  54     mIsChromeContainer(PR_FALSE),
  55     mIsURIContentListener(PR_TRUE)
  56 {
  57     NS_ASSERTION(mUI, "No GeckoContainerUI! How do you expect this to work???");
  58     if (aRole)
  59         mRole = aRole;
  60 }
  61
  62 GeckoContainer::~GeckoContainer()
  63 {
  64     mUI->Destroyed();
  65 }
  66
  67 nsresult GeckoContainer::CreateBrowser(PRInt32 aX, PRInt32 aY,
  68                                          PRInt32 aCX, PRInt32 aCY, nativeWindow aParent,
  69                                          nsIWebBrowser **aBrowser)
  70 {
  71     NS_ENSURE_ARG_POINTER(aBrowser);
  72     *aBrowser = nsnull;
  73
  74     nsresult rv;
  75     mWebBrowser = do_CreateInstance(NS_WEBBROWSER_CONTRACTID, &rv);
  76     if (!mWebBrowser || NS_FAILED(rv))
  77         return NS_ERROR_FAILURE;
  78
  79     mWebBrowser->SetContainerWindow(static_cast<nsIWebBrowserChrome *>(this));
  80
  81     nsCOMPtr<nsIDocShellTreeItem> dsti = do_QueryInterface(mWebBrowser);
  82     dsti->SetItemType(
  83         mIsChromeContainer ?
  84             nsIDocShellTreeItem::typeChromeWrapper :
  85             nsIDocShellTreeItem::typeContentWrapper);
  86
  87     nsCOMPtr<nsIBaseWindow> browserBaseWindow = do_QueryInterface(mWebBrowser);
  88
  89     mNativeWindow = aParent;
  90
  91     if (!mNativeWindow)
  92         return NS_ERROR_FAILURE;
  93
  94     browserBaseWindow->InitWindow( mNativeWindow,
  95                              nsnull,
  96                              aX, aY, aCX, aCY);
  97     browserBaseWindow->Create();
  98
  99     nsCOMPtr<nsIWebProgressListener> listener(static_cast<nsIWebProgressListener*>(this));
 100     nsCOMPtr<nsIWeakReference> thisListener(do_GetWeakReference(listener));
 101     (void)mWebBrowser->AddWebBrowserListener(thisListener,
 102         NS_GET_IID(nsIWebProgressListener));
 103
 104     if (mIsURIContentListener)
 105         mWebBrowser->SetParentURIContentListener(static_cast<nsIURIContentListener *>(this));
 106
 107
 108     // The window has been created. Now register for history notifications
 109 //    mWebBrowser->AddWebBrowserListener(thisListener, NS_GET_IID(nsISHistoryListener));
 110
 111     if (mWebBrowser)
 112     {
 113       *aBrowser = mWebBrowser;
 114       NS_ADDREF(*aBrowser);
 115       return NS_OK;
 116     }
 117     return NS_ERROR_FAILURE;
 118 }
 119
 120
 121 void GeckoContainer::ContentFinishedLoading()
 122 {
 123   // if it was a chrome window and no one has already specified a size,
 124   // size to content
 125   if (mWebBrowser && !mSizeSet &&
 126      (mChromeFlags & nsIWebBrowserChrome::CHROME_OPENAS_CHROME)) {
 127     nsCOMPtr<nsIDOMWindow> contentWin;
 128     mWebBrowser->GetContentDOMWindow(getter_AddRefs(contentWin));
 129     if (contentWin)
 130         contentWin->SizeToContent();
 131     mUI->ShowWindow(PR_TRUE);
 132   }
 133 }
 134
 135 //*****************************************************************************
 136 // GeckoContainer::nsISupports
 137 //*****************************************************************************
 138
 139 NS_IMPL_ADDREF(GeckoContainer)
 140 NS_IMPL_RELEASE(GeckoContainer)
 141
 142 NS_INTERFACE_MAP_BEGIN(GeckoContainer)
 143    NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(nsISupports, nsIWebBrowserChrome)
 144    NS_INTERFACE_MAP_ENTRY(nsIInterfaceRequestor)
 145    NS_INTERFACE_MAP_ENTRY(nsIWebBrowserChrome)
 146    NS_INTERFACE_MAP_ENTRY(nsIWebBrowserChromeFocus)
 147    NS_INTERFACE_MAP_ENTRY(nsIEmbeddingSiteWindow)
 148    NS_INTERFACE_MAP_ENTRY(nsIEmbeddingSiteWindow2)
 149    NS_INTERFACE_MAP_ENTRY(nsIWebProgressListener) // optional
 150    NS_INTERFACE_MAP_ENTRY(nsISupportsWeakReference)
 151    NS_INTERFACE_MAP_ENTRY(nsIObserver)
 152    NS_INTERFACE_MAP_ENTRY(nsIURIContentListener)
 153    NS_INTERFACE_MAP_ENTRY(nsIContextMenuListener2)
 154    NS_INTERFACE_MAP_ENTRY(nsITooltipListener)
 155    NS_INTERFACE_MAP_ENTRY(nsIGeckoContainer)
 156 NS_INTERFACE_MAP_END
 157
 158
 159 //*****************************************************************************
 160 // GeckoContainer::nsIGeckoContainer
 161 //*****************************************************************************
 162
 163 NS_IMETHODIMP GeckoContainer::GetRole(nsACString &aRole)
 164 {
 165     aRole = mRole;
 166     return NS_OK;
 167 }
 168
 169 NS_IMETHODIMP GeckoContainer::GetContainerUI(GeckoContainerUI **pUI)
 170 {
 171     *pUI = mUI;
 172     return NS_OK;
 173 }
 174
 175 //*****************************************************************************
 176 // GeckoContainer::nsIInterfaceRequestor
 177 //*****************************************************************************
 178
 179 NS_IMETHODIMP GeckoContainer::GetInterface(const nsIID &aIID, void** aInstancePtr)
 180 {
 181     NS_ENSURE_ARG_POINTER(aInstancePtr);
 182
 183     *aInstancePtr = 0;
 184     if (aIID.Equals(NS_GET_IID(nsIDOMWindow)))
 185     {
 186         if (mWebBrowser)
 187         {
 188             return mWebBrowser->GetContentDOMWindow((nsIDOMWindow **) aInstancePtr);
 189         }
 190         return NS_ERROR_NOT_INITIALIZED;
 191     }
 192     return QueryInterface(aIID, aInstancePtr);
 193 }
 194
 195 //*****************************************************************************
 196 // GeckoContainer::nsIWebBrowserChrome
 197 //*****************************************************************************
 198
 199 NS_IMETHODIMP GeckoContainer::SetStatus(PRUint32 aType, const PRUnichar* aStatus)
 200 {
 201     mUI->UpdateStatusBarText(aStatus);
 202     return NS_OK;
 203 }
 204
 205 NS_IMETHODIMP GeckoContainer::GetWebBrowser(nsIWebBrowser** aWebBrowser)
 206 {
 207     NS_ENSURE_ARG_POINTER(aWebBrowser);
 208     *aWebBrowser = mWebBrowser;
 209     NS_IF_ADDREF(*aWebBrowser);
 210     return NS_OK;
 211 }
 212
 213 NS_IMETHODIMP GeckoContainer::SetWebBrowser(nsIWebBrowser* aWebBrowser)
 214 {
 215     mWebBrowser = aWebBrowser;
 216     return NS_OK;
 217 }
 218
 219 NS_IMETHODIMP GeckoContainer::GetChromeFlags(PRUint32* aChromeMask)
 220 {
 221     *aChromeMask = mChromeFlags;
 222     return NS_OK;
 223 }
 224
 225 NS_IMETHODIMP GeckoContainer::SetChromeFlags(PRUint32 aChromeMask)
 226 {
 227     mChromeFlags = aChromeMask;
 228     return NS_OK;
 229 }
 230
 231 NS_IMETHODIMP GeckoContainer::DestroyBrowserWindow(void)
 232 {
 233     mUI->Destroy();
 234     return NS_OK;
 235 }
 236
 237
 238 // IN: The desired browser client area dimensions.
 239 NS_IMETHODIMP GeckoContainer::SizeBrowserTo(PRInt32 aWidth, PRInt32 aHeight)
 240 {
 241   /* This isn't exactly correct: we're setting the whole window to
 242      the size requested for the browser. At time of writing, though,
 243      it's fine and useful for winEmbed's purposes. */
 244   mUI->SizeTo(aWidth, aHeight);
 245   mSizeSet = PR_TRUE;
 246   return NS_OK;
 247 }
 248
 249
 250 NS_IMETHODIMP GeckoContainer::ShowAsModal(void)
 251 {
 252 /*  if (mDependentParent)
 253     mUI->EnableChromeWindow(mDependentParent, PR_FALSE);
 254
 255   mContinueModalLoop = PR_TRUE;
 256   mUI->RunEventLoop(mContinueModalLoop);
 257
 258   if (mDependentParent)
 259     mUI->EnableChromeWindow(mDependentParent, PR_TRUE);
 260 */
 261   return NS_OK;
 262 }
 263
 264 NS_IMETHODIMP GeckoContainer::IsWindowModal(PRBool *_retval)
 265 {
 266     *_retval = PR_FALSE;
 267     return NS_ERROR_NOT_IMPLEMENTED;
 268 }
 269
 270 NS_IMETHODIMP GeckoContainer::ExitModalEventLoop(nsresult aStatus)
 271 {
 272   mContinueModalLoop = PR_FALSE;
 273   return NS_OK;
 274 }
 275
 276 //*****************************************************************************
 277 // GeckoContainer::nsIWebBrowserChromeFocus
 278 //*****************************************************************************
 279
 280 NS_IMETHODIMP GeckoContainer::FocusNextElement()
 281 {
 282     return NS_ERROR_NOT_IMPLEMENTED;
 283 }
 284
 285 NS_IMETHODIMP GeckoContainer::FocusPrevElement()
 286 {
 287     return NS_ERROR_NOT_IMPLEMENTED;
 288 }
 289
 290 //*****************************************************************************
 291 // GeckoContainer::nsIWebProgressListener
 292 //*****************************************************************************
 293
 294 NS_IMETHODIMP GeckoContainer::OnProgressChange(nsIWebProgress *progress, nsIRequest *request,
 295                                                   PRInt32 curSelfProgress, PRInt32 maxSelfProgress,
 296                                                   PRInt32 curTotalProgress, PRInt32 maxTotalProgress)
 297 {
 298     mUI->UpdateProgress(curTotalProgress, maxTotalProgress);
 299     return NS_OK;
 300 }
 301
 302 NS_IMETHODIMP GeckoContainer::OnStateChange(nsIWebProgress *progress, nsIRequest *request,
 303                                                PRUint32 progressStateFlags, nsresult status)
 304 {
 305     if ((progressStateFlags & STATE_START) && (progressStateFlags & STATE_IS_DOCUMENT))
 306     {
 307         mUI->UpdateBusyState(PR_TRUE);
 308     }
 309
 310     if ((progressStateFlags & STATE_STOP) && (progressStateFlags & STATE_IS_DOCUMENT))
 311     {
 312         mUI->UpdateBusyState(PR_FALSE);
 313         mUI->UpdateProgress(0, 100);
 314         mUI->UpdateStatusBarText(nsnull);
 315         ContentFinishedLoading();
 316     }
 317
 318     return NS_OK;
 319 }
 320
 321
 322 NS_IMETHODIMP GeckoContainer::OnLocationChange(nsIWebProgress* aWebProgress,
 323                                                  nsIRequest* aRequest,
 324                                                  nsIURI *location)
 325 {
 326     PRBool isSubFrameLoad = PR_FALSE; // Is this a subframe load
 327     if (aWebProgress)
 328     {
 329         nsCOMPtr<nsIDOMWindow>  domWindow;
 330         nsCOMPtr<nsIDOMWindow>  topDomWindow;
 331         aWebProgress->GetDOMWindow(getter_AddRefs(domWindow));
 332         if (domWindow)
 333         {
 334             // Get root domWindow
 335             domWindow->GetTop(getter_AddRefs(topDomWindow));
 336         }
 337         if (domWindow != topDomWindow)
 338             isSubFrameLoad = PR_TRUE;
 339     }
 340     if (!isSubFrameLoad)
 341         mUI->UpdateCurrentURI();
 342     return NS_OK;
 343 }
 344
 345 NS_IMETHODIMP
 346 GeckoContainer::OnStatusChange(nsIWebProgress* aWebProgress,
 347                                  nsIRequest* aRequest,
 348                                  nsresult aStatus,
 349                                  const PRUnichar* aMessage)
 350 {
 351     mUI->UpdateStatusBarText(aMessage);
 352     return NS_OK;
 353 }
 354
 355
 356
 357 NS_IMETHODIMP
 358 GeckoContainer::OnSecurityChange(nsIWebProgress *aWebProgress,
 359                                     nsIRequest *aRequest,
 360                                     PRUint32 state)
 361 {
 362     return NS_OK;
 363 }
 364
 365
 366 //*****************************************************************************
 367 // GeckoContainer::nsIEmbeddingSiteWindow
 368 //*****************************************************************************
 369
 370 NS_IMETHODIMP GeckoContainer::SetDimensions(PRUint32 aFlags, PRInt32 x, PRInt32 y, PRInt32 cx, PRInt32 cy)
 371 {
 372     return NS_ERROR_NOT_IMPLEMENTED;
 373 }
 374
 375 NS_IMETHODIMP GeckoContainer::GetDimensions(PRUint32 aFlags, PRInt32 *x, PRInt32 *y, PRInt32 *cx, PRInt32 *cy)
 376 {
 377     if (aFlags & nsIEmbeddingSiteWindow::DIM_FLAGS_POSITION)
 378     {
 379         *x = 0;
 380         *y = 0;
 381     }
 382     if (aFlags & nsIEmbeddingSiteWindow::DIM_FLAGS_SIZE_INNER ||
 383         aFlags & nsIEmbeddingSiteWindow::DIM_FLAGS_SIZE_OUTER)
 384     {
 385         *cx = 0;
 386         *cy = 0;
 387     }
 388     return NS_ERROR_NOT_IMPLEMENTED;
 389 }
 390
 391 /* void setFocus (); */
 392 NS_IMETHODIMP GeckoContainer::SetFocus()
 393 {
 394     mUI->SetFocus();
 395     return NS_OK;
 396 }
 397
 398 /* attribute wstring title; */
 399 NS_IMETHODIMP GeckoContainer::GetTitle(PRUnichar * *aTitle)
 400 {
 401    NS_ENSURE_ARG_POINTER(aTitle);
 402
 403    *aTitle = nsnull;
 404
 405    return NS_ERROR_NOT_IMPLEMENTED;
 406 }
 407 NS_IMETHODIMP GeckoContainer::SetTitle(const PRUnichar * aTitle)
 408 {
 409     return NS_ERROR_NOT_IMPLEMENTED;
 410 }
 411
 412 /* attribute boolean visibility; */
 413 NS_IMETHODIMP GeckoContainer::GetVisibility(PRBool * aVisibility)
 414 {
 415     NS_ENSURE_ARG_POINTER(aVisibility);
 416     *aVisibility = PR_TRUE;
 417     return NS_OK;
 418 }
 419 NS_IMETHODIMP GeckoContainer::SetVisibility(PRBool aVisibility)
 420 {
 421     return NS_OK;
 422 }
 423
 424 /* attribute nativeSiteWindow siteWindow */
 425 NS_IMETHODIMP GeckoContainer::GetSiteWindow(void * *aSiteWindow)
 426 {
 427    NS_ENSURE_ARG_POINTER(aSiteWindow);
 428
 429    *aSiteWindow = mNativeWindow;
 430    return NS_OK;
 431 }
 432
 433 //*****************************************************************************
 434 // GeckoContainer::nsIEmbeddingSiteWindow2
 435 //*****************************************************************************
 436
 437 NS_IMETHODIMP GeckoContainer::Blur()
 438 {
 439    mUI->KillFocus();
 440    return NS_OK;
 441 }
 442
 443 //*****************************************************************************
 444 // GeckoContainer::nsIObserver
 445 //*****************************************************************************
 446
 447 NS_IMETHODIMP GeckoContainer::Observe(nsISupports *aSubject, const char *aTopic, const PRUnichar *someData)
 448 {
 449     nsresult rv = NS_OK;
 450     if (nsCRT::strcmp(aTopic, "profile-change-teardown") == 0)
 451     {
 452         // A profile change means death for this window
 453         mUI->Destroy();
 454     }
 455     return rv;
 456 }
 457
 458 //*****************************************************************************
 459 // GeckoContainer::nsIURIContentListener
 460 //*****************************************************************************
 461
 462 /* boolean onStartURIOpen (in nsIURI aURI); */
 463 NS_IMETHODIMP GeckoContainer::OnStartURIOpen(nsIURI *aURI, PRBool *_retval)
 464 {
 465     return NS_ERROR_NOT_IMPLEMENTED;
 466 }
 467
 468 /* boolean doContent (in string aContentType, in boolean aIsContentPreferred, in nsIRequest aRequest, out nsIStreamListener aContentHandler); */
 469 NS_IMETHODIMP GeckoContainer::DoContent(const char *aContentType, PRBool aIsContentPreferred, nsIRequest *aRequest, nsIStreamListener **aContentHandler, PRBool *_retval)
 470 {
 471     return NS_ERROR_NOT_IMPLEMENTED;
 472 }
 473
 474 /* boolean isPreferred (in string aContentType, out string aDesiredContentType); */
 475 NS_IMETHODIMP GeckoContainer::IsPreferred(const char *aContentType, char **aDesiredContentType, PRBool *_retval)
 476 {
 477     return NS_ERROR_NOT_IMPLEMENTED;
 478 }
 479
 480 /* boolean canHandleContent (in string aContentType, in boolean aIsContentPreferred, out string aDesiredContentType); */
 481 NS_IMETHODIMP GeckoContainer::CanHandleContent(const char *aContentType, PRBool aIsContentPreferred, char **aDesiredContentType, PRBool *_retval)
 482 {
 483     return NS_ERROR_NOT_IMPLEMENTED;
 484 }
 485
 486 /* attribute nsISupports loadCookie; */
 487 NS_IMETHODIMP GeckoContainer::GetLoadCookie(nsISupports * *aLoadCookie)
 488 {
 489     return NS_ERROR_NOT_IMPLEMENTED;
 490 }
 491 NS_IMETHODIMP GeckoContainer::SetLoadCookie(nsISupports * aLoadCookie)
 492 {
 493     return NS_ERROR_NOT_IMPLEMENTED;
 494 }
 495
 496 /* attribute nsIURIContentListener parentContentListener; */
 497 NS_IMETHODIMP GeckoContainer::GetParentContentListener(nsIURIContentListener * *aParentContentListener)
 498 {
 499     return NS_ERROR_NOT_IMPLEMENTED;
 500 }
 501 NS_IMETHODIMP GeckoContainer::SetParentContentListener(nsIURIContentListener * aParentContentListener)
 502 {
 503     return NS_ERROR_NOT_IMPLEMENTED;
 504 }
 505
 506 //*****************************************************************************
 507 // GeckoContainer::nsIContextMenuListener2
 508 //*****************************************************************************
 509
 510 /* void onShowContextMenu (in unsigned long aContextFlags, in nsIContextMenuInfo aUtils); */
 511 NS_IMETHODIMP GeckoContainer::OnShowContextMenu(PRUint32 aContextFlags, nsIContextMenuInfo *aContextMenuInfo)
 512 {
 513     mUI->ShowContextMenu(aContextFlags, aContextMenuInfo);
 514     return NS_OK;
 515 }
 516
 517
 518 //*****************************************************************************
 519 // GeckoContainer::nsITooltipListener
 520 //*****************************************************************************
 521
 522 /* void OnShowTooltip (in long aXCoords, in long aYCoords, in wstring aTipText); */
 523 NS_IMETHODIMP GeckoContainer::OnShowTooltip(PRInt32 aXCoords, PRInt32 aYCoords, const PRUnichar *aTipText)
 524 {
 525     mUI->ShowTooltip(aXCoords, aYCoords, aTipText);
 526     return NS_OK;
 527 }
 528
 529 /* void OnHideTooltip (); */
 530 NS_IMETHODIMP GeckoContainer::OnHideTooltip()
 531 {
 532     mUI->HideTooltip();
 533     return NS_OK;
 534 }