#ifndef __DALI_IMAGE_H__
#define __DALI_IMAGE_H__

/*
 * Copyright (c) 2015 Samsung Electronics Co., Ltd.
 *
 * Licensed 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
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 */

// EXTERNAL INCLUDES
#include <string>

// INTERNAL INCLUDES
#include <dali/public-api/object/base-handle.h>
#include <dali/public-api/signals/dali-signal.h>

namespace Dali
{
/**
 * @addtogroup dali_core_images
 * @{
 */

namespace Internal DALI_INTERNAL
{
class Image;
}

/**
 * @brief An Image object represents an image resource that can be used for rendering.
 *
 * Image objects can be shared between Actors. This is practical if you have a visual element on screen
 * which is repeatedly used.
 *
 * The image resource is released as soon as the last Image handle is released.
 * @SINCE_1_0.0
 * @note If a resource was shared between Image objects it exists until its last reference is gone.
 *
 * Image objects are responsible for the underlying resource's lifetime.
 *
 * Signals
 * | %Signal Name           | Method                       |
 * |------------------------|------------------------------|
 * | uploaded               | @ref UploadedSignal()        |
 * @SINCE_1_0.0
 */
class DALI_IMPORT_API Image : public BaseHandle
{
public:

  /**
   * @brief Type of signal for Image Uploaded.
   * @SINCE_1_0.0
   */
  typedef Signal< void (Image) > ImageSignalType;

public:

  /**
   * @brief Constructor which creates an empty Image handle.
   *
   * This class has no New method.
   * Use the appropriate New method of its subclasses to create an initialized handle.
   * (Dali::BufferImage::New(), Dali::EncodedBufferImage::New(), Dali::FrameBufferImage::New(),
   * Dali::NativeImage::New(), Dali::ResourceImage::New())
   * @SINCE_1_0.0
   */
  Image();

  /**
   * @brief Destructor
   *
   * This is non-virtual since derived Handle types must not contain data or virtual methods.
   * @SINCE_1_0.0
   */
  ~Image();

  /**
   * @brief This copy constructor is required for (smart) pointer semantics.
   *
   * @SINCE_1_0.0
   * @param [in] handle A reference to the copied handle
   */
  Image(const Image& handle);

  /**
   * @brief This assignment operator is required for (smart) pointer semantics.
   *
   * @SINCE_1_0.0
   * @param [in] rhs  A reference to the copied handle
   * @return A reference to this
   */
  Image& operator=(const Image& rhs);

  /**
   * @brief Downcast a handle to Image handle.
   *
   * If handle points to a Image object the
   * downcast produces valid handle. If not the returned handle is left uninitialized.
   * @SINCE_1_0.0
   * @param[in] handle Handle to an object
   * @return Handle to a Image object or an uninitialized handle
   */
  static Image DownCast( BaseHandle handle );

  /**
   * @brief Returns the width of the image.
   *
   * Returns either the requested width or the actual loaded width if no specific size was requested.
   *
   * @SINCE_1_0.0
   * @return Width of the image in pixels.
   */
  unsigned int GetWidth() const;

  /**
   * @brief Returns the height of the image.
   *
   * Returns either the requested height or the actual loaded height if no specific size was requested.
   *
   * @SINCE_1_0.0
   * @return Height of the image in pixels.
   */
  unsigned int GetHeight() const;

public: // Signals

  /**
   * @brief This signal is emitted when the image data gets uploaded to GL.
   *
   * It Will be sent after an actor using the image is added to
   * the stage, when such a staged image is reloaded, or when a staged
   * BufferImage calls Update().
   * @SINCE_1_0.0
   * @return A signal object to Connect() with.
   */
  ImageSignalType& UploadedSignal();

public: // Not intended for application developers

  explicit DALI_INTERNAL Image(Internal::Image*);
};

/**
 * @}
 */
} // namespace Dali

#endif // __DALI_IMAGE_H__
