summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/animations/XIterateContainer.idl
diff options
context:
space:
mode:
Diffstat (limited to 'offapi/com/sun/star/animations/XIterateContainer.idl')
-rw-r--r--offapi/com/sun/star/animations/XIterateContainer.idl67
1 files changed, 67 insertions, 0 deletions
diff --git a/offapi/com/sun/star/animations/XIterateContainer.idl b/offapi/com/sun/star/animations/XIterateContainer.idl
new file mode 100644
index 000000000..5268c05f5
--- /dev/null
+++ b/offapi/com/sun/star/animations/XIterateContainer.idl
@@ -0,0 +1,67 @@
+/* -*- 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 __com_sun_star_animations_XIterateContainer_idl__
+#define __com_sun_star_animations_XIterateContainer_idl__
+
+#include <com/sun/star/animations/XTimeContainer.idl>
+
+
+ module com { module sun { module star { module animations {
+
+
+/** An iterate container iterates over subitems of a given target object
+ and animates them by subsequently executes the contained effects on them.
+ <br>
+ This could be used to animate a target text word by word or letter by
+ letter.
+*/
+interface XIterateContainer : XTimeContainer
+{
+ /** a target that contains iterable contents, f.e. a paragraph.
+ <br>
+ See documentation of used animation engine for supported targets.
+ */
+ [attribute] any Target;
+
+ /** This attribute specifies an optional subitem from the target element
+ that should be animated.
+ <br>
+ A value of zero should always be the default and animate the complete target.
+ <br>
+ See documentation of used animation engine for supported subitems.
+ */
+ [attribute] short SubItem;
+
+ /** the type of iteration, this depends on the target.
+ <br>
+ See documentation of used animation engine for supported iteration types.
+ */
+ [attribute] short IterateType;
+
+ /** the time interval in second before the next iterated content is animated.
+ */
+ [attribute] double IterateInterval;
+};
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */