summaryrefslogtreecommitdiffstats
path: root/apps/shell_window.h
diff options
context:
space:
mode:
authorbenwells@chromium.org <benwells@chromium.org@0039d316-1c4b-4281-b951-d872f2087c98>2013-06-27 15:12:04 +0000
committerbenwells@chromium.org <benwells@chromium.org@0039d316-1c4b-4281-b951-d872f2087c98>2013-06-27 15:12:04 +0000
commit49045de5997002898f4fd32376f3f96eec32f278 (patch)
tree89a5c89e213226a48bac88efa9316e0ffee1c955 /apps/shell_window.h
parent7790c086f7a606b72b05a1109e4af56a4db4859c (diff)
downloadchromium_src-49045de5997002898f4fd32376f3f96eec32f278.zip
chromium_src-49045de5997002898f4fd32376f3f96eec32f278.tar.gz
chromium_src-49045de5997002898f4fd32376f3f96eec32f278.tar.bz2
Move ShellWindow into apps component.
This involves creating a new delegate type, ShellWindow::Delegate, which is implemented in chrome. BUG=159366 Review URL: https://chromiumcodereview.appspot.com/16702003 git-svn-id: svn://svn.chromium.org/chrome/trunk/src@208927 0039d316-1c4b-4281-b951-d872f2087c98
Diffstat (limited to 'apps/shell_window.h')
-rw-r--r--apps/shell_window.h380
1 files changed, 380 insertions, 0 deletions
diff --git a/apps/shell_window.h b/apps/shell_window.h
new file mode 100644
index 0000000..f283c80
--- /dev/null
+++ b/apps/shell_window.h
@@ -0,0 +1,380 @@
+// Copyright 2013 The Chromium Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+#ifndef CHROME_BROWSER_UI_EXTENSIONS_SHELL_WINDOW_H_
+#define CHROME_BROWSER_UI_EXTENSIONS_SHELL_WINDOW_H_
+
+#include "base/memory/scoped_ptr.h"
+#include "base/memory/weak_ptr.h"
+#include "chrome/browser/extensions/extension_keybinding_registry.h"
+#include "chrome/browser/sessions/session_id.h"
+#include "components/web_modal/web_contents_modal_dialog_manager_delegate.h"
+#include "content/public/browser/notification_observer.h"
+#include "content/public/browser/notification_registrar.h"
+#include "content/public/browser/web_contents_delegate.h"
+#include "content/public/common/console_message_level.h"
+#include "ui/base/ui_base_types.h" // WindowShowState
+#include "ui/gfx/image/image.h"
+#include "ui/gfx/rect.h"
+
+class GURL;
+class Profile;
+class NativeAppWindow;
+class SkRegion;
+
+namespace content {
+class WebContents;
+}
+
+namespace extensions {
+class Extension;
+class PlatformAppBrowserTest;
+class WindowController;
+
+struct DraggableRegion;
+}
+
+namespace ui {
+class BaseWindow;
+}
+
+namespace apps {
+
+// Manages the web contents for Shell Windows. The implementation for this
+// class should create and maintain the WebContents for the window, and handle
+// any message passing between the web contents and the extension system or
+// native window.
+class ShellWindowContents {
+ public:
+ ShellWindowContents() {}
+ virtual ~ShellWindowContents() {}
+
+ // Called to initialize the WebContents, before the app window is created.
+ virtual void Initialize(Profile* profile, const GURL& url) = 0;
+
+ // Called to load the contents, after the app window is created.
+ virtual void LoadContents(int32 creator_process_id) = 0;
+
+ // Called when the native window changes.
+ virtual void NativeWindowChanged(NativeAppWindow* native_app_window) = 0;
+
+ // Called when the native window closes.
+ virtual void NativeWindowClosed() = 0;
+
+ virtual content::WebContents* GetWebContents() const = 0;
+
+ private:
+ DISALLOW_COPY_AND_ASSIGN(ShellWindowContents);
+};
+
+// ShellWindow is the type of window used by platform apps. Shell windows
+// have a WebContents but none of the chrome of normal browser windows.
+class ShellWindow : public content::NotificationObserver,
+ public content::WebContentsDelegate,
+ public web_modal::WebContentsModalDialogManagerDelegate,
+ public extensions::ExtensionKeybindingRegistry::Delegate {
+ public:
+ enum WindowType {
+ WINDOW_TYPE_DEFAULT = 1 << 0, // Default shell window.
+ WINDOW_TYPE_PANEL = 1 << 1, // OS controlled panel window (Ash only).
+ WINDOW_TYPE_V1_PANEL = 1 << 2, // For apps v1 support in Ash; deprecate
+ // with v1 apps.
+ };
+
+ enum Frame {
+ FRAME_CHROME, // Chrome-style window frame.
+ FRAME_NONE, // Frameless window.
+ };
+
+ struct CreateParams {
+ CreateParams();
+ ~CreateParams();
+
+ WindowType window_type;
+ Frame frame;
+ bool transparent_background; // Only supported on ash.
+
+ // Specify the initial content bounds of the window (excluding any window
+ // decorations). INT_MIN designates 'unspecified' for the position
+ // components, and 0 for the size components. When unspecified, they should
+ // be replaced with a default value.
+ gfx::Rect bounds;
+
+ gfx::Size minimum_size;
+ gfx::Size maximum_size;
+
+ std::string window_key;
+
+ // The process ID of the process that requested the create.
+ int32 creator_process_id;
+
+ // Initial state of the window.
+ ui::WindowShowState state;
+
+ // If true, don't show the window after creation.
+ bool hidden;
+
+ // If true, the window will be resizable by the user. Defaults to true.
+ bool resizable;
+
+ // If true, the window will be focused on creation. Defaults to true.
+ bool focused;
+ };
+
+ class Delegate {
+ public:
+ virtual ~Delegate();
+
+ // General initialization.
+ virtual void InitWebContents(content::WebContents* web_contents) = 0;
+
+ // Link handling.
+ virtual content::WebContents* OpenURLFromTab(
+ Profile* profile,
+ content::WebContents* source,
+ const content::OpenURLParams& params) = 0;
+ virtual void AddNewContents(Profile* profile,
+ content::WebContents* new_contents,
+ WindowOpenDisposition disposition,
+ const gfx::Rect& initial_pos,
+ bool user_gesture,
+ bool* was_blocked) = 0;
+
+ // Feature support.
+ virtual content::ColorChooser* ShowColorChooser(
+ content::WebContents* web_contents,
+ SkColor initial_color) = 0;
+ virtual void RunFileChooser(content::WebContents* tab,
+ const content::FileChooserParams& params) = 0;
+ virtual void RequestMediaAccessPermission(
+ content::WebContents* web_contents,
+ const content::MediaStreamRequest& request,
+ const content::MediaResponseCallback& callback,
+ const extensions::Extension* extension) = 0;
+ virtual int PreferredIconSize() = 0;
+
+ // Web contents modal dialog support.
+ virtual void SetWebContentsBlocked(content::WebContents* web_contents,
+ bool blocked) = 0;
+ virtual bool IsWebContentsVisible(content::WebContents* web_contents) = 0;
+ };
+
+ // Helper function for creating and intiailizing a v2 app window.
+ // The created shell window will take ownership of |delegate|.
+ static ShellWindow* Create(Profile* profile,
+ Delegate* delegate,
+ const extensions::Extension* extension,
+ const GURL& url,
+ const CreateParams& params);
+
+ // Convert draggable regions in raw format to SkRegion format. Caller is
+ // responsible for deleting the returned SkRegion instance.
+ static SkRegion* RawDraggableRegionsToSkRegion(
+ const std::vector<extensions::DraggableRegion>& regions);
+
+ // The constructor and Init methods are public for constructing a ShellWindow
+ // with a non-standard render interface (e.g. v1 apps using Ash Panels).
+ // Normally ShellWindow::Create should be used.
+ // The constructed shell window takes ownership of |delegate|.
+ ShellWindow(Profile* profile,
+ Delegate* delegate,
+ const extensions::Extension* extension);
+
+ // Initializes the render interface, web contents, and native window.
+ // |shell_window_contents| will become owned by ShellWindow.
+ void Init(const GURL& url,
+ ShellWindowContents* shell_window_contents,
+ const CreateParams& params);
+
+
+ const std::string& window_key() const { return window_key_; }
+ const SessionID& session_id() const { return session_id_; }
+ const extensions::Extension* extension() const { return extension_; }
+ const std::string& extension_id() const { return extension_id_; }
+ content::WebContents* web_contents() const;
+ WindowType window_type() const { return window_type_; }
+ bool window_type_is_panel() const {
+ return (window_type_ == WINDOW_TYPE_PANEL ||
+ window_type_ == WINDOW_TYPE_V1_PANEL);
+ }
+ Profile* profile() const { return profile_; }
+ const gfx::Image& app_icon() const { return app_icon_; }
+ const GURL& app_icon_url() { return app_icon_url_; }
+
+ NativeAppWindow* GetBaseWindow();
+ gfx::NativeWindow GetNativeWindow();
+
+ // Returns the bounds that should be reported to the renderer.
+ gfx::Rect GetClientBounds() const;
+
+ // This will return a slightly smaller icon then the app_icon to be used in
+ // application lists.
+ scoped_ptr<gfx::Image> GetAppListIcon();
+
+ // NativeAppWindows should call this to determine what the window's title
+ // is on startup and from within UpdateWindowTitle().
+ string16 GetTitle() const;
+
+ // Call to notify ShellRegistry and delete the window. Subclasses should
+ // invoke this method instead of using "delete this".
+ void OnNativeClose();
+
+ // Should be called by native implementations when the window size, position,
+ // or minimized/maximized state has changed.
+ void OnNativeWindowChanged();
+
+ // Should be called by native implementations when the window is activated.
+ void OnNativeWindowActivated();
+
+ // Specifies a url for the launcher icon.
+ void SetAppIconUrl(const GURL& icon_url);
+
+ // Called from the render interface to modify the draggable regions.
+ void UpdateDraggableRegions(
+ const std::vector<extensions::DraggableRegion>& regions);
+
+ // Updates the app image to |image|. Called internally from the image loader
+ // callback. Also called externally for v1 apps using Ash Panels.
+ void UpdateAppIcon(const gfx::Image& image);
+
+ // Transitions window into fullscreen, maximized, minimized or restores based
+ // on chrome.app.window API.
+ void Fullscreen();
+ void Maximize();
+ void Minimize();
+ void Restore();
+
+ ShellWindowContents* shell_window_contents_for_test() {
+ return shell_window_contents_.get();
+ }
+
+ protected:
+ virtual ~ShellWindow();
+
+ private:
+ // PlatformAppBrowserTest needs access to web_contents()
+ friend class extensions::PlatformAppBrowserTest;
+
+ // content::WebContentsDelegate implementation.
+ virtual void CloseContents(content::WebContents* contents) OVERRIDE;
+ virtual bool ShouldSuppressDialogs() OVERRIDE;
+ virtual content::ColorChooser* OpenColorChooser(
+ content::WebContents* web_contents, SkColor color) OVERRIDE;
+ virtual void RunFileChooser(
+ content::WebContents* tab,
+ const content::FileChooserParams& params) OVERRIDE;
+ virtual bool IsPopupOrPanel(
+ const content::WebContents* source) const OVERRIDE;
+ virtual void MoveContents(
+ content::WebContents* source, const gfx::Rect& pos) OVERRIDE;
+ virtual void NavigationStateChanged(const content::WebContents* source,
+ unsigned changed_flags) OVERRIDE;
+ virtual void ToggleFullscreenModeForTab(content::WebContents* source,
+ bool enter_fullscreen) OVERRIDE;
+ virtual bool IsFullscreenForTabOrPending(
+ const content::WebContents* source) const OVERRIDE;
+ virtual void RequestMediaAccessPermission(
+ content::WebContents* web_contents,
+ const content::MediaStreamRequest& request,
+ const content::MediaResponseCallback& callback) OVERRIDE;
+ virtual content::WebContents* OpenURLFromTab(
+ content::WebContents* source,
+ const content::OpenURLParams& params) OVERRIDE;
+ virtual void AddNewContents(content::WebContents* source,
+ content::WebContents* new_contents,
+ WindowOpenDisposition disposition,
+ const gfx::Rect& initial_pos,
+ bool user_gesture,
+ bool* was_blocked) OVERRIDE;
+ virtual void HandleKeyboardEvent(
+ content::WebContents* source,
+ const content::NativeWebKeyboardEvent& event) OVERRIDE;
+ virtual void RequestToLockMouse(content::WebContents* web_contents,
+ bool user_gesture,
+ bool last_unlocked_by_target) OVERRIDE;
+
+ // content::NotificationObserver implementation.
+ virtual void Observe(int type,
+ const content::NotificationSource& source,
+ const content::NotificationDetails& details) OVERRIDE;
+
+ // web_modal::WebContentsModalDialogManagerDelegate implementation.
+ virtual void SetWebContentsBlocked(content::WebContents* web_contents,
+ bool blocked) OVERRIDE;
+ virtual bool IsWebContentsVisible(
+ content::WebContents* web_contents) OVERRIDE;
+
+ // Helper method to add a message to the renderer's DevTools console.
+ void AddMessageToDevToolsConsole(content::ConsoleMessageLevel level,
+ const std::string& message);
+
+ // Saves the window geometry/position/screen bounds.
+ void SaveWindowPosition();
+
+ // Helper method to adjust the cached bounds so that we can make sure it can
+ // be visible on the screen. See http://crbug.com/145752 .
+ void AdjustBoundsToBeVisibleOnScreen(
+ const gfx::Rect& cached_bounds,
+ const gfx::Rect& cached_screen_bounds,
+ const gfx::Rect& current_screen_bounds,
+ const gfx::Size& minimum_size,
+ gfx::Rect* bounds) const;
+
+ // Load the app's image, firing a load state change when loaded.
+ void UpdateExtensionAppIcon();
+
+ void OnImageLoaded(const gfx::Image& image);
+
+ // extensions::ExtensionKeybindingRegistry::Delegate implementation.
+ virtual extensions::ActiveTabPermissionGranter*
+ GetActiveTabPermissionGranter() OVERRIDE;
+
+ // web_modal::WebContentsModalDialogManagerDelegate implementation.
+ virtual web_modal::WebContentsModalDialogHost*
+ GetWebContentsModalDialogHost() OVERRIDE;
+
+ // Callback from web_contents()->DownloadFavicon.
+ void DidDownloadFavicon(int id,
+ int http_status_code,
+ const GURL& image_url,
+ int requested_size,
+ const std::vector<SkBitmap>& bitmaps);
+
+ Profile* profile_; // weak pointer - owned by ProfileManager.
+ // weak pointer - owned by ExtensionService.
+ const extensions::Extension* extension_;
+ const std::string extension_id_;
+
+ // Identifier that is used when saving and restoring geometry for this
+ // window.
+ std::string window_key_;
+
+ const SessionID session_id_;
+ WindowType window_type_;
+ content::NotificationRegistrar registrar_;
+
+ // Icon shown in the task bar.
+ gfx::Image app_icon_;
+
+ // Icon URL to be used for setting the app icon. If not empty, app_icon_ will
+ // be fetched and set using this URL.
+ GURL app_icon_url_;
+
+ scoped_ptr<NativeAppWindow> native_app_window_;
+ scoped_ptr<ShellWindowContents> shell_window_contents_;
+ scoped_ptr<Delegate> delegate_;
+
+ base::WeakPtrFactory<ShellWindow> image_loader_ptr_factory_;
+
+ // Fullscreen entered by app.window api.
+ bool fullscreen_for_window_api_;
+ // Fullscreen entered by HTML requestFullscreen.
+ bool fullscreen_for_tab_;
+
+ DISALLOW_COPY_AND_ASSIGN(ShellWindow);
+};
+
+} // namespace apps
+
+#endif // CHROME_BROWSER_UI_EXTENSIONS_SHELL_WINDOW_H_