#define DALI_TOOLKIT_ASYNC_IMAGE_LOADER_H
/*
- * Copyright (c) 2016 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2018 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.
#include <dali/public-api/images/image-operations.h>
#include <dali/public-api/signals/dali-signal.h>
+// INTERNAL INCLUDES
+#include <dali-toolkit/public-api/dali-toolkit-common.h>
+
namespace Dali
{
class PixelData;
}
/**
+ * @addtogroup dali_toolkit_image_loader
+ * @{
+ */
+
+/**
* @brief The AsyncImageLoader is used to load pixel data from a URL asynchronously.
*
* The images are loaded in a worker thread to avoid blocking the main event thread.
*
* @endcode
*/
-class DALI_IMPORT_API AsyncImageLoader : public BaseHandle
+class DALI_TOOLKIT_API AsyncImageLoader : public BaseHandle
{
public:
AsyncImageLoader();
/**
- * @brief Destructor
+ * @brief Destructor.
* @SINCE_1_2_14
*
* This is non-virtual since derived Handle types must not contain data or virtual methods.
AsyncImageLoader& operator=( const AsyncImageLoader& handle );
/**
- * @brief Create a new loader to load the image asynchronously in a worker thread.
+ * @brief Creates a new loader to load the image asynchronously in a worker thread.
* @SINCE_1_2_14
*
- * @return The image loader.
+ * @return The image loader
*/
static AsyncImageLoader New();
/**
- * @brief Downcast a handle to AsyncImageLoader handle.
+ * @brief Downcasts a handle to AsyncImageLoader handle.
*
- * If the handle points to an AsyncImageLoader object the downcast produces
- * a valid handle. If not, the returned handle is left uninitialized.
+ * If the handle points to an AsyncImageLoader object, the downcast produces a valid handle.
+ * If not, the returned handle is left uninitialized.
*
* @SINCE_1_2_14
* @param[in] handle A handle to an object
static AsyncImageLoader DownCast( BaseHandle handle );
/**
- * @brief Start an image loading task.
+ * @brief Starts an image loading task.
* Note: When using this method, the following defaults will be used:
* fittingMode = FittingMode::DEFAULT
* samplingMode = SamplingMode::BOX_THEN_LINEAR
* orientationCorrection = true
*
* @SINCE_1_2_14
- *
- * @param[in] url The URL of the image file to load.
- * @return The loading task id.
+ * @REMARK_INTERNET
+ * @REMARK_STORAGE
+ * @param[in] url The URL of the image file to load
+ * @return The loading task id
*/
uint32_t Load( const std::string& url );
/**
- * @brief Start an image loading task.
+ * @brief Starts an image loading task.
* Note: When using this method, the following defaults will be used:
* fittingMode = FittingMode::DEFAULT
* samplingMode = SamplingMode::BOX_THEN_LINEAR
* orientationCorrection = true
*
* @SINCE_1_2_14
- *
- * @param[in] url The URL of the image file to load.
- * @param[in] dimensions The width and height to fit the loaded image to.
- * @return The loading task id.
+ * @REMARK_INTERNET
+ * @REMARK_STORAGE
+ * @param[in] url The URL of the image file to load
+ * @param[in] dimensions The width and height to fit the loaded image to
+ * @return The loading task id
*/
uint32_t Load( const std::string& url, ImageDimensions dimensions );
/**
- * @brief Start an image loading task.
+ * @brief Starts an image loading task.
* @SINCE_1_2_14
- *
- * @param[in] url The URL of the image file to load.
- * @param[in] dimensions The width and height to fit the loaded image to.
- * @param[in] fittingMode The method used to fit the shape of the image before loading to the shape defined by the size parameter.
- * @param[in] samplingMode The filtering method used when sampling pixels from the input image while fitting it to desired size.
- * @param[in] orientationCorrection Reorient the image to respect any orientation metadata in its header.
- * @return The loading task id.
+ * @REMARK_INTERNET
+ * @REMARK_STORAGE
+ * @param[in] url The URL of the image file to load
+ * @param[in] dimensions The width and height to fit the loaded image to
+ * @param[in] fittingMode The method used to fit the shape of the image before loading to the shape defined by the size parameter
+ * @param[in] samplingMode The filtering method used when sampling pixels from the input image while fitting it to desired size
+ * @param[in] orientationCorrection Reorient the image to respect any orientation metadata in its header
+ * @return The loading task id
*/
uint32_t Load( const std::string& url,
ImageDimensions dimensions,
bool orientationCorrection );
/**
- * @brief Cancel a image loading task if it is still queueing in the work thread.
+ * @brief Cancels an image loading task if it is still queueing in the work thread.
* @SINCE_1_2_14
*
* @param[in] loadingTaskId The task id returned when invoking the load call.
bool Cancel( uint32_t loadingTaskId );
/**
- * @brief Cancel all the loading tasks in the queue
+ * @brief Cancels all the loading tasks in the queue.
* @SINCE_1_2_14
*/
void CancelAll();
/**
- * @brief Signal emit for connected callback functions to get access to the loaded pixel data.
+ * @brief Signal emitted for connected callback functions to get access to the loaded pixel data.
*
* A callback of the following type may be connected:
* @code
* void YourCallbackName( uint32_t id, PixelData pixelData );
* @endcode
* @SINCE_1_2_14
- *
- * @return A reference to a signal object to Connect() with.
+ * @return A reference to a signal object to Connect() with
*/
ImageLoadedSignalType& ImageLoadedSignal();
*
* @note Not intended for application developers
* @SINCE_1_2_14
- *
- * @param[in] impl A pointer to the object.
+ * @param[in] impl A pointer to the object
*/
explicit DALI_INTERNAL AsyncImageLoader( Internal::AsyncImageLoader* impl );
/// @endcond
};
+/**
+ * @}
+ */
} // namespace Toolkit
} // namespace Dali
projects / platform / core / uifw / dali-toolkit.git / blobdiff