Purge underscored header file barriers

[platform/core/uifw/dali-toolkit.git] / dali-toolkit / internal / controls / buttons / push-button-impl.h

diff --git a/dali-toolkit/internal/controls/buttons/push-button-impl.h b/dali-toolkit/internal/controls/buttons/push-button-impl.h
index 730b746..d7e91d3 100644 (file)
--- a/dali-toolkit/internal/controls/buttons/push-button-impl.h
+++ b/dali-toolkit/internal/controls/buttons/push-button-impl.h
@@ -1,8 +1,8 @@
-#ifndef __DALI_TOOLKIT_INTERNAL_PUSH_BUTTON_H__
-#define __DALI_TOOLKIT_INTERNAL_PUSH_BUTTON_H__
+#ifndef DALI_TOOLKIT_INTERNAL_PUSH_BUTTON_H
+#define DALI_TOOLKIT_INTERNAL_PUSH_BUTTON_H
 
 /*
- * Copyright (c) 2014 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2019 Samsung Electronics Co., Ltd.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -19,7 +19,7 @@
  */
 
 // EXTERNAL INCLUDES
-#include <dali/public-api/common/dali-vector.h>
+#include <dali/public-api/common/vector-wrapper.h>
 
 // INTERNAL INCLUDES
 #include <dali-toolkit/public-api/controls/buttons/push-button.h>
@@ -49,29 +49,114 @@ public:
    */
   static Dali::Toolkit::PushButton New();
 
-protected: // From Button
+protected:
 
   /**
-   * Sets the Leave signal.
+   * Construct a new PushButton.
    */
-  virtual void OnButtonInitialize();
+  PushButton();
 
-protected: // From Control
+  /**
+   * A reference counted object may only be deleted by calling Unreference()
+   */
+  virtual ~PushButton();
+
+public:
+
+  // Properties
 
   /**
-   * @copydoc Control::GetNaturalSize()
+   * Enum for the alignment modes of the icon.
    */
-  virtual Vector3 GetNaturalSize();
+  enum IconAlignment
+  {
+    LEFT,
+    RIGHT,
+    TOP,
+    BOTTOM,
+    DEFAULT = RIGHT
+  };
 
   /**
-   * Construct a new PushButton.
+   * Called when a property of an object of this type is set.
+   * @param[in] object The object whose property is set.
+   * @param[in] index The property index.
+   * @param[in] value The new property value.
    */
-  PushButton();
+  static void SetProperty( BaseObject* object, Property::Index index, const Property::Value& value );
 
   /**
-   * A reference counted object may only be deleted by calling Unreference()
+   * Called to retrieve a property of an object of this type.
+   * @param[in] object The object whose property is to be retrieved.
+   * @param[in] index The property index.
+   * @return The current value of the property.
    */
-  virtual ~PushButton();
+  static Property::Value GetProperty( BaseObject* object, Property::Index propertyIndex );
+
+  /**
+   * Deprecated API for Setting Pushbutton image using an Actor
+   * @param[in] image, Image Actor that has a url which can be used to create an image visual
+   */
+  void SetButtonImage( Actor image );
+
+  /**
+   * Deprecated API for Setting Pushbutton image using an Actor
+   * @param[in] image, Image Actor that has a url which can be used to create an image visual
+   */
+  void SetBackgroundImage( Actor image );
+
+  /**
+   * Deprecated API for Setting Pushbutton image using an Actor
+   * @param[in] image, Image Actor that has a url which can be used to create an image visual
+   */
+  void SetSelectedImage( Actor image );
+
+  /**
+   * Deprecated API for Setting Pushbutton image using an Actor
+   * @param[in] image, Image Actor that has a url which can be used to create an image visual
+   */
+  void SetSelectedBackgroundImage( Actor image );
+
+  /**
+   * Deprecated API for Setting Pushbutton image using an Actor
+   * @param[in] image, Image Actor that has a url which can be used to create an image visual
+   */
+  void SetDisabledBackgroundImage( Actor image );
+
+  /**
+   * Deprecated API for Setting Pushbutton image using an Actor
+   * @param[in] image, Image Actor that has a url which can be used to create an image visual
+   */
+  void SetDisabledImage( Actor image );
+
+  /**
+   * Deprecated API for Setting Pushbutton image using an Actor
+   * @param[in] image, Image Actor that has a url which can be used to create an image visual
+   */
+  void SetDisabledSelectedImage( Actor image );
+
+private: // From Button
+
+  /**
+   * @copydoc Toolkit::Internal::Button::OnInitialize
+   */
+  virtual void OnInitialize();
+
+private:
+
+  /**
+   * @brief Sets the alignment mode to use to align the icon to the label.
+   *
+   * @param[in] iconAlignment The alignment mode to use
+   */
+  void SetIconAlignment( const PushButton::IconAlignment iconAlignment );
+
+  /**
+   * @brief Gets the alignment mode used to align the icon to the label.
+   *
+   * @return The alignment mode in use
+   */
+  const PushButton::IconAlignment GetIconAlignment() const;
 
 private:
 
@@ -80,6 +165,10 @@ private:
 
   // Undefined
   PushButton& operator=( const PushButton& );
+
+private:
+
+  IconAlignment  mIconAlignment;                 ///< The alignment of the icon against the label.
 };
 
 } // namespace Internal
@@ -108,4 +197,4 @@ inline const Toolkit::Internal::PushButton& GetImplementation( const Toolkit::Pu
 
 } // namespace Dali
 
-#endif // __DALI_TOOLKIT_INTERNAL_PUSH_BUTTON_H__
+#endif // DALI_TOOLKIT_INTERNAL_PUSH_BUTTON_H