base/dali-toolkit/public-api/controls/scrollable/scroll-component.h

   1 #ifndef __DALI_TOOLKIT_SCROLL_COMPONENT_H__
   2 #define __DALI_TOOLKIT_SCROLL_COMPONENT_H__
   3
   4 //
   5 // Copyright (c) 2014 Samsung Electronics Co., Ltd.
   6 //
   7 // Licensed under the Flora License, Version 1.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://floralicense.org/license/
  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 // INTERNAL INCLUDES
  21 #include <dali/dali.h>
  22 #include <dali-toolkit/public-api/controls/control.h>
  23
  24 namespace Dali DALI_IMPORT_API
  25 {
  26
  27 namespace Toolkit
  28 {
  29
  30 class ScrollComponentImpl;
  31 class ScrollConnector;
  32
  33 /**
  34  * Base class for scroll component handles.
  35  * Scroll-components such as scroll bars, indicators etc. are connected to scrollable containers via ScrollConnector.
  36  */
  37 class ScrollComponent : public Control
  38 {
  39
  40 public:
  41   /**
  42    * Create an uninitialized ScrollComponent; this can be initialized with ScrollComponent::New()
  43    * Calling member functions with an uninitialized Dali::Object is not allowed.
  44    */
  45   ScrollComponent();
  46
  47   /**
  48    * Copy constructor.
  49    */
  50   ScrollComponent( const ScrollComponent& scrollComponent );
  51
  52   /**
  53    * Assignment operator.
  54    */
  55   ScrollComponent& operator=( const ScrollComponent& scrollComponent );
  56
  57   /**
  58    * Virtual destructor.
  59    * Dali::Object derived classes typically do not contain member data.
  60    */
  61   virtual ~ScrollComponent();
  62
  63   /**
  64    * Downcast an Object handle to ScrollComponent. If handle points to a ScrollComponent the
  65    * downcast produces valid handle. If not the returned handle is left uninitialized.
  66    * @param[in] handle Handle to an object
  67    * @return handle to a ScrollComponent or an uninitialized handle
  68    */
  69   static ScrollComponent DownCast( BaseHandle handle );
  70
  71   /**
  72    * @brief Sets the scroll connector.
  73    *
  74    * @param[in] connector The scroll-connector used to connect with scrollable container.
  75    */
  76   void SetScrollConnector( ScrollConnector connector );
  77
  78   /**
  79    * @brief Retrieve the scroll connector.
  80    *
  81    * @return The scroll-connector used to connect with a scrollable container.
  82    */
  83   ScrollConnector GetScrollConnector() const;
  84
  85 public: // Not intended for application developers
  86
  87   /**
  88    * Creates a handle using the implementation.
  89    * @param[in]  implementation The Control implementation.
  90    */
  91   ScrollComponent( ScrollComponentImpl& implementation );
  92
  93   /**
  94    * Allows the creation of this Control from an Internal::CustomActor pointer.
  95    * @param[in]  internal  A pointer to the internal CustomActor.
  96    */
  97   ScrollComponent( Dali::Internal::CustomActor* internal );
  98 };
  99
 100 } // namespace Toolkit
 101
 102 } // namespace Dali
 103
 104 #endif // __DALI_TOOLKIT_SCROLL_COMPONENT_H__