diff options
Diffstat (limited to 'offapi/com/sun/star/animations')
| -rw-r--r-- | offapi/com/sun/star/animations/AnimationFill.idl | 28 | ||||
| -rw-r--r-- | offapi/com/sun/star/animations/AnimationNodeType.idl | 2 | ||||
| -rw-r--r-- | offapi/com/sun/star/animations/Event.idl | 2 | ||||
| -rw-r--r-- | offapi/com/sun/star/animations/EventTrigger.idl | 2 | ||||
| -rw-r--r-- | offapi/com/sun/star/animations/XAnimateSet.idl | 2 | ||||
| -rw-r--r-- | offapi/com/sun/star/animations/XAnimationNode.idl | 20 | ||||
| -rw-r--r-- | offapi/com/sun/star/animations/XIterateContainer.idl | 2 |
7 files changed, 37 insertions, 21 deletions
diff --git a/offapi/com/sun/star/animations/AnimationFill.idl b/offapi/com/sun/star/animations/AnimationFill.idl index cc9796cdffe9..32b3b77fb992 100644 --- a/offapi/com/sun/star/animations/AnimationFill.idl +++ b/offapi/com/sun/star/animations/AnimationFill.idl @@ -59,19 +59,35 @@ constants AnimationFill /** Specifies that the element will not extend past the end of the last instance of the simple duration. */ const short REMOVE = 1; - /** Specifies that the element will extend past the end of the last instance of the simple duration by "freezing" the element state at that point. The parent time container of the element determines how long the element is frozen (as described immediately below). */ + /** Specifies that the element will extend past the end of the last instance of the simple duration by + "freezing" the element state at that point. The parent time container of the element determines how + long the element is frozen (as described immediately below). + */ const short FREEZE = 2; - /** Setting this to "hold" has the same effect as setting to "freeze", except that the element is always frozen to extend to the end of the simple duration of the parent time container of theelement (independent of the type of time container). For profiles that support a layered layout model (e.g., SMIL 2.0 Language Profile), held elements (elements with fill="hold") will refresh their display area when a layer is added on top then later removed. */ + /** Setting this to "hold" has the same effect as setting to "freeze", except that the element is always + frozen to extend to the end of the simple duration of the parent time container of the element + (independent of the type of time container). For profiles that support a layered layout model + (e.g., SMIL 2.0 Language Profile), held elements (elements with fill="hold") will refresh their display + area when a layer is added on top then later removed. + */ const short HOLD = 3; - /** Setting this to "transition" has the same effect as setting to "freeze", except that the element is removed at the end of the transition. This value is only allowed on elements with media directly associated with them. If specified on any other element (e.g. a time container element in the SMIL language profile), the attribute is ignored. See the SMIL Transitions module. */ + /** Setting this to "transition" has the same effect as setting to "freeze", except that the element is + removed at the end of the transition. This value is only allowed on elements with media directly + associated with them. If specified on any other element (e.g. a time container element in the SMIL + language profile), the attribute is ignored. See the SMIL Transitions module. + */ const short TRANSITION = 4; - /** The fill behavior for this element depends on whether the element specifies any of the attributes that define the simple or active duration: + /** The fill behavior for this element depends on whether the element specifies any of the attributes + that define the simple or active duration: <ul> - <li>If none of the attributes duration, end, repeatCount or repeatDuration are specified on the element, then the element will have a fill behavior identical to that if it were specified as <const>AnimationFill::FREEZE</const>.</li> - <li>Otherwise, the element will have a fill behavior identical to that if it were specified as <const>AnimationFill::REMOVE</const.</li> + <li>If none of the attributes duration, end, repeatCount or repeatDuration are specified on + the element, then the element will have a fill behavior identical to that if it were specified + as <const>AnimationFill::FREEZE</const>.</li> + <li>Otherwise, the element will have a fill behavior identical to that if it were specified as + <const>AnimationFill::REMOVE</const.</li> </ul> */ const short AUTO = 5; diff --git a/offapi/com/sun/star/animations/AnimationNodeType.idl b/offapi/com/sun/star/animations/AnimationNodeType.idl index 3d290520a774..01834c8de1fb 100644 --- a/offapi/com/sun/star/animations/AnimationNodeType.idl +++ b/offapi/com/sun/star/animations/AnimationNodeType.idl @@ -35,7 +35,7 @@ /** This constants defines a type for an animation node. <br> - It can be used to quickly identify semantic blocks inside an animation hierachy. + It can be used to quickly identify semantic blocks inside an animation hierarchy. @see AnimationNode */ diff --git a/offapi/com/sun/star/animations/Event.idl b/offapi/com/sun/star/animations/Event.idl index be5e2e1c9872..297d336978d4 100644 --- a/offapi/com/sun/star/animations/Event.idl +++ b/offapi/com/sun/star/animations/Event.idl @@ -57,7 +57,7 @@ struct Event /** an option repeat value. If the <member>Trigger</member> is <const>EventTrigger</const>, this is the number of repeats - after wich the event is initially raised. + after which the event is initially raised. */ unsigned short Repeat; }; diff --git a/offapi/com/sun/star/animations/EventTrigger.idl b/offapi/com/sun/star/animations/EventTrigger.idl index e4e56f771bf1..4ded278b44db 100644 --- a/offapi/com/sun/star/animations/EventTrigger.idl +++ b/offapi/com/sun/star/animations/EventTrigger.idl @@ -65,7 +65,7 @@ constants EventTrigger const short ON_MOUSE_ENTER = 7; const short ON_MOUSE_LEAVE = 8; - /** This event is raised when the user wants the presentation to go one step foreward. + /** This event is raised when the user wants the presentation to go one step forward. */ const short ON_NEXT = 9; diff --git a/offapi/com/sun/star/animations/XAnimateSet.idl b/offapi/com/sun/star/animations/XAnimateSet.idl index 54782cbf1563..1f363f42c62b 100644 --- a/offapi/com/sun/star/animations/XAnimateSet.idl +++ b/offapi/com/sun/star/animations/XAnimateSet.idl @@ -41,7 +41,7 @@ This interface provides a simple means of just setting the value of an attribute for a specified duration. - When using XAnimateSet, the following memebers are ignored + When using XAnimateSet, the following members are ignored <ul> <li><member>XAnimate::Values</member></li> <li><member>XAnimate::KeyTimes</member></li> diff --git a/offapi/com/sun/star/animations/XAnimationNode.idl b/offapi/com/sun/star/animations/XAnimationNode.idl index b1681d296e48..f2d5d859ce5f 100644 --- a/offapi/com/sun/star/animations/XAnimationNode.idl +++ b/offapi/com/sun/star/animations/XAnimationNode.idl @@ -51,7 +51,7 @@ interface XAnimationNode : ::com::sun::star::container::XChild */ [readonly, attribute] short Type; - /** a sequnece of values that define the begining of this element + /** a sequence of values that define the beginning of this element <br> <member>Begin</member> is <ul> @@ -65,7 +65,7 @@ interface XAnimationNode : ::com::sun::star::container::XChild external event to the element.</li> <li><type>sequence<any></type> a sequence of values described above if more than one begin value is defined for this element.</li> - <li><void/> if no begin behaviour is defined for this element.</li> + <li><void/> if no begin behavior is defined for this element.</li> </ul> @see http://www.w3.org/TR/smil20/smil-timing.html#adef-begin @@ -86,7 +86,7 @@ interface XAnimationNode : ::com::sun::star::container::XChild */ [attribute] any Duration; - /** a sequnece of values that define the ending of this element + /** a sequence of values that define the ending of this element <br> <member>End</member> is <ul> @@ -100,7 +100,7 @@ interface XAnimationNode : ::com::sun::star::container::XChild external event to the element.</li> <li><type>sequence<any></type> a sequence of values described above if more than one begin value is defined for this element.</li> - <li><void/> if no end behaviour is defined for this element.</li> + <li><void/> if no end behavior is defined for this element.</li> </ul> @see http://www.w3.org/TR/smil20/smil-timing.html#adef-end @@ -110,12 +110,12 @@ interface XAnimationNode : ::com::sun::star::container::XChild /** controls the implicit duration of time containers, as a function of the children. <br> - The endsync attribute is only valid for + The EndSync attribute is only valid for par and excl time container elements, and media elements with timed children (e.g. animate or area elements). <member>EndSync</member> is - eiter a <atom>short</atom> constant from <const>EndSync</const>, + either a <atom>short</atom> constant from <const>EndSync</const>, an interface reference to a child <type>XTimeContainer</type> or <void/>. @@ -160,7 +160,7 @@ interface XAnimationNode : ::com::sun::star::container::XChild */ [attribute] any RepeatDuration; - /** the attribute that specify the behaviour how an element + /** the attribute that specify the behavior how an element should be extended beyond the active duration by freezing the final state of the element. <br> @@ -173,7 +173,7 @@ interface XAnimationNode : ::com::sun::star::container::XChild [attribute] short Fill; /** the default value for the fill behavior for this element and all - descendents. + descendants. <br> <member>FillDefault</member> is <ul> @@ -190,7 +190,7 @@ interface XAnimationNode : ::com::sun::star::container::XChild */ [attribute] short FillDefault; - /** defines the restart behaviour of this element. + /** defines the restart behavior of this element. <br> <member>Restart</member> is a <atom>short</atom> value from <const>AnimationRestart</const>. @@ -200,7 +200,7 @@ interface XAnimationNode : ::com::sun::star::container::XChild */ [attribute] short Restart; - /** defines the default restart behaviour for this element and all descendents. + /** defines the default restart behavior for this element and all descendants. @returns a value from <const>Restart</const>. diff --git a/offapi/com/sun/star/animations/XIterateContainer.idl b/offapi/com/sun/star/animations/XIterateContainer.idl index f22c5df4f0db..310ce04ded76 100644 --- a/offapi/com/sun/star/animations/XIterateContainer.idl +++ b/offapi/com/sun/star/animations/XIterateContainer.idl @@ -45,7 +45,7 @@ */ interface XIterateContainer : XTimeContainer { - /** a target that contains iterateable contents, f.e. a paragraph. + /** a target that contains iterable contents, f.e. a paragraph. <br> See documentation of used animation engine for supported targets. */ |