blob: 3750eaddcd2ed1a4a2ee8180c9a663329a75f3f3 [file] [log] [blame]
// Copyright 2017 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 UI_KEYBOARD_CONTAINER_BEHAVIOR_H_
#define UI_KEYBOARD_CONTAINER_BEHAVIOR_H_
#include "ui/aura/window.h"
#include "ui/compositor/scoped_layer_animation_settings.h"
#include "ui/keyboard/container_type.h"
#include "ui/keyboard/keyboard_export.h"
#include "ui/wm/core/window_animations.h"
namespace keyboard {
// Represents and encapsulates how the keyboard container should visually behave
// within the workspace window.
class KEYBOARD_EXPORT ContainerBehavior {
public:
virtual ~ContainerBehavior() {}
// Apply changes to the animation settings to animate the keyboard container
// showing.
virtual void DoShowingAnimation(
aura::Window* window,
ui::ScopedLayerAnimationSettings* animation_settings) = 0;
// Apply changes to the animation settings to animate the keyboard container
// hiding.
virtual void DoHidingAnimation(
aura::Window* window,
::wm::ScopedHidingAnimationSettings* animation_settings) = 0;
// Initialize the starting state of the keyboard container for the showing
// animation.
virtual void InitializeShowAnimationStartingState(
aura::Window* container) = 0;
// Used by the layout manager to intercept any bounds setting request to
// adjust the request to different bounds, if necessary. This method gets
// called at any time during the keyboard's life cycle.
virtual const gfx::Rect AdjustSetBoundsRequest(
const gfx::Rect& display_bounds,
const gfx::Rect& requested_bounds) = 0;
// Used to set the bounds to the default location. This is generally called
// during initialization, but may also be have identical behavior to
// AdjustSetBoundsRequest in the case of constant layouts such as the fixed
// full-width keyboard.
virtual void SetCanonicalBounds(aura::Window* container,
const gfx::Rect& display_bounds) = 0;
// A ContainerBehavior can choose to not allow overscroll to be used. It is
// important to note that the word "Allowed" is used because whether or not
// overscroll is "enabled" depends on multiple external factors.
virtual bool IsOverscrollAllowed() const = 0;
// Return whether the given coordinate is a drag handle.
virtual bool IsDragHandle(const gfx::Vector2d& offset,
const gfx::Size& keyboard_size) const = 0;
virtual void SavePosition(const gfx::Point& position) = 0;
virtual void HandlePointerEvent(bool isMouseButtonPressed,
const gfx::Vector2d& kb_offset) = 0;
virtual ContainerType GetType() const = 0;
// Removing focus from a text field should cause the keyboard to be dismissed.
virtual bool TextBlurHidesKeyboard() const = 0;
// The keyboard should be considered a reasonable hinderence to use the region
// of the screen behind it. This is used to determine if window manager or
// other system UI should respond to the presence of the keyboard such as
// moving windows out of the obscured region.
virtual bool BoundsObscureUsableRegion() const = 0;
// Any region of the screen that is occluded by the keyboard should cause the
// workspace to change its layout.
virtual bool BoundsAffectWorkspaceLayout() const = 0;
};
} // namespace keyboard
#endif // UI_KEYBOARD_CONTAINER_BEHAVIOR_H_