1 files changed, 77 insertions, 0 deletions
diff --git a/offapi/com/sun/star/rendering/XCustomSprite.idl b/offapi/com/sun/star/rendering/XCustomSprite.idl
new file mode 100644
index 000000000000..e02f3c62df84
--- /dev/null
+++ b/offapi/com/sun/star/rendering/XCustomSprite.idl
@@ -0,0 +1,77 @@
+/*************************************************************************
+ *
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * Copyright 2000, 2010 Oracle and/or its affiliates.
+ *
+ * OpenOffice.org - a multi-platform office productivity suite
+ *
+ * This file is part of OpenOffice.org.
+ *
+ * OpenOffice.org is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License version 3
+ * only, as published by the Free Software Foundation.
+ *
+ * OpenOffice.org is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License version 3 for more details
+ * (a copy is included in the LICENSE file that accompanied this code).
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * version 3 along with OpenOffice.org.  If not, see
+ * <http://www.openoffice.org/license.html>
+ * for a copy of the LGPLv3 License.
+ *
+ ************************************************************************/
+#ifndef __com_sun_star_rendering_XCustomSprite_idl__
+#define __com_sun_star_rendering_XCustomSprite_idl__
+
+#ifndef __com_sun_star_uno_XInterface_idl__
+#include <com/sun/star/uno/XInterface.idl>
+#endif
+#ifndef __com_sun_star_rendering_ViewState_idl__
+#include <com/sun/star/rendering/ViewState.idl>
+#endif
+#ifndef __com_sun_star_rendering_RenderState_idl__
+#include <com/sun/star/rendering/RenderState.idl>
+#endif
+#ifndef __com_sun_star_rendering_XSprite_idl__
+#include <com/sun/star/rendering/XSprite.idl>
+#endif
+
+module com { module sun { module star { module rendering {
+
+interface XCanvas;
+
+/** Interface to control a custom sprite object on a XSpriteCanvas.<p>
+
+    Every change performed on XCustomSprite objects is only visible
+    after a XSpriteCanvas::updateScreen() call, to facilitate
+    synchronized screen updates.
+
+    TODO: Maybe more than alpha has to be overridden from render state.
+    TODO: Provide means to change the output area
+ */
+interface XCustomSprite : XSprite
+{
+
+    /** Query a render canvas for this sprite's content.<p>
+
+        Whatever is rendered to this canvas will become visible on the
+        screen only after a XSpriteCanvas::updateScreen() call at the
+        associated sprite canvas. This canvas is not equivalent to the
+        host canvas of the sprite. At the very least, all output
+        happens relative to the sprite's upper left corner, i.e. the
+        origin of the sprite's canvas device coordinate system will
+        move with the sprite across the screen.
+
+        @return the canvas the sprite content can be rendered into.
+     */
+    XCanvas getContentCanvas();
+
+};
+
+}; }; }; };
+
+#endif