[content] Fix a description for ContentManager
[platform/framework/native/content.git] / inc / FCntTypes.h
1 //
2 // Open Service Platform
3 // Copyright (c) 2012 Samsung Electronics Co., Ltd.
4 //
5 // Licensed under the Apache License, Version 2.0 (the License);
6 // you may not use this file except in compliance with the License.
7 // You may obtain a copy of the License at
8 //
9 //     http://www.apache.org/licenses/LICENSE-2.0
10 //
11 // Unless required by applicable law or agreed to in writing, software
12 // distributed under the License is distributed on an "AS IS" BASIS,
13 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 // See the License for the specific language governing permissions and
15 // limitations under the License.
16 //
17 /**
18  * @file                        FCntTypes.h
19  * @brief               This is the header file for the definitions of constants and enumerators in the Tizen::Content namespace.
20  *
21  * This header file contains definitions for the constants and enumerators in the Tizen::Content namespace.
22  */
23
24 #ifndef _FCNT_TYPES_H_
25 #define _FCNT_TYPES_H_
26
27 namespace Tizen { namespace Base
28 {
29 class UuId;
30 }}
31
32 namespace Tizen { namespace Base
33 {
34 class String;
35 }}
36
37 namespace Tizen { namespace Content
38 {
39
40 /**
41  * The content ID.
42  *
43  * @since       2.0
44  */
45 typedef Tizen::Base::UuId ContentId;
46
47 /**
48  * @enum ContentType
49  *
50  * Defines the content type.
51  *
52  * @since       2.0
53  */
54 enum ContentType
55 {
56         CONTENT_TYPE_OTHER = 0, /**< Other types */
57         CONTENT_TYPE_IMAGE,             /**< An Image */
58         CONTENT_TYPE_AUDIO,             /**< An Audio */
59         CONTENT_TYPE_VIDEO,             /**< A Video */
60         CONTENT_TYPE_ALL,                       /**< @if OSPDEPREC The content type: all types @endif */ /**< @if OSPDEPREC @deprecated This enumeration field is deprecated as unified search will not be supported. @endif */
61         CONTENT_TYPE_UNKNOWN            /**< An Unknown type */
62 };
63
64 /**
65  * @enum ImageOrientationType
66  *
67  * Defines the orientation type of an image
68  *
69  * @since 2.0
70  */
71 enum ImageOrientationType
72 {
73         IMAGE_ORIENTATION_TYPE_UNKNOWN = 0,             /**< An Unknown type */
74         IMAGE_ORIENTATION_TYPE_NORMAL,                          /**< Normal */
75         IMAGE_ORIENTATION_TYPE_FLIP_HORIZONTAL, /**< Flip horizontal */
76         IMAGE_ORIENTATION_TYPE_ROTATE_180,                      /**< Rotate 180 degree */
77         IMAGE_ORIENTATION_TYPE_FLIP_VERTICAL,           /**< Flip vertical */
78         IMAGE_ORIENTATION_TYPE_TRANSPOSE,                       /**< Transpose */
79         IMAGE_ORIENTATION_TYPE_ROTATE_90,                       /**< Rotate 90 degree */
80         IMAGE_ORIENTATION_TYPE_TRANSVERSE,                      /**< Transverse */
81         IMAGE_ORIENTATION_TYPE_ROTATE_270                       /**< Rotate 270 degree */
82 };
83
84 /**
85  * @enum DownloadNetworkType
86  * Defines the download network type.
87  * @since 2.1
88  */
89 enum DownloadNetworkType
90 {
91         DOWNLOAD_NETWORK_DATA_NETWORK = 1,      /**< The data network is allowed */
92         DOWNLOAD_NETWORK_WIFI,                  /*< The wifi network is allowed */
93         DOWNLOAD_NETWORK_ALL = 100              /*< The all network types are allowed */
94 };
95
96 /**
97  * @enum DownloadState
98  *
99  * Defines the download state.
100  *
101  * @since 2.0
102  */
103 enum DownloadState
104 {
105         DOWNLOAD_STATE_NONE = 0,                /**< The download request does not exist */
106         DOWNLOAD_STATE_QUEUED,                  /**< The download request is listed in a download queue */
107         DOWNLOAD_STATE_DOWNLOADING,     /**< The download request is in progress */
108         DOWNLOAD_STATE_PAUSED,                  /**< The download request is in a paused state by user request */
109         DOWNLOAD_STATE_CANCELLED,               /**< The download request is cancelled by user request */
110         DOWNLOAD_STATE_COMPLETED,               /**< The download request is in a completed state */
111         DOWNLOAD_STATE_FAILED                   /**< The download request failed */
112 };
113
114 _OSP_EXPORT_ extern const wchar_t OSP_HOME[];
115 _OSP_EXPORT_ extern const wchar_t OSP_HOME_EXT[];
116 _OSP_EXPORT_ extern const wchar_t OSP_MEDIA_PHONE[];
117 _OSP_EXPORT_ extern const wchar_t OSP_MEDIA_MMC[];
118
119 } } // Tizen::Content
120
121 #endif  // _FCNT_TYPES_H_