blob: 4a17a7692f25a909f35dc1d87996d2c3a6ee5d16 [file] [log] [blame]
// Copyright (c) 2012 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 ASH_SHELL_DELEGATE_H_
#define ASH_SHELL_DELEGATE_H_
#include <string>
#include "ash/ash_export.h"
#include "ash/shell.h"
#include "base/callback.h"
#include "base/strings/string16.h"
class GURL;
namespace app_list {
class AppListViewDelegate;
}
namespace aura {
class Window;
}
namespace gfx {
class Image;
}
namespace ui {
class MenuModel;
}
namespace keyboard {
class KeyboardUI;
}
namespace ash {
class AccessibilityDelegate;
class MediaDelegate;
class NewWindowDelegate;
class SessionStateDelegate;
class ShelfDelegate;
class ShelfModel;
class SystemTrayDelegate;
class UserWallpaperDelegate;
class Shelf;
struct ShelfItem;
class ASH_EXPORT VirtualKeyboardStateObserver {
public:
// Called when keyboard is activated/deactivated.
virtual void OnVirtualKeyboardStateChanged(bool activated) {}
protected:
virtual ~VirtualKeyboardStateObserver() {}
};
// Delegate of the Shell.
class ASH_EXPORT ShellDelegate {
public:
// The Shell owns the delegate.
virtual ~ShellDelegate() {}
// Returns true if this is the first time that the shell has been run after
// the system has booted. false is returned after the shell has been
// restarted, typically due to logging in as a guest or logging out.
virtual bool IsFirstRunAfterBoot() const = 0;
// Returns true if multi-profiles feature is enabled.
virtual bool IsMultiProfilesEnabled() const = 0;
// Returns true if incognito mode is allowed for the user.
// Incognito windows are restricted for supervised users.
virtual bool IsIncognitoAllowed() const = 0;
// Returns true if we're running in forced app mode.
virtual bool IsRunningInForcedAppMode() const = 0;
// Returns true if |window| can be shown for the delegate's concept of current
// user.
virtual bool CanShowWindowForUser(aura::Window* window) const = 0;
// Returns true if the first window shown on first run should be
// unconditionally maximized, overriding the heuristic that normally chooses
// the window size.
virtual bool IsForceMaximizeOnFirstRun() const = 0;
// Called before processing |Shell::Init()| so that the delegate
// can perform tasks necessary before the shell is initialized.
virtual void PreInit() = 0;
// Called at the beginninig of Shell destructor so that
// delegate can use Shell instance to perform cleanup tasks.
virtual void PreShutdown() = 0;
// Invoked when the user uses Ctrl-Shift-Q to close chrome.
virtual void Exit() = 0;
// Create a shell-specific keyboard::KeyboardUI
virtual keyboard::KeyboardUI* CreateKeyboardUI() = 0;
// Called when virtual keyboard has been activated/deactivated.
virtual void VirtualKeyboardActivated(bool activated) = 0;
// Adds or removes virtual keyboard state observer.
virtual void AddVirtualKeyboardStateObserver(
VirtualKeyboardStateObserver* observer) = 0;
virtual void RemoveVirtualKeyboardStateObserver(
VirtualKeyboardStateObserver* observer) = 0;
// Opens the |url| in a new browser tab.
virtual void OpenUrl(const GURL& url) = 0;
// Get the AppListViewDelegate, creating one if it does not yet exist.
// Ownership stays with Chrome's AppListService, or the ShellDelegate.
virtual app_list::AppListViewDelegate* GetAppListViewDelegate() = 0;
// Creates a new ShelfDelegate. Shell takes ownership of the returned
// value.
virtual ShelfDelegate* CreateShelfDelegate(ShelfModel* model) = 0;
// Creates a system-tray delegate. Shell takes ownership of the delegate.
virtual SystemTrayDelegate* CreateSystemTrayDelegate() = 0;
// Creates a user wallpaper delegate. Shell takes ownership of the delegate.
virtual UserWallpaperDelegate* CreateUserWallpaperDelegate() = 0;
// Creates a session state delegate. Shell takes ownership of the delegate.
virtual SessionStateDelegate* CreateSessionStateDelegate() = 0;
// Creates a accessibility delegate. Shell takes ownership of the delegate.
virtual AccessibilityDelegate* CreateAccessibilityDelegate() = 0;
// Creates an application delegate. Shell takes ownership of the delegate.
virtual NewWindowDelegate* CreateNewWindowDelegate() = 0;
// Creates a media delegate. Shell takes ownership of the delegate.
virtual MediaDelegate* CreateMediaDelegate() = 0;
// Creates a menu model for the |shelf| and optional shelf |item|.
// If |item| is null, this creates a context menu for the desktop or shelf.
virtual ui::MenuModel* CreateContextMenu(ash::Shelf* shelf,
const ash::ShelfItem* item) = 0;
// Creates a GPU support object. Shell takes ownership of the object.
virtual GPUSupport* CreateGPUSupport() = 0;
// Get the product name.
virtual base::string16 GetProductName() const = 0;
virtual void OpenKeyboardShortcutHelpPage() const {}
virtual gfx::Image GetDeprecatedAcceleratorImage() const = 0;
// Toggles the status of the touchpad / touchscreen on or off.
virtual void ToggleTouchpad() {}
virtual void ToggleTouchscreen() {}
};
} // namespace ash
#endif // ASH_SHELL_DELEGATE_H_