dali/public-api/images/nine-patch-image.h

   1 #ifndef __DALI_NINE_PATCH_IMAGE_H__
   2 #define __DALI_NINE_PATCH_IMAGE_H__
   3
   4 /*
   5  * Copyright (c) 2015 Samsung Electronics Co., Ltd.
   6  *
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  *
  19  */
  20
  21 // INTERNAL INCLUDES
  22 #include <dali/public-api/images/resource-image.h>
  23 #include <dali/public-api/images/buffer-image.h>
  24 #include <dali/public-api/math/rect.h>
  25
  26 namespace Dali
  27 {
  28 /**
  29  * @addtogroup dali_core_images
  30  * @{
  31  */
  32
  33 namespace Internal DALI_INTERNAL
  34 {
  35 class NinePatchImage;
  36 }
  37
  38 /**
  39  * @brief NinePatchImage represents an nine-patch image resource.
  40  *
  41  * It contains a bitmap that is synchronously loaded from the file system that contains
  42  * a 9 patch border - a 1 pixel border that describes the stretch borders and the child
  43  * area.
  44  *
  45  * The class offers an API to read the stretch area and child area, but it does not
  46  * remove the border from it's bitmap. An API can be used to obtain a BufferImage with
  47  * the border removed.
  48  * @since_tizen 2.4
  49  * @remarks This is an experimental feature for ImageActor and might not be supported in the next release.
  50  * We do recommend not to use it.
  51  */
  52 class DALI_IMPORT_API NinePatchImage : public ResourceImage
  53 {
  54 public:
  55   /**
  56    * @brief Constructor which creates an uninitialized NinePatchImage object.
  57    *
  58    * Use @ref Image::New to create an initialised object.
  59    * @since_tizen 2.4
  60    */
  61   NinePatchImage();
  62
  63   /**
  64    * @brief Create a new NinePatchImage.
  65    *
  66    * A pixel buffer for image data is allocated and loaded from the filesystem.
  67    * Dali has ownership of the buffer.
  68    * @since_tizen 2.4
  69    * @param [in] filename File to load synchronously into buffer
  70    * @return A handle to a new instance of NinePatchImage
  71    * @note Default resource management policies are Immediate and Never
  72    *
  73    */
  74   static NinePatchImage New( const std::string& filename );
  75
  76   /**
  77    * @brief Downcast a handle to NinePatchImage handle.
  78    *
  79    * If handle points to a NinePatchImage the downcast produces valid
  80    * handle. If not the returned handle is left uninitialized.
  81    *
  82    * @since_tizen 2.4
  83    * @param[in] handle Handle to an object
  84    * @return Handle to a NinePatchImage or an uninitialized handle
  85    */
  86   static NinePatchImage DownCast( BaseHandle handle );
  87
  88   /**
  89    * @brief Destructor
  90    *
  91    * This is non-virtual since derived Handle types must not contain data or virtual methods.
  92    * @since_tizen 2.4
  93    */
  94   ~NinePatchImage();
  95
  96   /**
  97    * @brief This copy constructor is required for (smart) pointer semantics.
  98    *
  99    * @since_tizen 2.4
 100    * @param [in] handle A reference to the copied handle
 101    */
 102   NinePatchImage(const NinePatchImage& handle);
 103
 104   /**
 105    * @brief This assignment operator is required for (smart) pointer semantics.
 106    *
 107    * @since_tizen 2.4
 108    * @param [in] rhs  A reference to the copied handle
 109    * @return A reference to this
 110    */
 111   NinePatchImage& operator=(const NinePatchImage& rhs);
 112
 113   /**
 114    * @brief Get the stretch borders
 115    * @since_tizen 2.4
 116    * @return The border in pixels from the left, top, right, and bottom of the image respectively.
 117    */
 118   Vector4 GetStretchBorders();
 119
 120   /**
 121    * @brief Get the child rectangle
 122    * @since_tizen 2.4
 123    * @return The position and size of the child rectangle
 124    */
 125   Rect<int> GetChildRectangle();
 126
 127   /**
 128    * @brief Creates a buffer image from the bitmap with the 1 pixel border cropped off.
 129    *
 130    * This does not change the internal bitmap.
 131    *
 132    * @since_tizen 2.4
 133    * @return The cropped BufferImage
 134    */
 135   BufferImage CreateCroppedBufferImage();
 136
 137 public: // Not intended for application developers
 138
 139   explicit DALI_INTERNAL NinePatchImage(Internal::NinePatchImage*);
 140 };
 141
 142 /**
 143  * @}
 144  */
 145 } // namespace Dali
 146
 147 #endif // __DALI_NINE_PATCH_IMAGE_H__