inc/FCntImageContentInfo.h

   1 //
   2 // Copyright (c) 2012 Samsung Electronics Co., Ltd.
   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  * @file                        FCntImageContentInfo.h
  18  * @brief               This is the header file for the %ImageContentInfo class.
  19  *
  20  * This header file contains the declarations of the %ImageContentInfo class.
  21  */
  22
  23 #ifndef _FCNT_IMAGE_CONTENT_INFO_H_
  24 #define _FCNT_IMAGE_CONTENT_INFO_H_
  25
  26 #include <FCntContentInfo.h>
  27
  28 namespace Tizen { namespace Content
  29 {
  30
  31 class _ImageContentInfoImpl;
  32 class _ImageContentData;
  33
  34 /**
  35  * @class       ImageContentInfo
  36  * @brief       This class provides methods to access the image content information.
  37  *
  38  * @since       2.0
  39  *
  40  * @final       This class is not intended for extension.
  41  *
  42  * The %ImageContentInfo class provides methods to access the image content information that is extracted from a physical file. @n
  43  * Before getting the image content information, ContentManager must be used to create the content.
  44  *
  45  * For more information on the different types of content information, see <a href="../org.tizen.native.appprogramming/html/guide/content/device_content_mgmt.htm">Device Content Management</a>.
  46  *
  47  * The following example demonstrates how to use the %ImageContentInfo class.
  48  *
  49  * @code
  50  * result
  51  * MyClass::TestImageContentInfo(void)
  52  * {
  53  *              result r = E_SUCCESS;
  54  *
  55  *              ContentId contentId;
  56  *              ContentManager contentManager;
  57  *              r = contentManager.Construct();
  58  *              TryReturn(!IsFailed(r), r, "Construct failed.");
  59  *
  60  *              ImageContentInfo imageContentInfo;
  61  *              r = imageContentInfo.Construct(null);
  62  *              TryReturn(!IsFailed(r), r, "Construct failed.");
  63  *
  64  *              Tizen::Base::String sourcePath = Tizen::App::App::GetInstance()->GetAppRootPath() + L"data/flower.jpg";
  65  *              Tizen::Base::String destPath = Tizen::System::Environment::GetMediaPath() + L"Images/flower.jpg";
  66  *
  67  *              contentId = contentManager.CreateContent(sourcePath, destPath, false, &imageContentInfo);
  68  *              TryReturn(Tizen::Base::UuId::GetInvalidUuId() != contentId, GetLastResult(), "CreateContent failed.");
  69  *
  70  *              return r;
  71  * }
  72  * @endcode
  73  */
  74 class _OSP_EXPORT_ ImageContentInfo
  75         : public Tizen::Content::ContentInfo
  76 {
  77 public:
  78         /**
  79          * The object is not fully constructed after this constructor is called. @n
  80          * For full construction, the Construct() method must be called right after calling this constructor.
  81          *
  82          * @since               2.0
  83          */
  84         ImageContentInfo(void);
  85
  86         /**
  87          * This destructor overrides Tizen::Base::Object::~Object().
  88          *
  89          * @since               2.0
  90          */
  91         virtual ~ImageContentInfo(void);
  92
  93         /**
  94          * Initializes this instance of %ImageContentInfo with the specified parameter.
  95          *
  96          * @if OSPCOMPAT
  97          * @brief <i> [Compatibility] </i>
  98          * @endif
  99          * @since                       2.0
 100          * @if OSPCOMPAT
 101          * @compatibility This method has compatibility issues with OSP compatible applications. @n
 102          *                For more information, see @ref CompImageContentInfoConstructPage "here".
 103          * @endif
 104          *
 105          * @return              An error code
 106          * @param[in]   pContentPath            The content path @n
 107          *                                                                      The path should start with the directory path returned by
 108          *                                                                      either Tizen::System::Environment::GetMediaPath() or Tizen::System::Environment::GetExternalStoragePath() @n
 109          *                                                                      If the path is @c null,
 110          *                                                                      use ContentManager::CreateContent(const Tizen::Base::ByteBuffer&, const Tizen::Base::String&, const ContentInfo*) @n
 111          *                                                                      or ContentManager::CreateContent(const Tizen::Base::String&, const Tizen::Base::String&, bool, const ContentInfo*),
 112          *                                                                      instead of this method.
 113          * @exception   E_SUCCESS                       The method is successful.
 114          * @exception   E_FILE_NOT_FOUND        The specified file cannot be found or accessed.
 115          * @exception   E_INVALID_ARG           The specified input parameter is invalid.
 116          * @exception   E_OUT_OF_MEMORY         The memory is insufficient.
 117          * @exception   E_IO                            An I/O error has occurred.
 118          * @exception   E_SYSTEM                        An internal error has occurred.
 119          * @remarks     If the content has coordinates as metadata, they are automatically set.
 120          */
 121         result Construct(const Tizen::Base::String* pContentPath);
 122
 123         /**
 124          * @if OSPCOMPAT
 125          * @page        CompImageContentInfoConstructPage Compatibility for the file path.
 126          * @section     CompImageContentInfoConstructPageIssueSection Issues
 127          *                 The content path argument of this method in OSP compatible applications has the following issues: @n
 128          *                 <UL><li> The content path should be a path that begins with an allowed path prefix.
 129          *                     For example, L"/Media/Images/flower.jpg", L"/Storagecard/Media/Images/flower.jpg". </UL></li>
 130          *
 131          * @section             CompImageContentInfoConstructPageSolutionSection Resolutions
 132          *              This issue has been resolved in Tizen. @n
 133          *                 <UL><li> The content path can be a path without a specific allowed path prefix.
 134          *                 Applications do not need to know the specific allowed path prefixes.
 135          *                 To get the directory path, use the following methods:  </UL></li>
 136          *                 - For accessing the media directory, use Tizen::System::Environment::GetMediaPath().
 137          *                 - For accessing the external storage, use Tizen::System::Environment::GetExternalStoragePath().
 138          *
 139          * @endif
 140          */
 141
 142         /**
 143          * @if OSPDEPREC
 144          * Initializes this instance of %ImageContentInfo with the specified parameters.
 145          *
 146          * @brief       <i> [Deprecated] </i>
 147          * @deprecated   This method is deprecated as there is a problem in managing the user-defined thumbnail and device coordinates. @n
 148          *               Instead of using this method, use Construct(const Tizen::Base::String*). @n
 149          *               To set the coordinates in the ContentInfo instance, use ContentInfo::SetCoordinates(const Tizen::Locations::Coordinates&).
 150          * @since                       2.0
 151          *
 152          * @return                      An error code
 153          * @param[in]           contentPath                                     The content path
 154          * @param[in]           thumbnailPath                           The thumbnail path
 155          * @param[in]           setGps                                          Set to @c true to save the device's last known coordinates of the ContentInfo instance, @n
 156          *                                              else @c false @n
 157          *                                                                                              The coordinate information may be incorrect if it is outdated or has never been updated @n
 158          *                                              To update the coordinate information or to get the exact value,
 159          *                                              use Tizen::Locations::LocationProvider::RequestLocationUpdates() before calling this method.
 160          * @exception           E_SUCCESS                                       The method is successful.
 161          * @exception           E_FILE_NOT_FOUND                        The specified file cannot be found or accessed.
 162          * @exception           E_INVALID_ARG                           The specified input parameter is invalid.
 163          * @exception           E_OUT_OF_MEMORY                         The memory is insufficient.
 164          * @exception           E_IO                                            An I/O error has occurred.
 165          * @remarks
 166          *                              - The content path must start with @c '/Media' or @c '/Storagecard/Media'.
 167          *                              - The thumbnail path must start with @c '/Home', @c '/Media', or @c '/Storagecard/Media'. @n
 168          *                              The permitted format for a thumbnail image is bitmap (bmp).
 169          * @endif
 170          */
 171         virtual result Construct(const Tizen::Base::String& contentPath, const Tizen::Base::String& thumbnailPath = L"", bool setGps = false);
 172
 173         /**
 174          * Gets the width of the image file.
 175          *
 176          * @since               2.0
 177          *
 178          * @return              The width of the image file
 179          */
 180         int GetWidth(void) const;
 181
 182         /**
 183          * Gets the height of the image file.
 184          *
 185          * @since               2.0
 186          *
 187          * @return              The height of the image file
 188          */
 189         int GetHeight(void) const;
 190
 191         /**
 192          * Gets the title of the image file.
 193          *
 194          * @since               2.0
 195          *
 196          * @return              The title of the image file, @n
 197          *              else @c Unknown if the value is empty
 198          */
 199         Tizen::Base::String GetTitle(void) const;
 200
 201         /**
 202          * Gets the orientation of the image file.
 203          *
 204          * @since               2.0
 205          *
 206          * @return         The orientation of the image file
 207          */
 208         ImageOrientationType GetOrientation(void) const;
 209
 210 private:
 211
 212         /**
 213          * The implementation of this copy constructor is intentionally blank and declared as private to prohibit copying of objects.
 214          */
 215         ImageContentInfo(const ImageContentInfo& rhs);
 216
 217         /**
 218          * The implementation of this copy assignment operator is intentionally blank and declared as private to prohibit copying of objects.
 219          */
 220         ImageContentInfo& operator =(const ImageContentInfo& rhs);
 221
 222 private:
 223
 224         _ImageContentData* __pImageContentData;
 225         _ImageContentInfoImpl* __pImageContentInfoImpl;
 226         friend class _ImageContentInfoImpl;
 227
 228 };  // ImageContentInfo
 229
 230 }}  // Tizen::Content
 231
 232 #endif  // _FCNT_IMAGE_CONTENT_INFO_H_