include/efl_util_screenshot_extension.h

   1 /*
   2  * Copyright (c) 2016 Samsung Electronics Co., Ltd All Rights Reserved
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the License);
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an AS IS BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #ifndef __TIZEN_UI_EFL_UTIL_SCREENSHOT_EXTENSION_H__
  18 #define __TIZEN_UI_EFL_UTIL_SCREENSHOT_EXTENSION_H__
  19
  20 #ifdef __cplusplus
  21 extern "C" {
  22 #endif
  23
  24 #ifdef __GNUC__
  25 # if __GNUC__ >= 4
  26 #  ifndef API
  27 #   define API __attribute__ ((visibility("default")))
  28 #  endif
  29 # endif
  30 #endif
  31
  32 /**
  33  * @file efl_util_screenshot_extension.h
  34  */
  35
  36 /**
  37  * @addtogroup CAPI_EFL_UTIL_MODULE
  38  * @{
  39  */
  40
  41 /**
  42  * @platform
  43  * @brief Set auto rotation value for screenshot.
  44  * @since_tizen 4.0
  45  * @privlevel platform
  46  * @privilege %http://tizen.org/privilege/screenshot
  47  * @param[in]  screenshot  efl_util_screenshot_h handle
  48  * @param[in]  set  auto rotation value (1:use auto rotation, 0:don't use auto rotation)
  49  * @return @c 0 on success, otherwise a negative error value
  50  * @retval #EFL_UTIL_ERROR_NONE Successful
  51  * @retval #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter
  52  * @retval #EFL_UTIL_ERROR_PERMISSION_DENIED No permission for screenshot
  53  * @see efl_util_screenshot_get_auto_rotation()
  54  */
  55 API int efl_util_screenshot_set_auto_rotation(efl_util_screenshot_h screenshot, int set);
  56
  57 /**
  58  * @platform
  59  * @brief Get current auto rotation value of screenshot.
  60  * @since_tizen 4.0
  61  * @privlevel platform
  62  * @privilege %http://tizen.org/privilege/screenshot
  63  * @param[in]  screenshot  efl_util_screenshot_h handle
  64  * @param[out]  set  The current auto rotation value of screenshot
  65  * @return @c 0 on success, otherwise a negative error value
  66  * @retval #EFL_UTIL_ERROR_NONE Successful
  67  * @retval #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter
  68  * @retval #EFL_UTIL_ERROR_PERMISSION_DENIED No permission for screenshot
  69  * @see efl_util_screenshot_set_auto_rotation()
  70  */
  71 API int efl_util_screenshot_get_auto_rotation(efl_util_screenshot_h screenshot, int *set);
  72
  73 /**
  74  * @}
  75  */
  76
  77 #ifdef __cplusplus
  78 }
  79 #endif
  80 #endif /* __TIZEN_UI_EFL_UTIL_SCREENSHOT_EXTENSION_H__ */