1 files changed, 79 insertions, 0 deletions
diff --git a/slideshow/source/inc/animatableshape.hxx b/slideshow/source/inc/animatableshape.hxx
new file mode 100644
index 000000000..7cefad0f6
--- /dev/null
+++ b/slideshow/source/inc/animatableshape.hxx
@@ -0,0 +1,79 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ *   Licensed to the Apache Software Foundation (ASF) under one or more
+ *   contributor license agreements. See the NOTICE file distributed
+ *   with this work for additional information regarding copyright
+ *   ownership. The ASF licenses this file to you under the Apache
+ *   License, Version 2.0 (the "License"); you may not use this file
+ *   except in compliance with the License. You may obtain a copy of
+ *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+
+#ifndef INCLUDED_SLIDESHOW_SOURCE_INC_ANIMATABLESHAPE_HXX
+#define INCLUDED_SLIDESHOW_SOURCE_INC_ANIMATABLESHAPE_HXX
+
+#include <memory>
+
+#include "shape.hxx"
+
+
+namespace slideshow::internal
+    {
+        /** Represents an animatable shape.
+
+            This interface adds animation handling methods to a
+            shape. It allows transparent switching between
+            sprite-based viewing and static painting, depending on
+            whether animations are currently running.
+         */
+        class AnimatableShape : public Shape
+        {
+        public:
+            // Animation methods
+
+
+            /** Notify the Shape that an animation starts now
+
+                This method enters animation mode on all registered
+                views.
+
+                @attention This method is supposed to be called only
+                from the LayerManager, since it might involve shifting
+                shapes between different layers (and removing this
+                shape from the background layer in the first place)
+             */
+            virtual void enterAnimationMode() = 0;
+
+            /** Notify the Shape that it is no longer animated
+
+                This methods requests the Shape to end animation mode
+                on all registered views, if called more or equal the
+                times enterAnimationMode() was called. That is, the
+                Shape only leaves animation mode, if all requested
+                enterAnimationMode() call sites have issued their
+                matching leaveAnimationMode().
+
+                @attention This method is supposed to be called only
+                from the LayerManager, since it might involve shifting
+                shapes between different layers (and adding this
+                shape to the background layer again)
+             */
+            virtual void leaveAnimationMode() = 0;
+
+        };
+
+        typedef ::std::shared_ptr< AnimatableShape > AnimatableShapeSharedPtr;
+
+}
+
+#endif // INCLUDED_SLIDESHOW_SOURCE_INC_ANIMATABLESHAPE_HXX
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */