components/view_manager/access_policy.h

// Copyright 2014 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 COMPONENTS_VIEW_MANAGER_ACCESS_POLICY_H_
#define COMPONENTS_VIEW_MANAGER_ACCESS_POLICY_H_

#include "components/view_manager/ids.h"
#include "components/view_manager/public/interfaces/view_manager_constants.mojom.h"

namespace view_manager {

class ServerView;

// AccessPolicy is used by ViewTreeImpl to determine what a connection is
// allowed to do.
class AccessPolicy {
 public:
  virtual ~AccessPolicy() {}

  // Unless otherwise mentioned all arguments have been validated. That is the
  // |view| arguments are non-null unless otherwise stated (eg CanSetView() is
  // allowed to take a NULL view).
  virtual bool CanRemoveViewFromParent(const ServerView* view) const = 0;
  virtual bool CanAddView(const ServerView* parent,
                          const ServerView* child) const = 0;
  virtual bool CanReorderView(const ServerView* view,
                              const ServerView* relative_view,
                              mojo::OrderDirection direction) const = 0;
  virtual bool CanDeleteView(const ServerView* view) const = 0;
  virtual bool CanGetViewTree(const ServerView* view) const = 0;
  // Used when building a view tree (GetViewTree()) to decide if we should
  // descend into |view|.
  virtual bool CanDescendIntoViewForViewTree(const ServerView* view) const = 0;
  virtual bool CanEmbed(const ServerView* view) const = 0;
  virtual bool CanChangeViewVisibility(const ServerView* view) const = 0;
  virtual bool CanSetViewSurfaceId(const ServerView* view) const = 0;
  virtual bool CanSetViewBounds(const ServerView* view) const = 0;
  virtual bool CanSetViewProperties(const ServerView* view) const = 0;
  virtual bool CanSetViewTextInputState(const ServerView* view) const = 0;
  virtual bool CanSetFocus(const ServerView* view) const = 0;

  // Returns whether the connection should notify on a hierarchy change.
  // |new_parent| and |old_parent| are initially set to the new and old parents
  // but may be altered so that the client only sees a certain set of views.
  virtual bool ShouldNotifyOnHierarchyChange(
      const ServerView* view,
      const ServerView** new_parent,
      const ServerView** old_parent) const = 0;

  // Returns the view to supply to the client when focus changes to |focused|.
  virtual const ServerView* GetViewForFocusChange(
      const ServerView* focused) = 0;
};

}  // namespace view_manager

#endif  // COMPONENTS_VIEW_MANAGER_ACCESS_POLICY_H_