summaryrefslogtreecommitdiffstats
path: root/slideshow/source/inc/boolanimation.hxx
blob: 16b9271eaeb91a5bef8cbd061ef5e8baedb9b851 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
/* -*- 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_BOOLANIMATION_HXX
#define INCLUDED_SLIDESHOW_SOURCE_INC_BOOLANIMATION_HXX

#include "animation.hxx"


/* Definition of BoolAnimation interface */

namespace slideshow
{
    namespace internal
    {
        /** Interface defining a bool animation.

            This interface is a specialization of the Animation
            interface, and is used to animate attributes that have
            only two discrete values (on and off, or true and false,
            for example).
         */
        class BoolAnimation : public Animation
        {
        public:
            typedef bool ValueType;

            /** Set the animation to the given value

                @param bValue
                Current animation value.
             */
            virtual bool operator()( ValueType bValue ) = 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< BoolAnimation > BoolAnimationSharedPtr;

    }
}

#endif // INCLUDED_SLIDESHOW_SOURCE_INC_BOOLANIMATION_HXX

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */