third_party/WebKit/public/web/WebFrameWidget.h

   1 /*
   2  * Copyright (C) 2014 Google Inc. All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions are
   6  * met:
   7  *
   8  *     * Redistributions of source code must retain the above copyright
   9  * notice, this list of conditions and the following disclaimer.
  10  *     * Redistributions in binary form must reproduce the above
  11  * copyright notice, this list of conditions and the following disclaimer
  12  * in the documentation and/or other materials provided with the
  13  * distribution.
  14  *     * Neither the name of Google Inc. nor the names of its
  15  * contributors may be used to endorse or promote products derived from
  16  * this software without specific prior written permission.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29  */
  30
  31 #ifndef WebFrameWidget_h
  32 #define WebFrameWidget_h
  33
  34 #include "../platform/WebCommon.h"
  35 #include "../platform/WebPageVisibilityState.h"
  36 #include "public/web/WebWidget.h"
  37
  38 namespace blink {
  39
  40 class WebLocalFrame;
  41 class WebView;
  42 class WebWidgetClient;
  43
  44 class WebFrameWidget : public WebWidget {
  45 public:
  46     BLINK_EXPORT static WebFrameWidget* create(WebWidgetClient*, WebLocalFrame*);
  47     // Creates a frame widget for a WebView. Temporary helper to help transition
  48     // away from WebView inheriting WebWidget.
  49     // TODO(dcheng): Remove once transition is complete.
  50     BLINK_EXPORT static WebFrameWidget* create(WebWidgetClient*, WebView*, WebLocalFrame* mainFrame);
  51
  52     // Sets the visibility of the WebFrameWidget.
  53     // We still track page-level visibility, but additionally we need to notify a WebFrameWidget
  54     // when its owning RenderWidget receives a Show or Hide directive, so that it knows whether
  55     // it needs to draw or not.
  56     virtual void setVisibilityState(WebPageVisibilityState visibilityState, bool isInitialState) { }
  57
  58     // Temporary: there should only be one WebFrameWidget implementation but the
  59     // Blink API is currently in a transition state. See https://goo.gl/7yVrnb
  60     virtual bool forSubframe() const { return true; }
  61 };
  62
  63 } // namespace blink
  64
  65 #endif