diff options
Diffstat (limited to '')
-rw-r--r-- | slideshow/source/inc/enumanimation.hxx | 73 |
1 files changed, 73 insertions, 0 deletions
diff --git a/slideshow/source/inc/enumanimation.hxx b/slideshow/source/inc/enumanimation.hxx new file mode 100644 index 000000000..bb659b270 --- /dev/null +++ b/slideshow/source/inc/enumanimation.hxx @@ -0,0 +1,73 @@ +/* -*- 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_ENUMANIMATION_HXX +#define INCLUDED_SLIDESHOW_SOURCE_INC_ENUMANIMATION_HXX + +#include "animation.hxx" + + +/* Definition of EnumAnimation interface */ + +namespace slideshow +{ + namespace internal + { + /** Interface defining an enum animation. + + This interface is a specialization of the Animation + interface, and is used to animate attributes representable + by a set of constant values, such as UNO constants, or enums. + */ + class EnumAnimation : public Animation + { + public: + typedef sal_Int16 ValueType; + + /** Set the animation to value k + + @param k + Current animation value (must be in an + attribute-specific permissible range). Overflowing + values will be clipped to the permissible range + internally. + */ + virtual bool operator()( ValueType k ) = 0; + + /** Request the underlying value for this animation. + + This is necessary for pure To or By animations, as the + Activity cannot determine a sensible start value + otherwise. + + @attention Note that you are only permitted to query + for the underlying value, if the animation has actually + been started (via start() call). + */ + virtual ValueType getUnderlyingValue() const = 0; + }; + + typedef ::std::shared_ptr< EnumAnimation > EnumAnimationSharedPtr; + + } +} + +#endif // INCLUDED_SLIDESHOW_SOURCE_INC_ENUMANIMATION_HXX + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ |