dali-toolkit/internal/controls/scroll-component/scroll-bar-internal.h

   1 #ifndef __DALI_TOOLKIT_SCROLL_BAR_INTERNAL_H__
   2 #define __DALI_TOOLKIT_SCROLL_BAR_INTERNAL_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 // INTERNAL INCLUDES
  22 #include <dali-toolkit/public-api/controls/scrollable/scroll-component.h>
  23 #include <dali-toolkit/public-api/controls/scrollable/scrollable.h>
  24
  25 namespace Dali
  26 {
  27
  28 namespace Toolkit
  29 {
  30
  31 // Forward declarations
  32
  33 namespace Internal
  34 {
  35 // Forward declarations
  36
  37 class ScrollBarInternal;
  38 }
  39
  40 /**
  41  * ScrollBarInternal is a UI component that can be added to the sides of the scrollable controls
  42  * indicating the current scroll position.
  43  */
  44 class ScrollBarInternal : public ScrollComponent
  45 {
  46
  47 public:
  48
  49   /**
  50    * Create an uninitialized ScrollBarInternal; this can be initialized with ScrollBarInternal::New()
  51    * Calling member functions with an uninitialized Dali::Object is not allowed.
  52    * or horizontally (false)
  53    */
  54   ScrollBarInternal();
  55
  56   /**
  57    * Copy constructor.
  58    */
  59   ScrollBarInternal( const ScrollBarInternal& scrollBar );
  60
  61   /**
  62    * Assignment operator.
  63    */
  64   ScrollBarInternal& operator=( const ScrollBarInternal& scrollBar );
  65
  66   /**
  67    * Virtual destructor.
  68    * Dali::Object derived classes typically do not contain member data.
  69    */
  70   virtual ~ScrollBarInternal();
  71
  72     /**
  73    * Create an initialized ScrollBarInternal
  74    * @param[in] container Reference to the container of scroll bar
  75    * @param[in] vertical Whether ScrollBarInternal should be oriented vertically (true)
  76    * or horizontally (false)
  77    * @return A pointer to the created ScrollBarInternal.
  78    */
  79   static ScrollBarInternal New(Scrollable& container, bool vertical);
  80
  81   /**
  82    * Downcast an Object handle to ScrollBarInternal. If handle points to a ScrollBarInternal the
  83    * downcast produces valid handle. If not the returned handle is left uninitialized.
  84    * @param[in] handle Handle to an object
  85    * @return handle to a ScrollBarInternal or an uninitialized handle
  86    */
  87   static ScrollBarInternal DownCast( BaseHandle handle );
  88
  89   /**
  90    * Show ScrollBarInternal
  91    */
  92   void Show();
  93
  94   /**
  95    * Hide ScrollBarInternal
  96    */
  97   void Hide();
  98
  99 public: // Not intended for application developers
 100
 101   /**
 102    * Creates a handle using the Toolkit::Internal implementation.
 103    * @param[in]  implementation  The Control implementation.
 104    */
 105   ScrollBarInternal( Internal::ScrollBarInternal& implementation );
 106
 107   /**
 108    * Allows the creation of this Control from an Internal::CustomActor pointer.
 109    * @param[in]  internal  A pointer to the internal CustomActor.
 110    */
 111   ScrollBarInternal( Dali::Internal::CustomActor* internal );
 112 };
 113
 114 } // namespace Toolkit
 115
 116 } // namespace Dali
 117
 118 #endif // __DALI_TOOLKIT_SCROLL_BAR_INTERNAL_H__