src/mojo/services/public/cpp/view_manager/view_manager_delegate.h

   1 // Copyright 2014 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef MOJO_SERVICES_PUBLIC_CPP_VIEW_MANAGER_VIEW_MANAGER_DELEGATE_H_
   6 #define MOJO_SERVICES_PUBLIC_CPP_VIEW_MANAGER_VIEW_MANAGER_DELEGATE_H_
   7
   8 #include "base/memory/scoped_ptr.h"
   9 #include "mojo/public/interfaces/application/service_provider.mojom.h"
  10
  11 namespace mojo {
  12
  13 class ServiceProviderImpl;
  14 class View;
  15 class ViewManager;
  16
  17 // Interface implemented by an application using the view manager.
  18 class ViewManagerDelegate {
  19  public:
  20   // Called when the application implementing this interface is embedded at
  21   // |root|. |view_manager| is an implementation of an object bound to a
  22   // connection to the view manager service. The object is valid until
  23   // OnViewManagerDisconnected() is called with the same object.
  24   // This function is called for every embed, but there will be a unique
  25   // instance of |view_manager| only for every unique connection. See
  26   // the class description of ViewManager for some rules about when a new
  27   // connection is made.
  28   // |exported_services| is an object that the delegate can add services to to
  29   // expose to the embedder. |imported_services| exposes the services offered by
  30   // the embedder to the delegate. Note that if a different application is
  31   // subsequently embedded at |root|, the pipe(s) connecting |imported_services|
  32   // to the embedder and any services obtained from it are not broken and will
  33   // continue to be valid.
  34   virtual void OnEmbed(ViewManager* view_manager,
  35                        View* root,
  36                        ServiceProviderImpl* exported_services,
  37                        scoped_ptr<ServiceProvider> imported_services) = 0;
  38
  39   // Called when a connection to the view manager service is closed.
  40   // |view_manager| is not valid after this function returns.
  41   virtual void OnViewManagerDisconnected(ViewManager* view_manager) = 0;
  42
  43  protected:
  44   virtual ~ViewManagerDelegate() {}
  45 };
  46
  47 }  // namespace mojo
  48
  49 #endif  // MOJO_SERVICES_PUBLIC_CPP_VIEW_MANAGER_VIEW_MANAGER_DELEGATE_H_