Optimization to reduce Handle size by 50%

[platform/core/uifw/dali-adaptor.git] / capi / dali / public-api / adaptor-framework / common / clipboard.h

diff --git a/capi/dali/public-api/adaptor-framework/common/clipboard.h b/capi/dali/public-api/adaptor-framework/common/clipboard.h
index 13dc6ba..7feaab5 100644 (file)
--- a/capi/dali/public-api/adaptor-framework/common/clipboard.h
+++ b/capi/dali/public-api/adaptor-framework/common/clipboard.h
@@ -1,25 +1,26 @@
 #ifndef  __DALI_CLIPBOARD_H__
 #define  __DALI_CLIPBOARD_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.
-//
+/*
+ * Copyright (c) 2014 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.
+ *
+ */
 
 
 /**
- * @addtogroup CAPI_DALI_FRAMEWORK
+ * @addtogroup CAPI_DALI_ADAPTOR_MODULE
  * @{
  */
 
@@ -41,7 +42,8 @@ class Clipboard;
 }
 
 /**
- * The Clipboard can operate using various funtion.
+ * @brief Interface to the device's clipboard.
+ *
  * Clipboard can manage it's item and set show / hide status.
  */
 
@@ -49,55 +51,63 @@ class Clipboard : public BaseHandle
 {
 public:
   /**
-   * Create an uninitialized Clipboard;
-   *  this can be initialized with one of the derived Clipboard' New() methods
+   * @brief Create an uninitialized Clipboard.
+   *
+   * this can be initialized with one of the derived Clipboard' New() methods
    */
   Clipboard();
 
   /**
-   * Virtual destructor.
+   * @brief Destructor
+   *
+   * This is non-virtual since derived Handle types must not contain data or virtual methods.
    */
-  virtual ~Clipboard();
+  ~Clipboard();
 
   /**
-   * This constructor is used by Adaptor::GetClipboard().
+   * @brief This constructor is used by Adaptor::GetClipboard().
+   *
    * @param[in] clipboard A pointer to the clipboard.
    */
   Clipboard( Internal::Adaptor::Clipboard* clipboard );
 
   /**
-   * Retrieve a handle to the ClipboardEventNotifier instance
+   * @brief Retrieve a handle to the ClipboardEventNotifier instance.
+   *
    * @return A handle to the Clipboard
    */
   static Clipboard Get();
 
   /**
-   * Send the given string to the clipboard
+   * @brief Send the given string to the clipboard.
+   *
    * @param[in] itemData string to send to clip board
    * @return bool true if the internal clip board sending was successful.
    */
   bool SetItem( const std::string& itemData );
 
   /**
-   * Retreive the string at the given index in the clip board.
+   * @brief Retreive the string at the given index in the clipboard.
+   *
    * @param[in] index item in clipboard list to retrieve
    * @return string the text item at the current index.
    */
   std::string GetItem( unsigned int index );
 
   /**
-   * Returns the number of item currently in the clipboard
+   * @brief Returns the number of item currently in the clipboard.
+   *
    * @return unsigned int number of clipboard items
    */
   unsigned int NumberOfItems();
 
   /**
-   * Show the clipboard window
+   * @brief Show the clipboard window.
    */
   void ShowClipboard();
 
   /**
-   * Hide the clipboard window
+   * @brief Hide the clipboard window.
    */
   void HideClipboard();