dali-toolkit/internal/controls/image-view/image-view-impl.h

   1 #ifndef __DALI_TOOLKIT_INTERNAL_IMAGE_VIEW_H__
   2 #define __DALI_TOOLKIT_INTERNAL_IMAGE_VIEW_H__
   3
   4 /*
   5  * Copyright (c) 2014 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 // EXTERNAL INCLUDES
  22 #include <dali/public-api/object/property-map.h>
  23
  24 // INTERNAL INCLUDES
  25 #include <dali-toolkit/internal/controls/renderers/image/image-renderer.h>
  26 #include <dali-toolkit/public-api/controls/control-impl.h>
  27 #include <dali-toolkit/public-api/controls/image-view/image-view.h>
  28
  29 namespace Dali
  30 {
  31
  32 namespace Toolkit
  33 {
  34
  35 class ImageView;
  36
  37 namespace Internal
  38 {
  39 class ImageView : public Control
  40 {
  41 protected:
  42
  43   /**
  44    * Construct a new ImageView.
  45    */
  46   ImageView();
  47
  48   /**
  49    * A reference counted object may only be deleted by calling Unreference()
  50    */
  51   virtual ~ImageView();
  52
  53 public:
  54   /**
  55    * Create a new ImageView.
  56    * @return A smart-pointer to the newly allocated ImageView.
  57    */
  58   static Toolkit::ImageView New();
  59
  60   /**
  61    * @copydoc Dali::Toolkit::SetImage
  62    */
  63   void SetImage( Image image );
  64
  65   /**
  66    * @brief Sets this ImageView from an Dali::Property::Map
  67    *
  68    * If the handle is empty, ImageView will display nothing
  69    * @param[in] map The Dali::Property::Map to use for to display.
  70    */
  71   void SetImage( Dali::Property::Map map );
  72
  73   /**
  74    * @copydoc Dali::Toolkit::SetImage
  75    */
  76   void SetImage( const std::string& imageUrl, ImageDimensions size );
  77
  78   // Properties
  79   /**
  80    * Called when a property of an object of this type is set.
  81    * @param[in] object The object whose property is set.
  82    * @param[in] index The property index.
  83    * @param[in] value The new property value.
  84    */
  85   static void SetProperty( BaseObject* object, Property::Index index, const Property::Value& value );
  86
  87   /**
  88    * Called to retrieve a property of an object of this type.
  89    * @param[in] object The object whose property is to be retrieved.
  90    * @param[in] index The property index.
  91    * @return The current value of the property.
  92    */
  93   static Property::Value GetProperty( BaseObject* object, Property::Index propertyIndex );
  94
  95   /**
  96    * @brief Set the depth index of this image renderer
  97    *
  98    * Renderer with higher depth indices are rendered in front of other renderers with smaller values
  99    *
 100    * @param[in] depthIndex The depth index of this renderer
 101    */
 102   void SetDepthIndex( int depthIndex );
 103
 104 private: // From Control
 105
 106   /**
 107    * @copydoc Toolkit::Control::OnStageConnect()
 108    */
 109   virtual void OnStageConnection( int depth );
 110
 111   /**
 112    * @copydoc Toolkit::Control::OnStageDisconnection()
 113    */
 114   virtual void OnStageDisconnection();
 115
 116   /**
 117    * @copydoc Toolkit::Control::GetNaturalSize
 118    */
 119   virtual Vector3 GetNaturalSize();
 120
 121   /**
 122    * @copydoc Toolkit::Control::GetHeightForWidth()
 123    */
 124   virtual float GetHeightForWidth( float width );
 125
 126   /**
 127    * @copydoc Toolkit::Control::GetWidthForHeight()
 128    */
 129   virtual float GetWidthForHeight( float height );
 130
 131 private:
 132   // Undefined
 133   ImageView( const ImageView& );
 134   ImageView& operator=( const ImageView& );
 135
 136 private:
 137   Toolkit::ControlRenderer  mRenderer;
 138   ImageDimensions  mImageSize;
 139
 140   std::string      mUrl;          ///< the url for the image if the image came from a URL, empty otherwise
 141   Image            mImage;        ///< the Image if the image came from a Image, null otherwise
 142   Property::Map    mPropertyMap;  ///< the Property::Map if the image came from a Property::Map, empty otherwise
 143 };
 144
 145 } // namespace Internal
 146
 147 // Helpers for public-api forwarding methods
 148 inline Toolkit::Internal::ImageView& GetImpl( Toolkit::ImageView& obj )
 149 {
 150   DALI_ASSERT_ALWAYS(obj);
 151   Dali::RefObject& handle = obj.GetImplementation();
 152   return static_cast<Toolkit::Internal::ImageView&>(handle);
 153 }
 154
 155 inline const Toolkit::Internal::ImageView& GetImpl( const Toolkit::ImageView& obj )
 156 {
 157   DALI_ASSERT_ALWAYS(obj);
 158   const Dali::RefObject& handle = obj.GetImplementation();
 159   return static_cast<const Toolkit::Internal::ImageView&>(handle);
 160 }
 161
 162 } // namespace Toolkit
 163
 164 } // namespace Dali
 165
 166 #endif // __DALI_TOOLKIT_INTERNAL_IMAGE_VIEW_H__