dali-toolkit/internal/controls/scroll-component/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 namespace Internal DALI_INTERNAL
  31 {
  32 class ScrollComponent;
  33 }
  34
  35 /**
  36  * Base class for derived ScrollComponents
  37  * ScrollComponents such as ScrollBar are derived from this class.
  38  * To instantiate these ScrollBars and other derived components
  39  */
  40 class ScrollComponent : public Control
  41 {
  42
  43 public:
  44   /**
  45    * Create an uninitialized ScrollComponent; this can be initialized with ScrollComponent::New()
  46    * Calling member functions with an uninitialized Dali::Object is not allowed.
  47    */
  48   ScrollComponent();
  49
  50   /**
  51    * Copy constructor.
  52    */
  53   ScrollComponent( const ScrollComponent& scrollComponent );
  54
  55   /**
  56    * Assignment operator.
  57    */
  58   ScrollComponent& operator=( const ScrollComponent& scrollComponent );
  59
  60   /**
  61    * Virtual destructor.
  62    * Dali::Object derived classes typically do not contain member data.
  63    */
  64   virtual ~ScrollComponent();
  65
  66   /**
  67    * Downcast an Object handle to ScrollComponent. If handle points to a ScrollComponent the
  68    * downcast produces valid handle. If not the returned handle is left uninitialized.
  69    * @param[in] handle Handle to an object
  70    * @return handle to a ScrollComponent or an uninitialized handle
  71    */
  72   static ScrollComponent DownCast( BaseHandle handle );
  73
  74 public: // Not intended for application developers
  75
  76   /**
  77    * Creates a handle using the Toolkit::Internal implementation.
  78    * @param[in]  implementation  The Control implementation.
  79    */
  80   ScrollComponent( Internal::ScrollComponent& implementation );
  81
  82   /**
  83    * Allows the creation of this Control from an Internal::CustomActor pointer.
  84    * @param[in]  internal  A pointer to the internal CustomActor.
  85    */
  86   ScrollComponent( Dali::Internal::CustomActor* internal );
  87 };
  88
  89 } // namespace Toolkit
  90
  91 } // namespace Dali
  92
  93 #endif // __DALI_TOOLKIT_SCROLL_COMPONENT_H__