X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=inc%2FFAppAppResource.h;h=4382222cb9316cb3f176f80fcf41f1cd08cfd355;hb=f26b0f83d7c103adbd5468d05b5b89772563041f;hp=2733816ec4776b445782cb9bd4d7c69040b5fc36;hpb=2f8beb18897a92ca8476cf8dfb6b710f26da1ca3;p=platform%2Fframework%2Fnative%2Fappfw.git
diff --git a/inc/FAppAppResource.h b/inc/FAppAppResource.h
index 2733816..4382222 100644
--- a/inc/FAppAppResource.h
+++ b/inc/FAppAppResource.h
@@ -1,5 +1,4 @@
//
-// Open Service Platform
// Copyright (c) 2012 Samsung Electronics Co., Ltd.
//
// Licensed under the Apache License, Version 2.0 (the License);
@@ -48,7 +47,8 @@ namespace Tizen { namespace App
* - Use AppResource::GetBitmapN() to obtain a bitmap image that matches the screen density.
* - If the matching image does not exist, the image of the baseline density folder, ScreenDensity-High is used.
*
-* The instance of this class can be obtained through App::GetAppResource().
+* The instance of this class can be obtained through App::GetAppResource().
+*
* The following example demonstrates how to use the %AppResource class to get strings.
*
* @code
@@ -117,8 +117,8 @@ public:
* '720x1280' and if the file does not exist, it will then search the folder that corresponds to the current screen density,
* such as 'screen-density-xhigh'. After searching the density folder, all the other density folders are searched in the order high to low.
* If the requested image file is found in a density-specific folder that is different from the current screen density, the bitmap returned from this method is pre-scaled.
- * But in case of requested image file is nine-patch image saved as ".#.png" (For example : "img.#.png"),
- * then a bitmap instance which is value of returned pointer is not pre-scaled.
+ * But in case of requested image file is saved as ".#.png" (For example : "img.#.png"), then a bitmap instance which is value of returned pointer is not pre-scaled.
+ * So, it is recommended to use ".#.png" as extension (For example : "ninePatchImg.#.png") for nine-patch image file.
* Currently supported image formats are: JPEG, GIF, PNG, BMP, TIFF, and WBMP.
* For more information on the features, see Resource Fallback and Prescaling.
*
@@ -133,8 +133,9 @@ public:
* @exception E_UNSUPPORTED_FORMAT The image file format or specified pixel format is not supported.
* @exception E_FILE_NOT_FOUND The specified file cannot be found.
* @exception E_SYSTEM A system error has occurred.
- * @remarks The specific error code can be accessed using the GetLastResult() method.
- * @remarks There is a high probability for an occurrence of an out-of-memory exception. If possible, check whether the exception is E_OUT_OF_MEMORY or not. For more information on how to handle the out-of-memory exception, refer here.
+ * @remarks
+ * - The specific error code can be accessed using the GetLastResult() method.
+ * - There is a high probability for an occurrence of an out-of-memory exception. If possible, check whether the exception is E_OUT_OF_MEMORY or not. For more information on how to handle the out-of-memory exception, refer here.
*/
Tizen::Graphics::Bitmap* GetBitmapN(const Tizen::Base::String& imagePath, Tizen::Graphics::BitmapPixelFormat pixelFormat) const;
@@ -146,8 +147,8 @@ public:
* '720x1280' and if the file does not exist, it will then search the folder that corresponds to the current screen density,
* such as 'screen-density-xhigh'. After searching the density folder, all the other density folders are searched in the order high to low.
* If the requested image file is found in a density-specific folder that is different from the current screen density, the bitmap returned from this method is pre-scaled.
- * But in case of requested image file is nine-patch image saved as ".#.png" (For example : "img.#.png"),
- * then a bitmap instance which is value of returned pointer is not pre-scaled.
+ * But in case of requested image file is saved as ".#.png" (For example : "img.#.png"), then a bitmap instance which is value of returned pointer is not pre-scaled.
+ * So, it is recommended to use ".#.png" as extension (For example : "ninePatchImg.#.png") for nine-patch image file.
* Currently supported image formats are: JPEG, GIF, PNG, BMP, TIFF, and WBMP.
* For more information on the features, see Resource Fallback and Prescaling.
*
@@ -161,8 +162,9 @@ public:
* @exception E_UNSUPPORTED_FORMAT The image file format is not supported.
* @exception E_FILE_NOT_FOUND The specified file cannot be found.
* @exception E_SYSTEM A system error has occurred.
- * @remarks The specific error code can be accessed using the GetLastResult() method.
- * @remarks There is a high probability for an occurrence of an out-of-memory exception. If possible, check whether the exception is E_OUT_OF_MEMORY or not. For more information on how to handle the out-of-memory exception, refer here.
+ * @remarks
+ * - The specific error code can be accessed using the GetLastResult() method.
+ * - There is a high probability for an occurrence of an out-of-memory exception. If possible, check whether the exception is E_OUT_OF_MEMORY or not. For more information on how to handle the out-of-memory exception, refer here.
*/
Tizen::Graphics::Bitmap* GetBitmapN(const Tizen::Base::String& imagePath) const;
@@ -195,7 +197,7 @@ public:
*
* @since 2.0
*
- * @privlevel partner
+ * @privlevel platform
* @privilege %http://tizen.org/privilege/appsetting
*
* @return A pointer to the %AppResource instance, @n
@@ -216,7 +218,7 @@ public:
*
* @since 2.0
*
- * @privlevel partner
+ * @privlevel platform
* @privilege %http://tizen.org/privilege/appsetting
*
* @return An error code