inc/FUiCtrlAnimationFrame.h

   1 //
   2 // Open Service Platform
   3 // Copyright (c) 2012-2013 Samsung Electronics Co., Ltd.
   4 //
   5 // Licensed under the Apache License, Version 2.0 (the License);
   6 // you may not use this file except in compliance with the License.
   7 // You may obtain a copy of the License at
   8 //
   9 //     http://www.apache.org/licenses/LICENSE-2.0/
  10 //
  11 // Unless required by applicable law or agreed to in writing, software
  12 // distributed under the License is distributed on an "AS IS" BASIS,
  13 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14 // See the License for the specific language governing permissions and
  15 // limitations under the License.
  16 //
  17
  18 /**
  19  * @file        FUiCtrlAnimationFrame.h
  20  * @brief       This is the header file for the %AnimationFrame class.
  21  *
  22  * This header file contains the declarations of the %AnimationFrame class and its helper classes.
  23  */
  24
  25 #ifndef _FUI_CTRL_ANIMATION_FRAME_H_
  26 #define _FUI_CTRL_ANIMATION_FRAME_H_
  27
  28 #include <FBaseObject.h>
  29 #include <FGrpBitmap.h>
  30
  31 namespace Tizen { namespace Ui { namespace Controls
  32 {
  33
  34 class _AnimationFrameImpl;
  35
  36 /**
  37  * @class       AnimationFrame
  38  * @brief       This class defines the common behavior of an %AnimationFrame control.
  39  *
  40  * @since       2.0
  41  *
  42  * The %AnimationFrame class defines the common behavior of an %AnimationFrame control. @n
  43  * An animation frame includes an image to be displayed and its duration.
  44  * The duration indicates how long the image is displayed when the animation is playing.
  45  *
  46  * For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/ui/implementing_animation.htm">Animation</a>.
  47  *
  48  */
  49 class _OSP_EXPORT_ AnimationFrame
  50         : public Tizen::Base::Object
  51 {
  52
  53 public:
  54         /**
  55          * This is the default constructor for this class.
  56          *
  57          * @since               2.0
  58          */
  59         AnimationFrame(void);
  60
  61         /**
  62          * Initializes this instance of %AnimationFrame with the specified image and duration.
  63          *
  64          * @since               2.0
  65          *
  66          * @param[in]   frame           The bitmap to display
  67          * @param[in]   duration        The duration in milliseconds for which the bitmap is displayed
  68          */
  69         AnimationFrame(const Tizen::Graphics::Bitmap& frame, long duration);
  70
  71         /**
  72          * This is the destructor for this class.
  73          *
  74          * @since               2.0
  75          */
  76         ~AnimationFrame(void);
  77
  78         /**
  79          *      Sets the bitmap to be displayed during animation play.
  80          *
  81          * @since               2.0
  82          *
  83          * @param[in]   frame           The bitmap to display
  84          */
  85         void SetFrame(const Tizen::Graphics::Bitmap& frame);
  86
  87         /**
  88          * Gets the bitmap to be displayed.
  89          *
  90          * @since               2.0
  91          *
  92          * @return              The bitmap
  93          */
  94         const Tizen::Graphics::Bitmap* GetFrame(void) const;
  95
  96         /**
  97          * Sets the duration for which the bitmap is displayed.
  98          *
  99          * @since               2.0
 100          *
 101          * @param[in]   duration                The duration in milliseconds for which the bitmap is displayed
 102          */
 103         void SetDuration(long duration);
 104
 105         /**
 106          * Gets the duration for which the bitmap is displayed.
 107          *
 108          * @since       2.0
 109          *
 110          * @return      The duration value
 111          */
 112         long GetDuration(void) const;
 113
 114 private:
 115         //
 116         // The implementation of this copy constructor is intentionally blank and declared as private to prohibit copying of objects.
 117         //
 118         AnimationFrame(const AnimationFrame& rhs);
 119
 120         //
 121         // The implementation of this copy assignment operator is intentionally blank and declared as private to prohibit copying of objects.
 122         //
 123         AnimationFrame& operator =(const AnimationFrame& rhs);
 124
 125 private:
 126         _AnimationFrameImpl* __pAnimationFrameImpl;
 127
 128 };  // AnimationFrame
 129
 130 }}} // Tizen::Ui::Controls
 131
 132 #endif // _FUI_CTRL_ANIMATION_FRAME_H_