Mir
observer.h
Go to the documentation of this file.
1 /*
2  * Copyright © 2014 Canonical Ltd.
3  *
4  * This program is free software: you can redistribute it and/or modify it
5  * under the terms of the GNU General Public License version 3,
6  * as published by the Free Software Foundation.
7  *
8  * This program is distributed in the hope that it will be useful,
9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11  * GNU General Public License for more details.
12  *
13  * You should have received a copy of the GNU General Public License
14  * along with this program. If not, see <http://www.gnu.org/licenses/>.
15  *
16  * Authored by: Robert Carr <robert.carr@canonical.com>
17  */
18 
19 #ifndef MIR_SCENE_OBSERVER_H_
20 #define MIR_SCENE_OBSERVER_H_
21 
22 #include <memory>
23 
24 namespace mir
25 {
26 namespace scene
27 {
28 class Surface;
29 
33 class Observer
34 {
35 public:
36  virtual void surface_added(Surface* surface) = 0;
37  virtual void surface_removed(Surface* surface) = 0;
38  virtual void surfaces_reordered() = 0;
39 
40  // Used to indicate the scene has changed in some way beyond the present surfaces
41  // and will require full recomposition.
42  virtual void scene_changed() = 0;
43 
44  // Called at observer registration to notify of already existing surfaces.
45  virtual void surface_exists(Surface* surface) = 0;
46  // Called when observer is unregistered, for example, to provide a place to
47  // unregister SurfaceObservers which may have been added in surface_added/exists
48  virtual void end_observation() = 0;
49 
50 protected:
51  Observer() = default;
52  virtual ~Observer() = default;
53  Observer(Observer const&) = delete;
54  Observer& operator=(Observer const&) = delete;
55 };
56 
57 }
58 } // namespace mir
59 
60 #endif // MIR_SCENE_OBSERVER_H_
All things Mir.
Definition: buffer_stream.h:37
virtual void end_observation()=0
An observer for top level notifications of scene changes. In order to receive more granular change no...
Definition: observer.h:33
virtual void surface_removed(Surface *surface)=0
virtual ~Observer()=default
virtual void surface_added(Surface *surface)=0
virtual void surface_exists(Surface *surface)=0
Observer & operator=(Observer const &)=delete
virtual void scene_changed()=0
virtual void surfaces_reordered()=0
Definition: surface.h:40

Copyright © 2012,2013 Canonical Ltd.
Generated on Tue Mar 24 16:15:19 UTC 2015