Merge "Retrieve the input font's style." into devel/master

[platform/core/uifw/dali-toolkit.git] / dali-toolkit / public-api / controls / page-turn-view / page-turn-landscape-view.h

diff --git a/dali-toolkit/public-api/controls/page-turn-view/page-turn-landscape-view.h b/dali-toolkit/public-api/controls/page-turn-view/page-turn-landscape-view.h
index 2479044..d8503bf 100644 (file)
--- a/dali-toolkit/public-api/controls/page-turn-view/page-turn-landscape-view.h
+++ b/dali-toolkit/public-api/controls/page-turn-view/page-turn-landscape-view.h
@@ -1,26 +1,27 @@
 #ifndef __DALI_TOOLKIT_PAGE_TURN_LANDSCAPE_VIEW_H__
 #define __DALI_TOOLKIT_PAGE_TURN_LANDSCAPE_VIEW_H__
 
-//
-// Copyright (c) 2014 Samsung Electronics Co., Ltd.
-//
-// Licensed under the Flora License, Version 1.0 (the License);
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-//     http://floralicense.org/license/
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an AS IS BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-//
-
-//INTERNAL INCLUDES
+/*
+ * Copyright (c) 2015 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.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
+// INTERNAL INCLUDES
 #include <dali-toolkit/public-api/controls/page-turn-view/page-turn-view.h>
 
-namespace Dali DALI_IMPORT_API
+namespace Dali
 {
 
 namespace Toolkit
@@ -33,35 +34,42 @@ class PageTurnLandscapeView;
 }
 
 /**
- * PageTurnLandscapeView provides a page turn view in landscape mode
+ * @brief PageTurnLandscapeView provides a page turn view in landscape mode
+ * @SINCE_1_0.0
  */
-class PageTurnLandscapeView : public PageTurnView
+class DALI_IMPORT_API PageTurnLandscapeView : public PageTurnView
 {
 public:
   /**
-   * Create an uninitialized PageTurnLandscapeView; this can be initialized with PageTurnLandscapeView::New()
+   * @brief Create an uninitialized PageTurnLandscapeView; this can be initialized with PageTurnLandscapeView::New()
    * Calling member functions with an uninitialized Dali::Object is not allowed.
+   * @SINCE_1_0.0
    */
   PageTurnLandscapeView();
 
   /**
-   * Copy constructor.
+   * @brief Copy constructor.
+   * @SINCE_1_0.0
    */
   PageTurnLandscapeView( const PageTurnLandscapeView& pageTurnLandscapeView );
 
   /**
-   * Assignment operator.
+   * @brief Assignment operator.
+   * @SINCE_1_0.0
    */
   PageTurnLandscapeView& operator=( const PageTurnLandscapeView& pageTurnLandscapeView );
 
   /**
-   * Virtual destructor.
-   * Dali::Object derived classes typically do not contain member data.
+   * @brief Destructor
+   *
+   * This is non-virtual since derived Handle types must not contain data or virtual methods.
+   * @SINCE_1_0.0
    */
-  virtual ~PageTurnLandscapeView();
+  ~PageTurnLandscapeView();
 
   /**
-   * Create an initialized PageTurnLandscapeView control
+   * @brief Create an initialized PageTurnLandscapeView control
+   * @SINCE_1_0.0
    * @param[in] pageFactory The factory which provides PageTurnView with pages.
    * @param[in] pageSize The size of the page
    * @return A handle to the PageTurnLandscapeView control.
@@ -69,8 +77,9 @@ public:
   static PageTurnLandscapeView New( PageFactory& pageFactory, const Vector2& pageSize );
 
   /**
-   * Downcast an Object handle to PageTurnPortraitView. If handle points to a PageTurnLandscapeView the
+   * @brief Downcast an Object handle to PageTurnPortraitView. If handle points to a PageTurnLandscapeView the
    * downcast produces valid handle. If not the returned handle is left uninitialized.
+   * @SINCE_1_0.0
    * @param[in] handle Handle to an object
    * @return handle to a PageTurnLandscapeView or an uninitialized handle
    */
@@ -78,19 +87,21 @@ public:
 
 public: // Not intended for application developers
 
+  /// @cond internal
   /**
-   * Creates a handle using the Toolkit::Internal implementation.
+   * @brief Creates a handle using the Toolkit::Internal implementation.
+   * @SINCE_1_0.0
    * @param[in]  implementation  The Control implementation.
    */
-  PageTurnLandscapeView( Internal::PageTurnLandscapeView& implementation );
+  DALI_INTERNAL PageTurnLandscapeView( Internal::PageTurnLandscapeView& implementation );
 
   /**
-   * Allows the creation of this Control from an Internal::CustomActor pointer.
+   * @brief Allows the creation of this Control from an Internal::CustomActor pointer.
+   * @SINCE_1_0.0
    * @param[in]  internal  A pointer to the internal CustomActor.
    */
-  PageTurnLandscapeView( Dali::Internal::CustomActor* internal );
-
-
+  explicit DALI_INTERNAL PageTurnLandscapeView( Dali::Internal::CustomActor* internal );
+  /// @endcond
 };
 
 } // namespace Toolkit