1 files changed, 75 insertions, 0 deletions
diff --git a/sdext/source/presenter/PresenterSprite.hxx b/sdext/source/presenter/PresenterSprite.hxx
new file mode 100644
index 000000000..386d6a4f2
--- /dev/null
+++ b/sdext/source/presenter/PresenterSprite.hxx
@@ -0,0 +1,75 @@
+/* -*- 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_SDEXT_SOURCE_PRESENTER_PRESENTERSPRITE_HXX
+#define INCLUDED_SDEXT_SOURCE_PRESENTER_PRESENTERSPRITE_HXX
+
+#include <com/sun/star/rendering/XCustomSprite.hpp>
+#include <com/sun/star/rendering/XSpriteCanvas.hpp>
+
+namespace sdext::presenter {
+
+/** A wrapper around a css::rendering::XCustomSprite that allows
+    not only setting values like size, location, and transformation but also
+    provides read access to them.
+    It also handles the showing and hiding of a sprite.  This includes not
+    to show the sprite when its size is not yet defined (results in a crash)
+    and hiding a sprite before disposing it (results in zombie sprites.)
+*/
+class PresenterSprite final
+{
+public:
+    PresenterSprite();
+    ~PresenterSprite();
+    PresenterSprite(const PresenterSprite&) = delete;
+    PresenterSprite& operator=(const PresenterSprite&) = delete;
+
+    /** The given sprite canvas is used as factory to create the sprite that
+        is wrapped by objects of this class.
+        It is also used to call updateScreen() at (wrapped by the Update() method).
+    */
+    void SetFactory (
+        const css::uno::Reference<css::rendering::XSpriteCanvas>& rxSpriteFactory);
+
+    css::uno::Reference<css::rendering::XCanvas> GetCanvas();
+
+    void Show();
+    void Hide();
+
+    void Resize (const css::geometry::RealSize2D& rSize);
+    void MoveTo (const css::geometry::RealPoint2D& rLocation);
+
+    void Update();
+
+private:
+    css::uno::Reference<css::rendering::XSpriteCanvas> mxSpriteFactory;
+    css::uno::Reference<css::rendering::XCustomSprite> mxSprite;
+    css::geometry::RealSize2D maSize;
+    css::geometry::RealPoint2D maLocation;
+    bool mbIsVisible;
+
+    void ProvideSprite();
+    void DisposeSprite();
+};
+
+}
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */