blob: 1d6e205d887b7217614356051d12695197ce5f95 [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.
#include "ash/ash_export.h"
#include "base/basictypes.h"
#include "base/compiler_specific.h"
#include "base/memory/scoped_ptr.h"
#include "ui/aura/window_observer.h"
namespace ui {
class Layer;
namespace ash {
// ScreenDimmer displays a partially-opaque layer above everything
// else in the root window to darken the display. It shouldn't be used
// for long-term brightness adjustments due to performance
// considerations -- it's only intended for cases where we want to
// briefly dim the screen (e.g. to indicate to the user that we're
// about to suspend a machine that lacks an internal backlight that
// can be adjusted).
class ASH_EXPORT ScreenDimmer : public aura::WindowObserver {
class TestApi {
explicit TestApi(ScreenDimmer* dimmer) : dimmer_(dimmer) {}
ui::Layer* layer() { return dimmer_->dimming_layer_.get(); }
ScreenDimmer* dimmer_; // not owned
explicit ScreenDimmer(aura::Window* root_window);
virtual ~ScreenDimmer();
// Dim or undim the root window.
void SetDimming(bool should_dim);
// aura::WindowObserver overrides:
virtual void OnWindowBoundsChanged(aura::Window* root_window,
const gfx::Rect& old_bounds,
const gfx::Rect& new_bounds) OVERRIDE;
friend class TestApi;
aura::Window* root_window_;
// Partially-opaque layer that's stacked above all of the root window's
// children and used to dim the screen. NULL until the first time we dim.
scoped_ptr<ui::Layer> dimming_layer_;
// Are we currently dimming the screen?
bool currently_dimming_;
} // namespace ash