X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=inc%2FFSysEnvironment.h;h=5874d4f278ba06656d40486aeed3cd1dbfcc76a6;hb=4d451910df2d31e4c7ec7da85ded34bb09be862e;hp=688596397ef7b9668b694e3266277fab01c78388;hpb=ce380ff0d6dfbf0b1420e0b045f6077f2e124573;p=platform%2Fframework%2Fnative%2Fappfw.git diff --git a/inc/FSysEnvironment.h b/inc/FSysEnvironment.h index 6885963..5874d4f 100644 --- a/inc/FSysEnvironment.h +++ b/inc/FSysEnvironment.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); @@ -39,22 +38,23 @@ namespace Tizen { namespace System */ enum PredefinedDirectoryType { - PREDEFINED_DIRECTORY_IMAGES = 0, /** The directory for image files to be stored in internal storage (read-write permission) */ - PREDEFINED_DIRECTORY_SOUNDS, /** the directory for sound files to be stored in internal storage (read-write permission) */ - PREDEFINED_DIRECTORY_VIDEOS, /** The directory for video files to be stored in internal storage (read-write permission) */ - PREDEFINED_DIRECTORY_CAMERA, /** The directory for files to be stored in internal storage by camera application (read-write permission) */ - PREDEFINED_DIRECTORY_DOWNLOADS, /** The directory for files to be stored in internal storage by download manager (read-write permission) */ - PREDEFINED_DIRECTORY_OTHERS, /** The directory for other files to be stored in internal storage (read-write permission) */ - - PREDEFINED_DIRECTORY_EXTERNAL_IMAGES = 100, /** The directory for image files to be stored in external MMC (read-write permission) */ - PREDEFINED_DIRECTORY_EXTERNAL_SOUNDS, /** the directory for sound files to be stored in external MMC (read-write permission) */ - PREDEFINED_DIRECTORY_EXTERNAL_VIDEOS, /** The directory for video files to be stored in external MMC (read-write permission) */ - PREDEFINED_DIRECTORY_EXTERNAL_CAMERA, /** The directory for files to be stored in external MMC by camera application (read-write permission) */ - PREDEFINED_DIRECTORY_EXTERNAL_DOWNLOADS, /** The directory for files to be stored in external MMC by download manager (read-write permission) */ - PREDEFINED_DIRECTORY_EXTERNAL_OTHERS, /** The directory for other files to be stored in external MMC (read-write permission) */ - - PREDEFINED_DIRECTORY_APPLICATIONS = 200, /** The directory for applications to be installed in internal storage (read-only permission) */ - PREDEFINED_DIRECTORY_EXTERNAL_APPLICATIONS, /** The directory for applications to be installed in external MMC (read-only permission) */ + PREDEFINED_DIRECTORY_IMAGES = 0, /**< The directory for image files to be stored in internal storage (read-write permission) */ + PREDEFINED_DIRECTORY_SOUNDS, /**< The directory for sound files to be stored in internal storage (read-write permission) */ + PREDEFINED_DIRECTORY_VIDEOS, /**< The directory for video files to be stored in internal storage (read-write permission) */ + PREDEFINED_DIRECTORY_CAMERA, /**< The directory for files to be stored in internal storage by camera application (read-write permission) */ + PREDEFINED_DIRECTORY_DOWNLOADS, /**< The directory for files to be stored in internal storage by download manager (read-write permission) */ + PREDEFINED_DIRECTORY_OTHERS, /**< The directory for other files to be stored in internal storage (read-write permission) */ + PREDEFINED_DIRECTORY_SYSTEM_RINGTONES, /**< The directory for preloaded system ringtone files in internal storage (read only permission) @b Since: @b 2.1*/ + + PREDEFINED_DIRECTORY_EXTERNAL_IMAGES = 100, /**< The directory for image files to be stored in external MMC (read-write permission) */ + PREDEFINED_DIRECTORY_EXTERNAL_SOUNDS, /**< The directory for sound files to be stored in external MMC (read-write permission) */ + PREDEFINED_DIRECTORY_EXTERNAL_VIDEOS, /**< The directory for video files to be stored in external MMC (read-write permission) */ + PREDEFINED_DIRECTORY_EXTERNAL_CAMERA, /**< The directory for files to be stored in external MMC by camera application (read-write permission) */ + PREDEFINED_DIRECTORY_EXTERNAL_DOWNLOADS, /**< The directory for files to be stored in external MMC by download manager (read-write permission) */ + PREDEFINED_DIRECTORY_EXTERNAL_OTHERS, /**< The directory for other files to be stored in external MMC (read-write permission) */ + + PREDEFINED_DIRECTORY_APPLICATIONS = 200, /**< The directory for applications to be installed in internal storage (read-only permission) */ + PREDEFINED_DIRECTORY_EXTERNAL_APPLICATIONS, /**< The directory for applications to be installed in external MMC (read-only permission) */ }; /** @@ -72,7 +72,7 @@ class _OSP_EXPORT_ Environment public: /** - * Gets the path for the media directory that is usually used to store media contents. + * Gets the path for the media directory that stores the media contents. * * @since 2.0 * @@ -81,7 +81,7 @@ public: static Tizen::Base::String GetMediaPath(void); /** - * Gets the path for the default download directory that is usually used to store downloaded contents by the Tizen::Content::DownloadManager class. + * Gets the path for the default download directory that stores the downloaded contents by the Tizen::Content::DownloadManager class. * * @since 2.0 * @@ -101,14 +101,14 @@ public: /** * Gets the directory path according to the pre-defined directory type. * - * @since 2.0 + * @since 2.0 * - * @return The pre-defined directory path according to the specified @c dirType, @n - * else an empty string if the specified @c dirType is invalid - * @param[in] dirType The pre-defined directory type - * @remarks The directory path for some directory types such as IMAGES, SOUNDS, VIDEOS, CAMERA, DOWNLOADS, and OTHERS may not yet exist, - * so you must make sure that it exists before using it. - * @see Tizen::Io::Directory::Create() + * @return The pre-defined directory path according to the specified @c dirType, @n + * else an empty string if the specified @c dirType is invalid + * @param[in] dirType The pre-defined directory type + * @remarks The directory path for some directory types such as IMAGES, SOUNDS, VIDEOS, CAMERA, DOWNLOADS, and OTHERS may not yet exist, + * so you must make sure that it exists before using it. + * @see Tizen::Io::Directory::Create() */ static Tizen::Base::String GetPredefinedPath(PredefinedDirectoryType dirType);